Enterprise Information Portal APIs

com.ibm.mm.sdk.server
Class dkAbstractService

java.lang.Object
  |
  +--com.ibm.mm.sdk.server.dkAbstractService
All Implemented Interfaces:
DKConstant, DKMessageId, dkService
Direct Known Subclasses:
DKWorkFlowServiceFed

public class dkAbstractService
extends java.lang.Object
implements dkService, DKConstant, DKMessageId

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

dkAbstractService

public dkAbstractService()
                  throws DKException,
                         java.lang.Exception
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
Connects to the named service withuser name, authentication, and connect string information.
Specified by:
connect in interface 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
Disconnects from the service.
Specified by:
disconnect in interface dkService

serviceName

public java.lang.String serviceName()
                             throws java.lang.Exception
Returns the name of the service.
Specified by:
serviceName in interface dkService
Returns:
service name.

serviceType

public java.lang.String serviceType()
                             throws java.lang.Exception
Returns the type of the service.
Specified by:
serviceType in interface dkService
Returns:
service type.

serviceId

public java.lang.String serviceId()
                           throws java.lang.Exception
Returns the id of the service.
Specified by:
serviceId in interface dkService
Following copied from interface: com.ibm.mm.sdk.common.dkService
Returns:
service id.

serviceCategory

public java.lang.String serviceCategory()
                                 throws java.lang.Exception
Returns the category of the service.
Specified by:
serviceCategory in interface dkService
Returns:
service category.

userName

public java.lang.String userName()
                          throws java.lang.Exception
Returns the user name.
Specified by:
userName in interface dkService
Returns:
user name.

connection

public DKHandle connection()
                    throws java.lang.Exception
Returns the connection handle of the service.
Specified by:
connection in interface dkService
Returns:
DKHandle object.

isConnected

public boolean isConnected()
                    throws java.lang.Exception
Returns the status of connecting to the service.
Specified by:
isConnected in interface dkService
Returns:
boolean value indicating the connection status.

setServiceName

public void setServiceName(java.lang.String service_name)
                    throws java.lang.Exception
Sets the name of the service.
Specified by:
setServiceName in interface dkService
Parameters:
service_name - name of the service.

setUserName

public void setUserName(java.lang.String user_name)
                 throws java.lang.Exception
Sets the name of the user.
Specified by:
setUserName in interface dkService
Parameters:
user_name - user name.

getExtension

public dkExtension getExtension(java.lang.String extensionName)
                         throws DKException,
                                java.lang.Exception
Gets the extension object from a given extenstion name.
Specified by:
getExtension in interface 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
Adds a new extension object.
Specified by:
addExtension in interface 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
Remove an existing extension object
Specified by:
removeExtension in interface dkService
Parameters:
extensionName - name of extension object to be removed

listExtensionNames

public java.lang.String[] listExtensionNames()
                                      throws DKException,
                                             java.lang.Exception
Gets the list of extension objects' names
Specified by:
listExtensionNames in interface dkService
Returns:
an array of extension objects' names

destroy

public void destroy()
             throws DKException,
                    java.lang.Exception
service destroy - service cleanup if needed
Specified by:
destroy in interface dkService

EIP Java APIs

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