Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKAdminDomainsMgmtFed

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractAdminDomainsMgmt
        |
        +--com.ibm.mm.sdk.common.DKAdminDomainsMgmtFed
All Implemented Interfaces:
dkAdminDomainsMgmt, DKMessageId, java.io.Serializable

public class DKAdminDomainsMgmtFed
extends dkAbstractAdminDomainsMgmt
implements java.io.Serializable

The DKAdminDomainsMgmtFed 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 associating with administrative domains.

See Also:
dkAdminDomainsMgmt, Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKAdminDomainsMgmtFed(dkDatastore ds)
          Constructs and initializes an administrative domain management class.
 
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 addUserNames(java.lang.String domainName, java.lang.String[] userNames)
          adds a list of users to this admin domain
 dkAdminDomainDef createAdminDomain()
          Create a DKAdminDomainDefFed 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
 boolean isDomainEmpty(java.lang.String domainName)
          Returns true if this domain is empty, i.e.
 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[] 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 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
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractAdminDomainsMgmt
addResourceMgrNames, addSMSCollectionNames, listResourceMgrNames, listSMSCollectionNames, removeResourceMgrNames, removeSMSCollectionNames
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKAdminDomainsMgmtFed

public DKAdminDomainsMgmtFed(dkDatastore ds)
                      throws DKException,
                             java.lang.Exception
Constructs and initializes an administrative domain management class.

It initializes userManagement and authorizationMgmt objects from datastoreAdmin class for handling objects related to administrative domains.

Parameters:
ds - the owner datastore object
Throws:
DKException - fails to initialize management objects
See Also:
dkDatastoreDef.datastoreAdmin(), datastoreAdmin#userManagement, datastoreAdmin#authorizationMgmt
Method Detail

getDatastore

public dkDatastore getDatastore()
Gets the reference to the owner datastore object
Overrides:
getDatastore in class dkAbstractAdminDomainsMgmt
Returns:
the dkDatastore object

setDatastore

public void setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object
Overrides:
setDatastore in class dkAbstractAdminDomainsMgmt
Parameters:
ds - the dkDatastore object

listAdminDomains

public dkCollection listAdminDomains()
                              throws DKException,
                                     java.lang.Exception
gets a list of Admin Domain objects
Overrides:
listAdminDomains in class dkAbstractAdminDomainsMgmt
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
Overrides:
listAdminDomainNames in class dkAbstractAdminDomainsMgmt
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
Overrides:
add in class dkAbstractAdminDomainsMgmt
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
Overrides:
del in class dkAbstractAdminDomainsMgmt
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
Overrides:
del in class dkAbstractAdminDomainsMgmt
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
Overrides:
update in class dkAbstractAdminDomainsMgmt
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
Overrides:
retrieve in class dkAbstractAdminDomainsMgmt
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
Overrides:
retrieve in class dkAbstractAdminDomainsMgmt
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
Overrides:
listUserNames in class dkAbstractAdminDomainsMgmt
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
Overrides:
addUserNames in class dkAbstractAdminDomainsMgmt
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
Overrides:
removeUserNames in class dkAbstractAdminDomainsMgmt
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
Overrides:
listGroupNames in class dkAbstractAdminDomainsMgmt
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
Overrides:
addGroupNames in class dkAbstractAdminDomainsMgmt
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
Overrides:
removeGroupNames in class dkAbstractAdminDomainsMgmt
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
Overrides:
listPrivSetNames in class dkAbstractAdminDomainsMgmt
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
Overrides:
addPrivSetNames in class dkAbstractAdminDomainsMgmt
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
Overrides:
removePrivSetNames in class dkAbstractAdminDomainsMgmt
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
Overrides:
listACLNames in class dkAbstractAdminDomainsMgmt
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
Overrides:
addACLNames in class dkAbstractAdminDomainsMgmt
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
Overrides:
removeACLNames in class dkAbstractAdminDomainsMgmt
Parameters:
the - list of ACL 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
Overrides:
getIDfromName in class dkAbstractAdminDomainsMgmt
Returns:
admin domain ID
Throws:
DKException - if error occurs

createAdminDomain

public dkAdminDomainDef createAdminDomain()
Create a DKAdminDomainDefFed instance
Overrides:
createAdminDomain in class dkAbstractAdminDomainsMgmt
Returns:
the admin domain object definition

isDomainEmpty

public boolean isDomainEmpty(java.lang.String domainName)
                      throws DKNotExistException,
                             DKException,
                             java.lang.Exception
Returns true if this domain is empty, i.e. contains no object, false if the dommain contains at least one object
Parameters:
the - admin domain name
Returns:
true or false
Throws:
DKNotExistException - if domain does not exist
DKException - if error occurs

EIP Java APIs

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