org.identityconnectors.framework.api.operations.batch

Class BatchBuilder

java.lang.Object

org.identityconnectors.framework.api.operations.batch.BatchBuilder

public class BatchBuilder
extends Object

Builds a list of BatchTask objects.

Constructor Summary

Constructors

Constructor and Description
BatchBuilder()

Method Summary

Modifier and Type	Method and Description
void	addCreateOp(ObjectClass objectClass, Set<Attribute> createAttributes, OperationOptions options) Add a Create operation to the batch.
void	addDeleteOp(ObjectClass objectClass, Uid uid, OperationOptions options) Add a Delete operation to the batch.
void	addUpdateAddOp(ObjectClass objectClass, Uid uid, Set<Attribute> attributes, OperationOptions options) Add an Update:Add operation to the batch.
void	addUpdateRemoveOp(ObjectClass objectClass, Uid uid, Set<Attribute> attributes, OperationOptions options) Add an Update:Remove operation to the batch.
void	addUpdateReplaceOp(ObjectClass objectClass, Uid uid, Set<Attribute> attributes, OperationOptions options) Add an Update:Replace operation to the batch.
List<BatchTask>	build() Return the current task list as a copy of the original.

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchBuilder

public BatchBuilder()

Method Detail

addCreateOp

public void addCreateOp(ObjectClass objectClass,
                        Set<Attribute> createAttributes,
                        OperationOptions options)

Add a Create operation to the batch.

Parameters:

objectClass - the type of object to create. Must not be null.

createAttributes - includes all the attributes necessary to create the target object (including the ObjectClass attribute).

options - additional options that impact the way this operation is run. May be null.

addDeleteOp

public void addDeleteOp(ObjectClass objectClass,
                        Uid uid,
                        OperationOptions options)

Add a Delete operation to the batch.

Parameters:

objectClass - type of object to delete.

uid - The unique id that specifies the object to delete.

options - additional options that impact the way this operation is run. May be null.

addUpdateReplaceOp

public void addUpdateReplaceOp(ObjectClass objectClass,
                               Uid uid,
                               Set<Attribute> attributes,
                               OperationOptions options)

Add an Update:Replace operation to the batch.

Parameters:

objectClass - the type of object to modify. Must not be null.

uid - the uid of the object to modify. Must not be null.

attributes - set of new Attribute. the values in this set represent the new, merged values to be applied to the object. This set may also include operational attributes. Must not be null.

options - additional options that impact the way this operation is run. May be null.

addUpdateAddOp

public void addUpdateAddOp(ObjectClass objectClass,
                           Uid uid,
                           Set<Attribute> attributes,
                           OperationOptions options)

Add an Update:Add operation to the batch.

Parameters:

objectClass - the type of object to modify. Must not be null.

uid - the uid of the object to modify. Must not be null.

attributes - set of new Attribute. the values in this set represent the new, merged values to be applied to the object. This set may also include operational attributes. Must not be null.

options - additional options that impact the way this operation is run. May be null.

addUpdateRemoveOp

public void addUpdateRemoveOp(ObjectClass objectClass,
                              Uid uid,
                              Set<Attribute> attributes,
                              OperationOptions options)

Add an Update:Remove operation to the batch.

Parameters:

objectClass - the type of object to modify. Must not be null.

uid - the uid of the object to modify. Must not be null.

attributes - set of new Attribute. the values in this set represent the new, merged values to be applied to the object. This set may also include operational attributes. Must not be null.

options - additional options that impact the way this operation is run. May be null.

build

public List<BatchTask> build()

Return the current task list as a copy of the original. This is to prevent external modification of the task list thus preventing this builder from being reused.

Returns:

the list of batched tasks.