|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This class defines methods of service with basic methods
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 with user 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. |
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
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
public java.lang.String serviceName() throws java.lang.Exception
public java.lang.String serviceType() throws java.lang.Exception
public java.lang.String serviceId() throws java.lang.Exception
public java.lang.String serviceCategory() throws java.lang.Exception
public java.lang.String userName() throws java.lang.Exception
public DKHandle connection() throws java.lang.Exception
public boolean isConnected() throws java.lang.Exception
public void setServiceName(java.lang.String service_name) throws java.lang.Exception
service_name
- name of the service.public void setUserName(java.lang.String user_name) throws java.lang.Exception
user_name
- user name.public dkExtension getExtension(java.lang.String extensionName) throws DKException, java.lang.Exception
extensionName
- name of the extension object.public void addExtension(java.lang.String extensionName, dkExtension extensionObj) throws DKException, java.lang.Exception
extensionName
- name of new extension objectextensionObj
- the extension object to be setpublic void removeExtension(java.lang.String extensionName) throws DKException, java.lang.Exception
extensionName
- name of extension object to be removedpublic java.lang.String[] listExtensionNames() throws DKException, java.lang.Exception
public void destroy() throws DKException, java.lang.Exception
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |