|
Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server 11g Release 1 (11.1.1) E22649-02 ESAPI |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AdminManager
AdminManger manipulates the administration roles and grant privileges for them. AdminRole (PrincipalEntry and Principal) cannot be managed outside of AdminManager.
Method Summary | |
---|---|
AdminRoleEntry |
createAdminRole(java.lang.String adminRoleName, java.lang.String displayName, java.lang.String desc) |
void |
deleteAdminRole(java.lang.String adminRoleName, boolean cascade) Removes the administration role from policy store. |
AdminRoleEntry |
getAdminRole(java.lang.String adminRoleName) This method get administration role by role name. |
java.util.List<AdminRoleEntry> |
getAdminRoles(AdminRoleSearchQuery query) This method searches administration roles by an AdminRoleSearchQuery. |
java.util.List<PrincipalEntry> |
getAllAdminRolesMembers(java.lang.String adminRoleName) Returns the list of principalEntries granted to this administration role. |
java.util.Set<AdminResourceActionEntry> |
getGrantedAdminResources() Gets all granted AdminResourceActionEntry for the current administrator |
java.util.List<AdminResourceActionEntry> |
getGrantsForAdminRole(AdminRoleEntry adminRole) Get all the grants of the administration role. |
void |
grant(AdminRoleEntry adminRole, java.util.List<AdminResourceActionEntry> adminResourceActions) Grant Administrative resource actions to an admin role. |
void |
grantAdminRole(AdminRoleEntry role, java.util.List<PrincipalEntry> principalEntries) Adds these principals as member to this administration role. |
void |
modifyAdminRole(AdminRoleEntry roleEntry) Modify the administration role with the given role entry. |
void |
revoke(AdminRoleEntry adminRole, java.util.List<AdminResourceActionEntry> adminResourceActions) Revoke Administrative resource actions from an admin role. |
void |
revokeAdminRole(AdminRoleEntry role, java.util.List<PrincipalEntry> principalEntries) Removes this principal from this administration role. |
Methods inherited from interface oracle.security.jps.service.policystore.entitymanager.EntityManager |
---|
resolveReference |
Method Detail |
---|
AdminRoleEntry createAdminRole(java.lang.String adminRoleName, java.lang.String displayName, java.lang.String desc) throws PolicyObjectAlreadyExistsException, InvalidArgumentException, PolicyStoreException
adminRoleName
- The name of the administration role to be created.displayName
- The display name of the administration role to be created.desc
- The description of the administration role to be created.PolicyObjectAlreadyExistsException
- If the administration role with the same name already exist.InvalidArgumentException
PolicyStoreException
void deleteAdminRole(java.lang.String adminRoleName, boolean cascade) throws PolicyObjectNotFoundException, PolicyStoreException
adminRoleName
- The name of the role to be deleted.cascade
- Whether cascade delete policies associated with this role.PolicyObjectNotFoundException
- If the role with specified name does not exist, will throw PolicyObjectNotFoundExceptionInvalidArgumentException
PolicyStoreException
void modifyAdminRole(AdminRoleEntry roleEntry) throws InvalidArgumentException, PolicyObjectNotFoundException, PolicyStoreException
roleEntry
- The role entry holding the value to be modified.PolicyObjectNotFoundException
- If the specified administration role does not exist, will throw PolicyObjectNotFoundException.PolicyStoreException
InvalidArgumentException
AdminRoleEntry getAdminRole(java.lang.String adminRoleName) throws InvalidArgumentException, PolicyObjectNotFoundException, PolicyStoreException
adminRoleName
- The name of the administration role to get.InvalidArgumentException
PolicyObjectNotFoundException
- if the specified admin role does not existPolicyStoreException
java.util.List<AdminRoleEntry> getAdminRoles(AdminRoleSearchQuery query) throws PolicyStoreException
query
- The query object to query administration roles.PolicyStoreException
void grantAdminRole(AdminRoleEntry role, java.util.List<PrincipalEntry> principalEntries) throws InvalidArgumentException, PolicyStoreException
role
- The administration role to which the principalEntries will be added as member.principalEntries
- to be added. The principalEntry can only be an enterprise user or an enterprise role (group). The principalEntry cannot be an ApplicationRole or an AdminRole.InvalidArgumentException
- If the parameters are null.PolicyStoreException
- If there is back end error occur in the policy store.void revokeAdminRole(AdminRoleEntry role, java.util.List<PrincipalEntry> principalEntries) throws InvalidArgumentException, PolicyStoreException
role
- The administration role to which the principalEntries will be revoked.principalEntries
- to be revoked. The principalEntry can only be an enterprise user or an enterprise role (group). The principalEntry cannot be an ApplicationRole or an AdminRole.InvalidArgumentException
- If the parameters are null.PolicyStoreException
- If there is back end error occur in the policy store.java.util.List<PrincipalEntry> getAllAdminRolesMembers(java.lang.String adminRoleName) throws InvalidArgumentException, PolicyStoreException
adminRoleName
- The name of the administration role.InvalidArgumentException
PolicyStoreException
- If there is back end error occur in the policy store.void grant(AdminRoleEntry adminRole, java.util.List<AdminResourceActionEntry> adminResourceActions) throws InvalidArgumentException, PolicyStoreException
adminRole
-adminResourceActions
-PolicyObjectNotFoundException
- if the adminRole cannot be found.PolicyStoreException
- if an error occurred during this grant operation.InvalidArgumentException
void revoke(AdminRoleEntry adminRole, java.util.List<AdminResourceActionEntry> adminResourceActions) throws InvalidArgumentException, PolicyStoreException
adminRole
-adminResourceActions
-PolicyObjectNotFoundException
- if the adminRole cannot be found.PolicyStoreException
- if an error occurred during this grant operation.InvalidArgumentException
java.util.List<AdminResourceActionEntry> getGrantsForAdminRole(AdminRoleEntry adminRole) throws InvalidArgumentException, PolicyStoreException
adminRole
- The administration role to get grants.PolicyObjectNotFoundException
- If the specified administration role does not exist, will throw PolicyObjectNotFoundExceptionInvalidArgumentException
PolicyStoreException
java.util.Set<AdminResourceActionEntry> getGrantedAdminResources() throws PolicyStoreException
PolicyStoreException
- if an error occurred during this operation
|
Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server 11g Release 1 (11.1.1) E22649-02 ESAPI |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |