com.unboundid.scim.sdk
Class BulkStreamResponse

java.lang.Object
  com.unboundid.scim.sdk.BulkStreamResponse

All Implemented Interfaces:

SCIMResponse

public class BulkStreamResponse
extends Object
implements SCIMResponse

Implements a SCIMResponse to handle bulk responses without keeping the entire response in memory.

Constructor Summary

BulkStreamResponse(SCIMApplication application, RequestContext requestContext)
Create a new bulk stream response.

Method Summary

void	finalizeResponse() Release resources when this bulk stream response is no longer needed.
void	marshal(Marshaller marshaller, OutputStream outputStream) Marshals this response using the specified Marshaller to the specified OutputStream.
void	writeBulkOperation(BulkOperation o) Write a bulk operation to the response.

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkStreamResponse

public BulkStreamResponse(SCIMApplication application,
                          RequestContext requestContext)
                   throws SCIMException

Create a new bulk stream response.

Parameters:

application - The SCIM JAX-RS application.

requestContext - The bulk request context.

Throws:

SCIMException - If the bulk stream response could not be created.

Method Detail

writeBulkOperation

public void writeBulkOperation(BulkOperation o)
                        throws SCIMException

Write a bulk operation to the response.

Parameters:

o - The bulk operation to write.

Throws:

SCIMException - If the bulk operation could not be written.

finalizeResponse

public void finalizeResponse()

Release resources when this bulk stream response is no longer needed.

marshal

public void marshal(Marshaller marshaller,
                    OutputStream outputStream)
             throws Exception

Marshals this response using the specified Marshaller to the specified OutputStream.

Specified by:

marshal in interface SCIMResponse

Parameters:

marshaller - The Marshaller to use.

outputStream - The OutputStream to write to.

Throws:

Exception - if an error occurs while performing the marshaling.