Enterprise Information Portal APIs

com.ibm.mm.sdk.server
Class DKIKFServiceFed

java.lang.Object
  |
  +--com.ibm.mm.sdk.server.DKIKFServiceFed
All Implemented Interfaces:
DKConstant, DKConstantFed, dkIKFServiceFed, DKMessageId, DKMessageIdFed, dkService

public class DKIKFServiceFed
extends java.lang.Object
implements dkIKFServiceFed, DKConstantFed, DKMessageIdFed

This is an implementation of IKF service for EIP that provides a set of methods for the administration of IKF


Fields inherited from interface com.ibm.mm.sdk.common.dkIKFServiceFed
copyright, IKF_CATALOG_SERVER, IKF_LOGLEVEL_ERROR, IKF_LOGLEVEL_INFORMATION, IKF_LOGLEVEL_WARNING, IKF_LOGTRACE_SERVER, IKF_OBHAND_SERVER, IKF_SEARCH_SERVER, IKF_TRACELEVEL_DATA, IKF_TRACELEVEL_DUMP, IKF_TRACELEVEL_ENTRY_EXIT, IKF_TRACELEVEL_ERROR_EXCEP, IKF_TRACELEVEL_EVENT
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantFed
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdFed
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKIKFServiceFed()
          Constructs a new DKIKFServiceFed object.
 
Method Summary
 void addExtension(java.lang.String extensionName, dkExtension extensionObj)
          This method is not used in IKF context.
 void connect(java.lang.String service_name, java.lang.String user_name, java.lang.String authentication, java.lang.String connect_string)
          This method is currently not used in IKF context since no logon to the IKF system is needed at this time.
 DKHandle connection()
          Not used in IKF context.
 void destroy()
          This method is not used in IKF context.
 void disconnect()
          This method is currently not used in IKF context since no logon to the IKF system is needed at this time.
 dkExtension getExtension(java.lang.String extensionName)
          This method is not used in IKF context.
 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 isConnected()
          This method is currently not used in IKF context since no logon to the IKF system is needed at this time.
 java.lang.String[] listExtensionNames()
          This method is not used in IKF context.
 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 whole Ikf sub system 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 removeExtension(java.lang.String extensionName)
          This method is not used in IKF context.
 java.lang.String serviceCategory()
          This method is not used in IKF context.
 java.lang.String serviceId()
          This method is not used in IKF context.
 java.lang.String serviceName()
          This method is not used in IKF context.
 java.lang.String serviceType()
          This method is not used in IKF context.
 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
 void setServiceName(java.lang.String service_name)
          This method is not used in IKF context.
 void setUserName(java.lang.String user_name)
          This method is not used in IKF context.
 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
 java.lang.String userName()
          This method is currently not used in IKF context since no logon to the IKF system is needed at this time.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKIKFServiceFed

public DKIKFServiceFed()
                throws DKException,
                       java.lang.Exception
Constructs a new DKIKFServiceFed object.
Method Detail

connect

public void connect(java.lang.String service_name,
                    java.lang.String user_name,
                    java.lang.String authentication,
                    java.lang.String connect_string)
             throws DKException,
                    java.lang.Exception
This method is currently not used in IKF context since no logon to the IKF system is needed at this time.
Specified by:
connect in interface dkService
Following copied from interface: com.ibm.mm.sdk.common.dkService
Parameters:
service_name - name of the service.
user_name - user name.
authentication - authentification of the user.
connect_string - optional connection string.

disconnect

public void disconnect()
                throws DKException,
                       java.lang.Exception
This method is currently not used in IKF context since no logon to the IKF system is needed at this time.
Specified by:
disconnect in interface dkService

serviceName

public java.lang.String serviceName()
                             throws java.lang.Exception
This method is not used in IKF context.
Specified by:
serviceName in interface dkService
Following copied from interface: com.ibm.mm.sdk.common.dkService
Returns:
service name.

serviceCategory

public java.lang.String serviceCategory()
                                 throws java.lang.Exception
This method is not used in IKF context.
Specified by:
serviceCategory in interface dkService
Following copied from interface: com.ibm.mm.sdk.common.dkService
Returns:
service category.

serviceType

public java.lang.String serviceType()
                             throws java.lang.Exception
This method is not used in IKF context.
Specified by:
serviceType in interface dkService
Following copied from interface: com.ibm.mm.sdk.common.dkService
Returns:
service type.

getExtension

public dkExtension getExtension(java.lang.String extensionName)
                         throws DKException,
                                java.lang.Exception
This method is not used in IKF context.
Specified by:
getExtension in interface dkService
Following copied from interface: com.ibm.mm.sdk.common.dkService
Parameters:
extensionName - name of the extension object.
Returns:
extension object.

addExtension

public void addExtension(java.lang.String extensionName,
                         dkExtension extensionObj)
                  throws DKException,
                         java.lang.Exception
This method is not used in IKF context.
Specified by:
addExtension in interface dkService
Following copied from interface: com.ibm.mm.sdk.common.dkService
Parameters:
extensionName - name of new extension object
extensionObj - the extension object to be set

removeExtension

public void removeExtension(java.lang.String extensionName)
                     throws DKException,
                            java.lang.Exception
This method is not used in IKF context.
Specified by:
removeExtension in interface dkService
Following copied from interface: com.ibm.mm.sdk.common.dkService
Parameters:
extensionName - name of extension object to be removed

userName

public java.lang.String userName()
                          throws java.lang.Exception
This method is currently not used in IKF context since no logon to the IKF system is needed at this time.
Specified by:
userName in interface dkService
Following copied from interface: com.ibm.mm.sdk.common.dkService
Returns:
user name.

connection

public DKHandle connection()
                    throws java.lang.Exception
Not used in IKF context.
Specified by:
connection in interface dkService
Following copied from interface: com.ibm.mm.sdk.common.dkService
Returns:
DKHandle object.

isConnected

public boolean isConnected()
                    throws java.lang.Exception
This method is currently not used in IKF context since no logon to the IKF system is needed at this time.
Specified by:
isConnected in interface dkService
Following copied from interface: com.ibm.mm.sdk.common.dkService
Returns:
boolean value indicating the connection status.

setServiceName

public void setServiceName(java.lang.String service_name)
                    throws java.lang.Exception
This method is not used in IKF context.
Specified by:
setServiceName in interface dkService
Following copied from interface: com.ibm.mm.sdk.common.dkService
Parameters:
service_name - name of the service.

setUserName

public void setUserName(java.lang.String user_name)
                 throws java.lang.Exception
This method is not used in IKF context.
Specified by:
setUserName in interface dkService
Following copied from interface: com.ibm.mm.sdk.common.dkService
Parameters:
user_name - user name.

destroy

public void destroy()
             throws DKException,
                    java.lang.Exception
This method is not used in IKF context.
Specified by:
destroy in interface dkService

serviceId

public java.lang.String serviceId()
                           throws java.lang.Exception
This method is not used in IKF context.
Specified by:
serviceId in interface dkService
Following copied from interface: com.ibm.mm.sdk.common.dkService
Returns:
service id.

listExtensionNames

public java.lang.String[] listExtensionNames()
                                      throws DKException,
                                             java.lang.Exception
This method is not used in IKF context.
Specified by:
listExtensionNames in interface dkService
Following copied from interface: com.ibm.mm.sdk.common.dkService
Returns:
an array of extension objects' names

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
Specified by:
startIKFSystem in interface dkIKFServiceFed
Parameters:
instanceName - the name of the ikf instance to be accessed
shutdownPassword - the password that is needed to shutdown the servers
Returns:
int the ikf return code for this task
Throws:
DKException, - Exception

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
Specified by:
stopIKFSystem in interface dkIKFServiceFed
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
Throws:
DKException, - Exception

pingIKFSystem

public boolean[] pingIKFSystem(java.lang.String instanceName)
                        throws DKException,
                               java.lang.Exception
Pings the whole Ikf sub system to see if all servers are working correctly
Specified by:
pingIKFSystem in interface dkIKFServiceFed
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
Throws:
DKException, - Exception

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
Specified by:
pingIKFObserverHandler in interface dkIKFServiceFed
Parameters:
instanceName - the name of the ikf instance to be accessed
Returns:
boolean true=server is running, false=server is stopped
Throws:
DKException, - Exception

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
Specified by:
pingIKFTraceServer in interface dkIKFServiceFed
Parameters:
instanceName - the name of the ikf instance to be accessed
Returns:
boolean true=server is running, false=server is stopped
Throws:
DKException, - Exception

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
Specified by:
pingIKFCatalogServer in interface dkIKFServiceFed
Parameters:
instanceName - the name of the ikf instance to be accessed
Returns:
boolean true=server is running, false=server is stopped
Throws:
DKException, - Exception

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
Specified by:
pingIKFTextSearchServer in interface dkIKFServiceFed
Parameters:
instanceName - the name of the ikf instance to be accessed
Returns:
boolean true=server is running, false=server is stopped
Throws:
DKException, - Exception

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.
Specified by:
getIKFInstanceDir in interface dkIKFServiceFed
Parameters:
instanceName - the name of the ikf instance to be accessed
Returns:
String the full qualified path to the ikf instance root directory
Throws:
DKException, - Exception

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
Specified by:
setIKFTraceMode in interface dkIKFServiceFed
Parameters:
instanceName - the name of the ikf instance to be accessed
traceMode, - true=on, false= off
Throws:
DKException, - Exception

getIKFTraceMode

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

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
Specified by:
setIKFTraceLevel in interface dkIKFServiceFed
Parameters:
instanceName - the name of the ikf instance to be accessed
traceLevel - one of five different levels
Throws:
DKException, - Exception

getIKFTraceLevel

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

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
Specified by:
setIKFTraceFile in interface dkIKFServiceFed
Parameters:
instanceName - the name of the ikf instance to be accessed
traceFile - the full qualified path to the trace output file
Throws:
DKException, - Exception

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
Specified by:
getIKFTraceFile in interface dkIKFServiceFed
Parameters:
instanceName - the name of the ikf instance to be accessed
Returns:
String the full qualified path to the trace output file
Throws:
DKException, - Exception

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
Specified by:
setIKFLogMode in interface dkIKFServiceFed
Parameters:
instanceName - the name of the ikf instance to be accessed
logMode, - true=on, false= off
Throws:
DKException, - Exception

getIKFLogMode

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

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
Specified by:
setIKFLogLevel in interface dkIKFServiceFed
Parameters:
instanceName - the name of the ikf instance to be accessed
logLevel - one of three different levels
Throws:
DKException, - Exception

getIKFLogLevel

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

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
Specified by:
setIKFLogFile in interface dkIKFServiceFed
Parameters:
instanceName - the name of the ikf instance to be accessed
logFile - the full qualified path to the log output file
Throws:
DKException, - Exception

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
Specified by:
getIKFLogFile in interface dkIKFServiceFed
Parameters:
instanceName - the name of the ikf instance to be accessed
Returns:
String the full qualified path to the log output file
Throws:
DKException, - Exception

EIP Java APIs

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