public final class OperationOptions extends Object
Modifier and Type | Field and Description |
---|---|
static String |
OP_ATTRIBUTES_TO_GET
Determines which attributes to retrieve during
SearchApiOp and SyncApiOp . |
static String |
OP_CONTAINER
An option to use with
SearchApiOp that specifies the container under which to perform the search. |
static 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 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 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 String |
SCOPE_OBJECT
A value of
OP_SCOPE that indicates to search for the specified container object itself. |
static String |
SCOPE_ONE_LEVEL
A value of
OP_SCOPE that indicates to search for objects that the specified container directly contains. |
static String |
SCOPE_SUBTREE
A value of
OP_SCOPE that indicates to search for objects that the specified container directly or indirectly contains. |
Constructor and Description |
---|
OperationOptions(Map<String,Object> operationOptions)
Public only for serialization; please use
OperationOptionsBuilder . |
Modifier and Type | Method and Description |
---|---|
String[] |
getAttributesToGet()
Get the string array of attribute names to return in the object.
|
QualifiedUid |
getContainer()
Convenience method that returns
OP_CONTAINER . |
Map<String,Object> |
getOptions()
Returns a map of options.
|
String |
getRunAsUser()
Get the account to run the operation as..
|
GuardedString |
getRunWithPassword()
Get the password to run the operation as..
|
String |
getScope()
Convenience method that returns
OP_SCOPE . |
String |
toString()
Add basic debugging of internal data.
|
public static final String OP_SCOPE
SearchApiOp
(in conjunction with OP_CONTAINER
) that specifies how far
beneath the specified container to search. Must be one of the following values: public static final String SCOPE_OBJECT
OP_SCOPE
that indicates to search for the specified container object itself.public static final String SCOPE_ONE_LEVEL
OP_SCOPE
that indicates to search for objects that the specified container directly contains.public static final String SCOPE_SUBTREE
OP_SCOPE
that indicates to search for objects that the specified container directly or indirectly contains.public static final String OP_CONTAINER
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.public static final String OP_RUN_AS_USER
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.
public static final String OP_RUN_WITH_PASSWORD
ScriptOnResourceApiOp
and possibly others that specifies a password under which to
execute the script/operation.public static final String OP_ATTRIBUTES_TO_GET
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.
public OperationOptions(Map<String,Object> operationOptions)
OperationOptionsBuilder
.operationOptions
- The options.public Map<String,Object> getOptions()
ObjectSerializerFactory
for a list of supported types.public String toString()
public String getScope()
OP_SCOPE
.OP_SCOPE
.public QualifiedUid getContainer()
OP_CONTAINER
.OP_CONTAINER
.public String[] getAttributesToGet()
public String getRunAsUser()
public GuardedString getRunWithPassword()
Copyright © 2013. All Rights Reserved.