com.ibm.mm.sdk.common

Interface dkServiceMgr

All known implementing classes:
dkAbstractServiceMgr, DKServiceMgrImp
  1. 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

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

Method Detail

registerService

  1. java.lang.String registerService( dkService service)
  2. throws DKObjectAlreadyRegistered
  3. DKException
  4. java.lang.Exception
Registers a given service.
Returns:
the registered service-id
Throws:
if - service already registered
DKObjectAlreadyRegistered
DKException
java.lang.Exception

unregisterService

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

getService

  1. dkService getService(java.lang.String serviceId)
  2. throws DKObjectNotRegistered
  3. DKException
  4. java.lang.Exception
Gets a registered service.
Parameters:
serviceId - the service-id
Returns:
the service object
Throws:
DKObjectNotRegistered
DKException
java.lang.Exception

listServiceIds

  1. java.lang.String[] listServiceIds( )
  2. throws java.lang.Exception
Gets the list of registered service ids
Throws:
java.lang.Exception

listServiceIdsByCategory

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

listServiceIdsByType

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

listServiceIdsByServer

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