Skip navigation links

oracle.iam.policyengine.api
Interface PolicyTypeManager

public interface PolicyTypeManager

This class is responsible for:

• search operations on policy types
• path element search operations used by the UI-

Method Summary

java.util.List	getAllowedAttributePathElements(java.lang.String policyTypeId) Return a list of path elements associated with the specified policy type identifier.
java.util.List	getAllowedAttributePathElements(java.lang.String policyTypeId, java.util.List pathElements, java.util.Map controls) Return a list of path elements associated with the specified policy type identifier.
java.util.List	getAllowedAttributeValuePathElements(java.lang.String policyTypeId, java.util.List pathElements, SearchCriteria searchCriteria, java.util.Map controls) Return a list of path elements associated with the specified policy type identifier.
java.util.List	getAllowedReturnAttributePathElements(java.lang.String policyTypeId) Return a list of path elements associated with the specified policy type identifier.
java.util.List	getAllowedReturnAttributePathElements(java.lang.String policyTypeId, java.util.List pathElements, java.util.Map controls) Return a list of path elements associated with the specified policy type identifier.
java.util.List	getAllowedReturnAttributeValuePathElements(java.lang.String policyTypeId, java.util.List pathElements, SearchCriteria searchCriteria, java.util.Map controls) Return a list of path elements associated with the specified policy type identifier.
PolicyType	getDetails(java.lang.String entityId, java.util.Set retAttrs) Returns details of a policy type matching the specified entity identifier.
java.util.List	getPathElements(java.lang.String policyTypeId, java.lang.String path) Return a list of path elements associated with the specified policy type identifier and built from the specified path string.
java.util.List	getReturnPathElements(java.lang.String policyTypeId, java.lang.String path) Return a list of path elements associated with the specified policy type identifier and built from the specified path string.
java.util.List	search(SearchCriteria sc, java.util.Set retAttrs, java.util.Map config) Searches all policy types that match the specified search criteria.

Method Detail

getDetails

PolicyType getDetails(java.lang.String entityId,
                      java.util.Set retAttrs)
                      throws ValidationFailedException,
                             oracle.iam.platform.entitymgr.NoSuchEntityException,
                             AccessDeniedException,
                             EntitySearchException

Returns details of a policy type matching the specified entity identifier.

Parameters:

entityId - policy type entity identifier

retAttrs - set of attributes in policy type to return

Returns:

policy type matching entity identifier

Throws:

ValidationFailedException

oracle.iam.platform.entitymgr.NoSuchEntityException

AccessDeniedException

EntitySearchException

search

java.util.List search(SearchCriteria sc,
                      java.util.Set retAttrs,
                      java.util.Map config)
                      throws EntitySearchException,
                             AccessDeniedException,
                             oracle.iam.platform.entitymgr.NoSuchEntityException,
                             ValidationFailedException

Searches all policy types that match the specified search criteria.

Parameters:

sc - search criteria to use in search

retAttrs - set of attributes in policy type to return

config - configuration options such as pagination and sorting

Returns:

list of policy types matching search criteria

Throws:

EntitySearchException

AccessDeniedException

oracle.iam.platform.entitymgr.NoSuchEntityException

ValidationFailedException

getAllowedAttributePathElements

java.util.List getAllowedAttributePathElements(java.lang.String policyTypeId)
                                               throws PolicyTypeManagerException

Return a list of path elements associated with the specified policy type identifier. This method is used to get the top elements for the policy type.

Parameters:

policyTypeId - policy type identifier

Returns:

list of path elements for the specified policy type identifier

Throws:

PolicyTypeManagerException

getAllowedReturnAttributePathElements

java.util.List getAllowedReturnAttributePathElements(java.lang.String policyTypeId)
                                                     throws PolicyTypeManagerException

Return a list of path elements associated with the specified policy type identifier. This method is used to get the top elements for the policy type.

Parameters:

policyTypeId - policy type identifier

Returns:

list of path elements for the specified policy type identifier

Throws:

PolicyTypeManagerException

getAllowedAttributePathElements

java.util.List getAllowedAttributePathElements(java.lang.String policyTypeId,
                                               java.util.List pathElements,
                                               java.util.Map controls)
                                               throws PolicyTypeManagerException

Return a list of path elements associated with the specified policy type identifier. The specified list of path elements is the path elements currently being processed and can be used to calculate the new list being returned.

Parameters:

policyTypeId - policy type identifier

pathElements - list of path elements for the specified policy type identifier

controls - map that can be used in processing

Returns:

new list of path elements

Throws:

PolicyTypeManagerException

getAllowedReturnAttributePathElements

java.util.List getAllowedReturnAttributePathElements(java.lang.String policyTypeId,
                                                     java.util.List pathElements,
                                                     java.util.Map controls)
                                                     throws PolicyTypeManagerException

Return a list of path elements associated with the specified policy type identifier. The specified list of path elements is the path elements currently being processed and can be used to calculate the new list being returned.

Parameters:

policyTypeId - policy type identifier

pathElements - list of path elements for the specified policy type identifier

controls - map that can be used in processing

Returns:

new list of path elements

Throws:

PolicyTypeManagerException

getAllowedAttributeValuePathElements

java.util.List getAllowedAttributeValuePathElements(java.lang.String policyTypeId,
                                                    java.util.List pathElements,
                                                    SearchCriteria searchCriteria,
                                                    java.util.Map controls)
                                                    throws PolicyTypeManagerException

Return a list of path elements associated with the specified policy type identifier. The specified list of path elements is the path elements currently being processed and can be used to calculate the new list being returned. The specified search criteria can be used to customize the path element list to be returned. The specified control map can be used in the processing also.

Parameters:

policyTypeId - policy type identifier

pathElements - list of path elements for the specified policy type identifier

searchCriteria - searchCriteria search criteria to customize the search

controls - controls map that can be used in processing

Returns:

list of path elements

Throws:

PolicyTypeManagerException

getAllowedReturnAttributeValuePathElements

java.util.List getAllowedReturnAttributeValuePathElements(java.lang.String policyTypeId,
                                                          java.util.List pathElements,
                                                          SearchCriteria searchCriteria,
                                                          java.util.Map controls)
                                                          throws PolicyTypeManagerException

Return a list of path elements associated with the specified policy type identifier. The specified list of path elements is the path elements currently being processed and can be used to calculate the new list being returned. The specified search criteria can be used to customize the path element list to be returned. The specified control map can be used in the processing also.

Parameters:

policyTypeId - policy type identifier

pathElements - list of path elements for the specified policy type identifier

searchCriteria - search criteria to customize the search

controls - map that can be used in processing

Returns:

list of path elements

Throws:

PolicyTypeManagerException

getPathElements

java.util.List getPathElements(java.lang.String policyTypeId,
                               java.lang.String path)
                               throws PolicyTypeManagerException

Return a list of path elements associated with the specified policy type identifier and built from the specified path string.

Parameters:

policyTypeId - policy type identifier

path - string representing a path expression that can be parsed into a list of path elements

Returns:

list of path elements

Throws:

PolicyTypeManagerException

getReturnPathElements

java.util.List getReturnPathElements(java.lang.String policyTypeId,
                                     java.lang.String path)
                                     throws PolicyTypeManagerException

Return a list of path elements associated with the specified policy type identifier and built from the specified path string. The methods is used to process return attribute path elements.

Parameters:

policyTypeId - policy type identifier

path - string representing a path expression that can be parsed into a list of path elements

Returns:

list of path elements

Throws:

PolicyTypeManagerException

Skip navigation links