Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkIKFServiceFed

All Superinterfaces:
dkService
All Known Implementing Classes:
DKIKFServiceFed

public interface dkIKFServiceFed
extends dkService


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

copyright

public static final java.lang.String copyright

IKF_CATALOG_SERVER

public static final int IKF_CATALOG_SERVER
The following definitions are indexes that point into the server status array. The server status array is returned by pingIKFSystem.

IKF_OBHAND_SERVER

public static final int IKF_OBHAND_SERVER

IKF_LOGTRACE_SERVER

public static final int IKF_LOGTRACE_SERVER

IKF_SEARCH_SERVER

public static final int IKF_SEARCH_SERVER

IKF_TRACELEVEL_ERROR_EXCEP

public static final int IKF_TRACELEVEL_ERROR_EXCEP
Now the definitions for the trace and log levels:

IKF_TRACELEVEL_ENTRY_EXIT

public static final int IKF_TRACELEVEL_ENTRY_EXIT

IKF_TRACELEVEL_EVENT

public static final int IKF_TRACELEVEL_EVENT

IKF_TRACELEVEL_DATA

public static final int IKF_TRACELEVEL_DATA

IKF_TRACELEVEL_DUMP

public static final int IKF_TRACELEVEL_DUMP

IKF_LOGLEVEL_INFORMATION

public static final int IKF_LOGLEVEL_INFORMATION

IKF_LOGLEVEL_WARNING

public static final int IKF_LOGLEVEL_WARNING

IKF_LOGLEVEL_ERROR

public static final int IKF_LOGLEVEL_ERROR
Method Detail

startIKFSystem

public int startIKFSystem(java.lang.String instanceName,
                          java.lang.String shutdownPassword)
                   throws DKException,
                          java.lang.Exception
Starts the IKF subsystem by starting / launching all servers
Parameters:
instanceName - the name of the ikf instance to be accessed
shutdownPassword - the password that is needed to shut the servers down
Returns:
int the ikf return code for this task

stopIKFSystem

public int stopIKFSystem(java.lang.String instanceName,
                         java.lang.String shutdownPassword)
                  throws DKException,
                         java.lang.Exception
Stops the IKF subsystem by stopping all servers
Parameters:
instanceName - the name of the ikf instance to be accessed
shutdownPassword - the password that is needed to shut the servers down
Returns:
int the ikf return code for this task

pingIKFSystem

public boolean[] pingIKFSystem(java.lang.String instanceName)
                        throws DKException,
                               java.lang.Exception
Pings the Ikf Subsystem to see if all servers are working correctly
Parameters:
instanceName - the name of the ikf instance to be accessed
Returns:
array of boolean, index for server defined by IKF_xxx_SERVER, true=individual server is running, false=server is stopped

pingIKFObserverHandler

public boolean pingIKFObserverHandler(java.lang.String instanceName)
                               throws DKException,
                                      java.lang.Exception
Pings the Ikf Observer Handler to see if this server is working correctly
Parameters:
instanceName - the name of the ikf instance to be accessed
Returns:
boolean, true=server is running, false=server is stopped

pingIKFTraceServer

public boolean pingIKFTraceServer(java.lang.String instanceName)
                           throws DKException,
                                  java.lang.Exception
Pings the Ikf Trace Server to see if this server is working correctly
Parameters:
instanceName - the name of the ikf instance to be accessed
Returns:
boolean, true=server is running, false=server is stopped

pingIKFCatalogServer

public boolean pingIKFCatalogServer(java.lang.String instanceName)
                             throws DKException,
                                    java.lang.Exception
Pings the Ikf Catalog Server to see if this server is working correctly
Parameters:
instanceName - the name of the ikf instance to be accessed
Returns:
boolean, true=server is running, false=server is stopped

pingIKFTextSearchServer

public boolean pingIKFTextSearchServer(java.lang.String instanceName)
                                throws DKException,
                                       java.lang.Exception
Pings the Ikf Text Search Server to see if this server is working correctly
Parameters:
instanceName - the name of the ikf instance to be accessed
Returns:
boolean, true=server is running, false=server is stopped

getIKFInstanceDir

public java.lang.String getIKFInstanceDir(java.lang.String instanceName)
                                   throws DKException,
                                          java.lang.Exception
Gets the ikf instance root directory of the ikf installation on the target machine. This is valuable if the location of the trace/log output file has to be set.
Parameters:
instanceName - the name of the ikf instance to be accessed
Returns:
String the full qualified path to the ikf instance root directory

setIKFTraceMode

public void setIKFTraceMode(java.lang.String instanceName,
                            boolean traceMode)
                     throws DKException,
                            java.lang.Exception
Sets the trace mode for the specified ikf instance to either on or off
Parameters:
instanceName - the name of the ikf instance to be accessed
traceMode, - true=on, false=off

getIKFTraceMode

public boolean getIKFTraceMode(java.lang.String instanceName)
                        throws DKException,
                               java.lang.Exception
Gets the trace mode for the specified ikf instance
Parameters:
instanceName - the name of the ikf instance to be accessed
Returns:
boolean true=on, false=off

setIKFTraceLevel

public void setIKFTraceLevel(java.lang.String instanceName,
                             int traceLevel)
                      throws DKException,
                             java.lang.Exception
Sets the trace level for the specified ikf instance to any of five different levels
Parameters:
instanceName - the name of the ikf instance to be accessed
traceLevel - one of five different levels

getIKFTraceLevel

public int getIKFTraceLevel(java.lang.String instanceName)
                     throws DKException,
                            java.lang.Exception
Gets the trace level for the specified ikf instance
Parameters:
instanceName - the name of the ikf instance to be accessed
Returns:
int one of five different levels

setIKFTraceFile

public void setIKFTraceFile(java.lang.String instanceName,
                            java.lang.String traceFile)
                     throws DKException,
                            java.lang.Exception
Sets the trace output file for the specified ikf instance
Parameters:
instanceName - the name of the ikf instance to be accessed
traceFile - the full qualified path to the trace output file

getIKFTraceFile

public java.lang.String getIKFTraceFile(java.lang.String instanceName)
                                 throws DKException,
                                        java.lang.Exception
Gets the trace output file for the specified ikf instance
Parameters:
instanceName - the name of the ikf instance to be accessed
Returns:
String the full qualified path to the trace output file

setIKFLogMode

public void setIKFLogMode(java.lang.String instanceName,
                          boolean logMode)
                   throws DKException,
                          java.lang.Exception
Sets the logging mode for the specified ikf instance to either on or off
Parameters:
instanceName - the name of the ikf instance to be accessed
logMode, - true=on, false=off

getIKFLogMode

public boolean getIKFLogMode(java.lang.String instanceName)
                      throws DKException,
                             java.lang.Exception
Gets the logging mode for the specified ikf instance
Parameters:
instanceName - the name of the ikf instance to be accessed
Returns:
boolean true=on, false=off

setIKFLogLevel

public void setIKFLogLevel(java.lang.String instanceName,
                           int logLevel)
                    throws DKException,
                           java.lang.Exception
Sets the logging level for the specified ikf instance to any of three different levels
Parameters:
instanceName - the name of the ikf instance to be accessed
logLevel - one of three different levels

getIKFLogLevel

public int getIKFLogLevel(java.lang.String instanceName)
                   throws DKException,
                          java.lang.Exception
Gets the logging level for the specified ikf instance
Parameters:
instanceName - the name of the ikf instance to be accessed
Returns:
int one of three different levels

setIKFLogFile

public void setIKFLogFile(java.lang.String instanceName,
                          java.lang.String logFile)
                   throws DKException,
                          java.lang.Exception
Sets the log output file for the specified ikf instance
Parameters:
instanceName - the name of the ikf instance to be accessed
logFile - the full qualified path to the log output file

getIKFLogFile

public java.lang.String getIKFLogFile(java.lang.String instanceName)
                               throws DKException,
                                      java.lang.Exception
Gets the log output file for the specified ikf instance
Parameters:
instanceName - the name of the ikf instance to be accessed
Returns:
String the full qualified path to the log output file

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.