Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkServiceMgr

All Known Implementing Classes:
dkAbstractServiceMgr

public interface dkServiceMgr

Defines the interface to manage service classes. This class resides within datastore class. A service is identified by service category, service type, and the server name giving the service. These information forms an Id for the service. For example, Text Search Engine (TSE) service would be identified under a category "TEXT_SEARCH", service type "TS" and the server name, "TMMUF", or "TMBARNEY". Its id would be "TEXT_SEARCH:TS:TMBARNEY".


Method Summary
 dkService getService(java.lang.String serviceId)
          Gets a registered service.
 java.lang.String[] listServiceIds()
          Gets the list of registered service ids
 java.lang.String[] listServiceIdsByCategory(java.lang.String category)
          Gets the list of registered service ids by service category
 java.lang.String[] listServiceIdsByServer(java.lang.String server)
          Gets the list of registered service ids by server name
 java.lang.String[] listServiceIdsByType(java.lang.String type)
          Gets the list of registered service ids by service type
 java.lang.String registerService(dkService service)
          Registers a given service.
 void unregisterService(java.lang.String serviceId)
          Unregisters a given service.
 

Method Detail

registerService

public java.lang.String registerService(dkService service)
                                 throws DKObjectAlreadyRegistered,
                                        DKException,
                                        java.lang.Exception
Registers a given service.
Parameters:
the - service object to be registered
Returns:
the registered service-id
Throws:
if - service already registered

unregisterService

public void unregisterService(java.lang.String serviceId)
                       throws DKObjectNotRegistered,
                              DKException,
                              java.lang.Exception
Unregisters a given service.
Parameters:
serviceId - the service-id
Throws:
if - service not registered

getService

public dkService getService(java.lang.String serviceId)
                     throws DKObjectNotRegistered,
                            DKException,
                            java.lang.Exception
Gets a registered service.
Parameters:
serviceId - the service-id
Returns:
the service object

listServiceIds

public java.lang.String[] listServiceIds()
                                  throws java.lang.Exception
Gets the list of registered service ids

listServiceIdsByCategory

public java.lang.String[] listServiceIdsByCategory(java.lang.String category)
                                            throws java.lang.Exception
Gets the list of registered service ids by service category
Parameters:
category - the service category

listServiceIdsByType

public java.lang.String[] listServiceIdsByType(java.lang.String type)
                                        throws java.lang.Exception
Gets the list of registered service ids by service type
Parameters:
type - the service type

listServiceIdsByServer

public java.lang.String[] listServiceIdsByServer(java.lang.String server)
                                          throws java.lang.Exception
Gets the list of registered service ids by server name
Parameters:
server - the server name

EIP Java APIs

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