com.unboundid.scim.marshal
Interface Marshaller

All Known Implementing Classes:

JsonMarshaller, XmlMarshaller

public interface Marshaller

This interface provides methods that may be used to write SCIM objects to an external representation. There are marshaller implementations for XML and JSON. Marshaller implementations are required to be thread-safe.

Method Summary

void	bulkMarshal(OutputStream outputStream, int failOnErrors, List<BulkOperation> operations) Write the content of a SCIM bulk operation request or response to an output stream.
void	marshal(BaseResource resource, OutputStream outputStream) Write a SCIM object to an output stream.
void	marshal(Resources<? extends BaseResource> response, OutputStream outputStream) Write a SCIM listing response to an output stream.
void	marshal(SCIMException response, OutputStream outputStream) Write a SCIM error response to an output stream.

Method Detail

marshal

void marshal(BaseResource resource,
             OutputStream outputStream)
             throws SCIMException

Write a SCIM object to an output stream.

Parameters:

resource - The SCIM resource to be written.

outputStream - The output stream to which the SCIM object should be written.

Throws:

SCIMException - If the data could not be written.

marshal

void marshal(Resources<? extends BaseResource> response,
             OutputStream outputStream)
             throws SCIMException

Write a SCIM listing response to an output stream.

Parameters:

response - The SCIM response to be written.

outputStream - The output stream to which the SCIM response should be written.

Throws:

SCIMException - If the data could not be written.

marshal

void marshal(SCIMException response,
             OutputStream outputStream)
             throws SCIMException

Write a SCIM error response to an output stream.

Parameters:

response - The SCIM response to be written.

outputStream - The output stream to which the SCIM response should be written.

Throws:

SCIMException - If the data could not be written.

bulkMarshal

void bulkMarshal(OutputStream outputStream,
                 int failOnErrors,
                 List<BulkOperation> operations)
                 throws SCIMException

Write the content of a SCIM bulk operation request or response to an output stream.

Parameters:

outputStream - The output stream to which the content should be written.

failOnErrors - The value of failOnErrors, or -1 to not provide a value.

operations - The bulk operations to include in the content.

Throws:

SCIMException - If the data could not be written.