com.unboundid.scim.wink

Class BulkContentRequestHandler

java.lang.Object

com.unboundid.scim.sdk.BulkContentHandler

com.unboundid.scim.wink.BulkContentRequestHandler

public class BulkContentRequestHandler
extends BulkContentHandler

This class implements the bulk operation handler to process bulk operation requests in the SCIM server. The original purpose of the BulkContentHandler interface was to allow each operation to be processed as soon as it had been read so that we do not have to hold the entire content of a bulk request in memory. However, there are two issues making that approach infeasible:

1. Since JSON objects are unordered, the failOnErrors value could conceivably come after the Operations array, which would be too late.
2. It would not be possible to reject a request that exceeded the maxOperations setting without processing any operations.

Constructor Summary

Constructors

Constructor and Description
BulkContentRequestHandler(SCIMApplication application, RequestContext requestContext, SCIMBackend backend, BulkStreamResponse bulkStreamResponse, OAuthTokenHandler tokenHandler) Create a new instance of this bulk operation handler.

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

BulkContentRequestHandler

public BulkContentRequestHandler(SCIMApplication application,
                         RequestContext requestContext,
                         SCIMBackend backend,
                         BulkStreamResponse bulkStreamResponse,
                         OAuthTokenHandler tokenHandler)

Create a new instance of this bulk operation handler.

Parameters:

application - The SCIM application.

requestContext - The request context for the bulk request.

backend - The SCIM backend to process the operations.

bulkStreamResponse - The bulk stream response to write response operations to.

tokenHandler - The OAuth token handler implementation to use.

Method Detail

handleFailOnErrors

public void handleFailOnErrors(int failOnErrors)

Handles the value of failOnErrors.

Overrides:

handleFailOnErrors in class BulkContentHandler

Parameters:

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

transformValue

public String transformValue(int opIndex,
                    String value)

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

Overrides:

transformValue in class BulkContentHandler

Parameters:

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

value - The value to be transformed.

Returns:

The transformed value.

getResourceDescriptor

public ResourceDescriptor getResourceDescriptor(String endpoint)

Retrieve the resource descriptor for a given endpoint.

Overrides:

getResourceDescriptor in class BulkContentHandler

Parameters:

endpoint - A SCIM resource endpoint.

Returns:

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

handleOperation

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

Handle an individual operation.

Overrides:

handleOperation in class BulkContentHandler

Parameters:

opIndex - The index of the operation.

bulkOperation - The individual operation within the bulk operation.

Throws:

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

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

handleException

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

Handle an exception encountered when processing an individual operation.

Overrides:

handleException in class BulkContentHandler

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.