Skip navigation links

oracle.iam.identity.rolemgmt.api
Interface RoleCategoryManager

public interface RoleCategoryManager

The RoleCategoryManager API exposes the methods to manage role categories.

Method Summary

java.util.List	browse(java.util.Set retAttrs, java.util.Map configParams) Returns list of all the role categories available in the system.
RoleManagerResult	create(RoleCategory category) This method creates a role category in the backend datastore.
RoleManagerResult	delete(java.lang.String roleCategoryKey) Delete the role category.
RoleManagerResult	delete(java.lang.String attributeName, java.lang.Object attributeValue) This method deletes a role category based on the search criteria attributeName=attributeValue.
RoleCategory	getDetails(java.lang.String attributeName, java.lang.Object attributeValue, java.util.Set retAttrs) This method return the role category details for a role category based on the search criteria attributeName=attributeValue.
RoleCategory	getDetails(java.lang.String roleCategoryKey, java.util.Set retAttrs) Returns the profile details of the specified role category.
RoleManagerResult	modify(RoleCategory category) This method updates the existing role category with the values specified.
RoleManagerResult	modify(java.lang.String attributeName, java.lang.Object attributeValue, RoleCategory category) This method modifies the role category details for a role category based on the search criteria attributeName=attributeValue.
java.util.List	search(SearchCriteria criteria, java.util.Set retAttrs, java.util.Map configParams) Searches for role categories matching the specified SearchCriteria.

Method Detail

create

RoleManagerResult create(RoleCategory category)
                         throws ValidationFailedException,
                                AccessDeniedException,
                                RoleCategoryAlreadyExistsException,
                                RoleCategoryCreateException

This method creates a role category in the backend datastore.

Parameters:

category - The attributes and values for this role category. The id field of the category should be null, please see RoleCategory.RoleCategory(java.util.HashMap)

Returns:

RoleManagerResult containing the entity id of the role category created in the backend datastore.

Throws:

ValidationFailedException - if the validation during the orchestration process fails.

AccessDeniedException - if the logged-in user does not have the required authorization.

RoleCategoryAlreadyExistsException - if the role category already exists.

RoleCategoryCreateException - if the orchestration fails for the create operation.

modify

RoleManagerResult modify(RoleCategory category)
                         throws ValidationFailedException,
                                AccessDeniedException,
                                RoleCategoryModifyException,
                                NoSuchRoleCategoryException

This method updates the existing role category with the values specified.

Parameters:

category - The attributes and values to update the role category. A non null value is must for the role category to identify the entity to be modified, Please see RoleCategory.RoleCategory(java.lang.String, java.util.HashMap).

Returns:

RoleManagerResult containing the entity id of the role category updated in the backend datastore.

Throws:

ValidationFailedException - if the validation during the orchestration process fails.

AccessDeniedException - if the logged-in user does not have the required authorization.

RoleCategoryModifyException - if the orchestration fails for modify operation.

NoSuchRoleCategoryException - if the role category with given id is not found.

delete

RoleManagerResult delete(java.lang.String roleCategoryKey)
                         throws ValidationFailedException,
                                AccessDeniedException,
                                RoleCategoryDeleteException,
                                NoSuchRoleCategoryException

Delete the role category. This is a hard delete operation and will remove the role category from the backend datastore.

Parameters:

roleCategoryKey - The id of the role category to be deleted.

Returns:

RoleManagerResult containing the entity id of the role category deleted in the backend datastore.

Throws:

ValidationFailedException - if the validation during the orchestration process fails.

AccessDeniedException - if the logged-in user does not have the required authorization.

RoleCategoryDeleteException - if the orchestration fails for delete operation.

NoSuchRoleCategoryException - if the role category with given id is not found.

getDetails

RoleCategory getDetails(java.lang.String roleCategoryKey,
                        java.util.Set retAttrs)
                        throws AccessDeniedException,
                               NoSuchRoleCategoryException,
                               RoleCategoryLookupException

Returns the profile details of the specified role category.

Parameters:

roleCategoryKey - The id of the role category whose details are required.

retAttrs - The set of attributes which are to be returned for each role category.

Returns:

If the role category exists then an Identity object containing all the retAttrs of the role category are returned otherwise NoSuchRoleCategoryException exception is thrown.

Throws:

AccessDeniedException - if the logged-in user does not have the required authorization.

NoSuchRoleCategoryException - if the role category with given id is not found.

RoleCategoryLookupException - if there is an exception while doing the search.

search

java.util.List search(SearchCriteria criteria,
                      java.util.Set retAttrs,
                      java.util.Map configParams)
                      throws AccessDeniedException,
                             RoleCategorySearchException

Searches for role categories matching the specified SearchCriteria.

Parameters:

criteria - The search criteria based on which entries will be retrieved from the backend. The SearchCriteria Operators supported are AND, OR, NOT, GREATER_THAN, GREATER_EQUAL, LESS_THAN, LESS_EQUAL, EQUAL, NOT_EQUAL, CONTAINS.

retAttrs - The set of attributes which are to be returned for each role category.

configParams - Parameters to further configure the search operation. There are four configuration parameters. STARTROW, ENDROW, SORTEDBY and SORTORDER.

The STARTROW and ENDROW search configuration parameters indicates which subset of the complete search result is to be fetched.

The SORTEDBY search configuration parameter indicates the attribute on which search result is to be sorted. This parameter is optional and is set to Role Category Name by default.

The SORTORDER search configuration parameter indicates the order of sorting. There are two possible values for this parameter. To sort the result in ascending order use SortOrder.ASCENDING and to sort the result in descending order use SortOrder.DESCENDING. This parameter is optional and is set to SortOrder.ASCENDING by default.

Returns:

the list of role categories which matched the search criteria. This list is filtered based on the attribute and entity permissions of the logged-in user.

Throws:

AccessDeniedException - if the logged-in user does not have the required authorization.

RoleCategorySearchException - if there is an exception while doing the search

browse

java.util.List browse(java.util.Set retAttrs,
                      java.util.Map configParams)
                      throws AccessDeniedException,
                             RoleCategoryBrowseException

Returns list of all the role categories available in the system.

Parameters:

retAttrs - The set of attributes which are to be returned for each RoleCategory.

configParams - Parameters to further configure the browse operation. There are four configuration parameters. STARTROW, ENDROW, SORTEDBY and SORTORDER.

The STARTROW and ENDROW search configuration parameters indicates which subset of the complete search result is to be fetched.

The SORTEDBY search configuration parameter indicates the attribute on which search result is to be sorted. This parameter is optional and is set to Role Category Name by default.

The SORTORDER search configuration parameter indicates the order of sorting. There are two possible values for this parameter. To sort the result in ascending order use SortOrder.ASCENDING and to sort the result in descending order use SortOrder.DESCENDING. This parameter is optional and is set to SortOrder.ASCENDING by default.

Returns:

RoleCategory Entities

Throws:

AccessDeniedException - If the logged-in user does not have the required authorization.

RoleCategoryBrowseException - If operation fails.

getDetails

RoleCategory getDetails(java.lang.String attributeName,
                        java.lang.Object attributeValue,
                        java.util.Set retAttrs)
                        throws SearchKeyNotUniqueException,
                               AccessDeniedException,
                               NoSuchRoleCategoryException,
                               RoleCategoryLookupException

This method return the role category details for a role category based on the search criteria attributeName=attributeValue.

Parameters:

attributeName - The attribute name for the search criteria.

attributeValue - The attribute value for the search criteria.

retAttrs - The attributes to be returned for the role category.

Returns:

- The role category that matches the search criteria.

Throws:

SearchKeyNotUniqueException - if there is more than one role category of the search criteria.

AccessDeniedException - if the logged-in user does not have the required authorization.

RoleCategoryLookupException - if there is an exception while doing the search.

NoSuchRoleCategoryException - if the role category with given search criteria is not found.

modify

RoleManagerResult modify(java.lang.String attributeName,
                         java.lang.Object attributeValue,
                         RoleCategory category)
                         throws ValidationFailedException,
                                AccessDeniedException,
                                RoleCategoryModifyException,
                                NoSuchRoleCategoryException,
                                SearchKeyNotUniqueException,
                                RoleCategoryLookupException

This method modifies the role category details for a role category based on the search criteria attributeName=attributeValue.

Parameters:

attributeName - The attribute name for the search criteria.

attributeValue - The attribute value for the search criteria.

category - The attributes and values to update the role category with.

Returns:

RoleManagerResult containing the entity id of the role category updated in backend datastore.

Throws:

ValidationFailedException - if the validation during the orchestration process fails.

AccessDeniedException - if the logged-in user does not have the required authorization.

RoleCategoryModifyException - if the orchestration fails for modify operation.

NoSuchRoleCategoryException - if the role category with given search criteria is not found.

SearchKeyNotUniqueException - if there is more than one role category for the search criteria.

RoleCategoryLookupException - if there is an exception while doing the search.

delete

RoleManagerResult delete(java.lang.String attributeName,
                         java.lang.Object attributeValue)
                         throws SearchKeyNotUniqueException,
                                ValidationFailedException,
                                AccessDeniedException,
                                RoleCategoryDeleteException,
                                NoSuchRoleCategoryException,
                                RoleCategoryLookupException

This method deletes a role category based on the search criteria attributeName=attributeValue.

Parameters:

attributeName - The attribute name for the search criteria.

attributeValue - The attribute value for the search criteria.

Returns:

RoleManagerResult containing the entity id of the role category deleted in the backend datastore.

Throws:

SearchKeyNotUniqueException - if there is more than one role category for the search criteria.

ValidationFailedException - if the validation during the orchestration process fails.

AccessDeniedException - if the logged-in user does not have the required authorization.

RoleCategoryDeleteException - if the orchestration fails for delete operation.

NoSuchRoleCategoryException - if the role category with given search criteria is not found.

RoleCategoryLookupException - if there is an exception while doing the search.

Skip navigation links