|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.server.DKIKFServiceFed
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 |
public DKIKFServiceFed() throws DKException, java.lang.Exception
Method Detail |
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
connect
in interface dkService
com.ibm.mm.sdk.common.dkService
service_name
- name of the service.user_name
- user name.authentication
- authentification of the user.connect_string
- optional connection string.public void disconnect() throws DKException, java.lang.Exception
disconnect
in interface dkService
public java.lang.String serviceName() throws java.lang.Exception
serviceName
in interface dkService
com.ibm.mm.sdk.common.dkService
public java.lang.String serviceCategory() throws java.lang.Exception
serviceCategory
in interface dkService
com.ibm.mm.sdk.common.dkService
public java.lang.String serviceType() throws java.lang.Exception
serviceType
in interface dkService
com.ibm.mm.sdk.common.dkService
public dkExtension getExtension(java.lang.String extensionName) throws DKException, java.lang.Exception
getExtension
in interface dkService
com.ibm.mm.sdk.common.dkService
extensionName
- name of the extension object.public void addExtension(java.lang.String extensionName, dkExtension extensionObj) throws DKException, java.lang.Exception
addExtension
in interface dkService
com.ibm.mm.sdk.common.dkService
extensionName
- name of new extension objectextensionObj
- the extension object to be setpublic void removeExtension(java.lang.String extensionName) throws DKException, java.lang.Exception
removeExtension
in interface dkService
com.ibm.mm.sdk.common.dkService
extensionName
- name of extension object to be removedpublic java.lang.String userName() throws java.lang.Exception
userName
in interface dkService
com.ibm.mm.sdk.common.dkService
public DKHandle connection() throws java.lang.Exception
connection
in interface dkService
com.ibm.mm.sdk.common.dkService
public boolean isConnected() throws java.lang.Exception
isConnected
in interface dkService
com.ibm.mm.sdk.common.dkService
public void setServiceName(java.lang.String service_name) throws java.lang.Exception
setServiceName
in interface dkService
com.ibm.mm.sdk.common.dkService
service_name
- name of the service.public void setUserName(java.lang.String user_name) throws java.lang.Exception
setUserName
in interface dkService
com.ibm.mm.sdk.common.dkService
user_name
- user name.public void destroy() throws DKException, java.lang.Exception
destroy
in interface dkService
public java.lang.String serviceId() throws java.lang.Exception
serviceId
in interface dkService
com.ibm.mm.sdk.common.dkService
public java.lang.String[] listExtensionNames() throws DKException, java.lang.Exception
listExtensionNames
in interface dkService
com.ibm.mm.sdk.common.dkService
public int startIKFSystem(java.lang.String instanceName, java.lang.String shutdownPassword) throws DKException, java.lang.Exception
startIKFSystem
in interface dkIKFServiceFed
instanceName
- the name of the ikf instance to be accessedshutdownPassword
- the password that is needed to shutdown the serversDKException,
- Exceptionpublic int stopIKFSystem(java.lang.String instanceName, java.lang.String shutdownPassword) throws DKException, java.lang.Exception
stopIKFSystem
in interface dkIKFServiceFed
instanceName
- the name of the ikf instance to be accessedshutdownPassword
- the password that is needed to shut the servers downDKException,
- Exceptionpublic boolean[] pingIKFSystem(java.lang.String instanceName) throws DKException, java.lang.Exception
pingIKFSystem
in interface dkIKFServiceFed
instanceName
- the name of the ikf instance to be accessedDKException,
- Exceptionpublic boolean pingIKFObserverHandler(java.lang.String instanceName) throws DKException, java.lang.Exception
pingIKFObserverHandler
in interface dkIKFServiceFed
instanceName
- the name of the ikf instance to be accessedDKException,
- Exceptionpublic boolean pingIKFTraceServer(java.lang.String instanceName) throws DKException, java.lang.Exception
pingIKFTraceServer
in interface dkIKFServiceFed
instanceName
- the name of the ikf instance to be accessedDKException,
- Exceptionpublic boolean pingIKFCatalogServer(java.lang.String instanceName) throws DKException, java.lang.Exception
pingIKFCatalogServer
in interface dkIKFServiceFed
instanceName
- the name of the ikf instance to be accessedDKException,
- Exceptionpublic boolean pingIKFTextSearchServer(java.lang.String instanceName) throws DKException, java.lang.Exception
pingIKFTextSearchServer
in interface dkIKFServiceFed
instanceName
- the name of the ikf instance to be accessedDKException,
- Exceptionpublic java.lang.String getIKFInstanceDir(java.lang.String instanceName) throws DKException, java.lang.Exception
getIKFInstanceDir
in interface dkIKFServiceFed
instanceName
- the name of the ikf instance to be accessedDKException,
- Exceptionpublic void setIKFTraceMode(java.lang.String instanceName, boolean traceMode) throws DKException, java.lang.Exception
setIKFTraceMode
in interface dkIKFServiceFed
instanceName
- the name of the ikf instance to be accessedtraceMode,
- true=on, false= offDKException,
- Exceptionpublic boolean getIKFTraceMode(java.lang.String instanceName) throws DKException, java.lang.Exception
getIKFTraceMode
in interface dkIKFServiceFed
instanceName
- the name of the ikf instance to be accessedDKException,
- Exceptionpublic void setIKFTraceLevel(java.lang.String instanceName, int traceLevel) throws DKException, java.lang.Exception
setIKFTraceLevel
in interface dkIKFServiceFed
instanceName
- the name of the ikf instance to be accessedtraceLevel
- one of five different levelsDKException,
- Exceptionpublic int getIKFTraceLevel(java.lang.String instanceName) throws DKException, java.lang.Exception
getIKFTraceLevel
in interface dkIKFServiceFed
instanceName
- the name of the ikf instance to be accessedDKException,
- Exceptionpublic void setIKFTraceFile(java.lang.String instanceName, java.lang.String traceFile) throws DKException, java.lang.Exception
setIKFTraceFile
in interface dkIKFServiceFed
instanceName
- the name of the ikf instance to be accessedtraceFile
- the full qualified path to the trace output fileDKException,
- Exceptionpublic java.lang.String getIKFTraceFile(java.lang.String instanceName) throws DKException, java.lang.Exception
getIKFTraceFile
in interface dkIKFServiceFed
instanceName
- the name of the ikf instance to be accessedDKException,
- Exceptionpublic void setIKFLogMode(java.lang.String instanceName, boolean logMode) throws DKException, java.lang.Exception
setIKFLogMode
in interface dkIKFServiceFed
instanceName
- the name of the ikf instance to be accessedlogMode,
- true=on, false= offDKException,
- Exceptionpublic boolean getIKFLogMode(java.lang.String instanceName) throws DKException, java.lang.Exception
getIKFLogMode
in interface dkIKFServiceFed
instanceName
- the name of the ikf instance to be accessedDKException,
- Exceptionpublic void setIKFLogLevel(java.lang.String instanceName, int logLevel) throws DKException, java.lang.Exception
setIKFLogLevel
in interface dkIKFServiceFed
instanceName
- the name of the ikf instance to be accessedlogLevel
- one of three different levelsDKException,
- Exceptionpublic int getIKFLogLevel(java.lang.String instanceName) throws DKException, java.lang.Exception
getIKFLogLevel
in interface dkIKFServiceFed
instanceName
- the name of the ikf instance to be accessedDKException,
- Exceptionpublic void setIKFLogFile(java.lang.String instanceName, java.lang.String logFile) throws DKException, java.lang.Exception
setIKFLogFile
in interface dkIKFServiceFed
instanceName
- the name of the ikf instance to be accessedlogFile
- the full qualified path to the log output fileDKException,
- Exceptionpublic java.lang.String getIKFLogFile(java.lang.String instanceName) throws DKException, java.lang.Exception
getIKFLogFile
in interface dkIKFServiceFed
instanceName
- the name of the ikf instance to be accessedDKException,
- Exception
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |