|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.sun.identity.um.Common | +--com.sun.identity.um.Role
The Role
interface provides methods to manage role
Method Summary | |
void |
addUsers(java.util.Set users)
Adds users to the role. |
long |
getNumberOfUsers()
Gets number of users in the role. |
int |
getRoleType()
Gets the type of the role. |
java.util.Set |
getUserDNs()
Gets the DNs of users in the role. |
void |
removeUsers(java.util.Set users)
Removes users from the role. |
java.util.Set |
searchUsers(java.lang.String wildcard,
int level)
Searches for users in this role using wildcards and attribute values. |
java.util.Set |
searchUsers(java.lang.String wildcard,
java.util.Map avPairs,
int level)
Searches for users in this role using wildcards and attribute values. |
void |
setRoleType(int roleType)
Sets the type of the role. |
Methods inherited from class com.sun.identity.um.Common |
assignServices, delete, delete, getAssignedServices, getAttributes, getAttributes, getDN, getOrganizationDN, getParentDN, getServiceAttributes, getServiceStatus, isExists, modifyService, removeAttributes, setAttributes, setServiceStatus, store, unassignServices |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public int getRoleType() throws UMException, SSOException
UMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign on is no longer validpublic void setRoleType(int roleType) throws UMException, SSOException
roleType
- The type of the role.UMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign on is no longer validpublic void addUsers(java.util.Set users) throws UMException, SSOException
users
- The set of user DN's to be added to the role.UMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign on is no longer validpublic void removeUsers(java.util.Set users) throws UMException, SSOException
users
- The set of user DN's to be removed from the role.UMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign on is no longer validpublic long getNumberOfUsers() throws UMException, SSOException
UMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign on is no longer validpublic java.util.Set getUserDNs() throws UMException, SSOException
UMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign on is no longer validpublic java.util.Set searchUsers(java.lang.String wildcard, int level) throws UMException, SSOException
wildcard
- wildcard pattern to be used in the searchlevel
- the search level that needs to be used
(AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)UMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign on is no longer validpublic java.util.Set searchUsers(java.lang.String wildcard, java.util.Map avPairs, int level) throws UMException, SSOException
wildcard
- wildcard pattern to be used in the searchavPairs
- attribute-value pairs to match when searching userslevel
- the search level that needs to be used
(AMConstants.SCOPE_ONE or AMConstants.SCOPE_SUB)UMException
- if an error is encountered when trying to
access/retrieve data from the data storeSSOException
- if the sign on is no longer valid
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |