Skip navigation links

org.identityconnectors.framework.common.objects
Class OperationOptions

java.lang.Object
org.identityconnectors.framework.common.objects.OperationOptions

public final class OperationOptions

extends java.lang.Object

Arbitrary options to be passed into various operations. This serves as a catch-all for extra options.

Field Summary

static java.lang.String	OP_ATTRIBUTES_TO_GET Determines which attributes to retrieve during SearchApiOp and SyncApiOp.
static java.lang.String	OP_CONTAINER An option to use with SearchApiOp that specifies the container under which to perform the search.
static java.lang.String	OP_RUN_AS_USER An option to use with ScriptOnResourceApiOp and possibly others that specifies an account under which to execute the script/operation.
static java.lang.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.
static java.lang.String	OP_SCOPE An option to use with SearchApiOp (in conjunction with OP_CONTAINER) that specifies how far beneath the specified container to search.
static java.lang.String	SCOPE_OBJECT A value of OP_SCOPE that indicates to search for the specified container object itself.
static java.lang.String	SCOPE_ONE_LEVEL A value of OP_SCOPE that indicates to search for objects that the specified container directly contains.
static java.lang.String	SCOPE_SUBTREE A value of OP_SCOPE that indicates to search for objects that the specified container directly or indirectly contains.

Constructor Summary

OperationOptions(java.util.Map<java.lang.String,java.lang.Object> operationOptions)
Public only for serialization; please use OperationOptionsBuilder.

Method Summary

java.lang.String[]	getAttributesToGet() Get the string array of attribute names to return in the object.
QualifiedUid	getContainer() Convenience method that returns OP_CONTAINER.
java.util.Map<java.lang.String,java.lang.Object>	getOptions() Returns a map of options.
java.lang.String	getRunAsUser() Get the account to run the operation as..
GuardedString	getRunWithPassword() Get the password to run the operation as..
java.lang.String	getScope() Convenience method that returns OP_SCOPE.
java.lang.String	toString() Add basic debugging of internal data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

OP_SCOPE

public static final java.lang.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:

Constant Field Values

SCOPE_OBJECT

public static final java.lang.String SCOPE_OBJECT

A value of OP_SCOPE that indicates to search for the specified container object itself.

See Also:

Constant Field Values

SCOPE_ONE_LEVEL

public static final java.lang.String SCOPE_ONE_LEVEL

A value of OP_SCOPE that indicates to search for objects that the specified container directly contains.

See Also:

Constant Field Values

SCOPE_SUBTREE

public static final java.lang.String SCOPE_SUBTREE

A value of OP_SCOPE that indicates to search for objects that the specified container directly or indirectly contains.

See Also:

Constant Field Values

OP_CONTAINER

public static final java.lang.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:

Constant Field Values

OP_RUN_AS_USER

public static final java.lang.String OP_RUN_AS_USER

An option to use with ScriptOnResourceApiOp and possibly others 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:

Constant Field Values

OP_RUN_WITH_PASSWORD

public static final java.lang.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:

Constant Field Values

OP_ATTRIBUTES_TO_GET

public static final java.lang.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:

Constant Field Values

Constructor Detail

OperationOptions

public OperationOptions(java.util.Map<java.lang.String,java.lang.Object> operationOptions)

Public only for serialization; please use OperationOptionsBuilder.

Parameters:

operationOptions - The options.

Method Detail

getOptions

public java.util.Map<java.lang.String,java.lang.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 java.lang.String toString()

Add basic debugging of internal data.

Overrides:

toString in class java.lang.Object

getScope

public java.lang.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 java.lang.String[] getAttributesToGet()

Get the string array of attribute names to return in the object.

getRunAsUser

public java.lang.String getRunAsUser()

Get the account to run the operation as..

getRunWithPassword

public GuardedString getRunWithPassword()

Get the password to run the operation as..

Skip navigation links