Skip navigation links

oracle.iam.ida.api
Interface PolicyViolationManager

public interface PolicyViolationManager

Public API for PolicyViolation entity operations.

Method Summary

void	assignPolicyViolations(java.util.List policyViolationIds, java.lang.String remediator, Remediator.RemediatorType remediatorType) Assign or reassign a collection of policy violations
void	closePolicyViolation(java.lang.String policyViolationId, java.lang.String comment) Closes a policy violation.
void	completePolicyViolation(java.lang.String policyViolationId) Completes a policy violation.
java.util.List	findPolicyViolationsForEntity(java.lang.String userId, java.lang.String entityType, java.lang.String entityId, java.lang.String parentEntityId) Returns the non-closed policy violations for which given entity is one of the causes.
java.util.List	getActionHistory(java.lang.String policyViolationId, java.util.Map configParams) Returns action history for a given policy violation
PolicyViolation	getDetails(java.lang.String policyViolationId, java.util.Set retAttrs) Loads the policy violation with given policy violation Id
java.util.List	search(SearchCriteria searchCriteria, java.util.Set retAttrs, java.util.Map configParams) Return the list of policy violations matching the search criteria.

Method Detail

getDetails

PolicyViolation getDetails(java.lang.String policyViolationId,
                           java.util.Set retAttrs)
                           throws IDAEngineException

Loads the policy violation with given policy violation Id

Parameters:

policyViolationId - Id of the policy violation to be retrieved.

retAttrs - Set of attributes which need to populated, use null to get all attributes.

Returns:

PolicyViolation entity with cause details

Throws:

IDAEngineException - A runtime exception containing information on how to find detailed information in a server log.

search

java.util.List search(SearchCriteria searchCriteria,
                      java.util.Set retAttrs,
                      java.util.Map configParams)
                      throws IDAEngineException

Return the list of policy violations matching the search criteria. Each returned entity will be populated with specified attributes. Range of items can be specified using configParams. Ordering of items can be specified using configParams.

Parameters:

searchCriteria - Search criteria indicating which objects to retrieve. Use null to get all objects.

retAttrs - Attributes to be filled in for each object returned. Use null to get all attributes.

configParams - Parameters to configure ordering and range of results. Use null to get all results without sorting. There are four configuration parameters: STARTROW, ENDROW, SORTEDBY and SORTORDER. Defined as String constants in package oracle.iam.identity.utils.Constants: SEARCH_STARTROW, SEARCH_ENDROW, SEARCH_SORTEDBY and SEARCH_SORTORDER

The STARTROW and ENDROW parameters indicate the subset of the complete search result to be fetched. Default values are -1 (complete results are returned). If ENDROW < STARTROW then an IllegalArgumentException is thrown.

The SORTEDBY parameter indicates the attribute used for sorting. This parameter is optional and set to null by default.

The SORTORDER parameter indicates order of sorting: ASCENDING or DESCENDING. Defined as an enum in package oracle.iam.platform.entitymgr.spi.entity.Searchable.SortOrder. This parameter is optional and is ASCENDING by default.

Returns:

List of PolicyViolation objects containing specified attributes.

Throws:

IDAEngineException - A runtime exception containing information on how to find detailed information in a server log.

completePolicyViolation

void completePolicyViolation(java.lang.String policyViolationId)
                             throws IDAEngineException

Completes a policy violation. SOA policy vioaltion remediation task will be closed. Policy violation will move to completed state via SOA callback.

Parameters:

policyViolationId - Id of the policy violation to be completed.

Throws:

IDAEngineException - A runtime exception containing information on how to find detailed information in a server log.

closePolicyViolation

void closePolicyViolation(java.lang.String policyViolationId,
                          java.lang.String comment)
                          throws IDAEngineException

Closes a policy violation. Policy violation remediation task will also be closed in SOA

Parameters:

policyViolationId - Id of the policy violation to be closed.

Throws:

IDAEngineException - A runtime exception containing information on how to find detailed information in a server log.

getActionHistory

java.util.List getActionHistory(java.lang.String policyViolationId,
                                java.util.Map configParams)
                                throws IDAEngineException

Returns action history for a given policy violation

Parameters:

policyViolationId - Id of the policy violation for the search.

configParams - Parameters to configure ordering and range of results. Use null to get all results without sorting.

Throws:

IDAEngineException - A runtime exception containing information on how to find detailed information in a server log.

findPolicyViolationsForEntity

java.util.List findPolicyViolationsForEntity(java.lang.String userId,
                                             java.lang.String entityType,
                                             java.lang.String entityId,
                                             java.lang.String parentEntityId)
                                             throws IDAEngineException

Returns the non-closed policy violations for which given entity is one of the causes.

Parameters:

userId - User key for which violations are to be found. (IAM_USER_ID in Certifications)

entityType - Type of entity, from IDAConstants: REMEDIATION_TYPE_ENTITLEMENT, REMEDIATION_TYPE_ACCOUNT, REMEDIATION_TYPE_ROLE

entityId - Id of the entity - Role: UGP Key, Account: OIU Key, Entitlement: ENT_LIST key. (IAM_ID in Certifications)

parentEntityId - If entityType is Entitlement, this parameter indicates the account (OIU) key. Else this will be null/ignored.

Returns:

List of policy violations

Throws:

IDAEngineException

assignPolicyViolations

void assignPolicyViolations(java.util.List policyViolationIds,
                            java.lang.String remediator,
                            Remediator.RemediatorType remediatorType)
                            throws IDAEngineException

Assign or reassign a collection of policy violations

Note: In this release, only PolicyViolations with status PolicyViolation.Status.OPEN may be assigned

Parameters:

policyViolationIds - - list of policy violation ids

remediator - - username (if remediatoryType is user ) or role name ( if remediatoryType = Role )

remediatorType - - Remediator.remediatorType (Remediator.remediatorType.USER or Remediator.remediatorType.ROLE )

Throws:

IDAEngineException

Skip navigation links