Uses of Class
org.identityconnectors.framework.common.objects.OperationOptions

Packages that use OperationOptions

Package	Description
org.identityconnectors.framework.api.operations
org.identityconnectors.framework.api.operations.batch
org.identityconnectors.framework.common.objects
org.identityconnectors.framework.spi.operations

Uses of OperationOptions in org.identityconnectors.framework.api.operations

Methods in org.identityconnectors.framework.api.operations with parameters of type OperationOptions

Modifier and Type	Method	Description
Uid	UpdateApiOp.addAttributeValues(ObjectClass objclass, Uid uid, Set<Attribute> valuesToAdd, OperationOptions options)	Update the object specified by the ObjectClass and Uid, adding to the current values of each attribute the values provided.
Uid	AuthenticationApiOp.authenticate(ObjectClass objectClass, String username, GuardedString password, OperationOptions options)	Most basic authentication available.
Uid	CreateApiOp.create(ObjectClass objectClass, Set<Attribute> createAttributes, OperationOptions options)	Create a target object based on the specified attributes.
void	DeleteApiOp.delete(ObjectClass objectClass, Uid uid, OperationOptions options)	Delete the object that the specified Uid identifies (if any).
Subscription	BatchApiOp.executeBatch(List<BatchTask> tasks, Observer<BatchResult> observer, OperationOptions options)	Execute a series of BatchTask.
ConnectorObject	GetApiOp.getObject(ObjectClass objectClass, Uid uid, OperationOptions options)	Get a particular ConnectorObject based on the Uid.
Subscription	BatchApiOp.queryBatch(BatchToken token, Observer<BatchResult> observer, OperationOptions options)	Query an ongoing batch execution for new results.
Uid	UpdateApiOp.removeAttributeValues(ObjectClass objclass, Uid uid, Set<Attribute> valuesToRemove, OperationOptions options)	Update the object specified by the ObjectClass and Uid, removing from the current values of each attribute the values provided.
Uid	ResolveUsernameApiOp.resolveUsername(ObjectClass objectClass, String username, OperationOptions options)	Resolve the given authentication username to the corresponding Uid.
Object	ScriptOnConnectorApiOp.runScriptOnConnector(ScriptContext request, OperationOptions options)	Runs the script.
Object	ScriptOnResourceApiOp.runScriptOnResource(ScriptContext request, OperationOptions options)	Runs a script on a specific target resource.
SearchResult	SearchApiOp.search(ObjectClass objectClass, Filter filter, ResultsHandler handler, OperationOptions options)	Search the resource for all objects that match the object class and filter.
Subscription	ConnectorEventSubscriptionApiOp.subscribe(ObjectClass objectClass, Filter eventFilter, Observer<ConnectorObject> handler, OperationOptions operationOptions)
Subscription	SyncEventSubscriptionApiOp.subscribe(ObjectClass objectClass, SyncToken token, Observer<SyncDelta> handler, OperationOptions operationOptions)	Create a subscription to a given sync topic.
SyncToken	SyncApiOp.sync(ObjectClass objectClass, SyncToken token, SyncResultsHandler handler, OperationOptions options)	Request synchronization events--i.e., native changes to target objects.
Uid	UpdateApiOp.update(ObjectClass objectClass, Uid uid, Set<Attribute> replaceAttributes, OperationOptions options)	Update the object specified by the ObjectClass and Uid, replacing the current values of each attribute with the values provided.

Uses of OperationOptions in org.identityconnectors.framework.api.operations.batch

Methods in org.identityconnectors.framework.api.operations.batch that return OperationOptions

Modifier and Type	Method	Description
OperationOptions	CreateBatchTask.getOptions()
OperationOptions	DeleteBatchTask.getOptions()
OperationOptions	UpdateBatchTask.getOptions()

Methods in org.identityconnectors.framework.api.operations.batch with parameters of type OperationOptions

Modifier and Type	Method	Description
void	BatchBuilder.addCreateOp(ObjectClass objectClass, Set<Attribute> createAttributes, OperationOptions options)	Add a Create operation to the batch.
void	BatchBuilder.addDeleteOp(ObjectClass objectClass, Uid uid, OperationOptions options)	Add a Delete operation to the batch.
void	BatchBuilder.addUpdateAddOp(ObjectClass objectClass, Uid uid, Set<Attribute> attributes, OperationOptions options)	Add an Update:Add operation to the batch.
void	BatchBuilder.addUpdateRemoveOp(ObjectClass objectClass, Uid uid, Set<Attribute> attributes, OperationOptions options)	Add an Update:Remove operation to the batch.
void	BatchBuilder.addUpdateReplaceOp(ObjectClass objectClass, Uid uid, Set<Attribute> attributes, OperationOptions options)	Add an Update:Replace operation to the batch.

Constructors in org.identityconnectors.framework.api.operations.batch with parameters of type OperationOptions

Modifier	Constructor	Description
	CreateBatchTask(ObjectClass objectClass, Set<Attribute> createAttributes, OperationOptions options)	Create a target object based on the specified attributes.
	DeleteBatchTask(ObjectClass objectClass, Uid uid, OperationOptions options)	Delete the object that the specified Uid identifies (if any).
	UpdateBatchTask(ObjectClass objectClass, Uid uid, Set<Attribute> replaceAttributes, OperationOptions options, UpdateType type)	See UpdateApiOp.

Uses of OperationOptions in org.identityconnectors.framework.common.objects

Methods in org.identityconnectors.framework.common.objects that return OperationOptions

Modifier and Type	Method	Description
OperationOptions	OperationOptionsBuilder.build()	Creates the OperationOptions.

Constructors in org.identityconnectors.framework.common.objects with parameters of type OperationOptions

Modifier	Constructor	Description
	OperationOptionsBuilder(OperationOptions options)	Create a builder from an existing set of options.

Uses of OperationOptions in org.identityconnectors.framework.spi.operations

Methods in org.identityconnectors.framework.spi.operations with parameters of type OperationOptions

Modifier and Type	Method	Description
Uid	UpdateAttributeValuesOp.addAttributeValues(ObjectClass objclass, Uid uid, Set<Attribute> valuesToAdd, OperationOptions options)	Update the object specified by the ObjectClass and Uid, adding to the current values of each attribute the values provided.
Uid	AuthenticateOp.authenticate(ObjectClass objectClass, String username, GuardedString password, OperationOptions options)	Simple authentication with two parameters presumed to be user name and password.
Uid	CreateOp.create(ObjectClass objectClass, Set<Attribute> createAttributes, OperationOptions options)	The Connector developer is responsible for taking the attributes given (which always includes the ObjectClass) and create an object and its Uid.
FilterTranslator<T>	SearchOp.createFilterTranslator(ObjectClass objectClass, OperationOptions options)	Creates a filter translator that will translate a specified filter into one or more native queries.
void	DeleteOp.delete(ObjectClass objectClass, Uid uid, OperationOptions options)	The Connector developer is responsible for calling the native delete methods to remove the object specified by its unique id.
Subscription	BatchOp.executeBatch(List<BatchTask> tasks, Observer<BatchResult> observer, OperationOptions options)	Execute a series of BatchTask.
void	SearchOp.executeQuery(ObjectClass objectClass, T query, ResultsHandler handler, OperationOptions options)	ConnectorFacade calls this method once for each native query that the FilterTranslator produces in response to the Filter passed into SearchApiOp.
Subscription	BatchOp.queryBatch(BatchToken token, Observer<BatchResult> observer, OperationOptions options)	Query an ongoing batch execution for new results.
Uid	UpdateAttributeValuesOp.removeAttributeValues(ObjectClass objclass, Uid uid, Set<Attribute> valuesToRemove, OperationOptions options)	Update the object specified by the ObjectClass and Uid, removing from the current values of each attribute the values provided.
Uid	ResolveUsernameOp.resolveUsername(ObjectClass objectClass, String username, OperationOptions options)	Resolve an object to its Uid based on its username.
Object	ScriptOnConnectorOp.runScriptOnConnector(ScriptContext request, OperationOptions options)	Runs the script request.
Object	ScriptOnResourceOp.runScriptOnResource(ScriptContext request, OperationOptions options)	Run the specified script on the target resource that this connector manages.
Subscription	ConnectorEventSubscriptionOp.subscribe(ObjectClass objectClass, Filter eventFilter, Observer<ConnectorObject> observer, OperationOptions operationOptions)
Subscription	SyncEventSubscriptionOp.subscribe(ObjectClass objectClass, SyncToken token, Observer<SyncDelta> observer, OperationOptions operationOptions)
void	SyncOp.sync(ObjectClass objectClass, SyncToken token, SyncResultsHandler handler, OperationOptions options)	Request synchronization events--i.e., native changes to target objects.
Uid	UpdateOp.update(ObjectClass objectClass, Uid uid, Set<Attribute> replaceAttributes, OperationOptions options)	Update the object specified by the ObjectClass and Uid, replacing the current values of each attribute with the values provided.