|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ScanRunManager
Public API for ScanRun entity operations.
Method Summary | |
---|---|
java.lang.String |
createAccessRequestPreventivePreviewScan(RequestData requestData) Deprecated. 11.1.2.3.0 This method is for OIM internal use only and might be removed in a future release. Use ScanRunManager.createUserPreventivePreviewScan(oracle.iam.request.vo.RequestData, boolean, java.util.Set) |
java.lang.String |
createDetectivePreviewScan(BasicSelectionCriteria userCriteria, java.lang.String policyId) Perform an asynchronous detective preview scan of the specified users using the specified audit policy. |
boolean |
createDetectiveScan(java.lang.String scanDefinitionName, java.lang.String jobName, Trigger trigger) Create and schedule a job to run a detective scan using the given IDA Scan definition. |
java.lang.String |
createRoleLCMPreventivePreviewScan(Role role, java.lang.String requestId) Deprecated. 11.1.2.3.0 This method is for OIM internal use only and might be removed in a future release. Use ScanRunManager.createRolePreventivePreviewScan(oracle.iam.identity.rolemgmt.vo.Role, boolean, java.util.Set) |
java.lang.String |
createRolePreventivePreviewScan(Role role, boolean useDefaultPolicySet, java.util.Set auditPolicyIds) Perform a synchronous audit policy scan to find the set of violations that would be introduced if the specified role were to be modified by the addition or removal of the access policies as specified in the Role attributes. |
java.lang.String |
createUserPreventivePreviewScan(RequestData requestData, boolean useDefaultPolicySet, java.util.Set policyIds) Perform a synchronous audit policy scan to find the set of violations that would be introduced if the specified request (requestData) were granted. |
void |
deleteByScanToken(java.lang.String scanToken) Delete the ScanRun entity identified by the supplied scanToken. |
java.util.List |
findPolicyScanRuns(java.lang.String policyId, SearchCriteria criteria, java.util.Set retAttrs, java.util.Map configParams) Return list of ScanRun entities matching the search criteria for the policy Id. |
java.util.List |
findPolicyViolations(java.lang.String scanRunId, SearchCriteria policyViolationCriteria, java.util.Set retAttrs, java.util.Map configParams) For the specified scan run find the PolicyViolation entities matching the search criteria. |
ScanRun |
getDetails(java.lang.String scanRunId, java.util.Set retAttrs) Return specified ScanRun entity populated with specified attributes. |
java.util.List |
search(SearchCriteria criteria, java.util.Set retAttrs, java.util.Map configParams) Return list of ScanRun entities matching the search criteria. |
void |
stopDetectivePreviewScan(java.lang.String scanToken) Stop the asynchronous policy preview scan. |
Method Detail |
---|
@Deprecated
java.lang.String createAccessRequestPreventivePreviewScan(RequestData requestData)
throws InvalidArgumentException
ScanRunManager.createUserPreventivePreviewScan(oracle.iam.request.vo.RequestData, boolean, java.util.Set)
Authorization: Caller must be authorized to submit requestData
requestData
-InvalidArgumentException
java.lang.String createDetectivePreviewScan(BasicSelectionCriteria userCriteria, java.lang.String policyId) throws InvalidArgumentException
userCriteria
- criteria to be used when selecting users for the scanpolicyId
- ID of the audit policy to be used for the scannull
if no violations were produced.InvalidArgumentException
boolean createDetectiveScan(java.lang.String scanDefinitionName, java.lang.String jobName, Trigger trigger) throws AlreadyExistsException, InvalidArgumentException
scanDefinitionName
- - name of the definition to use for the jobjobName
- - name for the jobtrigger
- - scheduling information. If trigger is null, job will be added in the system but will not run.AlreadyExistsException
InvalidArgumentException
@Deprecated
java.lang.String createRoleLCMPreventivePreviewScan(Role role,
java.lang.String requestId)
throws InvalidArgumentException
ScanRunManager.createRolePreventivePreviewScan(oracle.iam.identity.rolemgmt.vo.Role, boolean, java.util.Set)
role
- the Role
instance to examinerequestId
- required during request approval (supposing the request was submitted with one or more outstanding violations)null
if no violations were producedInvalidArgumentException
java.lang.String createRolePreventivePreviewScan(Role role, boolean useDefaultPolicySet, java.util.Set auditPolicyIds) throws InvalidArgumentException
Caller may set useDefaultPolicySet to TRUE and provide zero or more audit policy IDs to augment the default list, or may set the flag to false and provide one or more audit policy IDs to be scanned.
role
- the Role
instance to examineuseDefaultPolicySet
- if true
, the scan will use default and any additional policies specified; otherwise, the scan will not use default policiesauditPolicyIds
- Additional policies to applynull
if no violations were producedInvalidArgumentException
java.lang.String createUserPreventivePreviewScan(RequestData requestData, boolean useDefaultPolicySet, java.util.Set policyIds) throws InvalidArgumentException
requestData
- Request data which includes users (Beneficiary
) and requested access (RequestBeneficiaryEntity
)useDefaultPolicySet
- if true
, the scan will use default and any additional policies specified; otherwise, the scan will not use default policiespolicyIds
- Additional policies to applynull
if no violations were producedInvalidArgumentException
void deleteByScanToken(java.lang.String scanToken) throws InvalidArgumentException
scanToken
- Token associated with a preview scan and violationsInvalidArgumentException
ScanRun getDetails(java.lang.String scanRunId, java.util.Set retAttrs) throws InvalidArgumentException
scanRunId
- - ID of entity to be retrieved.retAttrs
- - Attributes to be loaded. Use null
to get all attributes.InvalidArgumentException
java.util.List search(SearchCriteria criteria, java.util.Set retAttrs, java.util.Map configParams)
criteria
- 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.
NOTE: Can throw IDAEngineException - A runtime exception containing information on how to find detailed information in a server log.
java.util.List findPolicyViolations(java.lang.String scanRunId, SearchCriteria policyViolationCriteria, java.util.Set retAttrs, java.util.Map configParams)
policyViolationCriteria
- 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.
NOTE: Can throw IDAEngineException - A runtime exception containing information on how to find detailed information in a server log.
java.util.List findPolicyScanRuns(java.lang.String policyId, SearchCriteria criteria, java.util.Set retAttrs, java.util.Map configParams)
policyId
- PolicyId in question for associated preview scan runs.criteria
- 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.
void stopDetectivePreviewScan(java.lang.String scanToken) throws InvalidArgumentException
scanToken
- token returned by ScanRunManager.createDetectivePreviewScan(oracle.iam.certification.vo.BasicSelectionCriteria, java.lang.String)
InvalidArgumentException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |