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

EntryReference	createRoleCategory(RoleCategoryEntry entry) Validates and creates the given role category in the backend data store.
void	deleteRoleCategory(EntryReference rcRef) 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(EntryReference rcRef, javax.naming.directory.ModificationItem[] modItems) 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

EntryReference createRoleCategory(RoleCategoryEntry entry)
                                  throws InvalidArgumentException,
                                         PolicyObjectAlreadyExistsException,
                                         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:

entry - Role category to be created. Cannot be null.

Returns:

Reference to the newly 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(EntryReference rcRef,
                        javax.naming.directory.ModificationItem[] modItems)
                        throws InvalidArgumentException,
                               PolicyStoreOperationNotAllowedException,
                               PolicyStoreException

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

Parameters:

rcRef - Reference to the role category that is to be modified. Cannot be null.

modItems - Modifications to be made to the role category. Can be null.

Throws:

InvalidArgumentException - if 1. rcRef is null OR 2. points to invalid data OR 3. if an invalid property name is given for any modItem OR 4. if more than one value is given for description/ display name OR 5. modop is not REMOVE and no value is given for description/ display name OR 6. description/ display name is not of type String OR

PolicyStoreOperationNotAllowedException - if trying to change name of the role category.

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

deleteRoleCategory

void deleteRoleCategory(EntryReference rcRef)
                        throws PolicyObjectNotFoundException,
                               PolicyStoreOperationNotAllowedException,
                               PolicyStoreException

Deletes the role category.

Parameters:

rcRef - Reference to role category.

Throws:

InvalidArgumentException - if rcRef is null OR points to invalid data.

PolicyStoreOperationNotAllowedException - if any roles belong to this category. You must move those roles to different category/ remove their category before deleting a category.

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

PolicyObjectNotFoundException

Skip navigation links