Package org.identityconnectors.framework.common.objects

Class OperationOptions

java.lang.Object
org.identityconnectors.framework.common.objects.OperationOptions
public final class OperationOptions extends Object
Arbitrary options to be passed into various operations. This serves as a catch-all for extra options.

  • Field Details

    • OP_SCOPE

      public static final String OP_SCOPE
      An option to use with SearchApiOp (in conjunction with OP_CONTAINER) that specifies how far beneath the specified container to search. Must be one of the following values:
      1. SCOPE_OBJECT
      2. SCOPE_ONE_LEVEL
      3. SCOPE_SUBTREE
      See Also:

    • SCOPE_OBJECT

      public static final String SCOPE_OBJECT
      A value of OP_SCOPE that indicates to search for the specified container object itself.
      See Also:

    • SCOPE_ONE_LEVEL

      public static final String SCOPE_ONE_LEVEL
      A value of OP_SCOPE that indicates to search for objects that the specified container directly contains.
      See Also:

    • SCOPE_SUBTREE

      public static final String SCOPE_SUBTREE
      A value of OP_SCOPE that indicates to search for objects that the specified container directly or indirectly contains.
      See Also:

    • OP_CONTAINER

      public static final String OP_CONTAINER
      An option to use with SearchApiOp that specifies the container under which to perform the search. Must be of type QualifiedUid. Should be implemented for those object classes whose ObjectClassInfo.isContainer() returns true.
      See Also:

    • OP_RUN_AS_USER

      public static final String OP_RUN_AS_USER
      An option that specifies an account under which to execute the script/operation. The specified account will appear to have performed any action that the script/operation performs.

      Check the javadoc for a particular connector to see whether that connector supports this option.

      See Also:

    • OP_RUN_WITH_PASSWORD

      public static final String OP_RUN_WITH_PASSWORD
      An option to use with ScriptOnResourceApiOp and possibly others that specifies a password under which to execute the script/operation.
      See Also:

    • OP_ATTRIBUTES_TO_GET

      public static final String OP_ATTRIBUTES_TO_GET
      Determines which attributes to retrieve during SearchApiOp and SyncApiOp.

      This option overrides the default behavior, which is for the connector to return exactly the set of attributes that are identified as returned by default in the schema for that connector.

      This option allows a client application to request additional attributes that would not otherwise not be returned (generally because such attributes are more expensive for a connector to fetch and to format) and/or to request only a subset of the attributes that would normally be returned.

      See Also:

    • OP_TOTAL_PAGED_RESULTS_POLICY

      public static final String OP_TOTAL_PAGED_RESULTS_POLICY
      An option to use with SearchApiOp that specifies the policy used for calculating the total number of paged results.
      Since:
      1.5
      See Also:

    • OP_PAGED_RESULTS_OFFSET

      public static final String OP_PAGED_RESULTS_OFFSET
      An option to use with SearchApiOp that specifies the index within the result set of the first result which should be returned.
      Since:
      1.4
      See Also:

    • OP_PAGE_SIZE

      public static final String OP_PAGE_SIZE
      An option to use with SearchApiOp that specifies the requested page results page size.
      Since:
      1.4
      See Also:

    • OP_SORT_KEYS

      public static final String OP_SORT_KEYS
      An option to use with SearchApiOp that specifies the sort keys which should be used for ordering the ConnectorObject returned by search request.
      Since:
      1.4
      See Also:

    • OP_FAIL_ON_ERROR

      public static final String OP_FAIL_ON_ERROR
      An option to specify whether a BatchApiOp should abort processing on the first error encountered in the batch. Default behavior is to continue processing in spite of errors.
      Since:
      1.5
      See Also:

    • OP_REQUIRE_SERIAL

      public static final String OP_REQUIRE_SERIAL
      An option to instruct a connector that batched operations must be executed in serial fashion where possible/applicable. The default behavior should be to execute tasks in parallel for speed and efficiency. In either case the task id must be reflected in teh response for each task so they can be properly reordered.
      Since:
      1.5
      See Also:

  • Constructor Details

    • OperationOptions

      public OperationOptions(Map<String,Object> operationOptions)
      Public only for serialization; please use OperationOptionsBuilder .
      Parameters:
      operationOptions - The options.

  • Method Details

    • getOptions

      public Map<String,Object> getOptions()
      Returns a map of options. Each value in the map must be of a type that the framework can serialize. See ObjectSerializerFactory for a list of supported types.
      Returns:
      A map of options.

    • toString

      public String toString()
      Add basic debugging of internal data.
      Overrides:
      toString in class Object

    • getScope

      public String getScope()
      Convenience method that returns OP_SCOPE.
      Returns:
      The value for OP_SCOPE.

    • getContainer

      public QualifiedUid getContainer()
      Convenience method that returns OP_CONTAINER.
      Returns:
      The value for OP_CONTAINER.

    • getAttributesToGet

      public String[] getAttributesToGet()
      Get the string array of attribute names to return in the object.

    • getRunAsUser

      public String getRunAsUser()
      Get the account to run the operation as..

    • getRunWithPassword

      public GuardedString getRunWithPassword()
      Get the password to run the operation as..

    • getPagedResultsCookie

      public String getPagedResultsCookie()
      Returns the opaque cookie which is used by the Connector to track its position in the set of query results. Paged results will be enabled if and only if the page size is non-zero.

      The cookie must be null in the initial search request sent by the client. For subsequent search requests the client must include the cookie returned with the previous search result, until the resource provider returns a null cookie indicating that the final page of results has been returned.

      Returns:
      The opaque cookie which is used by the Connector to track its position in the set of search results, or null if paged results are not requested (when the page size is 0), or if the first page of results is being requested (when the page size is non-zero).
      Since:
      1.4
      See Also:

    • getTotalPagedResultsPolicy

      public SearchResult.CountPolicy getTotalPagedResultsPolicy()
      Returns the SearchResult.CountPolicy used to calculate SearchResult.getTotalPagedResults().
      Returns:
      The count policy.
      Since:
      1.5
      See Also:

    • getPagedResultsOffset

      public Integer getPagedResultsOffset()
      Returns the index within the result set of the first result which should be returned. Paged results will be enabled if and only if the page size is non-zero. If the parameter is not present or a value less than 1 is specified then the page following the previous page returned will be returned. A value equal to or greater than 1 indicates that a specific page should be returned starting from the position specified.
      Returns:
      The index within the result set of the first result which should be returned.
      Since:
      1.4
      See Also:

    • getPageSize

      public Integer getPageSize()
      Returns the requested page results page size or 0 if paged results are not required. For all paged result requests other than the initial request, a cookie should be provided with the search request. See getPagedResultsCookie() for more information.
      Returns:
      The requested page results page size or 0 if paged results are not required.
      Since:
      1.4
      See Also:

    • getSortKeys

      public SortKey[] getSortKeys()
      Returns the sort keys which should be used for ordering the ConnectorObjects returned by this search request.
      Returns:
      The sort keys which should be used for ordering the ConnectorObjects returned by this search request (never null).
      Since:
      1.4

    • getFailOnError

      public boolean getFailOnError()
      Returns the state of the failOnError option; defaults to false.

    • getRequireSerial

      public boolean getRequireSerial()
      Return the state of the allowParallel option; defaults to false.