com.marklogic.client.io

Class JAXBHandle<C>

java.lang.Object

com.marklogic.client.impl.HandleImplementation<R,W>

com.marklogic.client.io.BaseHandle<java.io.InputStream,OutputStreamSender>

com.marklogic.client.io.JAXBHandle<C>

Type Parameters:

C - one of the classes (or the <?> wildcard for any of the classes) registered with the JAXB Context

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, AbstractWriteHandle, BufferableContentHandle<C,java.io.InputStream>, BufferableHandle, ContentHandle<C>, ResendableContentHandle<C,java.io.InputStream>, SPARQLResultsReadHandle, TriplesReadHandle, TriplesWriteHandle, XMLReadHandle, XMLWriteHandle, OutputStreamSender

public class JAXBHandle<C>
extends BaseHandle<java.io.InputStream,OutputStreamSender>
implements ResendableContentHandle<C,java.io.InputStream>, OutputStreamSender, XMLReadHandle, XMLWriteHandle

A JAXB Handle roundtrips a POJO (a Java data structure) to and from a database document. The POJO class must have JAXB annotations or must be generated by xjc from an XML Schema. The JAXB Handle must be initialized with a JAXB Context with which the root POJO classes have been registered. Important: Do not use the JAXB unmarshaller to parse XML from an untrusted source as it is vulnerable to XXE attacks.

Field Summary

Fields inherited from interface com.marklogic.client.document.ContentDescriptor

UNKNOWN_LENGTH

Constructor Summary

Constructors

Constructor and Description
JAXBHandle(jakarta.xml.bind.JAXBContext context) Initializes the JAXB handle with the JAXB context for the classes of the marshalled or unmarshalled structure.
JAXBHandle(jakarta.xml.bind.JAXBContext context, java.lang.Class<C> contentClass) Initializes the JAXB handle with the JAXB context for the classes of the marshalled or unmarshalled structure.

Method Summary

Modifier and Type	Method and Description
C	bytesToContent(byte[] buffer) Converts a byte serialization to the content representation.
byte[]	contentToBytes(C content) Converts the content representation to bytes.
void	fromBuffer(byte[] buffer) fromBuffer() unmarshals a JAXB POJO from a byte array buffer.
C	get() Returns the root object of the JAXB structure for the content.
<T> T	get(java.lang.Class<T> as) Returns the root object of the JAXB structure for the content cast to a more specific class.
java.lang.Class<C>	getContentClass() Returns the class of the handled content, which may be a base class of the actual class of a content object.
jakarta.xml.bind.Marshaller	getMarshaller() Returns the marshaller that converts a tree data structure from Java objects to XML, reusing any existing marshaller.
jakarta.xml.bind.Marshaller	getMarshaller(boolean reuse) Returns the marshaller that converts a tree data structure from Java objects to XML.
jakarta.xml.bind.Unmarshaller	getUnmarshaller() Returns the unmarshaller that converts a tree data structure from XML to Java objects, reusing any existing unmarshaller.
jakarta.xml.bind.Unmarshaller	getUnmarshaller(boolean reuse) Returns the unmarshaller that converts a tree data structure from XML to Java objects.
static ContentHandleFactory	newFactory(java.lang.Class<?>... pojoClasses) Creates a factory to create a JAXBHandle instance for POJO instances of the specified classes.
static ContentHandleFactory	newFactory(jakarta.xml.bind.JAXBContext context, java.lang.Class<?>... pojoClasses) Creates a factory to create a JAXBHandle instance for POJO instances of the specified classes.
JAXBHandle<C>	newHandle() Constructs a new handle for the same content representation, initializing the new handle with the same format and mime type.
JAXBHandle<C>[]	newHandleArray(int length) Constructs an uninitialized array with the specified length with items of the same content representation.
protected java.lang.Class<java.io.InputStream>	receiveAs()
protected void	receiveContent(java.io.InputStream serialization)
protected OutputStreamSender	sendContent()
void	set(C content) Assigns the root object of the JAXB structure for the content.
void	setFormat(Format format) Restricts the format to XML.
byte[]	toBuffer() Copies the content of the handle to a byte array buffer encoded in UTF-8.
C	toContent(java.io.InputStream serialization) Converts the serialization to the content representation.
java.lang.String	toString() Returns the JAXB structure as an XML string.
JAXBHandle<C>	with(C content) Assigns the root object of the JAXB structure for the content and returns the handle as a fluent convenience.
JAXBHandle<C>	withMimetype(java.lang.String mimetype) Specifies the mime type of the content and returns the handle as a fluent convenience.
void	write(java.io.OutputStream out) Implements a callback to write content to the provided output stream for sending to the database server.

Methods inherited from class com.marklogic.client.io.BaseHandle

getByteLength, getFormat, getMimetype, getServerTimestamp, setByteLength, setMimetype, setServerTimestamp

Methods inherited from class com.marklogic.client.impl.HandleImplementation

getPointInTimeQueryTimestamp, isResendable, setPointInTimeQueryTimestamp, setResendable, setResponseServerTimestamp

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.marklogic.client.io.marker.ResendableContentHandle

newHandle, resendableHandleFor

Methods inherited from interface com.marklogic.client.io.marker.BufferableContentHandle

resendableHandleFor

Methods inherited from interface com.marklogic.client.io.marker.ContentHandle

newArray

Constructor Detail

JAXBHandle

public JAXBHandle(jakarta.xml.bind.JAXBContext context)

Initializes the JAXB handle with the JAXB context for the classes of the marshalled or unmarshalled structure.

Parameters:

context - the JAXB context

JAXBHandle

public JAXBHandle(jakarta.xml.bind.JAXBContext context,
                  java.lang.Class<C> contentClass)

Initializes the JAXB handle with the JAXB context for the classes of the marshalled or unmarshalled structure.

Parameters:

context - the JAXB context

contentClass - the class of the content

Method Detail

newFactory

public static ContentHandleFactory newFactory(java.lang.Class<?>... pojoClasses)
                                       throws jakarta.xml.bind.JAXBException

Creates a factory to create a JAXBHandle instance for POJO instances of the specified classes.

Parameters:

pojoClasses - the POJO classes for which this factory provides a handle

Returns:

the factory

Throws:

jakarta.xml.bind.JAXBException - if a JAXB error occurs while initializing the new factory

newFactory

public static ContentHandleFactory newFactory(jakarta.xml.bind.JAXBContext context,
                                              java.lang.Class<?>... pojoClasses)

Creates a factory to create a JAXBHandle instance for POJO instances of the specified classes.

Parameters:

context - the JAXB context for marshaling the POJO classes

pojoClasses - the POJO classes for which this factory provides a handle

Returns:

the factory

get

public C get()

Returns the root object of the JAXB structure for the content.

Specified by:

get in interface ContentHandle<C>

Returns:

the root JAXB object

get

public <T> T get(java.lang.Class<T> as)

Returns the root object of the JAXB structure for the content cast to a more specific class.

Type Parameters:

T - the type to return

Parameters:

as - the class of the object

Returns:

the root JAXB object

set

public void set(C content)

Assigns the root object of the JAXB structure for the content.

Specified by:

set in interface ContentHandle<C>

Parameters:

content - the root JAXB object

with

public JAXBHandle<C> with(C content)

Assigns the root object of the JAXB structure for the content and returns the handle as a fluent convenience.

Parameters:

content - the root JAXB object

Returns:

this handle

getContentClass

public java.lang.Class<C> getContentClass()

Description copied from interface: ContentHandle

Returns the class of the handled content, which may be a base class of the actual class of a content object. Note that implementations should override the default method, which returns null if the handle doesn't have any content.

Specified by:

getContentClass in interface ContentHandle<C>

Returns:

the class for the handled content

newHandle

public JAXBHandle<C> newHandle()

Description copied from interface: ContentHandle

Constructs a new handle for the same content representation, initializing the new handle with the same format and mime type.

Specified by:

newHandle in interface BufferableContentHandle<C,java.io.InputStream>

Specified by:

newHandle in interface ContentHandle<C>

Specified by:

newHandle in interface ResendableContentHandle<C,java.io.InputStream>

Returns:

the new handle

newHandleArray

public JAXBHandle<C>[] newHandleArray(int length)

Description copied from interface: BufferableContentHandle

Constructs an uninitialized array with the specified length with items of the same content representation.

Specified by:

newHandleArray in interface BufferableContentHandle<C,java.io.InputStream>

Specified by:

newHandleArray in interface ResendableContentHandle<C,java.io.InputStream>

Parameters:

length - the number of positions in the array

Returns:

the uninitialized array

setFormat

public void setFormat(Format format)

Restricts the format to XML.

Specified by:

setFormat in interface ContentDescriptor

Overrides:

setFormat in class BaseHandle<java.io.InputStream,OutputStreamSender>

Parameters:

format - the format of the content

withMimetype

public JAXBHandle<C> withMimetype(java.lang.String mimetype)

Specifies the mime type of the content and returns the handle as a fluent convenience.

Parameters:

mimetype - the mime type of the content

Returns:

this handle

fromBuffer

public void fromBuffer(byte[] buffer)

fromBuffer() unmarshals a JAXB POJO from a byte array buffer. The buffer must store the marshaled XML for the JAXB POJO in UTF-8 encoding. JAXB cannot unmarshal arbitrary XML.

Specified by:

fromBuffer in interface BufferableHandle

Parameters:

buffer - the byte array

toBuffer

public byte[] toBuffer()

Description copied from interface: BufferableHandle

Copies the content of the handle to a byte array buffer encoded in UTF-8.

Specified by:

toBuffer in interface BufferableHandle

Returns:

the byte array

bytesToContent

public C bytesToContent(byte[] buffer)

Description copied from interface: BufferableContentHandle

Converts a byte serialization to the content representation.

Specified by:

bytesToContent in interface BufferableContentHandle<C,java.io.InputStream>

Parameters:

buffer - the byte serialization

Returns:

the content representation

contentToBytes

public byte[] contentToBytes(C content)

Description copied from interface: BufferableContentHandle

Converts the content representation to bytes.

Specified by:

contentToBytes in interface BufferableContentHandle<C,java.io.InputStream>

Parameters:

content - the content

Returns:

the byte serialization of the content

toContent

public C toContent(java.io.InputStream serialization)

Description copied from interface: BufferableContentHandle

Converts the serialization to the content representation.

Specified by:

toContent in interface BufferableContentHandle<C,java.io.InputStream>

Parameters:

serialization - a serialization of the content

Returns:

the content representation

toString

public java.lang.String toString()

Returns the JAXB structure as an XML string.

Overrides:

toString in class java.lang.Object

getUnmarshaller

public jakarta.xml.bind.Unmarshaller getUnmarshaller()
                                              throws jakarta.xml.bind.JAXBException

Returns the unmarshaller that converts a tree data structure from XML to Java objects, reusing any existing unmarshaller.

Returns:

the unmarshaller for the JAXB context

Throws:

jakarta.xml.bind.JAXBException - if unmarshaller initialization fails

getUnmarshaller

public jakarta.xml.bind.Unmarshaller getUnmarshaller(boolean reuse)
                                              throws jakarta.xml.bind.JAXBException

Returns the unmarshaller that converts a tree data structure from XML to Java objects.

Parameters:

reuse - whether to reuse an existing unmarshaller

Returns:

the unmarshaller for the JAXB context

Throws:

jakarta.xml.bind.JAXBException - if unmarshaller initialization fails

getMarshaller

public jakarta.xml.bind.Marshaller getMarshaller()
                                          throws jakarta.xml.bind.JAXBException

Returns the marshaller that converts a tree data structure from Java objects to XML, reusing any existing marshaller.

Returns:

the marshaller for the JAXB context

Throws:

jakarta.xml.bind.JAXBException - if marshaller initialization fails

getMarshaller

public jakarta.xml.bind.Marshaller getMarshaller(boolean reuse)
                                          throws jakarta.xml.bind.JAXBException

Returns the marshaller that converts a tree data structure from Java objects to XML.

Parameters:

reuse - whether to reuse an existing marshaller

Returns:

the marshaller for the JAXB context

Throws:

jakarta.xml.bind.JAXBException - if marshaller initialization fails

receiveAs

protected java.lang.Class<java.io.InputStream> receiveAs()

Overrides:

receiveAs in class com.marklogic.client.impl.HandleImplementation<java.io.InputStream,OutputStreamSender>

receiveContent

protected void receiveContent(java.io.InputStream serialization)

Overrides:

receiveContent in class com.marklogic.client.impl.HandleImplementation<java.io.InputStream,OutputStreamSender>

sendContent

protected OutputStreamSender sendContent()

Overrides:

sendContent in class com.marklogic.client.impl.HandleImplementation<java.io.InputStream,OutputStreamSender>

write

public void write(java.io.OutputStream out)
           throws java.io.IOException

Description copied from interface: OutputStreamSender

Implements a callback to write content to the provided output stream for sending to the database server.

Specified by:

write in interface OutputStreamSender

Parameters:

out - the output stream receiving the content

Throws:

java.io.IOException - if io problems arise