Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkAdminDomainsMgmt

All Known Implementing Classes:
dkAbstractAdminDomainsMgmt

public interface dkAdminDomainsMgmt

The dkAdminDomainsMgmt class represents and processes management functions for administrative domains. The dkAdminDomainsMgmt provides facilities to query, retrieve, update, store, and manage objects associating with administrative domains.

See Also:
DKAdminDomainsMgmtFed, DKAdminDomainsMgmtICM

Method Summary
 void add(dkAdminDomainDef adObj)
          adds an Admin Domain object into the persistent datastore
 void addACLNames(java.lang.String domainName, java.lang.String[] ACLNames)
          adds a list of ACLs to this admin domain
 void addGroupNames(java.lang.String domainName, java.lang.String[] groupNames)
          adds a list of user groups to this admin domain
 void addPrivSetNames(java.lang.String domainName, java.lang.String[] privSetNames)
          adds a list of privilege sets to this admin domain
 void addResourceMgrNames(java.lang.String domainName, java.lang.String[] RMNames)
          adds a list of resource managers to this admin domain
 void addSMSCollectionNames(java.lang.String domainName, java.lang.String[] collNames)
          adds a list of SMS collections to this admin domain
 void addUserNames(java.lang.String domainName, java.lang.String[] userNames)
          adds a list of users to this admin domain
 dkAdminDomainDef createAdminDomain()
          Create a DKAdminDomainDefICM instance
 void del(dkAdminDomainDef adObj)
          deletes an Admin Domain object from the persistent datastore
 void del(java.lang.String name)
          deletes an Admin Domain object from the persistent datastore
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object
 int getIDfromName(java.lang.String name)
          Get the Admin Domain ID from the given Domain name
 java.lang.String[] listACLNames(java.lang.String domainName)
          gets a list of ACLs defined to this admin domain
 java.lang.String[] listAdminDomainNames()
          gets a list of Admin Domain object names
 dkCollection listAdminDomains()
          gets a list of Admin Domain objects
 java.lang.String[] listGroupNames(java.lang.String domainName)
          gets a list of user groups defined to this admin domain
 java.lang.String[] listPrivSetNames(java.lang.String domainName)
          gets a list of privilege sets defined to this admin domain
 java.lang.String[] listResourceMgrNames(java.lang.String domainName)
          gets a list of resource managers defined to this admin domain
 java.lang.String[] listSMSCollectionNames(java.lang.String domainName)
          gets a list of SMS collections defined to this admin domain
 java.lang.String[] listUserNames(java.lang.String domainName)
          gets a list of users defined to this admin domain
 void removeACLNames(java.lang.String domainName, java.lang.String[] ACLNames)
          removes a list of ACLs from this admin domain
 void removeGroupNames(java.lang.String[] groupNames)
          removes a list of user groups from this admin domain
 void removePrivSetNames(java.lang.String domainName, java.lang.String[] privSetNames)
          removes a list of privilege sets from this admin domain
 void removeResourceMgrNames(java.lang.String[] RMNames)
          removes a list of resource managers from this admin domain
 void removeSMSCollectionNames(java.lang.String[] collNames)
          removes a list of SMS collections from this admin domain
 void removeUserNames(java.lang.String[] userNames)
          removes a list of users from this admin domain
 dkAdminDomainDef retrieve(dkAdminDomainDef adObj)
          retrieves an Admin Domain object from the persistent datastore
 dkAdminDomainDef retrieve(java.lang.String name)
          retrieves an Admin Domain object from the persistent datastore
 void setDatastore(dkDatastore ds)
          Sets the reference to the owner datastore object
 void update(dkAdminDomainDef adObj)
          updates an Admin Domain object in the persistent datastore
 

Method Detail

setDatastore

public void setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object

getDatastore

public dkDatastore getDatastore()
Gets the reference to the owner datastore object
Returns:
the dkDatastore object

listAdminDomains

public dkCollection listAdminDomains()
                              throws DKException,
                                     java.lang.Exception
gets a list of Admin Domain objects
Returns:
a collection of admin domain objects
Throws:
DKException - if error occurs

listAdminDomainNames

public java.lang.String[] listAdminDomainNames()
                                        throws DKException,
                                               java.lang.Exception
gets a list of Admin Domain object names
Returns:
a list of admin domain object names
Throws:
DKException - if error occurs

add

public void add(dkAdminDomainDef adObj)
         throws DKAlreadyExistException,
                DKException,
                java.lang.Exception
adds an Admin Domain object into the persistent datastore
Parameters:
adObj - -- an admin domain object to be added to the datastore
Throws:
DKAlreadyExistException - if domain object already exists
DKException - if error occurs

del

public void del(dkAdminDomainDef adObj)
         throws DKException,
                java.lang.Exception
deletes an Admin Domain object from the persistent datastore
Parameters:
adObj - -- an admin domain object to be deleted
Throws:
DKException - if error occurs

del

public void del(java.lang.String name)
         throws DKException,
                java.lang.Exception
deletes an Admin Domain object from the persistent datastore
Parameters:
name - -- admin domain object name to be deleted
Throws:
DKException - if error occurs

update

public void update(dkAdminDomainDef adObj)
            throws DKException,
                   java.lang.Exception
updates an Admin Domain object in the persistent datastore
Parameters:
adObj - -- an admin domain object to be updated
Throws:
DKException - if error occurs

retrieve

public dkAdminDomainDef retrieve(dkAdminDomainDef adObj)
                          throws DKException,
                                 java.lang.Exception
retrieves an Admin Domain object from the persistent datastore
Parameters:
adObj - -- an admin domain object to be retrieved
Returns:
-- the admin domain object retrieved
Throws:
DKException - if error occurs

retrieve

public dkAdminDomainDef retrieve(java.lang.String name)
                          throws DKException,
                                 java.lang.Exception
retrieves an Admin Domain object from the persistent datastore
Parameters:
adObj - -- an admin domain object name to be retrieved
Returns:
-- the admin domain object retrieved
Throws:
DKException - if error occurs

listUserNames

public java.lang.String[] listUserNames(java.lang.String domainName)
                                 throws DKNotExistException,
                                        DKException,
                                        java.lang.Exception
gets a list of users defined to this admin domain
Parameters:
the - admin domain name
Returns:
a list of user names for this domain
Throws:
DKException - if error occurs

addUserNames

public void addUserNames(java.lang.String domainName,
                         java.lang.String[] userNames)
                  throws DKNotExistException,
                         DKException,
                         java.lang.Exception
adds a list of users to this admin domain
Parameters:
the - admin domain name
the - list of user names
Throws:
DKException - if error occurs

removeUserNames

public void removeUserNames(java.lang.String[] userNames)
                     throws DKNotExistException,
                            DKException,
                            java.lang.Exception
removes a list of users from this admin domain
Parameters:
the - list of user names
Throws:
DKException - if error occurs

listGroupNames

public java.lang.String[] listGroupNames(java.lang.String domainName)
                                  throws DKNotExistException,
                                         DKException,
                                         java.lang.Exception
gets a list of user groups defined to this admin domain
Parameters:
the - admin domain name
Returns:
a list of user names for this domain
Throws:
DKException - if error occurs

addGroupNames

public void addGroupNames(java.lang.String domainName,
                          java.lang.String[] groupNames)
                   throws DKNotExistException,
                          DKException,
                          java.lang.Exception
adds a list of user groups to this admin domain
Parameters:
the - admin domain name
the - list of user group names
Throws:
DKException - if error occurs

removeGroupNames

public void removeGroupNames(java.lang.String[] groupNames)
                      throws DKNotExistException,
                             DKException,
                             java.lang.Exception
removes a list of user groups from this admin domain
Parameters:
the - list of user group names
Throws:
DKException - if error occurs

listPrivSetNames

public java.lang.String[] listPrivSetNames(java.lang.String domainName)
                                    throws DKNotExistException,
                                           DKException,
                                           java.lang.Exception
gets a list of privilege sets defined to this admin domain
Parameters:
the - admin domain name
Returns:
a list of privilege set names for this domain
Throws:
DKException - if error occurs

addPrivSetNames

public void addPrivSetNames(java.lang.String domainName,
                            java.lang.String[] privSetNames)
                     throws DKNotExistException,
                            DKException,
                            java.lang.Exception
adds a list of privilege sets to this admin domain
Parameters:
the - admin domain name
the - list of privilege set names
Throws:
DKException - if error occurs

removePrivSetNames

public void removePrivSetNames(java.lang.String domainName,
                               java.lang.String[] privSetNames)
                        throws DKNotExistException,
                               DKException,
                               java.lang.Exception
removes a list of privilege sets from this admin domain
Parameters:
the - list of privilege set names
Throws:
DKException - if error occurs

listACLNames

public java.lang.String[] listACLNames(java.lang.String domainName)
                                throws DKNotExistException,
                                       DKException,
                                       java.lang.Exception
gets a list of ACLs defined to this admin domain
Parameters:
the - admin domain name
Returns:
a list of ACL names for this domain
Throws:
DKException - if error occurs

addACLNames

public void addACLNames(java.lang.String domainName,
                        java.lang.String[] ACLNames)
                 throws DKNotExistException,
                        DKException,
                        java.lang.Exception
adds a list of ACLs to this admin domain
Parameters:
the - admin domain name
the - list of ACL names
Throws:
DKException - if error occurs

removeACLNames

public void removeACLNames(java.lang.String domainName,
                           java.lang.String[] ACLNames)
                    throws DKNotExistException,
                           DKException,
                           java.lang.Exception
removes a list of ACLs from this admin domain
Parameters:
the - list of ACL names
Throws:
DKException - if error occurs

listResourceMgrNames

public java.lang.String[] listResourceMgrNames(java.lang.String domainName)
                                        throws DKNotExistException,
                                               DKException,
                                               java.lang.Exception
gets a list of resource managers defined to this admin domain
Parameters:
the - admin domain name
Returns:
a list of resource manager names for this domain
Throws:
DKException - if error occurs

addResourceMgrNames

public void addResourceMgrNames(java.lang.String domainName,
                                java.lang.String[] RMNames)
                         throws DKNotExistException,
                                DKException,
                                java.lang.Exception
adds a list of resource managers to this admin domain
Parameters:
the - admin domain name
the - list of resource manager names
Throws:
DKException - if error occurs

removeResourceMgrNames

public void removeResourceMgrNames(java.lang.String[] RMNames)
                            throws DKNotExistException,
                                   DKException,
                                   java.lang.Exception
removes a list of resource managers from this admin domain
Parameters:
the - list of resource manager names
Throws:
DKException - if error occurs

listSMSCollectionNames

public java.lang.String[] listSMSCollectionNames(java.lang.String domainName)
                                          throws DKNotExistException,
                                                 DKException,
                                                 java.lang.Exception
gets a list of SMS collections defined to this admin domain
Parameters:
the - admin domain name
Returns:
a list of SMS collection names for this domain
Throws:
DKException - if error occurs

addSMSCollectionNames

public void addSMSCollectionNames(java.lang.String domainName,
                                  java.lang.String[] collNames)
                           throws DKNotExistException,
                                  DKException,
                                  java.lang.Exception
adds a list of SMS collections to this admin domain
Parameters:
the - admin domain name
the - list of SMS collection names
Throws:
DKException - if error occurs

removeSMSCollectionNames

public void removeSMSCollectionNames(java.lang.String[] collNames)
                              throws DKNotExistException,
                                     DKException,
                                     java.lang.Exception
removes a list of SMS collections from this admin domain
Parameters:
the - list of SMS collection names
Throws:
DKException - if error occurs

getIDfromName

public int getIDfromName(java.lang.String name)
                  throws DKException,
                         java.lang.Exception
Get the Admin Domain ID from the given Domain name
Returns:
admin domain ID
Throws:
DKException - if error occurs

createAdminDomain

public dkAdminDomainDef createAdminDomain()
                                   throws DKException,
                                          java.lang.Exception
Create a DKAdminDomainDefICM instance
Returns:
the admin domain object definition

EIP Java APIs

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