public final class OperationOptions extends Object
Modifier and Type | Field and Description |
---|---|
static String |
OP_ALLOW_PARTIAL_ATTRIBUTE_VALUES
An option to use with
SearchApiOp which specifies that the search
operation may return objects with partial attribute values. |
static String |
OP_ALLOW_PARTIAL_RESULTS
An option to use with
SearchApiOp which specifies that the search
operation may return only a reasonable subset of the results (objects). |
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_PAGE_SIZE
An option to use with
SearchApiOp that specifies the requested
page results page size. |
static String |
OP_PAGED_RESULTS_COOKIE
An option to use with
SearchApiOp that specifies an opaque cookie
which is used by the connector to track its position in the set of query
results. |
static 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. |
static String |
OP_RETURN_DEFAULT_ATTRIBUTES
If set to true the connector will return all the attributes that are returned
by default.
|
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 |
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. |
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 |
---|---|
Boolean |
getAllowPartialAttributeValues()
Returns a flag which specifies that the search
operation may return objects with partial attribute values.
|
Boolean |
getAllowPartialResults()
Returns a flag which specifies that the search
operation may return only a reasonable subset of the results.
|
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 |
getPagedResultsCookie()
Returns the opaque cookie which is used by the Connector to track its
position in the set of query results.
|
Integer |
getPagedResultsOffset()
Returns the index within the result set of the first result which should
be returned.
|
Integer |
getPageSize()
Returns the requested page results page size or
0 if paged
results are not required. |
Boolean |
getReturnDefaultAttributes()
Returns the flag indicating whether to return the default attributes
on top of those specified by OP_ATTRIBUTES_TO_GET.
|
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 . |
SortKey[] |
getSortKeys()
Returns the sort keys which should be used for ordering the
ConnectorObject s returned by this search request. |
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 static final String OP_RETURN_DEFAULT_ATTRIBUTES
public static final String OP_ALLOW_PARTIAL_RESULTS
SearchApiOp
which specifies that the search
operation may return only a reasonable subset of the results (objects). If this option
is specified then the connector is free to sacrifice completeness in favor
of performance. In this case the server size limits and short-cuts may be
used to get a better operation performance.
Even if this option is specified the connector must set the allResultsReturned
flag in SearchResult in case that partial results were returned.public static final String OP_ALLOW_PARTIAL_ATTRIBUTE_VALUES
SearchApiOp
which specifies that the search
operation may return objects with partial attribute values. E.g. it may result
group object with only a partial list of members (or no member list at all).
This allows for a more efficient searches in cases, that the search result
is only meant to be displayed in the user interface table. Composing the list
of all the members of a big groups may be significant overhead and this option
allows to reduce that overhead.
Even if this option is specified the connector must set the
attributeValueCompleteness status in Attribute in case that partial attribute
values were returned.
Please note that the connector may return incomplete attributes even if
this flag is NOT set. E.g. in case that the connector knows that the password
is set but it cannot reveal its value.public static final String OP_PAGED_RESULTS_COOKIE
SearchApiOp
that specifies an opaque cookie
which is used by the connector to track its position in the set of query
results.public static final String OP_PAGED_RESULTS_OFFSET
SearchApiOp
that specifies the index within
the result set of the first result which should be returned.public static final String OP_PAGE_SIZE
SearchApiOp
that specifies the requested
page results page size.public static final String OP_SORT_KEYS
SearchApiOp
that specifies the sort keys
which should be used for ordering the ConnectorObject
returned by
search request.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 Boolean getReturnDefaultAttributes()
public String getRunAsUser()
public GuardedString getRunWithPassword()
public Boolean getAllowPartialResults()
public Boolean getAllowPartialAttributeValues()
public String getPagedResultsCookie()
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.
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).getPageSize()
,
getPagedResultsOffset()
public Integer getPagedResultsOffset()
getPageSize()
,
getPagedResultsCookie()
public Integer getPageSize()
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.0
if paged
results are not required.getPagedResultsCookie()
,
getPagedResultsOffset()
public SortKey[] getSortKeys()
ConnectorObject
s returned by this search request.ConnectorObject
s returned by this search request (never
null
).Copyright © 2019. All rights reserved.