com.marklogic.client.io

Class JacksonDatabindHandle<T>

java.lang.Object

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

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

com.marklogic.client.impl.JacksonBaseHandle<T>

com.marklogic.client.io.JacksonDatabindHandle<T>

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, AbstractWriteHandle, BufferableContentHandle<T,java.io.InputStream>, BufferableHandle, ContentHandle<T>, CtsQueryWriteHandle, DocumentMetadataReadHandle, DocumentMetadataWriteHandle, DocumentPatchHandle, JSONReadHandle, JSONWriteHandle, QueryOptionsListReadHandle, QueryOptionsReadHandle, QueryOptionsWriteHandle, ResendableContentHandle<T,java.io.InputStream>, RuleListReadHandle, RuleReadHandle, RuleWriteHandle, SearchReadHandle, SPARQLResultsReadHandle, StructureReadHandle, StructureWriteHandle, TextReadHandle, TextWriteHandle, TriplesReadHandle, TriplesWriteHandle, TuplesReadHandle, ValuesListReadHandle, ValuesReadHandle, XMLReadHandle, XMLWriteHandle, OutputStreamSender

public class JacksonDatabindHandle<T>
extends com.marklogic.client.impl.JacksonBaseHandle<T>
implements ResendableContentHandle<T,java.io.InputStream>, JSONReadHandle, JSONWriteHandle, TextReadHandle, TextWriteHandle, XMLReadHandle, XMLWriteHandle, StructureReadHandle, StructureWriteHandle, CtsQueryWriteHandle

An adapter for using the Jackson Open Source library for JSON; represents JSON content for reading or writing as objects of the specified POJO class. Enables reading and writing JSON directly to or from POJOs.

Field Summary

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

UNKNOWN_LENGTH

Constructor Summary

Constructors

Constructor and Description
JacksonDatabindHandle(java.lang.Class<T> contentClass) Specify the type of content this JacksonDatabindHandle will manage.
JacksonDatabindHandle(T content) Provides a handle on POJO content.

Method Summary

Modifier and Type	Method and Description
T	get() Returns the content.
java.lang.Class<T>	getContentClass() Returns the class of the handled content, which may be a base class of the actual class of a content object.
com.fasterxml.jackson.databind.ObjectMapper	getMapper() Provides access to the ObjectMapper used internally so you can configure it to fit your JSON.
protected boolean	hasContent()
static ContentHandleFactory	newFactory(java.lang.Class<?>... pojoClasses) Creates a factory to create a JacksonDatabindHandle instance for POJO instances of the specified classes.
static ContentHandleFactory	newFactory(com.fasterxml.jackson.databind.ObjectMapper mapper, java.lang.Class<?>... pojoClasses) Creates a factory to create a JacksonDatabindHandle instance for POJO instances of the specified classes.
JacksonDatabindHandle<T>	newHandle() Constructs a new handle for the same content representation, initializing the new handle with the same format and mime type.
JacksonDatabindHandle<T>[]	newHandleArray(int length) Constructs an uninitialized array with the specified length with items of the same content representation.
protected void	receiveContent(java.io.InputStream content)
protected OutputStreamSender	sendContent()
protected OutputStreamSender	sendContent(T content)
void	set(T content) Assigns your custom POJO as the content.
void	setMapper(com.fasterxml.jackson.databind.ObjectMapper mapper) Enables clients to specify their own ObjectMapper instance, including databinding mappers for formats other than JSON.
T	toContent(java.io.InputStream serialization) Converts the serialization to the content representation.
JacksonDatabindHandle<T>	with(T content) Assigns a your custom POJO as the content and returns the handle.
JacksonDatabindHandle<T>	withFormat(Format format) Specifies the format of the content and returns the handle as a fluent convenience.
JacksonDatabindHandle<T>	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.impl.JacksonBaseHandle

bytesToContent, contentToBytes, fromBuffer, receiveAs, toBuffer, toString

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

getByteLength, getFormat, getMimetype, getServerTimestamp, setByteLength, setFormat, 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

bytesToContent, contentToBytes, resendableHandleFor

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

fromBuffer, toBuffer

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

newArray

Constructor Detail

JacksonDatabindHandle

public JacksonDatabindHandle(java.lang.Class<T> contentClass)

Specify the type of content this JacksonDatabindHandle will manage.

Parameters:

contentClass - the class of your custom POJO for databinding

JacksonDatabindHandle

public JacksonDatabindHandle(T content)

Provides a handle on POJO content.

Parameters:

content - the POJO which should be serialized

Method Detail

newFactory

public static ContentHandleFactory newFactory(java.lang.Class<?>... pojoClasses)

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

Parameters:

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

Returns:

the factory

newFactory

public static ContentHandleFactory newFactory(com.fasterxml.jackson.databind.ObjectMapper mapper,
                                              java.lang.Class<?>... pojoClasses)

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

Parameters:

mapper - the Jackson ObjectMapper for marshaling the POJO classes

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

Returns:

the factory

withFormat

public JacksonDatabindHandle<T> withFormat(Format format)

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

Parameters:

format - the format of the content

Returns:

this handle

withMimetype

public JacksonDatabindHandle<T> 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

get

public T get()

Returns the content.

Specified by:

get in interface ContentHandle<T>

Specified by:

get in class com.marklogic.client.impl.JacksonBaseHandle<T>

Returns:

the content you provided if you called JacksonDatabindHandle(Object) or set(Object) or if the content is being de-serialized, a pojo of the specified type populated with the data

set

public void set(T content)

Assigns your custom POJO as the content.

Specified by:

set in interface ContentHandle<T>

Specified by:

set in class com.marklogic.client.impl.JacksonBaseHandle<T>

Parameters:

content - your custom POJO

with

public JacksonDatabindHandle<T> with(T content)

Assigns a your custom POJO as the content and returns the handle.

Parameters:

content - your custom POJO

Returns:

the handle

getContentClass

public java.lang.Class<T> 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<T>

Returns:

the class for the handled content

newHandle

public JacksonDatabindHandle<T> 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<T,java.io.InputStream>

Specified by:

newHandle in interface ContentHandle<T>

Specified by:

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

Returns:

the new handle

newHandleArray

public JacksonDatabindHandle<T>[] 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<T,java.io.InputStream>

Specified by:

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

Parameters:

length - the number of positions in the array

Returns:

the uninitialized array

getMapper

public com.fasterxml.jackson.databind.ObjectMapper getMapper()

Provides access to the ObjectMapper used internally so you can configure it to fit your JSON.

Overrides:

getMapper in class com.marklogic.client.impl.JacksonBaseHandle<T>

Returns:

the ObjectMapper instance

setMapper

public void setMapper(com.fasterxml.jackson.databind.ObjectMapper mapper)

Enables clients to specify their own ObjectMapper instance, including databinding mappers for formats other than JSON. For example:

ObjectMapper mapper = new CsvMapper();
mapper.configure(JsonGenerator.Feature.AUTO_CLOSE_TARGET, false);
mapper.configure(JsonParser.Feature.AUTO_CLOSE_SOURCE, false);
handle.setMapper(mapper);
 

Use at your own risk! Note that you most likely want to set to false the two options we demonstrate above (JsonGenerator.Feature.AUTO_CLOSE_TARGET and JsonParser.Feature.AUTO_CLOSE_SOURCE) as we do so your mapper will not close streams which we may need to reuse if we have to resend a network request.

Overrides:

setMapper in class com.marklogic.client.impl.JacksonBaseHandle<T>

toContent

public T toContent(java.io.InputStream serialization)

Description copied from interface: BufferableContentHandle

Converts the serialization to the content representation.

Specified by:

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

Specified by:

toContent in class com.marklogic.client.impl.JacksonBaseHandle<T>

Parameters:

serialization - a serialization of the content

Returns:

the content representation

hasContent

protected boolean hasContent()

Specified by:

hasContent in class com.marklogic.client.impl.JacksonBaseHandle<T>

sendContent

protected OutputStreamSender sendContent()

Overrides:

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

sendContent

protected OutputStreamSender sendContent(T content)

Specified by:

sendContent in class com.marklogic.client.impl.JacksonBaseHandle<T>

receiveContent

protected void receiveContent(java.io.InputStream content)

Overrides:

receiveContent 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