Skip navigation links

oracle.iam.policyengine.vo
Interface PolicyTypeSchema

public interface PolicyTypeSchema

This interface defines set of methods that need to be defined if a new policy type schema needs to be implemented. This interface tends to track the PolicyTypeManager interface.

Method Summary

java.util.List	getAllowedPathElements(java.util.List pathElements, java.util.Map controls, PolicyType pt) Return a list of path elements associated with the specified list of path elements.
java.util.List	getAllowedPathElementValues(java.util.List pathElements, SearchCriteria searchCriteria, java.util.Map controls, PolicyType pt) Return a list of path elements associated with the specified list of path elements.
java.util.List	getAllowedReturnPathElements(java.util.List pathElements, java.util.Map controls, PolicyType pt) Return a list of path elements associated with the specified list of path elements.
java.util.List	getAllowedReturnPathElements(PolicyType pt) Return a list of path elements associated with the specified policy type identifier.
java.util.List	getAllowedReturnPathElementValues(java.util.List pathElements, SearchCriteria searchCriteria, java.util.Map controls, PolicyType pt) Return a list of path elements associated with the specified list of path elements.
java.util.List	getAllowedTopPathElements(PolicyType pt) Return a list of path elements associated with the specified policy type identifier.
java.util.List	getBasePathElements(java.lang.String entityType, java.util.List pathElements, java.util.Map controls, PolicyType pt) Return list of path elements built from the specified entity type, path element list, controls and policy type.
java.util.List	getPathElements(PolicyType pt, java.lang.String path) Return a list of path elements associated with the specified policy type and built from the specified path string.
java.util.List	getReturnPathElements(PolicyType pt, java.lang.String path) Return a list of path elements associated with the specified policy type and built from the specified path string.
java.util.List	postProcessAllowedPathElementValues(java.util.List pathElements, java.util.List bashElements, SearchCriteria searchCriteria, java.util.Map controls, PolicyType pt) This method can be used to process the allowed path element values list after it is built.
java.util.List	postProcessAllowedReturnPathElementValues(java.util.List pathElements, java.util.List baseElements, SearchCriteria searchCriteria, java.util.Map controls, PolicyType pt) This method can be used to process the allowed return values path element values list after it is built.
java.util.List	postProcessPathElements(java.lang.String entityType, java.util.List baseElements, java.util.List pathElements, java.util.Map controls, PolicyType pt) This method can be used to process the base element list after it is built.

Method Detail

getAllowedTopPathElements

java.util.List getAllowedTopPathElements(PolicyType pt)
                                         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 specified policy type.

Parameters:

pt - policy type

Returns:

list of path elements for the specified policy type identifier

Throws:

PolicyTypeManagerException

getAllowedReturnPathElements

java.util.List getAllowedReturnPathElements(PolicyType pt)
                                            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 specified policy type.

Parameters:

pt - policy type

Returns:

list of path elements for the specified policy type identifier

Throws:

PolicyTypeManagerException

getAllowedPathElements

java.util.List getAllowedPathElements(java.util.List pathElements,
                                      java.util.Map controls,
                                      PolicyType pt)
                                      throws PolicyTypeManagerException

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

Parameters:

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

controls - map that can be used in processing

pt - policy type that can be used in processing

Returns:

new list of path elements

Throws:

PolicyTypeManagerException

getAllowedReturnPathElements

java.util.List getAllowedReturnPathElements(java.util.List pathElements,
                                            java.util.Map controls,
                                            PolicyType pt)
                                            throws PolicyTypeManagerException

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

Parameters:

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

controls - map that can be used in processing

pt - policy type that can be used in processing

Returns:

new list of path elements

Throws:

PolicyTypeManagerException

getAllowedPathElementValues

java.util.List getAllowedPathElementValues(java.util.List pathElements,
                                           SearchCriteria searchCriteria,
                                           java.util.Map controls,
                                           PolicyType pt)
                                           throws PolicyTypeManagerException

Return a list of path elements associated with the specified list of path elements. 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:

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

pt - policy type that can be used in processing

Returns:

list of path elements

Throws:

PolicyTypeManagerException

getAllowedReturnPathElementValues

java.util.List getAllowedReturnPathElementValues(java.util.List pathElements,
                                                 SearchCriteria searchCriteria,
                                                 java.util.Map controls,
                                                 PolicyType pt)
                                                 throws PolicyTypeManagerException

Return a list of path elements associated with the specified list of path elements. 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:

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

pt - policy type that can be used in processing

Returns:

list of path elements

Throws:

PolicyTypeManagerException

getPathElements

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

Return a list of path elements associated with the specified policy type and built from the specified path string. This method uses the AllowedTopElements PathElements from he policy type.

Parameters:

pt - policy type

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(PolicyType pt,
                                     java.lang.String path)
                                     throws PolicyTypeManagerException

Return a list of path elements associated with the specified policy type and built from the specified path string. This method uses the AllowedReturnAttributes Path Elements of the policy type.

Parameters:

pt - policy type

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

Returns:

list of path elements

Throws:

PolicyTypeManagerException

getBasePathElements

java.util.List getBasePathElements(java.lang.String entityType,
                                   java.util.List pathElements,
                                   java.util.Map controls,
                                   PolicyType pt)
                                   throws PolicyTypeManagerException

Return list of path elements built from the specified entity type, path element list, controls and policy type.

Parameters:

entityType - entity type

pathElements - list of path elemenets

controls - map of objects to control building the list

pt - policy type

Returns:

list of path elements

Throws:

PolicyTypeManagerException

postProcessPathElements

java.util.List postProcessPathElements(java.lang.String entityType,
                                       java.util.List baseElements,
                                       java.util.List pathElements,
                                       java.util.Map controls,
                                       PolicyType pt)
                                       throws PolicyTypeManagerException

This method can be used to process the base element list after it is built. The specified entity type, base element list, the current path element list, map of controls and policy type can be used in the post processing.

Parameters:

entityType - entity type

baseElements - list of path elements returned from getBasePathElements method

pathElements - list of current path elements

controls - map of control objects

pt - policy type

Returns:

list of path elements

Throws:

PolicyTypeManagerException

postProcessAllowedPathElementValues

java.util.List postProcessAllowedPathElementValues(java.util.List pathElements,
                                                   java.util.List bashElements,
                                                   SearchCriteria searchCriteria,
                                                   java.util.Map controls,
                                                   PolicyType pt)
                                                   throws PolicyTypeManagerException

This method can be used to process the allowed path element values list after it is built. The specified entity type, the current path element list, map of controls and policy type can be used in the post processing.

Parameters:

entityType - entity type

pathElements - list of current path elements

controls - map of control objects

pt - policy type

Returns:

list of path elements

Throws:

PolicyTypeManagerException

postProcessAllowedReturnPathElementValues

java.util.List postProcessAllowedReturnPathElementValues(java.util.List pathElements,
                                                         java.util.List baseElements,
                                                         SearchCriteria searchCriteria,
                                                         java.util.Map controls,
                                                         PolicyType pt)
                                                         throws PolicyTypeManagerException

This method can be used to process the allowed return values path element values list after it is built. The specified entity type, the current path element list, map of controls and policy type can be used in the post processing.

Parameters:

entityType - entity type

pathElements - list of current path elements

controls - map of control objects

pt - policy type

Returns:

list of path elements

Throws:

PolicyTypeManagerException

Skip navigation links