Index

DKAdminDomainsMgmtICM

Purpose:

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

The DKAdminDomainsMgmtICM class is created by calling its constructor with the associated datastore object as a parameter.

See Also: dkAdminDomainsMgmt

Since: Version 8

Class summary:

class DKEXPORT DKAdminDomainsMgmtICM : public dkAdminDomainsMgmt{
public:
     DKAdminDomainsMgmtICM(dkDatastore* ds);
     virtual ~DKAdminDomainsMgmtICM();
     virtual long getIDfromName(const char* name);
     virtual dkAdminDomainDef* createAdminDomain();
     virtual dkAdminDomainDef* retrieve(const char* name);
     virtual dkAdminDomainDef* retrieve(dkAdminDomainDef* adObj);
     virtual DKString* listAdminDomainNames(long& arrSize);
     virtual dkCollection* listAdminDomains();
     virtual void add(dkAdminDomainDef* adObj);
     virtual void del(dkAdminDomainDef* adObj);
     virtual void del(const char* name);
     virtual void update(dkAdminDomainDef* adObj);
     virtual DKBoolean isDomainEmpty(const char* domainName);
 
     virtual void addACLNames(const char* domainName, const char**  ACLNames,long arrSize);
     virtual void addGroupNames(const char* domainName, const char**  groupNames,long arrSize);
     virtual void addPrivSetNames(const char* domainName, const char**  privSetNames,long arrSize);
     virtual void addResourceMgrNames(const char* domainName, const char**  RMNames,long arrSize);
     virtual void addSMSCollectionNames(const char* domainName, const char**  collNames,long arrSize);
     virtual void addUserNames(const char* domainName, const char**  userNames,long arrSize);
     virtual DKString* listACLNames(const char* domainName,long& arrSize);
     virtual DKString* listGroupNames(const char* domainName,long& arrSize);
     virtual DKString* listPrivSetNames(const char* domainName,long& arrSize);
     virtual DKString* listResourceMgrNames(const char* domainName,long& arrSize);
     virtual DKString* listSMSCollectionNames(const char* domainName,long& arrSize);
     virtual DKString* listUserNames(const char* domainName,long& arrSize);
 
     virtual void removeACLNames(const char* domainName,const char**  ACLNames,long arrSize);
     virtual void removeGroupNames(const char* domainName,const char**  groupNames,long arrSize);
     virtual void removePrivSetNames(const char* domainName,const char**  privSetNames,long arrSize); 
     virtual void removeResourceMgrNames(const char* domainName,const char**  RMNames,long arrSize);
     virtual void removeSMSCollectionNames(const char* domainName,const char**  collNames,long arrSize);
     virtual void removeUserNames(const char* domainName,const char**  userNames,long arrSize);
 };

Members:

Constructors and destructor
DKAdminDomainsMgmtICM(dkDatastore * ds);

Constructor that takes a datastore instance as a parameter. The returned admin domain mgmt instance is associated with the datastore instance. Equivalent to calling the default constructor followed by the setDatastore method on the created object. Parameters: ds - valid instance of a datastore object. Should be an instance of DKDatastoreICM

virtual DKAdminDomainsMgmtICM();

Destructor for the object.

Member functions

add
Adds an admin domain object into the persistent datastore. Parameters: Admin domain object of type DKAdminDomainDefICM. See Also: DKAdminDomainDefICM
void add(dkAdminDomainDef* adObj)

addACLNames
Adds the list of ACL names in the 2nd input parameter to the administration domain specified by the name in the first parameter. Parameters:
  • domainName - name of the adminstration domain to which the list of ACL names is to be added.
  • ACLNames - list of ACL names that is to be added to the specified adminstration domain.
  • arrSize - size of the ACLNames array.

See Also: DKAccessControlListICM

void addACLNames(const char* domainName, const char**  ACLNames,long arrSize)

addGroupNames
Adds the list of user group names in the 2nd input parameter to the administration domain specified by the name in the first parameter. Parameters:
  • domainName - name of the administration domain to which the list of user group names is to be added.
  • groupNames - list of user group names that is to be added to the specified administration domain.
  • arrSize - size of the groupNames array.

See Also: DKUserGroupDefICM

void addGroupNames(const char* domainName, const char**  groupNames,long arrSize)

addPrivSetNames
Adds the list of privilege set names in the 2nd input parameter to the administration domain specified by the name in the first parameter. Parameters:
  • domainName - name of the administration domain to which the list of privilege set names is to be added.
  • privSetNames -list of privilege set names that is to be added to the specified administrative domain.
  • arrSize - size of the privSetNames array.

See Also: DKPrivilegeSetICM

void addPrivSetNames(const char* domainName, const char**  privSetNames,long arrSize)

addResourceMgrNames
Adds the list of resource manager names in the 2nd input parameter to the administration domain specified by the name in the first parameter. Parameters:
  • domainName - name of the adminstration domain to which the list of resource manager names is to be added.
  • RMNames - list of resource manager names that is to be added to the specified administration domain.
  • arrSize - size of the RMNames array.

See Also: DKResourceMgrDefICM

void addResourceMgrNames(const char* domainName, const char**  RMNames,long arrSize)

addSMSCollectionNames
Adds the list of SMS collection names in the 2nd input parameter to the administration domain specified by the name in the first parameter. Parameters:
  • domainName - name of the administration domain to which the list of SMS collection names is to be added.
  • collNames - list of SMS collection names that is to be added to the specified administration domain.
  • arrSize - size of the collNames array.

See Also: DKSMSCollectionDefICM

void addSMSCollectionNames(const char* domainName, const char**  collNames,long arrSize)

addUserNames
Adds the list of user names in the 2nd input parameter to the administration domain specified by the name in the first parameter. Parameters:
  • domainName - name of the administration domain to which the list of user names is to be added.
  • userNames - list of user names that is to be added to the specified administration domain.
  • arrSize - size of the userNames array.

See Also: DKUserDefICM

void addUserNames(const char* domainName, const char**  userNames,long arrSize)

createAdminDomain
Creates a new admin domain definition instance associated with the datastore that supports this admin domain management object. Returns: Instance of DKAdminDomainDefICM object. See Also: DKAdminDomainDefICM.
dkAdminDomainDef* createAdminDomain()

del
Deletes an administration domain object whose name is specified by the input parameter from the persistent datastore. Parameters: name - name of administration domain object to be deleted See Also: DKAdminDomainDefICM.
void del(const char* name);

del
Deletes an administration domain object that is specified by the input parameter from the persistent datastore. Parameters: adObj - adminstration domain object to be deleted from the persistent datastore. The parameter is an instance of DKAdminDomainDefICM. See Also: DKAdminDomainDefICM.
void del(dkAdminDomainDef* adObj);

getIDfromName
Retrieves the admin domain id for the given admin domain name. Parameters: name - name of the admin domain for which the id is to be retrieved. Returns: id of admin domain whose name was passed in.
long getIDfromName(const char* name)

isDomainEmpty
Returns true if this domain is empty, i.e. contains no object, false if the domain contains at least one object. Parameters: domainName - name of the domain that is to be checked for emptiness. Returns: TRUE if the domain is empty, FALSE otherwise.
DKBoolean isDomainEmpty(const char*  domainName)

listACLNames
Retrieves the list of ACL names for the specified administration domain. Parameters:
  • domainName - name of the adminstration domain for which the list of ACL names is to be retrieved.
  • arrSize - size of ACL name list retrieved.

Returns: List of ACL names as DKString variable instances. See Also: DKAccessControlListICM

DKString* listACLNames(const char* domainName,long& arrSize) 

listAdminDomainNames
Retrieves a list of administration domain names. Parameters: arrSize- return parameter indicating the number of administration domain names returned. Returns: A list of administration domain names as DKString variable instances.
DKString* listAdminDomainNames(long& arrSize)

listAdminDomains
Retrieves a list of administration domain objects. Returns: Collection of administration domain objects as instances of DKAdminDomainDefICM objects. See Also: DKAdminDomainDefICM
dkCollection* listAdminDomains()

listGroupNames
Retrieves the list of user group names for the specified administration domain. Parameters:
  • domainName - name of the administration domain for which the list of user group names is to be retrieved.
  • arrSize - size of user group name list retrieved.

Returns: List of user group name as DKString variable instances. See Also: DKUserGroupDefICM

DKString* listGroupNames(const char* domainName,long& arrSize) 

listPrivSetNames
Retrieves the list of privilege set names for the specified administration domain. Parameters:
  • domainName - name of the administration domain for which the list of privilege set names is to be retrieved.
  • arrSize - size of privilege set name list retrieved.

Returns: List of privilege set names as DKString variable instances. See Also: DKPrivilegeSetICM

DKString* listPrivSetNames(const char* domainName, long& arrSize)

listResourceMgrNames
Retrieves the list of resource manager names for the specified administration domain. Parameters:
  • domainName - name of the administration domain for which the list of resource manager names is to be retrieved.
  • arrSize - size of resource manager name list retrieved.

Returns: List of resource manager names as DKString variable instances. See Also: DKResourceMgrDefICM

DKString* listResourceMgrNames(const char* domainName, long& arrSize)

listSMSCollectionNames
Retrieves the list of SMS Collection names for the specified administration domain. Parameters:
  • domainName - name of the administration domain for which the list of SMS collection names is to be retrieved.
  • arrSize - size of SMS Collection name list retrieved.

Returns: List of SMS Collection names as DKString variable instances. See Also: DKSMSCollectionDefICM

DKString* listSMSCollectionNames(const char* domainName,long& arrSize)

listUserNames
Retrieves the list of user names for the specified administration domain. Parameters:
  • domainName - name of the administration domain for which the list of user names is to be retrieved.
  • arrSize - size of user name list retrieved.

Returns: List of user names as DKString variable instances. See Also: DKUserDefICM

DKString* listUserNames(const char* domainName,long& arrSize)

removeACLNames
Removes the list of ACL names specified in the 2nd parameter from the administration domain whose name is specified in the 1st parameter. Parameters:
  • domainName - name of the administration domain from which the list of ACL names is to be removed.
  • ACLNames - list of ACL names to be removed from the specified administration domain.
  • arrSize - size of the ACLNames list.

Returns: List of user names as DKString variable instances. See Also: DKAccessControlListICM

void removeACLNames(const char* domainName,const char**  ACLNames,long arrSize)

removeGroupNames
Removes the list of user group names specified in the 2nd parameter from the administration domain whose name is specified in the 1st parameter. Parameters:
  • domainName - name of the administration domain from which the list of user group names is to be removed.
  • groupNames - list of user group names to be removed from the specified administration domain.
  • arrSize - size of the groupNames list.

Returns: List of user names as DKString variable instances. See Also: DKUserGroupDefICM

void removeGroupNames(const char* domainName, const char**  groupNames, long arrSize)

removePrivSetNames
Removes the list of privilege set names specified in the 2nd parameter from the administration domain whose name is specified in the 1st parameter. Parameters:
  • domainName - name of the administration domain from which the list of privilege set names is to be removed.
  • privSetNames - list of privilege set names to be removed from the specified administration domain.
  • arrSize - size of the privSetNames list.

See Also: DKPrivilegeSetICM

void removePrivSetNames(const char* domainName,const char**  privSetNames,long arrSize)

removeResourceMgrNames
Removes the list of resource manager names specified in the 2nd parameter from the administration domain whose name is specified in the 1st parameter. Parameters:
  • domainName - name of the administration domain from which the list of resource manager names is to be removed.
  • RMNames - list of resource manager names to be removed from the specified administration domain.
  • arrSize - size of the RMNames list.

See Also: DKResourceMgrDefICM

void removeResourceMgrNames(const char* domainName,const char**  RMNames,long arrSize)

removeSMSCollectionNames
Removes the list of SMS Collection names specified in the 2nd parameter from the administration domain whose name is specified in the 1st parameter. Parameters:
  • domainName- name of the administration domain from which the list of SMS collection names is to be removed.
  • collNames - list of SMS collection names to be removed from the specified administration domain.
  • arrSize - size of the collNames list.

See Also: DKSMSCollectionDefICM

void removeSMSCollectionNames(const char* domainName, const char** collNames, long arrSize)

removeUserNames
Removes the list of user names specified in the 2nd parameter from the administration domain whose name is specified in the 1st parameter. Parameters:
  • domainName - name of the administration domain from which the list of user names is to be removed.
  • userNames - list of user names to be removed from the specified administration domain.
  • arrSize - size of the userNames list.

See Also: DKUserDefICM

void removeUserNames(const char* domainName, const char** userNames, long arrSize)

retrieve
Retrieves an admin domain definition object specified by the name parameter from the persistent datastore Parameters: adObj - admin domain definition object based on whose attributes the retrieve operation will be done. Returns: Previously created admin domain definition object from the persistent datastore
dkAdminDomainDef* retrieve(dkAdminDomainDef* adObj)

retrieve
Retrieves an admin domain definition object specified by the name parameter from the persistent datastore. Parameters: name - name of admin domain definition object to be retrieved. Returns: id of admin domain whose name was passed in. See Also: DKAdminDomainDefICM
dkAdminDomainDef* retrieve(const char* name)

update
Updates the definition of the administration domain object specified in the input parameter. Parameters: adObj - administration domain object to be deleted from the persistent datastore. The parameter is an instance of DKAdminDomainDefICM
void update(dkAdminDomainDef* adObj)

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