public interface RoleManager
Modifier and Type | Method and Description |
---|---|
Role |
createRole(java.lang.String name)
Create role in the application scope
|
Role |
createRole(java.lang.String name, int scope)
Create role within specified scope
|
void |
dropRole(Role role) |
void |
dropRole(RoleProfile role)
Drop the role from the identity repository.
|
SearchResponse |
getGrantedRoles(java.security.Principal principal, boolean direct)
Get all the roles granted to this principal.
|
SearchResponse |
getManagedRoles(java.security.Principal principal, boolean direct)
Get all the roles managed by this principal.
|
SearchResponse |
getOwnedRoles(java.security.Principal principal, boolean direct)
Get all the roles owned by this principal.
|
void |
grantRole(Role parent, java.security.Principal principal)
Grant the specified role to the principal
|
boolean |
isCreateRoleSupported() |
boolean |
isDropRoleSupported() |
boolean |
isGranted(Role parent, java.security.Principal principal)
Determines whether specified role has been granted to this principal.
|
boolean |
isManagedBy(Role parent, java.security.Principal principal)
Determines whether specified role is managed by this principal.
|
boolean |
isModifyRoleSupported() |
boolean |
isOwnedBy(Role parent, java.security.Principal principal)
Determines whether specified role is owned by this principal.
|
void |
revokeRole(Role parent, java.security.Principal principal)
Revoke the specified role from the principal
|
boolean isDropRoleSupported()
boolean isCreateRoleSupported()
boolean isModifyRoleSupported()
Role createRole(java.lang.String name, int scope) throws IMException
OperationNotSupportedException
- Thrown by the service provider if it doesn't support role creation.ObjectExistsException
- Thrown if the role already existsNoPermissionException
- Thrown if the caller doesn't have permission to create a role.OperationFailureException
- Thrown in case of operation failureIMException
- Thrown by the service provider in case of any other problem.Role createRole(java.lang.String name) throws IMException
OperationNotSupportedException
- Thrown by the service provider if it doesn't support role creation.ObjectExistsException
- Thrown if the role already existsNoPermissionException
- Thrown if the caller doesn't have permission to create a role.OperationFailureException
- Thrown in case of operation failureIMException
- Thrown by the service provider in case of any other problem.void dropRole(RoleProfile role) throws IMException
OperationNotSupportedException
- Thrown by the service provider if it doesn't support role drop.ObjectNotFoundException
- Thrown if the role does not exist.NoPermissionException
- Thrown if the caller doesn't have permission to drop a role.OperationFailureException
- Thrown in case of operation failureIMException
- Thrown by the service provider in case of any other problem.void dropRole(Role role) throws IMException
IMException
void grantRole(Role parent, java.security.Principal principal) throws IMException
OperationNotSupportedException
- Thrown by the service provider if it doesn't support role grant.NoPermissionException
- Thrown if the caller doesn't have permission to grant a role.OperationFailureException
- Thrown in case of operation failureIMException
- Thrown by the service provider in case of any other problem.void revokeRole(Role parent, java.security.Principal principal) throws IMException
OperationNotSupportedException
- Thrown by the service provider if it doesn't support role revoke.NoPermissionException
- Thrown if the caller doesn't have permission to revoke a role.OperationFailureException
- Thrown in case of operation failureIMException
- Thrown by the service provider in case of any other problem.SearchResponse getGrantedRoles(java.security.Principal principal, boolean direct) throws IMException
principal
- prinicipal whose granted roles need to be fetched.direct
- If true all the roles granted directly to this principal will be returned. If false both the direct and the indirect roles granted to this principal will be returned.ObjectNotFoundException
- Thrown if the search doesn't return any results.NoPermissionException
- Thrown if the caller doesn't have permission to execute this operation.OperationFailureException
- Thrown in case of operation failureIMException
- Thrown by the service provider in case of any other problem.SearchResponse getOwnedRoles(java.security.Principal principal, boolean direct) throws IMException
principal
- prinicipal whose owned roles need to be fetched.direct
- If true all the roles owned directly by this principal will be returned. If false both the direct and the indirect roles owned by this principal will be returned.ObjectNotFoundException
- Thrown if the search doesn't return any results.NoPermissionException
- Thrown if the caller doesn't have permission to execute this operation.OperationFailureException
- Thrown in case of operation failureIMException
- Thrown by the service provider in case of any other problem.SearchResponse getManagedRoles(java.security.Principal principal, boolean direct) throws IMException
principal
- prinicipal whose managed roles need to be fetched.direct
- If true all the roles managed directly by this principal will be returned. If false both the direct and the indirect roles managed by this principal will be returned.ObjectNotFoundException
- Thrown if the search doesn't return any results.NoPermissionException
- Thrown if the caller doesn't have permission to execute this operation.OperationFailureException
- Thrown in case of operation failureIMException
- Thrown by the service provider in case of any other problem.boolean isGranted(Role parent, java.security.Principal principal) throws IMException
NoPermissionException
- Thrown if the caller doesn't have permission to execute this operation.OperationFailureException
- Thrown in case of operation failureIMException
- Thrown by the service provider in case of any other problem.boolean isManagedBy(Role parent, java.security.Principal principal) throws IMException
NoPermissionException
- Thrown if the caller doesn't have permission to execute this operation.OperationFailureException
- Thrown in case of operation failureIMException
- Thrown by the service provider in case of any other problem.boolean isOwnedBy(Role parent, java.security.Principal principal) throws IMException
NoPermissionException
- Thrown if the caller doesn't have permission to execute this operation.OperationFailureException
- Thrown in case of operation failureIMException
- Thrown by the service provider in case of any other problem.