Skip navigation links

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

All Superinterfaces:

EntityManager

public interface RoleCategoryManager

extends EntityManager

An entity manager that creates, reads, updates and modifies a RoleCategory

Method Summary

RoleCategoryEntry	createRoleCategory(java.lang.String name, java.lang.String displayName, java.lang.String description) Validates and creates the given role category in the backend data store.
void	deleteRoleCategory(java.lang.String name) Deletes the role category.
java.util.List<RoleCategoryEntry>	getRoleCategories(RoleCategorySearchQuery query) Gets all the role categories satisfying the query in the current scope (system/ application).
RoleCategoryEntry	getRoleCategory(java.lang.String name) Get the role category entry given name of the role category.
void	modifyRoleCategory(RoleCategoryEntry entry) Modifies the role category referred by rcRef.

Methods inherited from interface oracle.security.jps.service.policystore.entitymanager.EntityManager

resolveReference

Method Detail

getRoleCategories

java.util.List<RoleCategoryEntry> getRoleCategories(RoleCategorySearchQuery query)
                                                    throws PolicyStoreException

Gets all the role categories satisfying the query in the current scope (system/ application). To get all role categories defined in the scope, set matcher to ANY and value to match to null.

Parameters:

query - Query to be applied. Cannot be null.

Returns:

List of role category entries. If no role categories match the query, returns an empty list.

Throws:

PolicyStoreException - in case of any errors in interaction with backend data store.

InvalidArgumentException - if query is null.

getRoleCategory

RoleCategoryEntry getRoleCategory(java.lang.String name)
                                  throws PolicyObjectNotFoundException,
                                         PolicyStoreException

Get the role category entry given name of the role category.

Parameters:

name - Name of the role category to be fetched. Returns null if name is null.

Returns:

Role category entry for the given role category.

Throws:

PolicyObjectNotFoundException - if object does not exist

PolicyStoreException - in case of any errors in interaction with backend data store.

createRoleCategory

RoleCategoryEntry createRoleCategory(java.lang.String name,
                                     java.lang.String displayName,
                                     java.lang.String description)
                                     throws PolicyStoreException

Validates and creates the given role category in the backend data store. Name of the role category is expected to be unique in the scope of an application.

Parameters:

name - of the the Role category to be created. Cannot be null.

displayName - of the Role category to be created. It is optional.

description - of the Role category to be created. It is optional.

Returns:

thenewly created role category.

Throws:

InvalidArgumentException - if entry is null.

PolicyObjectAlreadyExistsException - if a role category with the same name already exists.

PolicyStoreException - in case of any errors in interaction with backend data store.

modifyRoleCategory

void modifyRoleCategory(RoleCategoryEntry entry)
                        throws PolicyStoreException

Modifies the role category referred by rcRef. If modItems is null, does nothing.

Parameters:

entry - to be modified

Throws:

PolicyStoreException - in case of any errors in interaction with backend data store.

deleteRoleCategory

void deleteRoleCategory(java.lang.String name)
                        throws PolicyObjectNotFoundException,
                               PolicyStoreException

Deletes the role category.

Parameters:

name - of the role category to delete.

Throws:

InvalidArgumentException - if name is null.

PolicyObjectNotFoundException - if the role category cannot be found.

PolicyStoreException - if an error occurs while deleting the role category.

Skip navigation links