Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKRMConfigurationMgmtICM

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractConfigurationMgmt
        |
        +--com.ibm.mm.sdk.common.DKRMConfigurationMgmtICM
All Implemented Interfaces:
dkConfigurationMgmt, DKConstant, DKConstantICM, DKMessageId, DKMessageIdICM, java.io.Serializable

public class DKRMConfigurationMgmtICM
extends dkAbstractConfigurationMgmt
implements DKMessageIdICM, DKConstantICM, java.io.Serializable

Use this class to represent the resource manager entities in an ICM datastore and manage the resource manager in the ICM datastore. The resource managers and the SMS collections in the resource managers can created, listed, updated and deleted in the ICM datastore.

See Also:
DKResourceMgrDefICM., Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdICM
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantICM
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Constructor Summary
DKRMConfigurationMgmtICM(dkDatastore ds)
          Constructs a resrouce manager configuration managment object for ICM datastore and initializes the datastore on which this object manages.
 
Method Summary
 void addResourceMgr(DKResourceMgrDefICM rmObject)
          Adds a new resource manager to the ICM datastore and if successful, the local cache is updated.
 void addRMAccessType(DKNLSKeywordDefICM rmAccessTypeObj)
          Defines a new resource manager access protcol string.
 void addSMSCollection(DKSMSCollectionDefICM rmCollObject)
          Adds a new resource manager SMS collection to this ICM datastore Note: Upon successful addition this SMS collection is added to the local cache.
 void clearCache()
          Clears all cache data The lists: rmCache, smsCollCache smsIDCache will be cleared.
 void delResourceMgr(java.lang.String rmName)
          Removes a resource manager from the ICM datastore and if successful, the local cache is updated.
 void delRMAccessType(java.lang.String rmAccessTypeName)
          Removes a current resource manager access protocol string by name
 void delSMSCollection(java.lang.String rmCollName)
          Removes all resource manager SMS collections from the ICM datastoreis with the specified name.
 void delSMSCollection(java.lang.String rmCollName, short rmCode)
          Removes the resource manager SMS collection from the ICM datastore with a given name and belonging to a resource manager specified by the resource manager code.
 java.lang.String[] listResourceMgrNames()
          Gets a list of resource manager names associated with the current ICM datastore.
 java.lang.String[] listResourceMgrNames(int domainID)
          Gets a list of resource manager names that are in the specified administrative domain id and associated with the current ICM datastore.
 java.lang.String[] listResourceMgrNames(java.lang.String domainName)
          Gets a list of resource manager names that are in the specified administrative domain name and associated with the current ICM datastore.
 dkCollection listResourceMgrs()
          Gets a collection of resource manager objects defined to the ICM datastore.
 dkCollection listResourceMgrs(int domainID)
          Gets a collection of resource manager objects defined to the ICM datastore and assigned to the specified administrative domain id.
 dkCollection listResourceMgrs(java.lang.String domainName)
          Gets a collection of resource manager objects defined to the ICM datastore and assigned to the specified administrative domain name.
 dkCollection listRMAccessTypes()
          lists the resource manager access protocols strings that are supported by the datastore to access the resource managers.
 java.lang.String[] listSMSCollectionNames()
          lists all resource manager SMS collections names from the ICM datastore.
 java.lang.String[] listSMSCollectionNames(int domainID)
          Lists all resource manager SMS collection names from the ICM datastore that are assigned to a specified administrative domain id lists resourcelists resource manager collection names from the datastore
 java.lang.String[] listSMSCollectionNames(int domainID, short rmCode)
          Lists all resource manager SMS collection names from the ICM datastore that are assigned to a specified administrative domain id and belonging to a specified resource manager.
 java.lang.String[] listSMSCollectionNames(short rmCode)
          Lists all resource manager SMS collection names that belong the specified resource manager from the ICM datastore.
 java.lang.String[] listSMSCollectionNames(java.lang.String domainName)
          Lists all resource manager SMS collection names from the ICM datastore that are assigned to a specified administrative domain name.
 java.lang.String[] listSMSCollectionNames(java.lang.String domainName, short rmCode)
          Lists all resource manager SMS collection names from the ICM datastore that are assigned to a specified administrative domain name and belonging to a specified resource manager.
 dkCollection listSMSCollections()
          lists all resource manager SMS collections from the ICM datastore.
 dkCollection listSMSCollections(int domainID)
          Lists all resource manager SMS collections from the ICM datastore that are assigned to a specified administrative domain id.
 dkCollection listSMSCollections(int domainID, short rmCode)
          Lists all resource manager SMS collections from the ICM datastore that are assigned to a specified administrative domain id and belonging to a specified resource manager.
 dkCollection listSMSCollections(short rmCode)
          Lists all resource manager SMS collections that belong the specified resource manager from the ICM datastore.
 dkCollection listSMSCollections(java.lang.String domainName)
          Lists all resource manager SMS collections from the ICM datastore that are assigned to a specified administrative domain name.
 dkCollection listSMSCollections(java.lang.String domainName, short rmCode)
          Lists all resource manager SMS collections from the ICM datastore that are assigned to a specified administrative domain name and belonging to a specified resource manager.
 DKResourceMgrDefICM retrieveResourceMgr(java.lang.String rmName)
          Given the resource manager name it is retrieved from the ICM datastore.
 DKResourceMgrDefICM retrieveResourceMgrByID(short rmCode)
          Given the resource manager code it is retrieved from the ICM datastore.
 DKNLSKeywordDefICM retrieveRMAccessType(java.lang.String accessTypeName)
          Retrieves a resource manager access protocol string from the ICM datastore.
 dkCollection retrieveSMSCollection(java.lang.String rmCollName)
          retrieve a resource manager SMS collection with the specified name from the ICM datastore irrespective of the resource manager to which these resource manager SMS collections belong to.
 DKSMSCollectionDefICM retrieveSMSCollection(java.lang.String rmCollName, short rmCode)
          retrieve a resource manager SMS collection with the specified name, belonging to the specified resource manager code from the ICM datastore.
 DKSMSCollectionDefICM retrieveSMSCollection(java.lang.String rmCollName, java.lang.String rmName)
          retrieve a resource manager SMS collection with the specified name, belonging to the specified resource manager name from the ICM datastore.
 DKSMSCollectionDefICM retrieveSMSCollectionByID(short rmCollID)
          Deprecated. replace by retrieveSMSCollectionByID(short rmCode, short rmCollID)
 DKSMSCollectionDefICM retrieveSMSCollectionByID(short rmCollID, short rmCode)
          Retrieve a resource manager SMS collection with the specified id, belonging to the specified resource manager code from the ICM datastore.
 void updateReplicaRulesForSMSCollection(DKSMSCollectionDefICM smsCollObj)
          Updates the replica rules for the resource manager SMS collection
 void updateResourceMgr(DKResourceMgrDefICM rmObject)
          Updates a resource manager in the ICM datastore.
 void updateRMAccessType(DKNLSKeywordDefICM rmAccessTypeObj)
          Updates a resource manager access protocol string.
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractConfigurationMgmt
getDatastore, setDatastore
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKRMConfigurationMgmtICM

public DKRMConfigurationMgmtICM(dkDatastore ds)
                         throws DKException,
                                java.lang.Exception
Constructs a resrouce manager configuration managment object for ICM datastore and initializes the datastore on which this object manages.
Parameters:
ds - - a reference to ICM datastore object on which the resoruce manager configuration is managed.
Throws:
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.
Method Detail

listRMAccessTypes

public dkCollection listRMAccessTypes()
                               throws DKException,
                                      java.lang.Exception
lists the resource manager access protocols strings that are supported by the datastore to access the resource managers. This class lists the protocol names and this name can be used to the retrieve the details by calling the retrieveRMAccessType method. Note: These access protocols can be used when defining a new resource manager to ICM datastore
Returns:
a dkCollection of DKNLSKeywordDefICM objects which are the access protocols that is supported by the datastore to access the resource managers.
Throws:
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.
See Also:
DKNLSKeywordsDefICM.

retrieveRMAccessType

public DKNLSKeywordDefICM retrieveRMAccessType(java.lang.String accessTypeName)
                                        throws DKNotExistException,
                                               DKException,
                                               java.lang.Exception
Retrieves a resource manager access protocol string from the ICM datastore.
Parameters:
accessTypeName - - name of the access protocol.
Returns:
a DKNLSKeywordDefICM object to represent the resource manager access protocol
Throws:
DKNotExistException - if the access protocol name does not exist in the system
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

addRMAccessType

public void addRMAccessType(DKNLSKeywordDefICM rmAccessTypeObj)
                     throws DKAlreadyExistException,
                            DKException,
                            java.lang.Exception
Defines a new resource manager access protcol string.
Parameters:
rmAccessTypeObj - - a DKNLSKeywordDefICM object to be added. This object defines the resource manager protocol string. The access protocol can be up to 32 characters long and the access protocol description can be up to 254 characters long.
Throws:
DKAlreadyExistException - if the access protocol already exists in the system
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

updateRMAccessType

public void updateRMAccessType(DKNLSKeywordDefICM rmAccessTypeObj)
                        throws DKNotExistException,
                               DKException,
                               java.lang.Exception
Updates a resource manager access protocol string.
Parameters:
rmAccessTypeObj - - a DKNLSKeywordDefICM object to be updated
Throws:
DKNotExistException - if the access protocol does not exist in the system
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

delRMAccessType

public void delRMAccessType(java.lang.String rmAccessTypeName)
                     throws DKNotExistException,
                            DKException,
                            java.lang.Exception
Removes a current resource manager access protocol string by name
Parameters:
rmAccessTypeName - - an access protocol name to be removed
Throws:
DKNotExistException - if the access protocol name does not exist in the system
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

listSMSCollections

public dkCollection listSMSCollections()
                                throws DKException,
                                       java.lang.Exception
lists all resource manager SMS collections from the ICM datastore. Note:the local cache is updated with this resource manager SMS collection list.
Returns:
a dkCollection of DKSMSCollectionDefICM objects that are available in the ICM datastore.
Throws:
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.
See Also:
DKSMSCollectionDefICM

listSMSCollections

public dkCollection listSMSCollections(short rmCode)
                                throws DKException,
                                       java.lang.Exception
Lists all resource manager SMS collections that belong the specified resource manager from the ICM datastore. Note: the local cache is updated with this resource manager SMS collection list.
Parameters:
rmCode - - resource manager code whose resource manager SMS collections are to be listed.
Returns:
a dkCollection of DKSMSCollectionDefICM objects for a given resource manager.
Throws:
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.
See Also:
DKSMSCollectionDefICM

listSMSCollections

public dkCollection listSMSCollections(int domainID)
                                throws DKException,
                                       java.lang.Exception
Lists all resource manager SMS collections from the ICM datastore that are assigned to a specified administrative domain id. Note: the local cache is updated with this resource manager SMS collection list.
Parameters:
domainID - - administrative domain id whose resource manager SMS collections are to be listed.
Returns:
a dkCollection of DKSMSCollectionDefICM objects
Throws:
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

listSMSCollections

public dkCollection listSMSCollections(java.lang.String domainName)
                                throws DKException,
                                       java.lang.Exception
Lists all resource manager SMS collections from the ICM datastore that are assigned to a specified administrative domain name. Note: the local cache is updated with this resource manager SMS collection list.
Parameters:
domainName - - admininistrative domain name whose resource manager SMS collections are to be listed.
Returns:
a dkCollection of DKSMSCollectionDefICM objects
Throws:
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

listSMSCollections

public dkCollection listSMSCollections(int domainID,
                                       short rmCode)
                                throws DKException,
                                       java.lang.Exception
Lists all resource manager SMS collections from the ICM datastore that are assigned to a specified administrative domain id and belonging to a specified resource manager. Note: the local cache is updated with this resource manager SMS collection list.
Parameters:
domainID - - administrative domain id whose resource manager SMS collections are to be listed.
rmCode - - resource manager code to which the resource manager SMS collection belongs to.
Returns:
a dkCollection of DKSMSCollectionDefICM objects
Throws:
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

listSMSCollections

public dkCollection listSMSCollections(java.lang.String domainName,
                                       short rmCode)
                                throws DKException,
                                       java.lang.Exception
Lists all resource manager SMS collections from the ICM datastore that are assigned to a specified administrative domain name and belonging to a specified resource manager. Note: the local cache is updated with this resource manager SMS collection list.
Parameters:
domainName - - administrative domain name whose resource manager SMS collections are to be listed.
rmCode - - resource manager code to which the resource manager SMS collection belongs to.
Returns:
a dkCollection of DKSMSCollectionDefICM objects
Throws:
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

listSMSCollectionNames

public java.lang.String[] listSMSCollectionNames()
                                          throws DKException,
                                                 java.lang.Exception
lists all resource manager SMS collections names from the ICM datastore.
Returns:
a string array of resource manager collection names that are available in the ICM datastore
Throws:
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

listSMSCollectionNames

public java.lang.String[] listSMSCollectionNames(short rmCode)
                                          throws DKNotExistException,
                                                 DKException,
                                                 java.lang.Exception
Lists all resource manager SMS collection names that belong the specified resource manager from the ICM datastore.
Parameters:
rmCode - - resource manager code whose resource manager SMS collections names are to be listed.
Returns:
a string array of resource manager SMS collection names that belong to the specified resource manager.
Throws:
DKNotExistException - if the resource manager Collection does not exist in the system
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

listSMSCollectionNames

public java.lang.String[] listSMSCollectionNames(int domainID)
                                          throws DKException,
                                                 java.lang.Exception
Lists all resource manager SMS collection names from the ICM datastore that are assigned to a specified administrative domain id lists resourcelists resource manager collection names from the datastore
Parameters:
domainID - - administrative domain id whose resource manager SMS collection names are to be listed.
Returns:
a string array of resource manager SMS collection names
Throws:
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

listSMSCollectionNames

public java.lang.String[] listSMSCollectionNames(java.lang.String domainName)
                                          throws DKException,
                                                 java.lang.Exception
Lists all resource manager SMS collection names from the ICM datastore that are assigned to a specified administrative domain name.
Parameters:
domainName - - administrative domain name
Returns:
a string array of resource manager collection names that are assigned to the specified domain name.
Throws:
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

listSMSCollectionNames

public java.lang.String[] listSMSCollectionNames(int domainID,
                                                 short rmCode)
                                          throws DKNotExistException,
                                                 DKException,
                                                 java.lang.Exception
Lists all resource manager SMS collection names from the ICM datastore that are assigned to a specified administrative domain id and belonging to a specified resource manager.
Parameters:
domainID - - administrative domain id whose resource manager SMS collection names are to be listed.
rmCode - - resource manager code to which the resource manager SMS collection names belongs to.
Returns:
a string array of resource manager collection names that are assigned to the specified domain id and belonging to the specified resource manager.
Throws:
DKNotExistException - if the resource manager code does not exist in the system
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

listSMSCollectionNames

public java.lang.String[] listSMSCollectionNames(java.lang.String domainName,
                                                 short rmCode)
                                          throws DKNotExistException,
                                                 DKException,
                                                 java.lang.Exception
Lists all resource manager SMS collection names from the ICM datastore that are assigned to a specified administrative domain name and belonging to a specified resource manager.
Parameters:
domainName - - administrative domain name whose resource manager SMS collections are to be listed.
rmCode - - resource manager code to which the resource manager SMS collection belongs to.
Returns:
a string array of resource manager collection names that are assigned to the specified domain name and belonging to the specified resource manager.
Throws:
DKNotExistException - if the resource manager code does not exist in the system
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

addSMSCollection

public void addSMSCollection(DKSMSCollectionDefICM rmCollObject)
                      throws DKAlreadyExistException,
                             DKException,
                             java.lang.Exception
Adds a new resource manager SMS collection to this ICM datastore Note: Upon successful addition this SMS collection is added to the local cache.
Parameters:
rmCollObject - DKSMSCollectionDefICM object to be added. Note: Upon successful addition the SMS collection code is updated.
Throws:
DKAlreadExistException - if the resource manager collection already exist in the system
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

delSMSCollection

public void delSMSCollection(java.lang.String rmCollName)
                      throws DKNotExistException,
                             DKException,
                             java.lang.Exception
Removes all resource manager SMS collections from the ICM datastoreis with the specified name. a given collection name Upon successful deletion the local cache is also updated.
Parameters:
rmCollName - - resource manager SMS collection name to be deleted.
Throws:
DKNotExistException - if the resource manager collection name does not exist in the system
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

delSMSCollection

public void delSMSCollection(java.lang.String rmCollName,
                             short rmCode)
                      throws DKNotExistException,
                             DKException,
                             java.lang.Exception
Removes the resource manager SMS collection from the ICM datastore with a given name and belonging to a resource manager specified by the resource manager code.
Parameters:
rmCollName - - resource manager SMS collection name which is to be deleted.
rmCode - - resource manager code to which the specified resource manager SMS collection belongs to.
Throws:
DKNotExistException - if the resource manager collection name or resource manager code does not exist in the system
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

retrieveSMSCollection

public DKSMSCollectionDefICM retrieveSMSCollection(java.lang.String rmCollName,
                                                   java.lang.String rmName)
                                            throws DKNotExistException,
                                                   DKException,
                                                   java.lang.Exception
retrieve a resource manager SMS collection with the specified name, belonging to the specified resource manager name from the ICM datastore. Note: If the local cache is enabled and if the resource manager SMS collections are cached then it is retrieved from the local cache. If is not found in the local cache it retrieves from the ICM datastore.
Parameters:
rmCollName - - resource manager SMS collection name to be retrieved.
rmName - - resource manager name to which this resource manager SMS collection belongs to.
Returns:
a DKSMSCollectionDefICM object
Throws:
DKNotExistException - if the resource manager collection name or resource manager name does not exist in the system
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

retrieveSMSCollection

public DKSMSCollectionDefICM retrieveSMSCollection(java.lang.String rmCollName,
                                                   short rmCode)
                                            throws DKNotExistException,
                                                   DKException,
                                                   java.lang.Exception
retrieve a resource manager SMS collection with the specified name, belonging to the specified resource manager code from the ICM datastore. Note: If the local cache is enabled and if the resource manager SMS collections are cached then it is retrieved from the local cache. If is not found in the local cache it retrieves from the ICM datastore.
Parameters:
rmCollName - - resource manager SMS collection name to be retrieved.
rmCode - - resource manager code to which this resource manager SMS collection belongs to
Returns:
a DKSMSCollectionDefICM object
Throws:
java.lang.IllegalArgumentException - if the input resource manager code is not valid
DKNotExistException - if the resource manager code does not exist in the system
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

retrieveSMSCollection

public dkCollection retrieveSMSCollection(java.lang.String rmCollName)
                                   throws DKNotExistException,
                                          DKException,
                                          java.lang.Exception
retrieve a resource manager SMS collection with the specified name from the ICM datastore irrespective of the resource manager to which these resource manager SMS collections belong to. Note: If the local cache is enabled and if the resource manager SMS collections are cached then it is retrieved from the local cache. If is not found in the local cache it retrieves from the ICM datastore.
Parameters:
rmCollName - - resource manager SMS collection name to be retrieved.
Returns:
a collection of DKSMSCollectionDefICM objects.
Throws:
DKNotExistException - if the collection name does not exist in the system
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

retrieveSMSCollectionByID

public DKSMSCollectionDefICM retrieveSMSCollectionByID(short rmCollID)
                                                throws DKNotExistException,
                                                       DKException,
                                                       java.lang.Exception
Deprecated. replace by retrieveSMSCollectionByID(short rmCode, short rmCollID)

Retrieve a resource manager collection from this library server by collection id
Parameters:
rmCollID - resource manager collection id
Throws:
java.lang.IllegalArgumentException - if the input collection code is not valid
DKNotExistException - if the collection code does not exist in the system
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

retrieveSMSCollectionByID

public DKSMSCollectionDefICM retrieveSMSCollectionByID(short rmCollID,
                                                       short rmCode)
                                                throws DKNotExistException,
                                                       DKException,
                                                       java.lang.Exception
Retrieve a resource manager SMS collection with the specified id, belonging to the specified resource manager code from the ICM datastore. Note: If the local cache is enabled and if the resource manager SMS collections are cached then it is retrieved from the local cache. If is not found in the local cache it retrieves from the ICM datastore.
Parameters:
rmCollID - resource manager collection id
rmCode - resource manager code
Throws:
DKNotExistException - if the resource manager code or collection code does not exist in the system
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

updateReplicaRulesForSMSCollection

public void updateReplicaRulesForSMSCollection(DKSMSCollectionDefICM smsCollObj)
                                        throws DKException,
                                               java.lang.Exception
Updates the replica rules for the resource manager SMS collection
Parameters:
smsCollObj - - a DKSMSCollectionDefICM SMS collection object with the updated replica rules.
Throws:
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

listResourceMgrNames

public java.lang.String[] listResourceMgrNames()
                                        throws DKException,
                                               java.lang.Exception
Gets a list of resource manager names associated with the current ICM datastore.
Returns:
a string array of resource manager names which are associated with the current ICM datastore
Throws:
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

listResourceMgrNames

public java.lang.String[] listResourceMgrNames(int domainID)
                                        throws DKException,
                                               java.lang.Exception
Gets a list of resource manager names that are in the specified administrative domain id and associated with the current ICM datastore.
Parameters:
domainId - - id of the administrative domain
Returns:
a string array of resource manager names that are in the specified administrative domain id.
Throws:
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

listResourceMgrNames

public java.lang.String[] listResourceMgrNames(java.lang.String domainName)
                                        throws DKException,
                                               java.lang.Exception
Gets a list of resource manager names that are in the specified administrative domain name and associated with the current ICM datastore.
Parameters:
domainName - - name of the administrative domain
Returns:
a string array of resource manager names that are in the specified administrative domain name.
Throws:
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

listResourceMgrs

public dkCollection listResourceMgrs()
                              throws DKException,
                                     java.lang.Exception
Gets a collection of resource manager objects defined to the ICM datastore.
Returns:
dkCollection of DKResourceMgrDefICM objects
Throws:
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

listResourceMgrs

public dkCollection listResourceMgrs(int domainID)
                              throws DKException,
                                     java.lang.Exception
Gets a collection of resource manager objects defined to the ICM datastore and assigned to the specified administrative domain id.
Parameters:
domainID - - administrative domain id.
Returns:
dkCollection of DKResourceMgrDefICM objects
Throws:
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

listResourceMgrs

public dkCollection listResourceMgrs(java.lang.String domainName)
                              throws DKException,
                                     java.lang.Exception
Gets a collection of resource manager objects defined to the ICM datastore and assigned to the specified administrative domain name.
Parameters:
domainName - - administrative domain name
Returns:
dkCollection of DKResourceMgrDefICM objects
Throws:
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

addResourceMgr

public void addResourceMgr(DKResourceMgrDefICM rmObject)
                    throws DKAlreadyExistException,
                           DKException,
                           java.lang.Exception
Adds a new resource manager to the ICM datastore and if successful, the local cache is updated.
Parameters:
rmObject - DKResourceMgrDefICM object to be added
Throws:
DKAlreadyExistException - when the resource manager already exists in the server
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

delResourceMgr

public void delResourceMgr(java.lang.String rmName)
                    throws DKNotExistException,
                           DKException,
                           java.lang.Exception
Removes a resource manager from the ICM datastore and if successful, the local cache is updated.
Parameters:
rmName - resource manager name
Throws:
DKNotExistException - if the resource manager name does not exist in the system
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

updateResourceMgr

public void updateResourceMgr(DKResourceMgrDefICM rmObject)
                       throws DKNotExistException,
                              DKException,
                              java.lang.Exception
Updates a resource manager in the ICM datastore. If successful, the local cache is updated.
Parameters:
rmName - resource manager name
Throws:
DKNotExistException - if the resource manager does not exist in the system
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

retrieveResourceMgr

public DKResourceMgrDefICM retrieveResourceMgr(java.lang.String rmName)
                                        throws DKNotExistException,
                                               DKException,
                                               java.lang.Exception
Given the resource manager name it is retrieved from the ICM datastore. The local cache is checked first to see it is available and if it is not available in the local cache it retrives it from the ICM datastore.
Parameters:
rmName - - resource manager name
Throws:
DKNotExistException - if the resource manager name does not exist in the system
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

retrieveResourceMgrByID

public DKResourceMgrDefICM retrieveResourceMgrByID(short rmCode)
                                            throws java.lang.IllegalArgumentException,
                                                   DKNotExistException,
                                                   DKException,
                                                   java.lang.Exception
Given the resource manager code it is retrieved from the ICM datastore. The local cache is checked first to see it is available and if it is not available in the local cache it retrives it from the ICM datastore.Retrieve a resource.
Parameters:
rmCode - resource manager code
Returns:
DKResourceMgrDefICM object
Throws:
java.lang.IllegalArgumentException - if the input resource manager code is not valid
DKNotExistException - if the resource manager code does not exist in the system
DKException - if there is an internal server error
java.lang.Exception - if there is a problem with the communication error.

clearCache

public void clearCache()
                throws DKException,
                       java.lang.Exception
Clears all cache data The lists: rmCache, smsCollCache smsIDCache will be cleared.
Overrides:
clearCache in class dkAbstractConfigurationMgmt

EIP Java APIs

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