|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AdminRoleService
Service interface to query admin roles defined in an OIM installation and manage scoped user memberships in these roles.
Method Summary | |
---|---|
AdminRoleMembership |
addAdminRoleMembership(AdminRoleMembership membership) Add a admin role membership. |
AdminRole |
getAdminRole(java.lang.String roleName) Returns a a admin role matching the given name (case-insensitive). |
AdminRole |
getAdminRoleForID(java.lang.String roleId) Returns a a admin role matching the given name. |
java.util.List |
getAdminRoles() Returns list of admin roles available in an installation |
java.util.List |
getAdminRoles(java.lang.String scopeId) Returns list of admin roles available within the context of the passed scope-id. |
java.util.List |
getAdminRolesForUser(java.lang.String userId, java.util.Map paramsMap) Get the list of admin roles for passed userId |
java.util.List |
getGlobalAdminRoles() Returns a list of admin roles which should never be assigned within organization scope. |
java.util.List |
getScopedAdminRoles() Returns list of admin roles which must be assigned within a valid organization scope. |
java.util.List |
listMembershipsForUserByRoleName(java.lang.String userId, java.util.List roleName) Returns a list of user's admin role memberships based on role names.. |
java.util.List |
listMembershipsInScope(java.lang.String scopeId, java.lang.String roleName, boolean includeHierarchy, java.util.Map paramsMap) Returns a list of admin role membership in the given scope. |
java.util.List |
listUsersMembership(java.lang.String userId, java.lang.String roleName, java.lang.String scopeId, boolean includeHierarchy, java.util.Map paramsMap) Returns a list of user's admin role memberships based on the parameters. |
boolean |
removeAdminRoleMembership(AdminRoleMembership membership) Removes a admin role membership |
boolean |
updateRoleMemberships(AdminRoleMembership roleMembership) Method to update the role memberships. |
Method Detail |
---|
java.util.List getAdminRoles()
java.util.List getScopedAdminRoles()
java.util.List getGlobalAdminRoles()
AdminRole getAdminRole(java.lang.String roleName)
roleName
- name of the admin role, required, not-nullAdminRole getAdminRoleForID(java.lang.String roleId)
roleId
- id of the admin role, required, not-nullAdminRoleMembership addAdminRoleMembership(AdminRoleMembership membership)
membership
- a valid membership to add, requiredjava.lang.IllegalArgumentException
- this runtime exception will be thrown if admin role is global scoped and membership is attempted within a scope.boolean removeAdminRoleMembership(AdminRoleMembership membership)
membership
- a valid membership to be removed, requiredjava.util.List listUsersMembership(java.lang.String userId, java.lang.String roleName, java.lang.String scopeId, boolean includeHierarchy, java.util.Map paramsMap)
userId
- a valid user-id, requiredroleName
- - optional, the Admin role name filterscopeId
- optional, specific scope filterincludeHierarchy
- this parameter is honored only when a valid scope id is passed. If true, then include any user's memberships to scope's parent, otherwise include direct scope assignment.java.util.List listMembershipsInScope(java.lang.String scopeId, java.lang.String roleName, boolean includeHierarchy, java.util.Map paramsMap)
scopeId
- a valid scope id, requiredroleName
- - optional, the Admin role name filterincludeHierarchy
- If true, then include any memberships in this scope inherited from the parent of this scope, otherwise include only direct membership to the scope.boolean updateRoleMemberships(AdminRoleMembership roleMembership)
rolemembership
- that has updated datajava.util.List getAdminRolesForUser(java.lang.String userId, java.util.Map paramsMap)
userId
-java.util.List listMembershipsForUserByRoleName(java.lang.String userId, java.util.List roleName)
userId
- a valid user-id, requiredroleName
- - required, the Admin role name filterjava.util.List getAdminRoles(java.lang.String scopeId)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |