org.apache.camel.component.jackson

Class JacksonDataFormat

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.component.jackson.JacksonDataFormat

All Implemented Interfaces:

org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.DataFormat, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

Direct Known Subclasses:

ListJacksonDataFormat

public class JacksonDataFormat
extends org.apache.camel.support.ServiceSupport
implements org.apache.camel.spi.DataFormat

A data format (DataFormat) using Jackson to marshal to and from JSON.

Field Summary

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
JacksonDataFormat() Use the default Jackson ObjectMapper and Map
JacksonDataFormat(Class<?> unmarshalType) Use the default Jackson ObjectMapper and with a custom unmarshal type
JacksonDataFormat(Class<?> unmarshalType, Class<?> jsonView) Use the default Jackson ObjectMapper and with a custom unmarshal type and JSON view
JacksonDataFormat(com.fasterxml.jackson.databind.ObjectMapper mapper, Class<?> unmarshalType) Use a custom Jackson mapper and and unmarshal type
JacksonDataFormat(com.fasterxml.jackson.databind.ObjectMapper mapper, Class<?> unmarshalType, Class<?> jsonView) Use a custom Jackson mapper, unmarshal type and JSON view

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doStart()
protected void	doStop()
Class<? extends Collection>	getCollectionType()
String	getInclude()
Class<?>	getJsonView()
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
Class<?>	getUnmarshalType()
boolean	isAllowJmsType()
boolean	isPrettyPrint()
boolean	isUseList()
void	marshal(org.apache.camel.Exchange exchange, Object graph, OutputStream stream)
void	setAllowJmsType(boolean allowJmsType) Allows jackson to use the JMSType header as an indicator what the classname is for unmarshaling json content to POJO By default this option is false.
void	setCollectionType(Class<? extends Collection> collectionType)
void	setInclude(String include)
void	setJsonView(Class<?> jsonView)
void	setPrettyPrint(boolean prettyPrint)
void	setUnmarshalType(Class<?> unmarshalType)
void	setUseList(boolean useList)
Object	unmarshal(org.apache.camel.Exchange exchange, InputStream stream)
void	useList() Uses ArrayList when unmarshalling.
void	useMap() Uses HashMap when unmarshalling.

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

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

Constructor Detail

JacksonDataFormat

public JacksonDataFormat()

Use the default Jackson ObjectMapper and Map

JacksonDataFormat

public JacksonDataFormat(Class<?> unmarshalType)

Use the default Jackson ObjectMapper and with a custom unmarshal type

Parameters:

unmarshalType - the custom unmarshal type

JacksonDataFormat

public JacksonDataFormat(Class<?> unmarshalType,
                 Class<?> jsonView)

Use the default Jackson ObjectMapper and with a custom unmarshal type and JSON view

Parameters:

unmarshalType - the custom unmarshal type

jsonView - marker class to specify properties to be included during marshalling. See also http://wiki.fasterxml.com/JacksonJsonViews

JacksonDataFormat

public JacksonDataFormat(com.fasterxml.jackson.databind.ObjectMapper mapper,
                 Class<?> unmarshalType)

Use a custom Jackson mapper and and unmarshal type

Parameters:

mapper - the custom mapper

unmarshalType - the custom unmarshal type

JacksonDataFormat

public JacksonDataFormat(com.fasterxml.jackson.databind.ObjectMapper mapper,
                 Class<?> unmarshalType,
                 Class<?> jsonView)

Use a custom Jackson mapper, unmarshal type and JSON view

Parameters:

mapper - the custom mapper

unmarshalType - the custom unmarshal type

jsonView - marker class to specify properties to be included during marshalling. See also http://wiki.fasterxml.com/JacksonJsonViews

Method Detail

marshal

public void marshal(org.apache.camel.Exchange exchange,
           Object graph,
           OutputStream stream)
             throws Exception

Specified by:

marshal in interface org.apache.camel.spi.DataFormat

Throws:

Exception

unmarshal

public Object unmarshal(org.apache.camel.Exchange exchange,
               InputStream stream)
                 throws Exception

Specified by:

unmarshal in interface org.apache.camel.spi.DataFormat

Throws:

Exception

getUnmarshalType

public Class<?> getUnmarshalType()

setUnmarshalType

public void setUnmarshalType(Class<?> unmarshalType)

getCollectionType

public Class<? extends Collection> getCollectionType()

setCollectionType

public void setCollectionType(Class<? extends Collection> collectionType)

getJsonView

public Class<?> getJsonView()

setJsonView

public void setJsonView(Class<?> jsonView)

getObjectMapper

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

getInclude

public String getInclude()

setInclude

public void setInclude(String include)

isAllowJmsType

public boolean isAllowJmsType()

isPrettyPrint

public boolean isPrettyPrint()

setPrettyPrint

public void setPrettyPrint(boolean prettyPrint)

isUseList

public boolean isUseList()

setUseList

public void setUseList(boolean useList)

useList

public void useList()

Uses ArrayList when unmarshalling.

useMap

public void useMap()

Uses HashMap when unmarshalling.

setAllowJmsType

public void setAllowJmsType(boolean allowJmsType)

Allows jackson to use the JMSType header as an indicator what the classname is for unmarshaling json content to POJO

By default this option is false.

doStart

protected void doStart()
                throws Exception

Specified by:

doStart in class org.apache.camel.support.ServiceSupport

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Specified by:

doStop in class org.apache.camel.support.ServiceSupport

Throws:

Exception