Skip navigation links

oracle.security.jps.service.policystore.entitymanager
Interface AdminManager

All Superinterfaces:

EntityManager

public interface AdminManager

extends EntityManager

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

createAdminRole

AdminRoleEntry createAdminRole(java.lang.String adminRoleName,
                               java.lang.String displayName,
                               java.lang.String desc)
                               throws PolicyObjectAlreadyExistsException,
                                      InvalidArgumentException,
                                      PolicyStoreException

Parameters:

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.

Returns:

The AdminRoleEntry object that is just created.

Throws:

PolicyObjectAlreadyExistsException - If the administration role with the same name already exist.

InvalidArgumentException

PolicyStoreException

deleteAdminRole

void deleteAdminRole(java.lang.String adminRoleName,
                     boolean cascade)
                     throws PolicyObjectNotFoundException,
                            PolicyStoreException

Removes the administration role from policy store.

Parameters:

adminRoleName - The name of the role to be deleted.

cascade - Whether cascade delete policies associated with this role.

Throws:

PolicyObjectNotFoundException - If the role with specified name does not exist, will throw PolicyObjectNotFoundException

InvalidArgumentException

PolicyStoreException

modifyAdminRole

void modifyAdminRole(AdminRoleEntry roleEntry)
                     throws InvalidArgumentException,
                            PolicyObjectNotFoundException,
                            PolicyStoreException

Modify the administration role with the given role entry.

Parameters:

roleEntry - The role entry holding the value to be modified.

Throws:

PolicyObjectNotFoundException - If the specified administration role does not exist, will throw PolicyObjectNotFoundException.

PolicyStoreException

InvalidArgumentException

getAdminRole

AdminRoleEntry getAdminRole(java.lang.String adminRoleName)
                            throws InvalidArgumentException,
                                   PolicyObjectNotFoundException,
                                   PolicyStoreException

This method get administration role by role name.

Parameters:

adminRoleName - The name of the administration role to get.

Returns:

The role entry with the specified name.

Throws:

InvalidArgumentException

PolicyObjectNotFoundException - if the specified admin role does not exist

PolicyStoreException

getAdminRoles

java.util.List<AdminRoleEntry> getAdminRoles(AdminRoleSearchQuery query)
                                             throws PolicyStoreException

This method searches administration roles by an AdminRoleSearchQuery. If there is no administration role matched, it will return an empty list.

Parameters:

query - The query object to query administration roles.

Returns:

List of AdminRoleEntry which match the query criteria, it will return empty list if there is no matched roles.

Throws:

PolicyStoreException

grantAdminRole

void grantAdminRole(AdminRoleEntry role,
                    java.util.List<PrincipalEntry> principalEntries)
                    throws InvalidArgumentException,
                           PolicyStoreException

Adds these principals as member to this administration role.

Parameters:

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.

Throws:

InvalidArgumentException - If the parameters are null.

PolicyStoreException - If there is back end error occur in the policy store.

revokeAdminRole

void revokeAdminRole(AdminRoleEntry role,
                     java.util.List<PrincipalEntry> principalEntries)
                     throws InvalidArgumentException,
                            PolicyStoreException

Removes this principal from this administration role.

Parameters:

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.

Throws:

InvalidArgumentException - If the parameters are null.

PolicyStoreException - If there is back end error occur in the policy store.

getAllAdminRolesMembers

java.util.List<PrincipalEntry> getAllAdminRolesMembers(java.lang.String adminRoleName)
                                                       throws InvalidArgumentException,
                                                              PolicyStoreException

Returns the list of principalEntries granted to this administration role.

Parameters:

adminRoleName - The name of the administration role.

Returns:

the list of principals granted to this administration role.

Throws:

InvalidArgumentException

PolicyStoreException - If there is back end error occur in the policy store.

grant

void grant(AdminRoleEntry adminRole,
           java.util.List<AdminResourceActionEntry> adminResourceActions)
           throws InvalidArgumentException,
                  PolicyStoreException

Grant Administrative resource actions to an admin role.

Parameters:

adminRole -

adminResourceActions -

Throws:

PolicyObjectNotFoundException - if the adminRole cannot be found.

PolicyStoreException - if an error occurred during this grant operation.

InvalidArgumentException

revoke

void revoke(AdminRoleEntry adminRole,
            java.util.List<AdminResourceActionEntry> adminResourceActions)
            throws InvalidArgumentException,
                   PolicyStoreException

Revoke Administrative resource actions from an admin role.

Parameters:

adminRole -

adminResourceActions -

Throws:

PolicyObjectNotFoundException - if the adminRole cannot be found.

PolicyStoreException - if an error occurred during this grant operation.

InvalidArgumentException

getGrantsForAdminRole

java.util.List<AdminResourceActionEntry> getGrantsForAdminRole(AdminRoleEntry adminRole)
                                                               throws InvalidArgumentException,
                                                                      PolicyStoreException

Get all the grants of the administration role.

Parameters:

adminRole - The administration role to get grants.

Returns:

The list of AdminResourceActionEntry that are granted to this role. Empty list if there is no grants.

Throws:

PolicyObjectNotFoundException - If the specified administration role does not exist, will throw PolicyObjectNotFoundException

InvalidArgumentException

PolicyStoreException

getGrantedAdminResources

java.util.Set<AdminResourceActionEntry> getGrantedAdminResources()
                                                                 throws PolicyStoreException

Gets all granted AdminResourceActionEntry for the current administrator

Returns:

set of AdminResourceActionEntry at the current level (System, Application or Specific PolicyDomain).

Throws:

PolicyStoreException - if an error occurred during this operation

Skip navigation links