Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class dkAbstractAdminDomainsMgmt

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

public abstract class dkAbstractAdminDomainsMgmt
extends java.lang.Object
implements dkAdminDomainsMgmt, DKMessageId, java.io.Serializable

The dkAbstractAdminDomainsMgmt class represents and processes management functions for administrative domains. The dkAbstractAdminDomainsMgmt 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
dkAbstractAdminDomainsMgmt()
          Constructs a new dkAbstractAdminDomainsMgmt class without owner datastore object.
dkAbstractAdminDomainsMgmt(dkDatastore ds)
          Constructs a new dkAbstractAdminDomainsMgmt class with owner datastore object
 
Method Summary
 void add(dkAdminDomainDef adObj)
          Adds the given admin domain object to 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()
          Creates a dkAdminDomainDef instance
 void del(dkAdminDomainDef adObj)
          Deletes the given admin domain object from persistent datastore
 void del(java.lang.String name)
          Deletes the given admin domain object from persistent datastore
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object
 int getIDfromName(java.lang.String name)
          Gets the domain ID of the given domain from persistent datastore
 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 names from persistent datastore
 dkCollection listAdminDomains()
          Gets a list of admin domains from persistent datastore
 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 an admin domain We always move the groups to Public 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 an admin domain We always move the users to Default Domain.
 dkAdminDomainDef retrieve(dkAdminDomainDef adObj)
          Retrieves the given admin domain object from persistent datastore
 dkAdminDomainDef retrieve(java.lang.String name)
          Retrieves the given admin domain object from persistent datastore
 void setDatastore(dkDatastore ds)
          Sets the reference to the owner datastore object
 void update(dkAdminDomainDef adObj)
          Updates the given admin domain object in persistent datastore
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

dkAbstractAdminDomainsMgmt

public dkAbstractAdminDomainsMgmt()
Constructs a new dkAbstractAdminDomainsMgmt class without owner datastore object.

dkAbstractAdminDomainsMgmt

public dkAbstractAdminDomainsMgmt(dkDatastore ds)
Constructs a new dkAbstractAdminDomainsMgmt class with owner datastore object
Parameters:
ds - reference to owner datastore object
Method Detail

setDatastore

public void setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object
Specified by:
setDatastore in interface dkAdminDomainsMgmt

getDatastore

public dkDatastore getDatastore()
Gets the reference to the owner datastore object
Specified by:
getDatastore in interface dkAdminDomainsMgmt
Returns:
the dkDatastore object

listAdminDomains

public dkCollection listAdminDomains()
                              throws DKException,
                                     java.lang.Exception
Gets a list of admin domains from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listAdminDomains in interface dkAdminDomainsMgmt
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 names from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listAdminDomainNames in interface dkAdminDomainsMgmt
Returns:
an array of admin domain names
Throws:
DKException - if error occurs

add

public void add(dkAdminDomainDef adObj)
         throws DKAlreadyExistException,
                DKException,
                java.lang.Exception
Adds the given admin domain object to persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
add in interface dkAdminDomainsMgmt
Parameters:
adObj - admin domain object to be added.
Throws:
DKException - if error

del

public void del(dkAdminDomainDef adObj)
         throws DKException,
                java.lang.Exception
Deletes the given admin domain object from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
del in interface dkAdminDomainsMgmt
Parameters:
adObj - -- admin domain object to be deleted.
Throws:
DKException - if error

del

public void del(java.lang.String name)
         throws DKException,
                java.lang.Exception
Deletes the given admin domain object from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
del in interface dkAdminDomainsMgmt
Parameters:
name - -- admin domain object to be deleted.
Throws:
DKException - if error

update

public void update(dkAdminDomainDef adObj)
            throws DKException,
                   java.lang.Exception
Updates the given admin domain object in persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
update in interface dkAdminDomainsMgmt
Parameters:
adObj - -- admin domain object to be updated.
Throws:
DKException - if error

retrieve

public dkAdminDomainDef retrieve(dkAdminDomainDef adObj)
                          throws DKException,
                                 java.lang.Exception
Retrieves the given admin domain object from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
retrieve in interface dkAdminDomainsMgmt
Parameters:
name - -- admin domain object to be retrieved.
Throws:
DKException - if error

retrieve

public dkAdminDomainDef retrieve(java.lang.String name)
                          throws DKException,
                                 java.lang.Exception
Retrieves the given admin domain object from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
retrieve in interface dkAdminDomainsMgmt
Parameters:
name - -- admin domain name to be retrieved.
Throws:
DKException - if error

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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listUserNames in interface dkAdminDomainsMgmt
Returns:
a list of user names

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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
addUserNames in interface dkAdminDomainsMgmt
Following copied from interface: com.ibm.mm.sdk.common.dkAdminDomainsMgmt
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 an admin domain We always move the users to Default Domain.

Note:DKUsageError exception thrown if method is not implemented

Specified by:
removeUserNames in interface dkAdminDomainsMgmt
Following copied from interface: com.ibm.mm.sdk.common.dkAdminDomainsMgmt
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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listGroupNames in interface dkAdminDomainsMgmt
Returns:
a list of user group names

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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
addGroupNames in interface dkAdminDomainsMgmt
Following copied from interface: com.ibm.mm.sdk.common.dkAdminDomainsMgmt
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 an admin domain We always move the groups to Public Domain

Note:DKUsageError exception thrown if method is not implemented

Specified by:
removeGroupNames in interface dkAdminDomainsMgmt
Following copied from interface: com.ibm.mm.sdk.common.dkAdminDomainsMgmt
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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listPrivSetNames in interface dkAdminDomainsMgmt
Returns:
a list of privilege set names

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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
addPrivSetNames in interface dkAdminDomainsMgmt
Following copied from interface: com.ibm.mm.sdk.common.dkAdminDomainsMgmt
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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
removePrivSetNames in interface dkAdminDomainsMgmt
Following copied from interface: com.ibm.mm.sdk.common.dkAdminDomainsMgmt
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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listACLNames in interface dkAdminDomainsMgmt
Returns:
a list of ACL names

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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
addACLNames in interface dkAdminDomainsMgmt
Following copied from interface: com.ibm.mm.sdk.common.dkAdminDomainsMgmt
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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
removeACLNames in interface dkAdminDomainsMgmt
Following copied from interface: com.ibm.mm.sdk.common.dkAdminDomainsMgmt
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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listResourceMgrNames in interface dkAdminDomainsMgmt
Returns:
a list of resource manager names

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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
addResourceMgrNames in interface dkAdminDomainsMgmt
Following copied from interface: com.ibm.mm.sdk.common.dkAdminDomainsMgmt
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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
removeResourceMgrNames in interface dkAdminDomainsMgmt
Following copied from interface: com.ibm.mm.sdk.common.dkAdminDomainsMgmt
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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listSMSCollectionNames in interface dkAdminDomainsMgmt
Returns:
a list of collection names

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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
addSMSCollectionNames in interface dkAdminDomainsMgmt
Following copied from interface: com.ibm.mm.sdk.common.dkAdminDomainsMgmt
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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
removeSMSCollectionNames in interface dkAdminDomainsMgmt
Following copied from interface: com.ibm.mm.sdk.common.dkAdminDomainsMgmt
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
Gets the domain ID of the given domain from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
getIDfromName in interface dkAdminDomainsMgmt
Parameters:
name - -- admin domain name.
Throws:
DKException - if error

createAdminDomain

public dkAdminDomainDef createAdminDomain()
                                   throws DKException,
                                          java.lang.Exception
Creates a dkAdminDomainDef instance
Specified by:
createAdminDomain in interface dkAdminDomainsMgmt
Following copied from interface: com.ibm.mm.sdk.common.dkAdminDomainsMgmt
Returns:
the admin domain object definition

EIP Java APIs

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