|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt | +--com.ibm.mm.sdk.common.DKACLMgmtFed
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 |
public DKACLMgmtFed()
public DKACLMgmtFed(dkDatastore ds)
ds
- dkDatastore - datastore objectpublic DKACLMgmtFed(dkDatastore ds, int accessLevel)
ds
- dkDatastore - datastore objectMethod Detail |
public void setDatastore(dkDatastore ds)
setDatastore
in class dkAbstractAuthorizationMgmt
ds
- dkDatastore - datastore objectpublic dkDatastore getDatastore()
getDatastore
in class dkAbstractAuthorizationMgmt
public void setAccessLevel(int accessLevel)
public dkCollection listPrivileges() throws DKException, java.lang.Exception
listPrivileges
in class dkAbstractAuthorizationMgmt
com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
DKException
- if error occurspublic java.lang.String[] listPrivilegeNames() throws DKException, java.lang.Exception
listPrivilegeNames
in class dkAbstractAuthorizationMgmt
com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
DKException
- if error occurspublic void add(dkPrivilege privObj) throws DKAlreadyExistException, DKException, java.lang.Exception
add
in class dkAbstractAuthorizationMgmt
priv
- a DKPrivilegeFed to be added to the datastorepublic void del(dkPrivilege privObj) throws DKNotExistException, DKException, java.lang.Exception
del
in class dkAbstractAuthorizationMgmt
priv
- the privilege to be deletedpublic void update(dkPrivilege privObj) throws DKAlreadyExistException, DKException, java.lang.Exception
update
in class dkAbstractAuthorizationMgmt
priv
- a DKPrivilegeFed object to be updated in the datastorepublic dkPrivilege retrievePrivilege(java.lang.String name) throws DKNotExistException, DKException, java.lang.Exception
retrievePrivilege
in class dkAbstractAuthorizationMgmt
name
- the name of the privilege to be retrieved from the datastorepublic dkPrivilege retrievePrivilege(long id) throws DKNotExistException, DKException, java.lang.Exception
id
- the id of the privilege to be retrieved from the datastorepublic dkPrivilege getPrivilege(java.lang.String name) throws DKException, java.lang.Exception
name
- the name of the privilegepublic dkCollection listPrivilegeSets(java.lang.String domainName) throws DKException, java.lang.Exception
public java.lang.String[] listPrivilegeSetNames(java.lang.String domainName) throws DKException, java.lang.Exception
public dkCollection listPrivilegeSets() throws DKException, java.lang.Exception
listPrivilegeSets
in class dkAbstractAuthorizationMgmt
com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
DKException
- if error occurspublic java.lang.String[] listPrivilegeSetNames() throws DKException, java.lang.Exception
listPrivilegeSetNames
in class dkAbstractAuthorizationMgmt
com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
DKException
- if error occurspublic void add(dkPrivilegeSet privSetObj) throws DKAlreadyExistException, DKException, java.lang.Exception
add
in class dkAbstractAuthorizationMgmt
privSet
- a DKPrivilegeSetFed to be added to the datastorepublic void addDomainPrivilegeSet(java.lang.String domainName, java.lang.String[] privSetNames) throws DKException, java.lang.Exception
privSet
- a DKPrivilegeSetICM to be added to the datastorepublic void del(dkPrivilegeSet privSetObj) throws DKNotExistException, DKException, java.lang.Exception
del
in class dkAbstractAuthorizationMgmt
privSet
- the privilege set to be deletedpublic void removeDomainPrivilegeSet(java.lang.String domainName, java.lang.String[] privSetNames) throws DKException, java.lang.Exception
privSet
- a DKPrivilegeSetICM to be added to the datastorepublic void update(dkPrivilegeSet privSetObj) throws DKNotExistException, DKException, java.lang.Exception
update
in class dkAbstractAuthorizationMgmt
privSet
- a DKPrivilegeSetFed object to be updated in the datastorepublic dkPrivilegeSet retrievePrivilegeSet(java.lang.String name) throws DKNotExistException, DKException, java.lang.Exception
retrievePrivilegeSet
in class dkAbstractAuthorizationMgmt
name
- the name of the privilege to be retrieved from the datastorepublic dkPrivilegeSet retrievePrivilegeSet(long id) throws DKNotExistException, DKException, java.lang.Exception
name
- the name of the privilege to be retrieved from the datastorepublic dkPrivilegeSet getPrivilegeSet(java.lang.String name) throws DKException, java.lang.Exception
name
- the name of the privilege setpublic dkCollection listPrivInSet(java.lang.String name) throws DKNotExistException, DKException, java.lang.Exception
name
- the name of the privilege set whose privileges are to be retrieved from the datastorepublic dkCollection listPrivInSet(long id) throws DKNotExistException, DKException, java.lang.Exception
id
- the id of the privilege set whose privileges are to be retrieved from the datastorepublic java.lang.String[] getPrivilegeSetNames() throws DKException, java.lang.Exception
DKException
- when error occurs in the serverpublic dkCollection getPrivilegeSets() throws DKException, java.lang.Exception
DKException
- when error occurs in the serverpublic void removePrivilegeSet(java.lang.String privName) throws DKNotExistException, DKException, java.lang.Exception
privName
- String - privilege set name to be removedDKNotExistException
- when the given privName does not exist
in EIP serverDKException
- when error occurs in the serverpublic dkPrivilegeSet retrieveUserPrivilegeSet(java.lang.String userId) throws DKException, java.lang.Exception
retrieveUserPrivilegeSet
in class dkAbstractAuthorizationMgmt
userName
- user name to retrieve the privilege set for.DKException
- if errorpublic dkPrivilegeSet retrieveUserGroupPrivilegeSet(java.lang.String userGroupId) throws DKException, java.lang.Exception
retrieveUserGroupPrivilegeSet
in class dkAbstractAuthorizationMgmt
userGroup
- user group to retrieve the privilege set for.DKException
- if errorpublic dkCollection listPrivilegeGroups() throws DKException, java.lang.Exception
listPrivilegeGroups
in class dkAbstractAuthorizationMgmt
com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
DKException
- if error occurspublic java.lang.String[] listPrivilegeGroupNames() throws DKException, java.lang.Exception
listPrivilegeGroupNames
in class dkAbstractAuthorizationMgmt
com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
DKException
- if error occurspublic void add(dkPrivilegeGroup privGroupObj) throws DKAlreadyExistException, DKException, java.lang.Exception
add
in class dkAbstractAuthorizationMgmt
privGroup
- a DKPrivilegeGroupFed to be added to the datastorepublic void del(dkPrivilegeGroup privGroupObj) throws DKNotExistException, DKException, java.lang.Exception
del
in class dkAbstractAuthorizationMgmt
privGroup
- the privilege group to be deletedpublic void update(dkPrivilegeGroup privGroupObj) throws DKAlreadyExistException, DKException, java.lang.Exception
update
in class dkAbstractAuthorizationMgmt
privGroup
- a DKPrivilegeGroupFed object to be updated in the datastorepublic dkPrivilegeGroup retrievePrivilegeGroup(java.lang.String name) throws DKNotExistException, DKException, java.lang.Exception
retrievePrivilegeGroup
in class dkAbstractAuthorizationMgmt
name
- the name of the privilege group to be retrieved from the datastorepublic dkPrivilegeGroup retrievePrivilegeGroup(long id) throws DKNotExistException, DKException, java.lang.Exception
id
- the id of the privilege group to be retrieved from the datastorepublic dkPrivilegeGroup getPrivilegeGroup(java.lang.String name) throws DKException, java.lang.Exception
name
- the name of the privilege grouppublic dkCollection listPrivInGroup(java.lang.String name) throws DKNotExistException, DKException, java.lang.Exception
name
- the name of the privilege group whose privileges are to be retrieved from the datastorepublic dkCollection listPrivInGroup(long id) throws DKNotExistException, DKException, java.lang.Exception
id
- the id of the privilege group whose privileges are to be retrieved from the datastorepublic dkCollection listAccessControlLists(java.lang.String domainName) throws DKException, java.lang.Exception
public java.lang.String[] listAccessControlListNames(java.lang.String domainName) throws DKException, java.lang.Exception
public dkCollection listAccessControlLists() throws DKException, java.lang.Exception
listAccessControlLists
in class dkAbstractAuthorizationMgmt
com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
DKException
- if error occurspublic java.lang.String[] listAccessControlListNames() throws DKException, java.lang.Exception
listAccessControlListNames
in class dkAbstractAuthorizationMgmt
com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
DKException
- if error occurspublic void add(dkAccessControlList aclObj) throws DKAlreadyExistException, DKException, java.lang.Exception
add
in class dkAbstractAuthorizationMgmt
acl
- a DKAccessControlListFed to be added to the datastorepublic void addDomainACL(java.lang.String domainName, java.lang.String[] aclNames) throws DKException, java.lang.Exception
public void del(dkAccessControlList aclObj) throws DKNotExistException, DKException, java.lang.Exception
del
in class dkAbstractAuthorizationMgmt
acl
- the access control list to be deletedpublic void removeDomainACL(java.lang.String domainName, java.lang.String[] aclNames) throws DKException, java.lang.Exception
public void update(dkAccessControlList aclObj) throws DKAlreadyExistException, DKException, java.lang.Exception
update
in class dkAbstractAuthorizationMgmt
acl
- a DKAccessControlListFed object to be updated in the datastorepublic dkAccessControlList retrieveAccessControlList(java.lang.String name) throws DKNotExistException, DKException, java.lang.Exception
retrieveAccessControlList
in class dkAbstractAuthorizationMgmt
name
- the name of the access control list to be retrieved from the datastorepublic dkAccessControlList retrieveAccessControlList(long id) throws DKNotExistException, DKException, java.lang.Exception
id
- the id of the access control list to be retrieved from the datastorepublic dkAccessControlList getAccessControlList(java.lang.String name) throws DKException, java.lang.Exception
name
- the name of the access control listpublic dkCollection listACLData(java.lang.String name) throws DKNotExistException, DKException, java.lang.Exception
name
- the name of the access control list whose data are to be retrieved from the datastorepublic dkCollection listACLData(long id) throws DKNotExistException, DKException, java.lang.Exception
id
- the id of the access control list whose data are to be retrieved from the datastorepublic void addACLRule(long aclCode, java.lang.String userId, short patronType, long privSetCode) throws DKAlreadyExistException, DKException, java.lang.Exception
aclCode
- the acl code of the access control listuserId
- the user id to be added to the access control listpatronType
- the type of the user: either DK_FED_PATRON_TYPE_USER, DK_FED_PATRON_TYPE_GROUP,
or DK_FED_PATRON_TYPE_PUBLICprivSetCode
- the privilege set code to be added to the access control listpublic void updateACLRule(long aclCode, java.lang.String userId, short patronType, long privSetCode) throws DKNotExistException, DKException, java.lang.Exception
aclCode
- the acl code of the access control listuserId
- the user id of which the associated user kind and privilege set are to be updatedpatronType
- the type of the user to be updated: either DK_FED_PATRON_TYPE_USER, DK_FED_PATRON_TYPE_GROUP,
or DK_FED_PATRON_TYPE_PUBLICprivSetCode
- the privilege set code to be updated in the access control listpublic void deleteACLRule(long aclCode, java.lang.String userId) throws DKNotExistException, DKException, java.lang.Exception
aclCode
- the acl code of the access control listuserId
- the user id to be deleted from the access control listpublic java.lang.String[] getACLNames() throws DKException, java.lang.Exception
public dkCollection getAccessControlLists() throws DKException, java.lang.Exception
DKException
- when error occurs in the serverpublic void removeAccessControlList(java.lang.String aclName) throws DKNotExistException, DKException, java.lang.Exception
aclName
- String - access control list name to be removedDKNotExistException
- when the given privName does not exist
in EIP serverDKException
- when error occurs in the serverpublic boolean[] isAuthorized(java.lang.String[] accessControlListNames, java.lang.String privilegeName) throws DKException, java.lang.Exception
aclObj
- dkAccessControlList - access control list object to be updatedDKException
- when error occurs in the serverpublic boolean isAuthorized(int privId, java.lang.String ACLName, java.lang.String usrGrpName, short usrGrpType) throws java.lang.IllegalArgumentException, DKNotExistException, DKException
privId
- short - privilege idACLName
- String - access control list nameusrGrpName
- String - userid or group nameusrGrpType
- short - DK_FED_PATRON_TYPE_USER or DK_FED_PATRON_TYPE_GROUPjava.lang.IllegalArgumentException
- if either privId or usrGrpType is invalidDKNotExistException
- if either ACLName or usrGrpName does not existDKException
- when error occurs in the serverpublic boolean isAuthorized(int privId, dkPrivilegeSet privSet) throws DKException, java.lang.Exception
privId
- short - privilege idprivSet
- dkPrivilegeSet - privilege set objectDKException
- when error occurs in the serverpublic dkCollection listGeneralPrivileges() throws DKException, java.lang.Exception
public void clearCache()
clearCache
in class dkAbstractAuthorizationMgmt
public boolean isCacheEnabled() throws DKException, java.lang.Exception
public void setCacheEnabled(boolean isEnabled) throws java.lang.Exception
isEnabled
- true if want to turn on cache, false otherwise, default is cachepublic void setTraceEnabled(boolean isEnabled)
isEnabled
- true if want to turn on trace, false otherwise, default is no tracepublic boolean isTraceEnabled()
public dkPrivilege createPrivilege()
createPrivilege
in class dkAbstractAuthorizationMgmt
com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
DKException
- if errorpublic dkPrivilegeSet createPrivilegeSet()
createPrivilegeSet
in class dkAbstractAuthorizationMgmt
com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
DKException
- if errorpublic dkPrivilegeGroup createPrivilegeGroup()
createPrivilegeGroup
in class dkAbstractAuthorizationMgmt
com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
DKException
- if errorpublic dkAccessControlList createAccessControlList()
createAccessControlList
in class dkAbstractAuthorizationMgmt
com.ibm.mm.sdk.common.dkAbstractAuthorizationMgmt
DKException
- if error
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |