|
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.dkAbstractAdminDomainsMgmt | +--com.ibm.mm.sdk.common.DKAdminDomainsMgmtICM
The DKAdminDomainsMgmtICM class is the implementation of the abstract class dkAdminDomainsMgmt. It represents and processes management functions for administrative domains. The dkAdminDomainsMgmt provides facilities to query, retrieve, update, store, and manage objects associated with administrative domains.
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKAdminDomainsMgmtICM(dkDatastore ds)
Constructs an administrative domain management class and initializes it with the datastore object. |
Method Summary | |
void |
add(dkAdminDomainDef adObj)
adds an Admininistrative Domain object into the datastore |
void |
addACLNames(java.lang.String domainName,
java.lang.String[] ACLNames)
adds a list of ACLs to this administrative domain |
void |
addGroupNames(java.lang.String domainName,
java.lang.String[] groupNames)
adds a list of user groups to this administrative domain. |
void |
addPrivSetNames(java.lang.String domainName,
java.lang.String[] privSetNames)
adds a list of privilege sets to this administrative domain |
void |
addUserNames(java.lang.String domainName,
java.lang.String[] userNames)
adds a list of users to the this administrative domain. |
dkAdminDomainDef |
createAdminDomain()
Create an instance of DKAdminDomainDefICM. |
void |
del(dkAdminDomainDef adObj)
deletes an Administrative Domain object from the datastore. |
void |
del(java.lang.String name)
deletes an Administrative Domain object from the datastore. |
dkDatastore |
getDatastore()
Gets the reference to the associated datastore object which this object manages. |
int |
getIDfromName(java.lang.String name)
Get the Admin Domain ID from the given Domain name |
boolean |
isDomainEmpty(java.lang.String domainName)
objectChecks if the Administrative Domain object is empty. |
java.lang.String[] |
listACLNames(java.lang.String domainName)
gets a list of ACLs defined to this administrative domain. |
java.lang.String[] |
listAdminDomainNames()
gets a list of Administrative Domain names defined in the datastore. |
dkCollection |
listAdminDomains()
gets a list of Administrative Domain objects defined in the datastore. |
java.lang.String[] |
listGroupNames(java.lang.String domainName)
gets a list of user groups defined to this administrative domain |
java.lang.String[] |
listPrivSetNames(java.lang.String domainName)
gets a list of privilege set names defined to this administrative domain |
java.lang.String[] |
listResourceMgrNames(java.lang.String domainName)
gets a list of resource managers defined to this administrative domain |
java.lang.String[] |
listSMSCollectionNames(java.lang.String domainName)
gets a list of SMS collections defined to this administrative domain |
java.lang.String[] |
listUserNames(java.lang.String domainName)
gets a list of users defined to this administrative domain |
void |
removeACLNames(java.lang.String domainName,
java.lang.String[] ACLNames)
removes a list of ACLs from this administrative domain |
void |
removeGroupNames(java.lang.String[] groupNames)
removes a list of user groups from this administrative domain. |
void |
removePrivSetNames(java.lang.String domainName,
java.lang.String[] privSetNames)
removes a list of privilege sets from this administrative domain |
void |
removeUserNames(java.lang.String[] userNames)
removes a list of users from this administrative domain. |
dkAdminDomainDef |
retrieve(dkAdminDomainDef adObj)
retrieves an Administrative Domain object from the datastore. |
dkAdminDomainDef |
retrieve(java.lang.String name)
retrieves an Administrative Domain object from the datastore. |
void |
setDatastore(dkDatastore ds)
Sets the datastore on which the administrative domains are to be managed. |
void |
update(dkAdminDomainDef adObj)
updates an Administrative Domain object in the datastore |
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractAdminDomainsMgmt |
addResourceMgrNames, addSMSCollectionNames, removeResourceMgrNames, removeSMSCollectionNames |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKAdminDomainsMgmtICM(dkDatastore ds) throws DKException, java.lang.Exception
It initializes userManagement, authorizationMgmt and configurationMgmt objects from datastore Admin class for handling objects related to administrative domains.
ds
- the owner datastore objectDKException
- fails to initialize management objectsdkDatastoreDef.datastoreAdmin()
,
DKDatastoreAdminICM.userManagement()
,
DKDatastoreAdminICM.authorizationMgmt()
,
DKDatastoreAdminICM.configurationManagement()
Method Detail |
public dkDatastore getDatastore()
getDatastore
in class dkAbstractAdminDomainsMgmt
public void setDatastore(dkDatastore ds)
setDatastore
in class dkAbstractAdminDomainsMgmt
ds
- the object datastore object on which the adminstrative domains are to be managed.public dkCollection listAdminDomains() throws DKException, java.lang.Exception
listAdminDomains
in class dkAbstractAdminDomainsMgmt
DKException
- if error occursjava.lang.Exception
- if error occurslistAdminDomainNames
public java.lang.String[] listAdminDomainNames() throws DKException, java.lang.Exception
listAdminDomainNames
in class dkAbstractAdminDomainsMgmt
DKException
- if error occursjava.lang.Exception
- if error occurslistAdminDomains
public void add(dkAdminDomainDef adObj) throws DKAlreadyExistException, DKException, java.lang.Exception
add
in class dkAbstractAdminDomainsMgmt
adObj
- an administrative domain object that describes the administrative domain to be added
to the datastore.DKAlreadyExistException
- if domain object already existsDKException
- if error occursjava.lang.Exception
- if error occurspublic void del(dkAdminDomainDef adObj) throws DKException, java.lang.Exception
del
in class dkAbstractAdminDomainsMgmt
adObj
- an administrative domain object that describes the
administrative domain to be deleted from the datastore.DKException
- if error occursjava.lang.Exception
- if error occurspublic void del(java.lang.String name) throws DKException, java.lang.Exception
del
in class dkAbstractAdminDomainsMgmt
name
- name of the administrative domain to be deleted from the datastore.DKException
- if error occursjava.lang.Exception
- if error occurspublic void update(dkAdminDomainDef adObj) throws DKException, java.lang.Exception
update
in class dkAbstractAdminDomainsMgmt
adObj
- the administrative domain object describing the administrative domain to be updatedDKException
- if error occursjava.lang.Exception
- if error occurspublic dkAdminDomainDef retrieve(dkAdminDomainDef adObj) throws DKException, java.lang.Exception
retrieve
in class dkAbstractAdminDomainsMgmt
adObj
- an administrative domain object to be retrieved.
Note: the name of the administrative domain is picked up from
the administrative domain object and the administrative domain matching
that name is retrievedDKException
- if error occursjava.lang.Exception
- if error occurspublic dkAdminDomainDef retrieve(java.lang.String name) throws DKException, java.lang.Exception
retrieve
in class dkAbstractAdminDomainsMgmt
name
- Name of the administrative domain that is to be retrieved.
Name can be up to 32 characters long.DKException
- if error occursjava.lang.Exception
- if error occurspublic java.lang.String[] listUserNames(java.lang.String domainName) throws DKException, java.lang.Exception
listUserNames
in class dkAbstractAdminDomainsMgmt
domanNamethe
- the name of the administrative domain from
which the users list is requested the admin domain nameDKException
- if error occursjava.lang.Exception
- if error occurspublic void addUserNames(java.lang.String domainName, java.lang.String[] userNames) throws DKException, java.lang.Exception
addUserNames
in class dkAbstractAdminDomainsMgmt
domainName
- Name of the administrative domain to which the list of users is added.userNames
- list of user names who are added to the specified administrative domain.
The users in this list should already be defined to the datastore.DKException
- if error occurs. for example:if one or more users in the list do not existjava.lang.Exception
- if error occurs.public void removeUserNames(java.lang.String[] userNames) throws DKNotExistException, DKException, java.lang.Exception
removeUserNames
in class dkAbstractAdminDomainsMgmt
userNames
- list of user names who are to be removed from this administrative domain.DKNotExistException
- if error occurs. for example: if one or more users in the list do not exist.DKException
- if error occursjava.lang.Exception
- if error occurs
Note: Before deleting a domain all the user belonging to the domain should be removed.public java.lang.String[] listGroupNames(java.lang.String domainName) throws DKException, java.lang.Exception
listGroupNames
in class dkAbstractAdminDomainsMgmt
domainName
- the name of the administrative domain from which the
user group names is requested.DKException
- if error occursjava.lang.Exception
- if error occurspublic void addGroupNames(java.lang.String domainName, java.lang.String[] groupNames) throws DKException, java.lang.Exception
addGroupNames
in class dkAbstractAdminDomainsMgmt
domainName
- Name of the administrative domain to which the list of user groups to be added.the - admin domain namegroupNames
- list of user group names which are added to the specified administrative domain. The user groups in the list should already be defined to the datastore.DKException
- if error occurs. for example:if one or more user groups in the list do not existjava.lang.Exception
- if error occurspublic void removeGroupNames(java.lang.String[] groupNames) throws DKNotExistException, DKException, java.lang.Exception
removeGroupNames
in class dkAbstractAdminDomainsMgmt
groupNames
- the list of user group namesDKNotExistException
- if error occurs. for example: if one or more user groups in the list do not exist.DKException
- if error occursjava.lang.Exception
- if error occurspublic java.lang.String[] listPrivSetNames(java.lang.String domainName) throws DKException, java.lang.Exception
listPrivSetNames
in class dkAbstractAdminDomainsMgmt
domainName
- the name of the administrative domain from which
the privilege set names list is requested.DKException
- if error occursjava.lang.Exception
- if error occurspublic void addPrivSetNames(java.lang.String domainName, java.lang.String[] privSetNames) throws DKException, java.lang.Exception
addPrivSetNames
in class dkAbstractAdminDomainsMgmt
domainNamethe
- The name of the administrative domain
to which the privilege sets are to be added.PrivSetNames
- A list of privilege set names to be added to the administrative domain.DKException
- if error occurs for example:if one or more privilege set in the list do not existjava.lang.Exception
- if error occurspublic void removePrivSetNames(java.lang.String domainName, java.lang.String[] privSetNames) throws DKNotExistException, DKException, java.lang.Exception
removePrivSetNames
in class dkAbstractAdminDomainsMgmt
domainNamethe
- The name of the administrative domain name from which
the privilege sets are to be removed.PrivSetNames
- - A list of privilege set names to be removed from the
administrative domain.DKNotExistException
- if error occurs. for example: if one or more privilege set in the list do not exist.DKException
- if error occursjava.lang.Exception
- if error occurs
Note: Before deleting an administrative domain all the privilege sets should be removedpublic java.lang.String[] listACLNames(java.lang.String domainName) throws DKException, java.lang.Exception
listACLNames
in class dkAbstractAdminDomainsMgmt
domainName
- the name of the administrative domain from which the ACLs list is requested.DKException
- if error occursjava.lang.Exception
- if error occurspublic void addACLNames(java.lang.String domainName, java.lang.String[] ACLNames) throws DKException, java.lang.Exception
addACLNames
in class dkAbstractAdminDomainsMgmt
domainName
- the name of the administrative domain to which the list of ACLs is added.ACLNames
- list of ACLs which are added to the specified administrative domain.DKException
- if error occurs for example:if one or more ACLs in the list do not existjava.lang.Exception
- if error occurspublic void removeACLNames(java.lang.String domainName, java.lang.String[] ACLNames) throws DKNotExistException, DKException, java.lang.Exception
removeACLNames
in class dkAbstractAdminDomainsMgmt
domainName
- The name of the administrative domain name from which the ACLs are to be removed.ACLNames
- A list of ACL names to be removed from the administrative domain.DKNotExistException
- if error occurs. for example: if one or more ACLs in the list do not exist.DKException
- if error occursjava.lang.Exception
- if error occurs
Note: Before deleting a domain all the ACLs in the domain should be removedpublic java.lang.String[] listResourceMgrNames(java.lang.String domainName) throws DKException, java.lang.Exception
listResourceMgrNames
in class dkAbstractAdminDomainsMgmt
domainName
- the name of the administrative domain from which the resource manager list is requested.DKException
- if error occursjava.lang.Exception
- if error occurspublic java.lang.String[] listSMSCollectionNames(java.lang.String domainName) throws DKException, java.lang.Exception
listSMSCollectionNames
in class dkAbstractAdminDomainsMgmt
DomainName
- - the name of the administrative domain from which the list of SMS Collections is requested.java.lang.Exception
- if error occursDKException
- if error occurspublic int getIDfromName(java.lang.String name) throws DKException, java.lang.Exception
getIDfromName
in class dkAbstractAdminDomainsMgmt
DKException
- if error occursjava.lang.Exception
- if error occurspublic dkAdminDomainDef createAdminDomain()
createAdminDomain
in class dkAbstractAdminDomainsMgmt
public boolean isDomainEmpty(java.lang.String domainName) throws DKNotExistException, DKException, java.lang.Exception
domainName
- The admin domain name which is to be verified if it is empty.DKNotExistException
- if domain does not existDKException
- if error occursjava.lang.Exception
- if error occurs
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |