com.unboundid.scim.marshal.xml

Class XmlMarshaller

java.lang.Object

com.unboundid.scim.marshal.xml.XmlMarshaller

All Implemented Interfaces:

Marshaller

public class XmlMarshaller
extends Object
implements Marshaller

This class provides a SCIM object marshaller implementation to write SCIM objects to their XML representation.

Constructor Summary

Constructors

Constructor and Description
XmlMarshaller()

Method Summary

Methods

Modifier and Type	Method and Description
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> resources, 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlMarshaller

public XmlMarshaller()

Method Detail

marshal

public void marshal(BaseResource resource,
           OutputStream outputStream)
             throws SCIMException

Write a SCIM object to an output stream.

Specified by:

marshal in interface Marshaller

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

public void marshal(SCIMException response,
           OutputStream outputStream)
             throws SCIMException

Write a SCIM error response to an output stream.

Specified by:

marshal in interface Marshaller

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

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

Write a SCIM listing response to an output stream.

Specified by:

marshal in interface Marshaller

Parameters:

resources - 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

public 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.

Specified by:

bulkMarshal in interface Marshaller

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.