com.unboundid.scim.sdk

Class BulkContentHandler

java.lang.Object

com.unboundid.scim.sdk.BulkContentHandler

Direct Known Subclasses:

BulkContentRequestHandler, BulkContentResponseHandler

public abstract class BulkContentHandler
extends Object

This class must be extended to handle the content of a bulk operation.

Constructor Summary

Constructors

Constructor and Description
BulkContentHandler()

Method Summary

Methods

Modifier and Type	Method and Description
ResourceDescriptor	getResourceDescriptor(String endpoint) Retrieve the resource descriptor for a given endpoint.
boolean	handleException(int opIndex, BulkException bulkException) Handle an exception encountered when processing an individual operation.
void	handleFailOnErrors(int failOnErrors) Handles the value of failOnErrors.
void	handleOperation(int opIndex, BulkOperation bulkOperation) Handle an individual operation.
String	transformValue(int opIndex, String value) Transform a data value.

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkContentHandler

public BulkContentHandler()

Method Detail

handleFailOnErrors

public void handleFailOnErrors(int failOnErrors)

Handles the value of failOnErrors.

Parameters:

failOnErrors - The number of errors that the Service Provider will accept before the operation is terminated and an error response is returned.

handleOperation

public void handleOperation(int opIndex,
                   BulkOperation bulkOperation)
                     throws BulkException,
                            SCIMException

Handle an individual operation.

Parameters:

opIndex - The index of the operation.

bulkOperation - The individual operation within the bulk operation.

Throws:

SCIMException - If an error occurs that prevents processing of the entire bulk content.

BulkException - If an error occurs while processing the individual operation within the bulk operation.

handleException

public boolean handleException(int opIndex,
                      BulkException bulkException)
                        throws SCIMException

Handle an exception encountered when processing an individual operation.

Parameters:

opIndex - The index of the operation.

bulkException - The exception encountered when processing an individual operation within the bulk operation.

Returns:

true if operations should continue to be provided, or false if the remaining operations are of no interest.

Throws:

SCIMException - If an error occurs that prevents processing of the entire bulk content.

getResourceDescriptor

public ResourceDescriptor getResourceDescriptor(String endpoint)

Retrieve the resource descriptor for a given endpoint.

Parameters:

endpoint - A SCIM resource endpoint.

Returns:

The resource descriptor for this endpoint, or null if the endpoint is unknown.

transformValue

public String transformValue(int opIndex,
                    String value)

Transform a data value. This method may be used to resolve bulkId references to resource IDs.

Parameters:

opIndex - The index of the bulk operation containing the data value.

value - The value to be transformed.

Returns:

The transformed value.