|
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.dkAbstractService
This class defines methods of service with basic methods
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.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
dkAbstractService()
|
Method Summary | |
void |
addExtension(java.lang.String extensionName,
dkExtension extensionObj)
Adds a new extension object. |
void |
connect(java.lang.String service_name,
java.lang.String user_name,
java.lang.String authentication,
java.lang.String connect_string)
Connects to the named service withuser name, authentication, and connect string information. |
DKHandle |
connection()
Returns the connection handle of the service. |
void |
destroy()
service destroy - service cleanup if needed |
void |
disconnect()
Disconnects from the service. |
dkExtension |
getExtension(java.lang.String extensionName)
Gets the extension object from a given extenstion name. |
boolean |
isConnected()
Returns the status of connecting to the service. |
java.lang.String[] |
listExtensionNames()
Gets the list of extension objects' names |
void |
removeExtension(java.lang.String extensionName)
Remove an existing extension object |
java.lang.String |
serviceCategory()
Returns the category of the service. |
java.lang.String |
serviceId()
Returns the id of the service. |
java.lang.String |
serviceName()
Returns the name of the service. |
java.lang.String |
serviceType()
Returns the type of the service. |
void |
setServiceName(java.lang.String service_name)
Sets the name of the service. |
void |
setUserName(java.lang.String user_name)
Sets the name of the user. |
java.lang.String |
userName()
Returns the user name. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public dkAbstractService() 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
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
public java.lang.String serviceType() throws java.lang.Exception
serviceType
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 serviceCategory() throws java.lang.Exception
serviceCategory
in interface dkService
public java.lang.String userName() throws java.lang.Exception
userName
in interface dkService
public DKHandle connection() throws java.lang.Exception
connection
in interface dkService
public boolean isConnected() throws java.lang.Exception
isConnected
in interface dkService
public void setServiceName(java.lang.String service_name) throws java.lang.Exception
setServiceName
in interface dkService
service_name
- name of the service.public void setUserName(java.lang.String user_name) throws java.lang.Exception
setUserName
in interface dkService
user_name
- user name.public dkExtension getExtension(java.lang.String extensionName) throws DKException, java.lang.Exception
getExtension
in interface 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
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
extensionName
- name of extension object to be removedpublic java.lang.String[] listExtensionNames() throws DKException, java.lang.Exception
listExtensionNames
in interface dkService
public void destroy() throws DKException, java.lang.Exception
destroy
in interface dkService
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |