Package oracle.iam.ida.api

Interface ScanDefinitionManager

public interface ScanDefinitionManager
Public API for ScanDefinition entity operations.

  • Method Details

    • create

      ScanDefinitionManagerResult create(ScanDefinition definition) throws IDAEngineException, AlreadyExistsException
      Persists a scan definition
      Parameters:
      definition - entity to store
      Returns:
      ScanDefinitionManagerResult includes the status of the operation and the scan definition id if the operation is successful
      Throws:
      IDAEngineException
      AlreadyExistsException

    • delete

      ScanDefinitionManagerResult delete(String scanDefinitionId) throws IDAEngineException
      Deletes a scan definition
      Parameters:
      scanDefinitionId - id of the scan definition to delete
      Returns:
      ScanDefinitionManagerResult includes the status of the operation
      Throws:
      IDAEngineException - A runtime exception containing information on how to find detailed information in a server log.

    • modify

      ScanDefinitionManagerResult modify(ScanDefinition scanDefinition) throws IDAEngineException
      Updates a scan definition
      Parameters:
      scanDefinition - object to update
      Returns:
      ScanDefinitionManagerResult includes the status of the operation and the scan definition id if the operation is successful
      Throws:
      IDAEngineException - A runtime exception containing information on how to find detailed information in a server log.

    • getDetails

      ScanDefinition getDetails(String scanDefinitionID, Set<String> retAttrs) throws IDAEngineException
      Retrieves a scan definition object by scanDefinitionId.
      Parameters:
      scanDefinitionID - id of the scan definition to be retrieved.
      retAttrs - scan definition attributes. If retAttrs is not null, the scan definition will be populated only for these attributes.
      Returns:
      the scan definition object or null if not found
      Throws:
      IDAEngineException - A runtime exception containing information on how to find detailed information in a server log.

    • search

      List<ScanDefinition> search(SearchCriteria criteria, Set<String> retAttrs, Map<String,Object> configParams) throws IDAEngineException
      Retrieves a list of scan definition objects
      Parameters:
      criteria - to retrieve the scan definition objects
      retAttrs - scan definition attributes. If retAttrs is not null, the scan definition will be populated only for these attributes
      configParams - to specify range of objects and ordering
      Returns:
      list of scan definition objects. An empty list if the criteria does not match any existing scan definitions.
      Throws:
      IDAEngineException - A runtime exception containing information on how to find detailed information in a server log.

    • search

      List<ScanDefinition> search(SearchCriteria criteria, Set<String> retAttrs, Map<String,Object> configParams, boolean includeScanRunCount) throws IDAEngineException
      Retrieves a list of scan definition objects
      Parameters:
      criteria - to retrieve the scan definition objects
      retAttrs - scan definition attributes. If retAttrs is not null, the scan definition will be populated only for these attributes.
      configParams - to specify range of objects and ordering
      includeScanRunCount - flag indicating if scan run count is to be included. If true, each scan defintion entity will include the count for the number of scan runs associated with the definition.
      Returns:
      list of scan definition objects. An empty list if the criteria does not match any existing scan definitions.
      Throws:
      IDAEngineException - A runtime exception containing information on how to find detailed information in a server log.