PolicyManager (Oracle Fusion Middleware Java API Reference for Oracle Identity Manager)

```
public interface PolicyManager
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`PolicyManagerResult`	`assignRuleToPolicy(java.lang.String policyId, java.lang.String ruleId, java.lang.Long index)` Assign the rule specified by the rule entity id to the policy specified by the policy entity id.
`PolicyManagerResult`	`create(Policy entity)` Create a policy using specified policy entity attributes.
`PolicyManagerResult`	`delete(java.lang.String entityId)` Delete the policy and all rule assignment relationships, i.e.
`PolicyManagerResult`	`disable(java.lang.String policyId)` Disable the policy associated with the specified policy entity id.
`PolicyManagerResult`	`enable(java.lang.String policyId)` Enable the policy associated with the specified policy entity id.
`Policy`	`getDetails(java.lang.String entityId, java.util.Set retAttrs)` Retrieve the attributes of the policy specified by the entity id.
`java.util.List`	`getRulesAssignedToPolicy(java.lang.String policyId)` Return rules assigned to the policy specified by the policy entity id.
`PolicyManagerResult`	`lock(java.lang.String policyId)` Lock the policy associated with the specified policy entity id.
`PolicyManagerResult`	`modify(Policy entity)` Modify the policy attributes specified in the policy entity.
`PolicyManagerResult`	`reorderPolicyRules(java.lang.String policyId, java.util.Map orderedPolicyRules)` Reorder the rules of the policy associated with specified policy entity id.
`PolicyManagerResult`	`replacePolicyRules(java.lang.String policyId, java.util.List ruleIds)` Replace all of the rules of the policy associated with the specified policy entity id, with the list of rule entity ids.
`java.util.List`	`search(SearchCriteria sc, java.util.Set retAttrs, java.util.Map config)` Search the policies in the system that match the specified search criteria.
`PolicyManagerResult`	`unAssignRuleFromPolicy(java.lang.String policyId, java.lang.String ruleId)` Unassign the rule specified by the rule entity id from the policy specified by the policy entity id.
`PolicyManagerResult`	`unlock(java.lang.String policyId)` Unlock the policy associated with the specified policy entity id.

Method Detail

create

PolicyManagerResult create(Policy entity)
                    throws ValidationFailedException,
                           EntityAlreadyExistsException,
                           EntityCreateException,
                           AccessDeniedException

Create a policy using specified policy entity attributes.

Parameters:: entity - policy entity
Returns:: PolicyManagerResult result that contains entity id of the newly created policy
Throws:: ValidationFailedException; EntityAlreadyExistsException; EntityCreateException; AccessDeniedException

modify

PolicyManagerResult modify(Policy entity)
                    throws ValidationFailedException,
                           EntityModifyException,
                           oracle.iam.platform.entitymgr.NoSuchEntityException,
                           AccessDeniedException,
                           EntityLockedException

Modify the policy attributes specified in the policy entity. The policy entity must constain an policy entity id.

Parameters:: entity - the policy entity
Returns:: PolicyManagerResult result of the policy modify
Throws:: ValidationFailedException; EntityModifyException; oracle.iam.platform.entitymgr.NoSuchEntityException; AccessDeniedException; EntityLockedException

delete
```
PolicyManagerResult delete(java.lang.String entityId)
                    throws EntityDeleteException,
                           oracle.iam.platform.entitymgr.NoSuchEntityException,
                           AccessDeniedException,
                           ValidationFailedException,
                           EntityLockedException
```
Delete the policy and all rule assignment relationships, i.e. remove rules from this policy.

Parameters:

entityId - policy entity Id

Returns:

PolicyManagerResult result of the policy delete

Throws:

EntityDeleteException, - NoSuchEntityException, AccessDeniedException, ValidationFailedException, EntityLockedException

EntityDeleteException

oracle.iam.platform.entitymgr.NoSuchEntityException

AccessDeniedException

ValidationFailedException

EntityLockedException

getDetails
```
Policy getDetails(java.lang.String entityId,
                  java.util.Set retAttrs)
           throws ValidationFailedException,
                  oracle.iam.platform.entitymgr.NoSuchEntityException,
                  AccessDeniedException,
                  EntitySearchException
```
Retrieve the attributes of the policy specified by the entity id. The retAttrs set specifies the attribute set to be returned.

Parameters:

entityId - the policy entity id

retAttrs - the attributes of the policy to be returned

Returns:

Policy entity associated with the entity id

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
```
Search the policies in the system that match the specified search criteria. The retAttrs set specifies the attribute set to be returned. The config map can used to specify parameters such as pagination and sorting.

Parameters:

sc - the search criteria

retAttrs - set of attributes of the policy to return

config - map of configuration parameters

Returns:

list of policy entities matching the search criteria

Throws:

EntitySearchException

AccessDeniedException

oracle.iam.platform.entitymgr.NoSuchEntityException

ValidationFailedException

lock

PolicyManagerResult lock(java.lang.String policyId)
                  throws ValidationFailedException,
                         oracle.iam.platform.entitymgr.NoSuchEntityException,
                         AccessDeniedException,
                         EntityLockException

Lock the policy associated with the specified policy entity id.

Parameters:: policyId - the policy entity id to lock
Returns:: PolicyManagerResult result of policy lock
Throws:: ValidationFailedException; oracle.iam.platform.entitymgr.NoSuchEntityException; AccessDeniedException; EntityLockException

unlock

PolicyManagerResult unlock(java.lang.String policyId)
                    throws ValidationFailedException,
                           oracle.iam.platform.entitymgr.NoSuchEntityException,
                           AccessDeniedException,
                           EntityLockException

Unlock the policy associated with the specified policy entity id.

Parameters:: policyId - the policy entity id to unlock
Returns:: PolicyManagerResult result of policy unlock
Throws:: ValidationFailedException; oracle.iam.platform.entitymgr.NoSuchEntityException; AccessDeniedException; EntityLockException

enable

PolicyManagerResult enable(java.lang.String policyId)
                    throws ValidationFailedException,
                           EntityDisableException,
                           oracle.iam.platform.entitymgr.NoSuchEntityException,
                           AccessDeniedException,
                           EntitySearchException,
                           EntityModifyException,
                           EntityLockedException

Enable the policy associated with the specified policy entity id.

Parameters:: policyId - the policy entity id to enable
Returns:: PolicyManagerResult result of policy enable
Throws:: ValidationFailedException; EntityDisableException; oracle.iam.platform.entitymgr.NoSuchEntityException; AccessDeniedException; EntitySearchException; EntityModifyException; EntityLockedException

disable

PolicyManagerResult disable(java.lang.String policyId)
                     throws ValidationFailedException,
                            EntityDisableException,
                            oracle.iam.platform.entitymgr.NoSuchEntityException,
                            AccessDeniedException,
                            EntitySearchException,
                            EntityModifyException,
                            EntityLockedException

Disable the policy associated with the specified policy entity id.

Parameters:: policyId - the policy entity id to disable
Returns:: PolicyManagerResult result of policy disable
Throws:: ValidationFailedException; EntityDisableException; oracle.iam.platform.entitymgr.NoSuchEntityException; AccessDeniedException; EntitySearchException; EntityModifyException; EntityLockedException

assignRuleToPolicy

PolicyManagerResult assignRuleToPolicy(java.lang.String policyId,
                                       java.lang.String ruleId,
                                       java.lang.Long index)
                                throws oracle.iam.platform.entitymgr.NoSuchEntityException,
                                       PolicyManagerException,
                                       AccessDeniedException,
                                       ValidationFailedException,
                                       EntityModifyException,
                                       EntitySearchException,
                                       EntityLockedException

Assign the rule specified by the rule entity id to the policy specified by the policy entity id. The index parameter specifies the position in the rule set to insert the rule.

Parameters:: policyId - the policy entity id; ruleId - the rule entity id; index - specifies the position in the rule set to insert the rule
Returns:: PolicyManagerResult result of the polivy rule assigment
Throws:: oracle.iam.platform.entitymgr.NoSuchEntityException; PolicyManagerException; AccessDeniedException; ValidationFailedException; EntityModifyException; EntitySearchException; EntityLockedException

unAssignRuleFromPolicy

PolicyManagerResult unAssignRuleFromPolicy(java.lang.String policyId,
                                           java.lang.String ruleId)
                                    throws oracle.iam.platform.entitymgr.NoSuchEntityException,
                                           PolicyManagerException,
                                           AccessDeniedException,
                                           EntityModifyException,
                                           ValidationFailedException,
                                           EntitySearchException,
                                           EntityLockedException

Unassign the rule specified by the rule entity id from the policy specified by the policy entity id.

Parameters:: policyId - the policy entity id; ruleId - the rule entity id
Returns:: PolicyManagerResult result of the policy rule unassignment
Throws:: oracle.iam.platform.entitymgr.NoSuchEntityException; PolicyManagerException; AccessDeniedException; EntityModifyException; ValidationFailedException; EntitySearchException; EntityLockedException

getRulesAssignedToPolicy

java.util.List getRulesAssignedToPolicy(java.lang.String policyId)
                                 throws oracle.iam.platform.entitymgr.NoSuchEntityException,
                                        PolicyManagerException,
                                        AccessDeniedException,
                                        EntitySearchException,
                                        ValidationFailedException

Return rules assigned to the policy specified by the policy entity id.

Parameters:: policyId - the policy id
Returns:: list of rules assigned to the policy
Throws:: oracle.iam.platform.entitymgr.NoSuchEntityException; PolicyManagerException; AccessDeniedException; EntitySearchException; ValidationFailedException

reorderPolicyRules

PolicyManagerResult reorderPolicyRules(java.lang.String policyId,
                                       java.util.Map orderedPolicyRules)
                                throws oracle.iam.platform.entitymgr.NoSuchEntityException,
                                       EntityLockedException,
                                       ValidationFailedException,
                                       AccessDeniedException,
                                       EntityModifyException

Reorder the rules of the policy associated with specified policy entity id. The orderedPolicyRules map specifies the new order of the rules.

Parameters:: policyId - the policy entity id; orderedPolicyRules - map specifiying the new rule order
Returns:: PolicyManagerResult result of the policy rule re-ordering
Throws:: oracle.iam.platform.entitymgr.NoSuchEntityException; EntityLockedException; ValidationFailedException; AccessDeniedException; EntityModifyException

replacePolicyRules
```
PolicyManagerResult replacePolicyRules(java.lang.String policyId,
                                       java.util.List ruleIds)
                                throws PolicyManagerException
```
Replace all of the rules of the policy associated with the specified policy entity id, with the list of rule entity ids.

Parameters:

policyId - the policy entity id

ruleIds - list of rules defining new policy rule set and ordering

Returns:

PolicyManagerResult result of the policy rule replacement

Throws:

PolicyManagerException

Interface PolicyManager