Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class dkAbstractAuthorizationMgmt

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
All Implemented Interfaces:
dkAuthorizationMgmt, DKMessageId, java.io.Serializable
Direct Known Subclasses:
DKACLMgmtFed, DKAuthorizationMgmtICM

public abstract class dkAbstractAuthorizationMgmt
extends java.lang.Object
implements dkAuthorizationMgmt, DKMessageId, java.io.Serializable

This class defines methods to access user information

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
dkAbstractAuthorizationMgmt()
          Constructs a new dkAbstractAuthorizationMgmt class without owner datastore object.
dkAbstractAuthorizationMgmt(dkDatastore ds)
          Constructs a new dkAbstractAuthorizationMgmt class with owner datastore object
 
Method Summary
 void add(dkAccessControlList aclObj)
          Adds the given access control list object from persistent datastore
 void add(dkPrivilege privObj)
          Adds the given privilege object to persistent datastore
 void add(dkPrivilegeGroup privGroupObj)
          Adds the given privilege group object to persistent datastore
 void add(dkPrivilegeSet privSetObj)
          Adds the given privilege set object from persistent datastore
 void clearCache()
          Clear datastore cache
 dkAccessControlList createAccessControlList()
          Creates an access control list object
 dkPrivilege createPrivilege()
          Creates a privilege object
 dkPrivilegeGroup createPrivilegeGroup()
          Creates a privilege group object
 dkPrivilegeSet createPrivilegeSet()
          Creates a privilege set object
 void del(dkAccessControlList aclObj)
          Deletes the given access control list object from persistent datastore
 void del(dkPrivilege privObj)
          Deletes the given privilege object from persistent datastore
 void del(dkPrivilegeGroup privGroupObj)
          Deletes the given privilege group object from persistent datastore
 void del(dkPrivilegeSet privSetObj)
          Deletes the given privilege set object from persistent datastore
 void deleteAccessControlList(java.lang.String aclName)
          Deletes the given access control list object from persistent datastore
 void deletePrivilege(java.lang.String privName)
          Deletes the given privilege object from persistent datastore
 void deletePrivilegeGroup(java.lang.String privGroupName)
          Deletes the given privilege group object from persistent datastore
 void deletePrivilegeSet(java.lang.String privSetName)
          Deletes the given privilege set object from persistent datastore
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object
 java.lang.String[] listAccessControlListNames()
          Gets a list of access control list names from persistent datastore
 dkCollection listAccessControlLists()
          Gets a list of access control list from persistent datastore
 java.lang.String[] listPrivilegeGroupNames()
          Gets a list of privilege group names from persistent datastore
 dkCollection listPrivilegeGroups()
          Gets a list of privilege group from persistent datastore
 java.lang.String[] listPrivilegeNames()
          Gets a list of privilege names from persistent datastore
 dkCollection listPrivileges()
          Gets a list of privileges from persistent datastore
 java.lang.String[] listPrivilegeSetNames()
          Gets a list of privilege set names from persistent datastore
 dkCollection listPrivilegeSets()
          Gets a list of privilege sets from persistent datastore
 dkAccessControlList retrieveAccessControlList(java.lang.String aclName)
          Retrieves the given access control list object from persistent datastore
 dkPrivilege retrievePrivilege(java.lang.String privName)
          Retrieves the given privilege object from persistent datastore
 dkPrivilegeGroup retrievePrivilegeGroup(java.lang.String privGroupName)
          Retrieves the given privilege group object from persistent datastore
 dkPrivilegeSet retrievePrivilegeSet(java.lang.String privSetName)
          Retrieves the given privilege set object from persistent datastore
 dkPrivilegeSet retrieveUserGroupPrivilegeSet(java.lang.String userGroup)
          Retrieves the privilege set object from persistent datastore based on the specified user group.
 dkPrivilegeSet retrieveUserPrivilegeSet(java.lang.String userName)
          Retrieves the privilege set object from persistent datastore based on the specified user name.
 void setDatastore(dkDatastore ds)
          Sets the reference to the owner datastore object
 void update(dkAccessControlList aclObj)
          Updates the given access control list object in persistent datastore
 void update(dkPrivilege privObj)
          Updates the given privilege object in persistent datastore
 void update(dkPrivilegeGroup privGroupObj)
          Updates the given privilege group object in persistent datastore
 void update(dkPrivilegeSet privSetObj)
          Updates the given privilege set object in persistent datastore
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

dkAbstractAuthorizationMgmt

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

dkAbstractAuthorizationMgmt

public dkAbstractAuthorizationMgmt(dkDatastore ds)
Constructs a new dkAbstractAuthorizationMgmt 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 dkAuthorizationMgmt

getDatastore

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

listPrivilegeSets

public dkCollection listPrivilegeSets()
                               throws DKException,
                                      java.lang.Exception
Gets a list of privilege sets from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listPrivilegeSets in interface dkAuthorizationMgmt
Returns:
a collection of dkPrivilegeSet objects
Throws:
DKException - if error occurs

listPrivilegeSetNames

public java.lang.String[] listPrivilegeSetNames()
                                         throws DKException,
                                                java.lang.Exception
Gets a list of privilege set names from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listPrivilegeSetNames in interface dkAuthorizationMgmt
Returns:
an array of privilege set names
Throws:
DKException - if error occurs

createPrivilegeSet

public dkPrivilegeSet createPrivilegeSet()
                                  throws DKException,
                                         java.lang.Exception
Creates a privilege set object

Note:DKUsageError exception thrown if method is not implemented

Specified by:
createPrivilegeSet in interface dkAuthorizationMgmt
Returns:
privilege set object
Throws:
DKException - if error

add

public void add(dkPrivilegeSet privSetObj)
         throws DKException,
                java.lang.Exception
Adds the given privilege set object from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
add in interface dkAuthorizationMgmt
Parameters:
privSetObj - privilege set object to be added.
Throws:
DKException - if error

del

public void del(dkPrivilegeSet privSetObj)
         throws DKException,
                java.lang.Exception
Deletes the given privilege set object from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
del in interface dkAuthorizationMgmt
Parameters:
privSetObj - privilege set object to be deleted.
Throws:
DKException - if error

deletePrivilegeSet

public void deletePrivilegeSet(java.lang.String privSetName)
                        throws DKException,
                               java.lang.Exception
Deletes the given privilege set object from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
deletePrivilegeSet in interface dkAuthorizationMgmt
Parameters:
privSetName - privilege set name to be retrieved.
Throws:
DKException - if error

update

public void update(dkPrivilegeSet privSetObj)
            throws DKException,
                   java.lang.Exception
Updates the given privilege set object in persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
update in interface dkAuthorizationMgmt
Parameters:
privSetObj - privilege set object to be updated.
Throws:
DKException - if error

retrievePrivilegeSet

public dkPrivilegeSet retrievePrivilegeSet(java.lang.String privSetName)
                                    throws DKException,
                                           java.lang.Exception
Retrieves the given privilege set object from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
retrievePrivilegeSet in interface dkAuthorizationMgmt
Parameters:
privSetName - privilege set name to be retrieved.
Throws:
DKException - if error

retrieveUserPrivilegeSet

public dkPrivilegeSet retrieveUserPrivilegeSet(java.lang.String userName)
                                        throws DKException,
                                               java.lang.Exception
Retrieves the privilege set object from persistent datastore based on the specified user name.

Note:DKUsageError exception thrown if method is not implemented

Specified by:
retrieveUserPrivilegeSet in interface dkAuthorizationMgmt
Parameters:
userName - user name to retrieve the privilege set for.
Throws:
DKException - if error

retrieveUserGroupPrivilegeSet

public dkPrivilegeSet retrieveUserGroupPrivilegeSet(java.lang.String userGroup)
                                             throws DKException,
                                                    java.lang.Exception
Retrieves the privilege set object from persistent datastore based on the specified user group.

Note:DKUsageError exception thrown if method is not implemented

Specified by:
retrieveUserGroupPrivilegeSet in interface dkAuthorizationMgmt
Parameters:
userGroup - user group to retrieve the privilege set for.
Throws:
DKException - if error

listPrivileges

public dkCollection listPrivileges()
                            throws DKException,
                                   java.lang.Exception
Gets a list of privileges from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listPrivileges in interface dkAuthorizationMgmt
Returns:
a collection of dkPrivilege objects
Throws:
DKException - if error occurs

listPrivilegeNames

public java.lang.String[] listPrivilegeNames()
                                      throws DKException,
                                             java.lang.Exception
Gets a list of privilege names from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listPrivilegeNames in interface dkAuthorizationMgmt
Returns:
an array of privilege names
Throws:
DKException - if error occurs

createPrivilege

public dkPrivilege createPrivilege()
                            throws DKException,
                                   java.lang.Exception
Creates a privilege object

Note:DKUsageError exception thrown if method is not implemented

Specified by:
createPrivilege in interface dkAuthorizationMgmt
Returns:
privilege object
Throws:
DKException - if error

add

public void add(dkPrivilege privObj)
         throws DKException,
                java.lang.Exception
Adds the given privilege object to persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
add in interface dkAuthorizationMgmt
Parameters:
privObj - privilege object to be added.
Throws:
DKException - if error

del

public void del(dkPrivilege privObj)
         throws DKException,
                java.lang.Exception
Deletes the given privilege object from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
del in interface dkAuthorizationMgmt
Parameters:
privObj - privilege object to be deleted.
Throws:
DKException - if error

deletePrivilege

public void deletePrivilege(java.lang.String privName)
                     throws DKException,
                            java.lang.Exception
Deletes the given privilege object from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
deletePrivilege in interface dkAuthorizationMgmt
Parameters:
privName - privilege name to be retrieved.
Throws:
DKException - if error

update

public void update(dkPrivilege privObj)
            throws DKException,
                   java.lang.Exception
Updates the given privilege object in persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
update in interface dkAuthorizationMgmt
Parameters:
privObj - privilege object to be updated.
Throws:
DKException - if error

retrievePrivilege

public dkPrivilege retrievePrivilege(java.lang.String privName)
                              throws DKException,
                                     java.lang.Exception
Retrieves the given privilege object from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
retrievePrivilege in interface dkAuthorizationMgmt
Parameters:
privName - privilege name to be retrieved.
Throws:
DKException - if error

listPrivilegeGroups

public dkCollection listPrivilegeGroups()
                                 throws DKException,
                                        java.lang.Exception
Gets a list of privilege group from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listPrivilegeGroups in interface dkAuthorizationMgmt
Returns:
a collection of dkPrivilegeGroup objects
Throws:
DKException - if error occurs

listPrivilegeGroupNames

public java.lang.String[] listPrivilegeGroupNames()
                                           throws DKException,
                                                  java.lang.Exception
Gets a list of privilege group names from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listPrivilegeGroupNames in interface dkAuthorizationMgmt
Returns:
an array of privilege group names
Throws:
DKException - if error occurs

createPrivilegeGroup

public dkPrivilegeGroup createPrivilegeGroup()
                                      throws DKException,
                                             java.lang.Exception
Creates a privilege group object

Note:DKUsageError exception thrown if method is not implemented

Specified by:
createPrivilegeGroup in interface dkAuthorizationMgmt
Returns:
privilege group object
Throws:
DKException - if error

add

public void add(dkPrivilegeGroup privGroupObj)
         throws DKException,
                java.lang.Exception
Adds the given privilege group object to persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
add in interface dkAuthorizationMgmt
Parameters:
privGroupObj - privilege group object to be added.
Throws:
DKException - if error

del

public void del(dkPrivilegeGroup privGroupObj)
         throws DKException,
                java.lang.Exception
Deletes the given privilege group object from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
del in interface dkAuthorizationMgmt
Parameters:
privGroupObj - privilege group object to be deleted.
Throws:
DKException - if error

deletePrivilegeGroup

public void deletePrivilegeGroup(java.lang.String privGroupName)
                          throws DKException,
                                 java.lang.Exception
Deletes the given privilege group object from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
deletePrivilegeGroup in interface dkAuthorizationMgmt
Parameters:
privGroupName - privilege group name to be retrieved.
Throws:
DKException - if error

update

public void update(dkPrivilegeGroup privGroupObj)
            throws DKException,
                   java.lang.Exception
Updates the given privilege group object in persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
update in interface dkAuthorizationMgmt
Parameters:
privGroupObj - privilege group object to be updated.
Throws:
DKException - if error

retrievePrivilegeGroup

public dkPrivilegeGroup retrievePrivilegeGroup(java.lang.String privGroupName)
                                        throws DKException,
                                               java.lang.Exception
Retrieves the given privilege group object from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
retrievePrivilegeGroup in interface dkAuthorizationMgmt
Parameters:
privGroupName - privilege group name to be retrieved.
Throws:
DKException - if error

listAccessControlLists

public dkCollection listAccessControlLists()
                                    throws DKException,
                                           java.lang.Exception
Gets a list of access control list from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listAccessControlLists in interface dkAuthorizationMgmt
Returns:
a collection of dkAccessControlList objects
Throws:
DKException - if error occurs

listAccessControlListNames

public java.lang.String[] listAccessControlListNames()
                                              throws DKException,
                                                     java.lang.Exception
Gets a list of access control list names from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listAccessControlListNames in interface dkAuthorizationMgmt
Returns:
an array of access control list names
Throws:
DKException - if error occurs

createAccessControlList

public dkAccessControlList createAccessControlList()
                                            throws DKException,
                                                   java.lang.Exception
Creates an access control list object

Note:DKUsageError exception thrown if method is not implemented

Specified by:
createAccessControlList in interface dkAuthorizationMgmt
Returns:
access control list object
Throws:
DKException - if error

add

public void add(dkAccessControlList aclObj)
         throws DKException,
                java.lang.Exception
Adds the given access control list object from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
add in interface dkAuthorizationMgmt
Parameters:
aclObj - access control list object to be added.
Throws:
DKException - if error

del

public void del(dkAccessControlList aclObj)
         throws DKException,
                java.lang.Exception
Deletes the given access control list object from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
del in interface dkAuthorizationMgmt
Parameters:
aclObj - access control list object to be deleted.
Throws:
DKException - if error

deleteAccessControlList

public void deleteAccessControlList(java.lang.String aclName)
                             throws DKException,
                                    java.lang.Exception
Deletes the given access control list object from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
deleteAccessControlList in interface dkAuthorizationMgmt
Parameters:
aclName - access control list name to be retrieved.
Throws:
DKException - if error

update

public void update(dkAccessControlList aclObj)
            throws DKException,
                   java.lang.Exception
Updates the given access control list object in persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
update in interface dkAuthorizationMgmt
Parameters:
aclObj - access control list object to be updated.
Throws:
DKException - if error

retrieveAccessControlList

public dkAccessControlList retrieveAccessControlList(java.lang.String aclName)
                                              throws DKException,
                                                     java.lang.Exception
Retrieves the given access control list object from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
retrieveAccessControlList in interface dkAuthorizationMgmt
Parameters:
aclName - access control list name to be retrieved.
Throws:
DKException - if error

clearCache

public void clearCache()
                throws DKException,
                       java.lang.Exception
Clear datastore cache

Note:DKUsageError exception thrown if method is not implemented

Specified by:
clearCache in interface dkAuthorizationMgmt

EIP Java APIs

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