Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKACLMgmtFed

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

public class DKACLMgmtFed
extends dkAbstractAuthorizationMgmt
implements java.io.Serializable

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKACLMgmtFed()
          Default constructor
DKACLMgmtFed(dkDatastore ds)
          Constructor with datastore reference
DKACLMgmtFed(dkDatastore ds, int accessLevel)
          Deprecated.  
 
Method Summary
 void add(dkAccessControlList aclObj)
          adds a new access control list into the persistent store // only define
 void add(dkPrivilege privObj)
          adds a privilege into the persistent store
 void add(dkPrivilegeGroup privGroupObj)
          adds a privilege group into the persistent store
 void add(dkPrivilegeSet privSetObj)
          adds a privilege set into the persistent store
 void addACLRule(long aclCode, java.lang.String userId, short patronType, long privSetCode)
          Adds an ACL rule to an existing access control list in the persistent datastore
 void addDomainACL(java.lang.String domainName, java.lang.String[] aclNames)
          adds one or more access control lists into a domain in the persistent store
 void addDomainPrivilegeSet(java.lang.String domainName, java.lang.String[] privSetNames)
          adds one or more privilege sets into a domain in the persistent store
 void clearCache()
          Clears all cache data
 dkAccessControlList createAccessControlList()
          Create a DKAccessControlListFed instance
 dkPrivilege createPrivilege()
          Create a DKPrivilgeFed instance
 dkPrivilegeGroup createPrivilegeGroup()
          Create a DKPrivilgeFedGroup instance
 dkPrivilegeSet createPrivilegeSet()
          Create a DKPrivilgeFedSet instance
 void del(dkAccessControlList aclObj)
          deletes an existing access control list from the persistent store
 void del(dkPrivilege privObj)
          deletes a privilege from the persistent store
 void del(dkPrivilegeGroup privGroupObj)
          deletes a privilege group from the persistent store
 void del(dkPrivilegeSet privSetObj)
          deletes a privilege set from the persistent store
 void deleteACLRule(long aclCode, java.lang.String userId)
          Deletes an ACL rule which is indicated by the userid from an existing access control list in the persistent datastore
 dkAccessControlList getAccessControlList(java.lang.String name)
          Gets an access control list from memory
 dkCollection getAccessControlLists()
          Deprecated.  
 java.lang.String[] getACLNames()
          Deprecated.  
 dkDatastore getDatastore()
          Gets the datastore object
 dkPrivilege getPrivilege(java.lang.String name)
          Gets a privilege from memory, a memory-only function
 dkPrivilegeGroup getPrivilegeGroup(java.lang.String name)
          Gets a privilege set from memory
 dkPrivilegeSet getPrivilegeSet(java.lang.String name)
          Gets a privilege set from memory
 java.lang.String[] getPrivilegeSetNames()
          Deprecated. no need to do this
 dkCollection getPrivilegeSets()
          Deprecated. no need to do this
 boolean isAuthorized(int privId, dkPrivilegeSet privSet)
          Checks authorization based on privilege id and privilege set object
 boolean isAuthorized(int privId, java.lang.String ACLName, java.lang.String usrGrpName, short usrGrpType)
          Checks authorization based on userid, ACL name and privilege id
 boolean[] isAuthorized(java.lang.String[] accessControlListNames, java.lang.String privilegeName)
          Updates an access control list object to EIP server
 boolean isCacheEnabled()
          Deprecated.  
 boolean isTraceEnabled()
          Checks to see if trace is currently enabled
 java.lang.String[] listAccessControlListNames()
          lists names of access control lists from persistent datastore
 java.lang.String[] listAccessControlListNames(java.lang.String domainName)
          lists names of access control lists from persistent datastore
 dkCollection listAccessControlLists()
          lists access control lists from persistent datastore
 dkCollection listAccessControlLists(java.lang.String domainName)
          lists access control lists from persistent datastore
 dkCollection listACLData(long id)
          list ACL data from the persistent store
 dkCollection listACLData(java.lang.String name)
          list ACL data from the persistent store
 dkCollection listGeneralPrivileges()
           
 java.lang.String[] listPrivilegeGroupNames()
          lists names of privilege groups from persistent datastore
 dkCollection listPrivilegeGroups()
          lists privilege groups from persistent datastore
 java.lang.String[] listPrivilegeNames()
          lists names of the privileges
 dkCollection listPrivileges()
          lists privileges from the datastore
 java.lang.String[] listPrivilegeSetNames()
          lists names of privilege sets from persistent datastore
 java.lang.String[] listPrivilegeSetNames(java.lang.String domainName)
          lists names of privilege sets from a particular domain in the persistent datastore
 dkCollection listPrivilegeSets()
          lists privilege sets from persistent datastore
 dkCollection listPrivilegeSets(java.lang.String domainName)
          lists privilege sets from a particular domain from persistent datastore
 dkCollection listPrivInGroup(long id)
          lists privileges in a privilege group from the persistent store
 dkCollection listPrivInGroup(java.lang.String name)
          lists privileges in a privilege group from the persistent store
 dkCollection listPrivInSet(long id)
          lists privileges in a privilege set from the persistent store
 dkCollection listPrivInSet(java.lang.String name)
          lists privileges in a privilege set from the persistent store
 void removeAccessControlList(java.lang.String aclName)
          Deprecated.  
 void removeDomainACL(java.lang.String domainName, java.lang.String[] aclNames)
          remove one or more access control lists into a domain in the persistent store
 void removeDomainPrivilegeSet(java.lang.String domainName, java.lang.String[] privSetNames)
          remove one or more privilege sets from a domain in the persistent store
 void removePrivilegeSet(java.lang.String privName)
          Deprecated. no need to do this
 dkAccessControlList retrieveAccessControlList(long id)
          retrieve an access control list from the persistent store
 dkAccessControlList retrieveAccessControlList(java.lang.String name)
          retrieve an access control list from the persistent store
 dkPrivilege retrievePrivilege(long id)
          retrieve a privilege from the persistent store
 dkPrivilege retrievePrivilege(java.lang.String name)
          retrieve a privilege from the persistent store
 dkPrivilegeGroup retrievePrivilegeGroup(long id)
          retrieve a privilege group from the persistent store
 dkPrivilegeGroup retrievePrivilegeGroup(java.lang.String name)
          retrieve a privilege group from the persistent store
 dkPrivilegeSet retrievePrivilegeSet(long id)
          retrieve a privilege from the persistent store
 dkPrivilegeSet retrievePrivilegeSet(java.lang.String name)
          retrieve a privilege from the persistent store
 dkPrivilegeSet retrieveUserGroupPrivilegeSet(java.lang.String userGroupId)
          Retrieves the privilege set object from persistent datastore based on the specified user group.
 dkPrivilegeSet retrieveUserPrivilegeSet(java.lang.String userId)
          Retrieves the privilege set object from persistent datastore based on the specified user name.
 void setAccessLevel(int accessLevel)
           
 void setCacheEnabled(boolean isEnabled)
          Sets whether data should be cached for performance
 void setDatastore(dkDatastore ds)
          Sets the datastore object
 void setTraceEnabled(boolean isEnabled)
          Sets whether we should turn on trace for debuggin purpose
 void update(dkAccessControlList aclObj)
          updates the name, description and ACL rules of an exising access control list in the persistent store
 void update(dkPrivilege privObj)
          updates a privilege in the persistent store
 void update(dkPrivilegeGroup privGroupObj)
          updates name, descripion and associated privileges of a privilege group in the persistent store
 void update(dkPrivilegeSet privSetObj)
          updates a privilege set in the persistent store
 void updateACLRule(long aclCode, java.lang.String userId, short patronType, long privSetCode)
          Updates patron type and privilege set associated with a user id in an existing access control list in the persistent datastore
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
deleteAccessControlList, deletePrivilege, deletePrivilegeGroup, deletePrivilegeSet
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKACLMgmtFed

public DKACLMgmtFed()
Default constructor

DKACLMgmtFed

public DKACLMgmtFed(dkDatastore ds)
Constructor with datastore reference
Parameters:
ds - dkDatastore - datastore object

DKACLMgmtFed

public DKACLMgmtFed(dkDatastore ds,
                    int accessLevel)
Deprecated.  

Constructor with datastore reference
Parameters:
ds - dkDatastore - datastore object
Method Detail

setDatastore

public void setDatastore(dkDatastore ds)
Sets the datastore object
Overrides:
setDatastore in class dkAbstractAuthorizationMgmt
Parameters:
ds - dkDatastore - datastore object

getDatastore

public dkDatastore getDatastore()
Gets the datastore object
Overrides:
getDatastore in class dkAbstractAuthorizationMgmt
Returns:
dkDatastore object

setAccessLevel

public void setAccessLevel(int accessLevel)

listPrivileges

public dkCollection listPrivileges()
                            throws DKException,
                                   java.lang.Exception
lists privileges from the datastore
Overrides:
listPrivileges in class dkAbstractAuthorizationMgmt
Following copied from class: com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
Returns:
a collection of dkPrivilege objects
Throws:
DKException - if error occurs

listPrivilegeNames

public java.lang.String[] listPrivilegeNames()
                                      throws DKException,
                                             java.lang.Exception
lists names of the privileges
Overrides:
listPrivilegeNames in class dkAbstractAuthorizationMgmt
Following copied from class: com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
Returns:
an array of privilege names
Throws:
DKException - if error occurs

add

public void add(dkPrivilege privObj)
         throws DKAlreadyExistException,
                DKException,
                java.lang.Exception
adds a privilege into the persistent store
Overrides:
add in class dkAbstractAuthorizationMgmt
Parameters:
priv - a DKPrivilegeFed to be added to the datastore

del

public void del(dkPrivilege privObj)
         throws DKNotExistException,
                DKException,
                java.lang.Exception
deletes a privilege from the persistent store
Overrides:
del in class dkAbstractAuthorizationMgmt
Parameters:
priv - the privilege to be deleted

update

public void update(dkPrivilege privObj)
            throws DKAlreadyExistException,
                   DKException,
                   java.lang.Exception
updates a privilege in the persistent store
Overrides:
update in class dkAbstractAuthorizationMgmt
Parameters:
priv - a DKPrivilegeFed object to be updated in the datastore

retrievePrivilege

public dkPrivilege retrievePrivilege(java.lang.String name)
                              throws DKNotExistException,
                                     DKException,
                                     java.lang.Exception
retrieve a privilege from the persistent store
Overrides:
retrievePrivilege in class dkAbstractAuthorizationMgmt
Parameters:
name - the name of the privilege to be retrieved from the datastore

retrievePrivilege

public dkPrivilege retrievePrivilege(long id)
                              throws DKNotExistException,
                                     DKException,
                                     java.lang.Exception
retrieve a privilege from the persistent store
Parameters:
id - the id of the privilege to be retrieved from the datastore

getPrivilege

public dkPrivilege getPrivilege(java.lang.String name)
                         throws DKException,
                                java.lang.Exception
Gets a privilege from memory, a memory-only function
Parameters:
name - the name of the privilege

listPrivilegeSets

public dkCollection listPrivilegeSets(java.lang.String domainName)
                               throws DKException,
                                      java.lang.Exception
lists privilege sets from a particular domain from persistent datastore

listPrivilegeSetNames

public java.lang.String[] listPrivilegeSetNames(java.lang.String domainName)
                                         throws DKException,
                                                java.lang.Exception
lists names of privilege sets from a particular domain in the persistent datastore

listPrivilegeSets

public dkCollection listPrivilegeSets()
                               throws DKException,
                                      java.lang.Exception
lists privilege sets from persistent datastore
Overrides:
listPrivilegeSets in class dkAbstractAuthorizationMgmt
Following copied from class: com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
Returns:
a collection of dkPrivilegeSet objects
Throws:
DKException - if error occurs

listPrivilegeSetNames

public java.lang.String[] listPrivilegeSetNames()
                                         throws DKException,
                                                java.lang.Exception
lists names of privilege sets from persistent datastore
Overrides:
listPrivilegeSetNames in class dkAbstractAuthorizationMgmt
Following copied from class: com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
Returns:
an array of privilege set names
Throws:
DKException - if error occurs

add

public void add(dkPrivilegeSet privSetObj)
         throws DKAlreadyExistException,
                DKException,
                java.lang.Exception
adds a privilege set into the persistent store
Overrides:
add in class dkAbstractAuthorizationMgmt
Parameters:
privSet - a DKPrivilegeSetFed to be added to the datastore

addDomainPrivilegeSet

public void addDomainPrivilegeSet(java.lang.String domainName,
                                  java.lang.String[] privSetNames)
                           throws DKException,
                                  java.lang.Exception
adds one or more privilege sets into a domain in the persistent store
Parameters:
privSet - a DKPrivilegeSetICM to be added to the datastore

del

public void del(dkPrivilegeSet privSetObj)
         throws DKNotExistException,
                DKException,
                java.lang.Exception
deletes a privilege set from the persistent store
Overrides:
del in class dkAbstractAuthorizationMgmt
Parameters:
privSet - the privilege set to be deleted

removeDomainPrivilegeSet

public void removeDomainPrivilegeSet(java.lang.String domainName,
                                     java.lang.String[] privSetNames)
                              throws DKException,
                                     java.lang.Exception
remove one or more privilege sets from a domain in the persistent store
Parameters:
privSet - a DKPrivilegeSetICM to be added to the datastore

update

public void update(dkPrivilegeSet privSetObj)
            throws DKNotExistException,
                   DKException,
                   java.lang.Exception
updates a privilege set in the persistent store
Overrides:
update in class dkAbstractAuthorizationMgmt
Parameters:
privSet - a DKPrivilegeSetFed object to be updated in the datastore

retrievePrivilegeSet

public dkPrivilegeSet retrievePrivilegeSet(java.lang.String name)
                                    throws DKNotExistException,
                                           DKException,
                                           java.lang.Exception
retrieve a privilege from the persistent store
Overrides:
retrievePrivilegeSet in class dkAbstractAuthorizationMgmt
Parameters:
name - the name of the privilege to be retrieved from the datastore

retrievePrivilegeSet

public dkPrivilegeSet retrievePrivilegeSet(long id)
                                    throws DKNotExistException,
                                           DKException,
                                           java.lang.Exception
retrieve a privilege from the persistent store
Parameters:
name - the name of the privilege to be retrieved from the datastore

getPrivilegeSet

public dkPrivilegeSet getPrivilegeSet(java.lang.String name)
                               throws DKException,
                                      java.lang.Exception
Gets a privilege set from memory
Parameters:
name - the name of the privilege set

listPrivInSet

public dkCollection listPrivInSet(java.lang.String name)
                           throws DKNotExistException,
                                  DKException,
                                  java.lang.Exception
lists privileges in a privilege set from the persistent store
Parameters:
name - the name of the privilege set whose privileges are to be retrieved from the datastore

listPrivInSet

public dkCollection listPrivInSet(long id)
                           throws DKNotExistException,
                                  DKException,
                                  java.lang.Exception
lists privileges in a privilege set from the persistent store
Parameters:
id - the id of the privilege set whose privileges are to be retrieved from the datastore

getPrivilegeSetNames

public java.lang.String[] getPrivilegeSetNames()
                                        throws DKException,
                                               java.lang.Exception
Deprecated. no need to do this

Gets a list of privilege sets names
Returns:
an array of privilege set names
Throws:
DKException - when error occurs in the server

getPrivilegeSets

public dkCollection getPrivilegeSets()
                              throws DKException,
                                     java.lang.Exception
Deprecated. no need to do this

Gets a collection of privilege set objects
Returns:
dkCollection of DKPrivilegeSetFed objects
Throws:
DKException - when error occurs in the server

removePrivilegeSet

public void removePrivilegeSet(java.lang.String privName)
                        throws DKNotExistException,
                               DKException,
                               java.lang.Exception
Deprecated. no need to do this

Removes a privilege set object from EIP server
Parameters:
privName - String - privilege set name to be removed
Throws:
DKNotExistException - when the given privName does not exist in EIP server
DKException - when error occurs in the server

retrieveUserPrivilegeSet

public dkPrivilegeSet retrieveUserPrivilegeSet(java.lang.String userId)
                                        throws DKException,
                                               java.lang.Exception
Retrieves the privilege set object from persistent datastore based on the specified user name.
Overrides:
retrieveUserPrivilegeSet in class dkAbstractAuthorizationMgmt
Parameters:
userName - user name to retrieve the privilege set for.
Throws:
DKException - if error

retrieveUserGroupPrivilegeSet

public dkPrivilegeSet retrieveUserGroupPrivilegeSet(java.lang.String userGroupId)
                                             throws DKException,
                                                    java.lang.Exception
Retrieves the privilege set object from persistent datastore based on the specified user group.
Overrides:
retrieveUserGroupPrivilegeSet in class dkAbstractAuthorizationMgmt
Parameters:
userGroup - user group to retrieve the privilege set for.
Throws:
DKException - if error

listPrivilegeGroups

public dkCollection listPrivilegeGroups()
                                 throws DKException,
                                        java.lang.Exception
lists privilege groups from persistent datastore
Overrides:
listPrivilegeGroups in class dkAbstractAuthorizationMgmt
Following copied from class: com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
Returns:
a collection of dkPrivilegeGroup objects
Throws:
DKException - if error occurs

listPrivilegeGroupNames

public java.lang.String[] listPrivilegeGroupNames()
                                           throws DKException,
                                                  java.lang.Exception
lists names of privilege groups from persistent datastore
Overrides:
listPrivilegeGroupNames in class dkAbstractAuthorizationMgmt
Following copied from class: com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
Returns:
an array of privilege group names
Throws:
DKException - if error occurs

add

public void add(dkPrivilegeGroup privGroupObj)
         throws DKAlreadyExistException,
                DKException,
                java.lang.Exception
adds a privilege group into the persistent store
Overrides:
add in class dkAbstractAuthorizationMgmt
Parameters:
privGroup - a DKPrivilegeGroupFed to be added to the datastore

del

public void del(dkPrivilegeGroup privGroupObj)
         throws DKNotExistException,
                DKException,
                java.lang.Exception
deletes a privilege group from the persistent store
Overrides:
del in class dkAbstractAuthorizationMgmt
Parameters:
privGroup - the privilege group to be deleted

update

public void update(dkPrivilegeGroup privGroupObj)
            throws DKAlreadyExistException,
                   DKException,
                   java.lang.Exception
updates name, descripion and associated privileges of a privilege group in the persistent store
Overrides:
update in class dkAbstractAuthorizationMgmt
Parameters:
privGroup - a DKPrivilegeGroupFed object to be updated in the datastore

retrievePrivilegeGroup

public dkPrivilegeGroup retrievePrivilegeGroup(java.lang.String name)
                                        throws DKNotExistException,
                                               DKException,
                                               java.lang.Exception
retrieve a privilege group from the persistent store
Overrides:
retrievePrivilegeGroup in class dkAbstractAuthorizationMgmt
Parameters:
name - the name of the privilege group to be retrieved from the datastore

retrievePrivilegeGroup

public dkPrivilegeGroup retrievePrivilegeGroup(long id)
                                        throws DKNotExistException,
                                               DKException,
                                               java.lang.Exception
retrieve a privilege group from the persistent store
Parameters:
id - the id of the privilege group to be retrieved from the datastore

getPrivilegeGroup

public dkPrivilegeGroup getPrivilegeGroup(java.lang.String name)
                                   throws DKException,
                                          java.lang.Exception
Gets a privilege set from memory
Parameters:
name - the name of the privilege group

listPrivInGroup

public dkCollection listPrivInGroup(java.lang.String name)
                             throws DKNotExistException,
                                    DKException,
                                    java.lang.Exception
lists privileges in a privilege group from the persistent store
Parameters:
name - the name of the privilege group whose privileges are to be retrieved from the datastore

listPrivInGroup

public dkCollection listPrivInGroup(long id)
                             throws DKNotExistException,
                                    DKException,
                                    java.lang.Exception
lists privileges in a privilege group from the persistent store
Parameters:
id - the id of the privilege group whose privileges are to be retrieved from the datastore

listAccessControlLists

public dkCollection listAccessControlLists(java.lang.String domainName)
                                    throws DKException,
                                           java.lang.Exception
lists access control lists from persistent datastore

listAccessControlListNames

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

listAccessControlLists

public dkCollection listAccessControlLists()
                                    throws DKException,
                                           java.lang.Exception
lists access control lists from persistent datastore
Overrides:
listAccessControlLists in class dkAbstractAuthorizationMgmt
Following copied from class: com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
Returns:
a collection of dkAccessControlList objects
Throws:
DKException - if error occurs

listAccessControlListNames

public java.lang.String[] listAccessControlListNames()
                                              throws DKException,
                                                     java.lang.Exception
lists names of access control lists from persistent datastore
Overrides:
listAccessControlListNames in class dkAbstractAuthorizationMgmt
Following copied from class: com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
Returns:
an array of access control list names
Throws:
DKException - if error occurs

add

public void add(dkAccessControlList aclObj)
         throws DKAlreadyExistException,
                DKException,
                java.lang.Exception
adds a new access control list into the persistent store // only define
Overrides:
add in class dkAbstractAuthorizationMgmt
Parameters:
acl - a DKAccessControlListFed to be added to the datastore

addDomainACL

public void addDomainACL(java.lang.String domainName,
                         java.lang.String[] aclNames)
                  throws DKException,
                         java.lang.Exception
adds one or more access control lists into a domain in the persistent store

del

public void del(dkAccessControlList aclObj)
         throws DKNotExistException,
                DKException,
                java.lang.Exception
deletes an existing access control list from the persistent store
Overrides:
del in class dkAbstractAuthorizationMgmt
Parameters:
acl - the access control list to be deleted

removeDomainACL

public void removeDomainACL(java.lang.String domainName,
                            java.lang.String[] aclNames)
                     throws DKException,
                            java.lang.Exception
remove one or more access control lists into a domain in the persistent store

update

public void update(dkAccessControlList aclObj)
            throws DKAlreadyExistException,
                   DKException,
                   java.lang.Exception
updates the name, description and ACL rules of an exising access control list in the persistent store
Overrides:
update in class dkAbstractAuthorizationMgmt
Parameters:
acl - a DKAccessControlListFed object to be updated in the datastore

retrieveAccessControlList

public dkAccessControlList retrieveAccessControlList(java.lang.String name)
                                              throws DKNotExistException,
                                                     DKException,
                                                     java.lang.Exception
retrieve an access control list from the persistent store
Overrides:
retrieveAccessControlList in class dkAbstractAuthorizationMgmt
Parameters:
name - the name of the access control list to be retrieved from the datastore

retrieveAccessControlList

public dkAccessControlList retrieveAccessControlList(long id)
                                              throws DKNotExistException,
                                                     DKException,
                                                     java.lang.Exception
retrieve an access control list from the persistent store
Parameters:
id - the id of the access control list to be retrieved from the datastore

getAccessControlList

public dkAccessControlList getAccessControlList(java.lang.String name)
                                         throws DKException,
                                                java.lang.Exception
Gets an access control list from memory
Parameters:
name - the name of the access control list

listACLData

public dkCollection listACLData(java.lang.String name)
                         throws DKNotExistException,
                                DKException,
                                java.lang.Exception
list ACL data from the persistent store
Parameters:
name - the name of the access control list whose data are to be retrieved from the datastore

listACLData

public dkCollection listACLData(long id)
                         throws DKNotExistException,
                                DKException,
                                java.lang.Exception
list ACL data from the persistent store
Parameters:
id - the id of the access control list whose data are to be retrieved from the datastore

addACLRule

public void addACLRule(long aclCode,
                       java.lang.String userId,
                       short patronType,
                       long privSetCode)
                throws DKAlreadyExistException,
                       DKException,
                       java.lang.Exception
Adds an ACL rule to an existing access control list in the persistent datastore
Parameters:
aclCode - the acl code of the access control list
userId - the user id to be added to the access control list
patronType - the type of the user: either DK_FED_PATRON_TYPE_USER, DK_FED_PATRON_TYPE_GROUP, or DK_FED_PATRON_TYPE_PUBLIC
privSetCode - the privilege set code to be added to the access control list

updateACLRule

public void updateACLRule(long aclCode,
                          java.lang.String userId,
                          short patronType,
                          long privSetCode)
                   throws DKNotExistException,
                          DKException,
                          java.lang.Exception
Updates patron type and privilege set associated with a user id in an existing access control list in the persistent datastore
Parameters:
aclCode - the acl code of the access control list
userId - the user id of which the associated user kind and privilege set are to be updated
patronType - the type of the user to be updated: either DK_FED_PATRON_TYPE_USER, DK_FED_PATRON_TYPE_GROUP, or DK_FED_PATRON_TYPE_PUBLIC
privSetCode - the privilege set code to be updated in the access control list

deleteACLRule

public void deleteACLRule(long aclCode,
                          java.lang.String userId)
                   throws DKNotExistException,
                          DKException,
                          java.lang.Exception
Deletes an ACL rule which is indicated by the userid from an existing access control list in the persistent datastore
Parameters:
aclCode - the acl code of the access control list
userId - the user id to be deleted from the access control list

getACLNames

public java.lang.String[] getACLNames()
                               throws DKException,
                                      java.lang.Exception
Deprecated.  

Gets a list of access list names
Returns:
an array of ACL names

getAccessControlLists

public dkCollection getAccessControlLists()
                                   throws DKException,
                                          java.lang.Exception
Deprecated.  

Gets a collection of access control list objects
Returns:
dkCollection of DKAccessControlListFed objects
Throws:
DKException - when error occurs in the server

removeAccessControlList

public void removeAccessControlList(java.lang.String aclName)
                             throws DKNotExistException,
                                    DKException,
                                    java.lang.Exception
Deprecated.  

Removes a access control list object from EIP server
Parameters:
aclName - String - access control list name to be removed
Throws:
DKNotExistException - when the given privName does not exist in EIP server
DKException - when error occurs in the server

isAuthorized

public boolean[] isAuthorized(java.lang.String[] accessControlListNames,
                              java.lang.String privilegeName)
                       throws DKException,
                              java.lang.Exception
Updates an access control list object to EIP server
Parameters:
aclObj - dkAccessControlList - access control list object to be updated
Throws:
DKException - when error occurs in the server

isAuthorized

public boolean isAuthorized(int privId,
                            java.lang.String ACLName,
                            java.lang.String usrGrpName,
                            short usrGrpType)
                     throws java.lang.IllegalArgumentException,
                            DKNotExistException,
                            DKException
Checks authorization based on userid, ACL name and privilege id
Parameters:
privId - short - privilege id
ACLName - String - access control list name
usrGrpName - String - userid or group name
usrGrpType - short - DK_FED_PATRON_TYPE_USER or DK_FED_PATRON_TYPE_GROUP
Returns:
true if the given userid has privilege based on the ACL and privilege id
Throws:
java.lang.IllegalArgumentException - if either privId or usrGrpType is invalid
DKNotExistException - if either ACLName or usrGrpName does not exist
DKException - when error occurs in the server

isAuthorized

public boolean isAuthorized(int privId,
                            dkPrivilegeSet privSet)
                     throws DKException,
                            java.lang.Exception
Checks authorization based on privilege id and privilege set object
Parameters:
privId - short - privilege id
privSet - dkPrivilegeSet - privilege set object
Throws:
DKException - when error occurs in the server

listGeneralPrivileges

public dkCollection listGeneralPrivileges()
                                   throws DKException,
                                          java.lang.Exception

clearCache

public void clearCache()
Clears all cache data
Overrides:
clearCache in class dkAbstractAuthorizationMgmt

isCacheEnabled

public boolean isCacheEnabled()
                       throws DKException,
                              java.lang.Exception
Deprecated.  

Checks to see if cache is currently enabled
Returns:
true if cached is enabled, false otherwise

setCacheEnabled

public void setCacheEnabled(boolean isEnabled)
                     throws java.lang.Exception
Sets whether data should be cached for performance
Parameters:
isEnabled - true if want to turn on cache, false otherwise, default is cache

setTraceEnabled

public void setTraceEnabled(boolean isEnabled)
Sets whether we should turn on trace for debuggin purpose
Parameters:
isEnabled - true if want to turn on trace, false otherwise, default is no trace

isTraceEnabled

public boolean isTraceEnabled()
Checks to see if trace is currently enabled
Returns:
true if trace is enabled, false otherwise

createPrivilege

public dkPrivilege createPrivilege()
Create a DKPrivilgeFed instance
Overrides:
createPrivilege in class dkAbstractAuthorizationMgmt
Following copied from class: com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
Returns:
privilege object
Throws:
DKException - if error

createPrivilegeSet

public dkPrivilegeSet createPrivilegeSet()
Create a DKPrivilgeFedSet instance
Overrides:
createPrivilegeSet in class dkAbstractAuthorizationMgmt
Following copied from class: com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
Returns:
privilege set object
Throws:
DKException - if error

createPrivilegeGroup

public dkPrivilegeGroup createPrivilegeGroup()
Create a DKPrivilgeFedGroup instance
Overrides:
createPrivilegeGroup in class dkAbstractAuthorizationMgmt
Following copied from class: com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
Returns:
privilege group object
Throws:
DKException - if error

createAccessControlList

public dkAccessControlList createAccessControlList()
Create a DKAccessControlListFed instance
Overrides:
createAccessControlList in class dkAbstractAuthorizationMgmt
Following copied from class: com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
Returns:
access control list object
Throws:
DKException - if error

EIP Java APIs

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