|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.dkAbstractConfigurationMgmt | +--com.ibm.mm.sdk.common.DKRMConfigurationMgmtICM
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.
DKResourceMgrDefICM.
, Serialized FormFields 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 |
public DKRMConfigurationMgmtICM(dkDatastore ds) throws DKException, java.lang.Exception
ds
- - a reference to ICM datastore object on which the resoruce manager configuration is managed.DKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.Method Detail |
public dkCollection listRMAccessTypes() throws DKException, java.lang.Exception
DKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.DKNLSKeywordsDefICM.
public DKNLSKeywordDefICM retrieveRMAccessType(java.lang.String accessTypeName) throws DKNotExistException, DKException, java.lang.Exception
accessTypeName
- - name of the access protocol.DKNotExistException
- if the access protocol name does not exist in the systemDKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public void addRMAccessType(DKNLSKeywordDefICM rmAccessTypeObj) throws DKAlreadyExistException, DKException, java.lang.Exception
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.DKAlreadyExistException
- if the access protocol already exists in the systemDKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public void updateRMAccessType(DKNLSKeywordDefICM rmAccessTypeObj) throws DKNotExistException, DKException, java.lang.Exception
rmAccessTypeObj
- - a DKNLSKeywordDefICM object to be updatedDKNotExistException
- if the access protocol does not exist in the systemDKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public void delRMAccessType(java.lang.String rmAccessTypeName) throws DKNotExistException, DKException, java.lang.Exception
rmAccessTypeName
- - an access protocol name to be removedDKNotExistException
- if the access protocol name does not exist in the systemDKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public dkCollection listSMSCollections() throws DKException, java.lang.Exception
DKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.DKSMSCollectionDefICM
public dkCollection listSMSCollections(short rmCode) throws DKException, java.lang.Exception
rmCode
- - resource manager code whose resource manager SMS collections are to be listed.DKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.DKSMSCollectionDefICM
public dkCollection listSMSCollections(int domainID) throws DKException, java.lang.Exception
domainID
- - administrative domain id whose resource manager SMS collections are to be listed.DKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public dkCollection listSMSCollections(java.lang.String domainName) throws DKException, java.lang.Exception
domainName
- - admininistrative domain name whose resource manager SMS collections are to be listed.DKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public dkCollection listSMSCollections(int domainID, short rmCode) throws DKException, java.lang.Exception
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.DKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public dkCollection listSMSCollections(java.lang.String domainName, short rmCode) throws DKException, java.lang.Exception
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.DKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public java.lang.String[] listSMSCollectionNames() throws DKException, java.lang.Exception
DKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public java.lang.String[] listSMSCollectionNames(short rmCode) throws DKNotExistException, DKException, java.lang.Exception
rmCode
- - resource manager code whose resource manager SMS collections names are to be listed.DKNotExistException
- if the resource manager Collection does not exist in the systemDKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public java.lang.String[] listSMSCollectionNames(int domainID) throws DKException, java.lang.Exception
domainID
- - administrative domain id whose resource manager SMS collection names are to be listed.DKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public java.lang.String[] listSMSCollectionNames(java.lang.String domainName) throws DKException, java.lang.Exception
domainName
- - administrative domain nameDKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public java.lang.String[] listSMSCollectionNames(int domainID, short rmCode) throws DKNotExistException, DKException, java.lang.Exception
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.DKNotExistException
- if the resource manager code does not exist in the systemDKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public java.lang.String[] listSMSCollectionNames(java.lang.String domainName, short rmCode) throws DKNotExistException, DKException, java.lang.Exception
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.DKNotExistException
- if the resource manager code does not exist in the systemDKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public void addSMSCollection(DKSMSCollectionDefICM rmCollObject) throws DKAlreadyExistException, DKException, java.lang.Exception
rmCollObject
- DKSMSCollectionDefICM object to be added. Note: Upon successful addition the SMS collection code is updated.DKAlreadExistException
- if the resource manager collection already exist in the systemDKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public void delSMSCollection(java.lang.String rmCollName) throws DKNotExistException, DKException, java.lang.Exception
rmCollName
- - resource manager SMS collection name to be deleted.DKNotExistException
- if the resource manager collection name does not exist in the systemDKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public void delSMSCollection(java.lang.String rmCollName, short rmCode) throws DKNotExistException, DKException, java.lang.Exception
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.DKNotExistException
- if the resource manager collection name or resource
manager code does not exist in the systemDKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public DKSMSCollectionDefICM retrieveSMSCollection(java.lang.String rmCollName, java.lang.String rmName) throws DKNotExistException, DKException, java.lang.Exception
rmCollName
- - resource manager SMS collection name to be retrieved.rmName
- - resource manager name to which this resource manager SMS collection belongs to.DKNotExistException
- if the resource manager collection name or resource
manager name does not exist in the systemDKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public DKSMSCollectionDefICM retrieveSMSCollection(java.lang.String rmCollName, short rmCode) throws DKNotExistException, DKException, java.lang.Exception
rmCollName
- - resource manager SMS collection name to be retrieved.rmCode
- - resource manager code to which this resource manager SMS collection belongs tojava.lang.IllegalArgumentException
- if the input resource manager code is not validDKNotExistException
- if the resource manager code does not exist in the systemDKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public dkCollection retrieveSMSCollection(java.lang.String rmCollName) throws DKNotExistException, DKException, java.lang.Exception
rmCollName
- - resource manager SMS collection name to be retrieved.DKNotExistException
- if the collection name does not exist in the systemDKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public DKSMSCollectionDefICM retrieveSMSCollectionByID(short rmCollID) throws DKNotExistException, DKException, java.lang.Exception
rmCollID
- resource manager collection idjava.lang.IllegalArgumentException
- if the input collection code is not validDKNotExistException
- if the collection code does not exist in the systemDKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public DKSMSCollectionDefICM retrieveSMSCollectionByID(short rmCollID, short rmCode) throws DKNotExistException, DKException, java.lang.Exception
rmCollID
- resource manager collection idrmCode
- resource manager codeDKNotExistException
- if the resource manager code or collection code does not exist in the systemDKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public void updateReplicaRulesForSMSCollection(DKSMSCollectionDefICM smsCollObj) throws DKException, java.lang.Exception
smsCollObj
- - a DKSMSCollectionDefICM SMS collection object with the updated replica rules.DKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public java.lang.String[] listResourceMgrNames() throws DKException, java.lang.Exception
DKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public java.lang.String[] listResourceMgrNames(int domainID) throws DKException, java.lang.Exception
domainId
- - id of the administrative domainDKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public java.lang.String[] listResourceMgrNames(java.lang.String domainName) throws DKException, java.lang.Exception
domainName
- - name of the administrative domainDKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public dkCollection listResourceMgrs() throws DKException, java.lang.Exception
DKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public dkCollection listResourceMgrs(int domainID) throws DKException, java.lang.Exception
domainID
- - administrative domain id.DKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public dkCollection listResourceMgrs(java.lang.String domainName) throws DKException, java.lang.Exception
domainName
- - administrative domain nameDKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public void addResourceMgr(DKResourceMgrDefICM rmObject) throws DKAlreadyExistException, DKException, java.lang.Exception
rmObject
- DKResourceMgrDefICM object to be addedDKAlreadyExistException
- when the resource manager already exists in the serverDKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public void delResourceMgr(java.lang.String rmName) throws DKNotExistException, DKException, java.lang.Exception
rmName
- resource manager nameDKNotExistException
- if the resource manager name does not exist in the systemDKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public void updateResourceMgr(DKResourceMgrDefICM rmObject) throws DKNotExistException, DKException, java.lang.Exception
rmName
- resource manager nameDKNotExistException
- if the resource manager does not exist in the systemDKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public DKResourceMgrDefICM retrieveResourceMgr(java.lang.String rmName) throws DKNotExistException, DKException, java.lang.Exception
rmName
- - resource manager nameDKNotExistException
- if the resource manager name does not exist in the systemDKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public DKResourceMgrDefICM retrieveResourceMgrByID(short rmCode) throws java.lang.IllegalArgumentException, DKNotExistException, DKException, java.lang.Exception
rmCode
- resource manager codejava.lang.IllegalArgumentException
- if the input resource manager code is not validDKNotExistException
- if the resource manager code does not exist in the systemDKException
- if there is an internal server errorjava.lang.Exception
- if there is a problem with the communication error.public void clearCache() throws DKException, java.lang.Exception
clearCache
in class dkAbstractConfigurationMgmt
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |