|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Field Summary | |
static java.lang.String |
copyright
|
static int |
IKF_CATALOG_SERVER
The following definitions are indexes that point into the server status array. |
static int |
IKF_LOGLEVEL_ERROR
|
static int |
IKF_LOGLEVEL_INFORMATION
|
static int |
IKF_LOGLEVEL_WARNING
|
static int |
IKF_LOGTRACE_SERVER
|
static int |
IKF_OBHAND_SERVER
|
static int |
IKF_SEARCH_SERVER
|
static int |
IKF_TRACELEVEL_DATA
|
static int |
IKF_TRACELEVEL_DUMP
|
static int |
IKF_TRACELEVEL_ENTRY_EXIT
|
static int |
IKF_TRACELEVEL_ERROR_EXCEP
Now the definitions for the trace and log levels: |
static int |
IKF_TRACELEVEL_EVENT
|
Method Summary | |
java.lang.String |
getIKFInstanceDir(java.lang.String instanceName)
Gets the ikf instance root directory of the ikf installation on the target machine. |
java.lang.String |
getIKFLogFile(java.lang.String instanceName)
Gets the log output file for the specified ikf instance |
int |
getIKFLogLevel(java.lang.String instanceName)
Gets the logging level for the specified ikf instance |
boolean |
getIKFLogMode(java.lang.String instanceName)
Gets the logging mode for the specified ikf instance |
java.lang.String |
getIKFTraceFile(java.lang.String instanceName)
Gets the trace output file for the specified ikf instance |
int |
getIKFTraceLevel(java.lang.String instanceName)
Gets the trace level for the specified ikf instance |
boolean |
getIKFTraceMode(java.lang.String instanceName)
Gets the trace mode for the specified ikf instance |
boolean |
pingIKFCatalogServer(java.lang.String instanceName)
Pings the Ikf Catalog Server to see if this server is working correctly |
boolean |
pingIKFObserverHandler(java.lang.String instanceName)
Pings the Ikf Observer Handler to see if this server is working correctly |
boolean[] |
pingIKFSystem(java.lang.String instanceName)
Pings the Ikf Subsystem to see if all servers are working correctly |
boolean |
pingIKFTextSearchServer(java.lang.String instanceName)
Pings the Ikf Text Search Server to see if this server is working correctly |
boolean |
pingIKFTraceServer(java.lang.String instanceName)
Pings the Ikf Trace Server to see if this server is working correctly |
void |
setIKFLogFile(java.lang.String instanceName,
java.lang.String logFile)
Sets the log output file for the specified ikf instance |
void |
setIKFLogLevel(java.lang.String instanceName,
int logLevel)
Sets the logging level for the specified ikf instance to any of three different levels |
void |
setIKFLogMode(java.lang.String instanceName,
boolean logMode)
Sets the logging mode for the specified ikf instance to either on or off |
void |
setIKFTraceFile(java.lang.String instanceName,
java.lang.String traceFile)
Sets the trace output file for the specified ikf instance |
void |
setIKFTraceLevel(java.lang.String instanceName,
int traceLevel)
Sets the trace level for the specified ikf instance to any of five different levels |
void |
setIKFTraceMode(java.lang.String instanceName,
boolean traceMode)
Sets the trace mode for the specified ikf instance to either on or off |
int |
startIKFSystem(java.lang.String instanceName,
java.lang.String shutdownPassword)
Starts the IKF subsystem by starting / launching all servers |
int |
stopIKFSystem(java.lang.String instanceName,
java.lang.String shutdownPassword)
Stops the IKF subsystem by stopping all servers |
Methods inherited from interface com.ibm.mm.sdk.common.dkService |
addExtension, connect, connection, destroy, disconnect, getExtension, isConnected, listExtensionNames, removeExtension, serviceCategory, serviceId, serviceName, serviceType, setServiceName, setUserName, userName |
Field Detail |
public static final java.lang.String copyright
public static final int IKF_CATALOG_SERVER
public static final int IKF_OBHAND_SERVER
public static final int IKF_LOGTRACE_SERVER
public static final int IKF_SEARCH_SERVER
public static final int IKF_TRACELEVEL_ERROR_EXCEP
public static final int IKF_TRACELEVEL_ENTRY_EXIT
public static final int IKF_TRACELEVEL_EVENT
public static final int IKF_TRACELEVEL_DATA
public static final int IKF_TRACELEVEL_DUMP
public static final int IKF_LOGLEVEL_INFORMATION
public static final int IKF_LOGLEVEL_WARNING
public static final int IKF_LOGLEVEL_ERROR
Method Detail |
public int startIKFSystem(java.lang.String instanceName, java.lang.String shutdownPassword) throws DKException, java.lang.Exception
instanceName
- the name of the ikf instance to be accessedshutdownPassword
- the password that is needed to shut the servers downpublic int stopIKFSystem(java.lang.String instanceName, java.lang.String shutdownPassword) throws DKException, java.lang.Exception
instanceName
- the name of the ikf instance to be accessedshutdownPassword
- the password that is needed to shut the servers downpublic boolean[] pingIKFSystem(java.lang.String instanceName) throws DKException, java.lang.Exception
instanceName
- the name of the ikf instance to be accessedpublic boolean pingIKFObserverHandler(java.lang.String instanceName) throws DKException, java.lang.Exception
instanceName
- the name of the ikf instance to be accessedpublic boolean pingIKFTraceServer(java.lang.String instanceName) throws DKException, java.lang.Exception
instanceName
- the name of the ikf instance to be accessedpublic boolean pingIKFCatalogServer(java.lang.String instanceName) throws DKException, java.lang.Exception
instanceName
- the name of the ikf instance to be accessedpublic boolean pingIKFTextSearchServer(java.lang.String instanceName) throws DKException, java.lang.Exception
instanceName
- the name of the ikf instance to be accessedpublic java.lang.String getIKFInstanceDir(java.lang.String instanceName) throws DKException, java.lang.Exception
instanceName
- the name of the ikf instance to be accessedpublic void setIKFTraceMode(java.lang.String instanceName, boolean traceMode) throws DKException, java.lang.Exception
instanceName
- the name of the ikf instance to be accessedtraceMode,
- true=on, false=offpublic boolean getIKFTraceMode(java.lang.String instanceName) throws DKException, java.lang.Exception
instanceName
- the name of the ikf instance to be accessedpublic void setIKFTraceLevel(java.lang.String instanceName, int traceLevel) throws DKException, java.lang.Exception
instanceName
- the name of the ikf instance to be accessedtraceLevel
- one of five different levelspublic int getIKFTraceLevel(java.lang.String instanceName) throws DKException, java.lang.Exception
instanceName
- the name of the ikf instance to be accessedpublic void setIKFTraceFile(java.lang.String instanceName, java.lang.String traceFile) throws DKException, java.lang.Exception
instanceName
- the name of the ikf instance to be accessedtraceFile
- the full qualified path to the trace output filepublic java.lang.String getIKFTraceFile(java.lang.String instanceName) throws DKException, java.lang.Exception
instanceName
- the name of the ikf instance to be accessedpublic void setIKFLogMode(java.lang.String instanceName, boolean logMode) throws DKException, java.lang.Exception
instanceName
- the name of the ikf instance to be accessedlogMode,
- true=on, false=offpublic boolean getIKFLogMode(java.lang.String instanceName) throws DKException, java.lang.Exception
instanceName
- the name of the ikf instance to be accessedpublic void setIKFLogLevel(java.lang.String instanceName, int logLevel) throws DKException, java.lang.Exception
instanceName
- the name of the ikf instance to be accessedlogLevel
- one of three different levelspublic int getIKFLogLevel(java.lang.String instanceName) throws DKException, java.lang.Exception
instanceName
- the name of the ikf instance to be accessedpublic void setIKFLogFile(java.lang.String instanceName, java.lang.String logFile) throws DKException, java.lang.Exception
instanceName
- the name of the ikf instance to be accessedlogFile
- the full qualified path to the log output filepublic java.lang.String getIKFLogFile(java.lang.String instanceName) throws DKException, java.lang.Exception
instanceName
- the name of the ikf instance to be accessed
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |