Package org.apache.camel.component.jackson

Class JacksonDataFormat

java.lang.Object

org.apache.camel.support.service.BaseService

org.apache.camel.support.service.ServiceSupport

org.apache.camel.component.jackson.AbstractJacksonDataFormat

org.apache.camel.component.jackson.JacksonDataFormat

All Implemented Interfaces:

AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.DataFormat, org.apache.camel.spi.DataFormatContentTypeHeader, org.apache.camel.spi.DataFormatName, org.apache.camel.spi.HasCamelContext, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

Direct Known Subclasses:

ListJacksonDataFormat

@Dataformat("jackson")
@Metadata(excludeProperties="library,permissions,dateFormatPattern")
public class JacksonDataFormat
extends AbstractJacksonDataFormat

Marshal POJOs to JSON and back using Jackson.

Field Summary

Fields inherited from class org.apache.camel.support.service.BaseService

BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Constructor	Description
JacksonDataFormat()	Use the default Jackson ObjectMapper and Object
JacksonDataFormat(com.fasterxml.jackson.databind.ObjectMapper mapper, Class<?> unmarshalType)	Use a custom Jackson mapper and an unmarshal type
JacksonDataFormat(com.fasterxml.jackson.databind.ObjectMapper mapper, Class<?> unmarshalType, Class<?> jsonView)	Use a custom Jackson mapper, unmarshal type and JSON view
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

Method Summary

Modifier and Type	Method	Description
protected com.fasterxml.jackson.databind.ObjectMapper	createNewObjectMapper()
String	getDataFormatName()
protected String	getDefaultContentType()
protected Class<? extends com.fasterxml.jackson.databind.ObjectMapper>	getObjectMapperClass()

Methods inherited from class org.apache.camel.component.jackson.AbstractJacksonDataFormat

addModule, disableFeature, disableFeature, disableFeature, doInit, doStart, doStop, enableFeature, enableFeature, enableFeature, getCamelContext, getCollectionType, getCollectionTypeName, getDisableFeatures, getEnableFeatures, getInclude, getJsonView, getJsonViewTypeName, getModuleClassNames, getModuleRefs, getModules, getNamingStrategy, getObjectMapper, getSchemaResolver, getTimezone, getUnmarshalType, getUnmarshalTypeName, isAllowJmsType, isAllowUnmarshallType, isAutoDiscoverObjectMapper, isAutoDiscoverSchemaResolver, isCombineUnicodeSurrogates, isContentTypeHeader, isEnableJacksonTypeConverter, isPrettyPrint, isUseDefaultObjectMapper, isUseList, marshal, setAllowJmsType, setAllowUnmarshallType, setAutoDiscoverObjectMapper, setAutoDiscoverSchemaResolver, setCamelContext, setCollectionType, setCollectionTypeName, setCombineUnicodeSurrogates, setContentTypeHeader, setDisableFeatures, setEnableFeatures, setEnableJacksonTypeConverter, setInclude, setJsonView, setJsonViewTypeName, setModuleClassNames, setModuleRefs, setModules, setNamingStrategy, setObjectMapper, setPrettyPrint, setSchemaResolver, setTimezone, setUnmarshalType, setUnmarshalTypeName, setUseDefaultObjectMapper, setUseList, unmarshal, unmarshal, useList, useMap

Methods inherited from class org.apache.camel.support.service.BaseService

build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, doSuspend, fail, getInternalLock, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.Service

build, close, init, start, stop

Methods inherited from interface org.apache.camel.ShutdownableService

shutdown

Methods inherited from interface org.apache.camel.StatefulService

getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

Methods inherited from interface org.apache.camel.SuspendableService

isSuspended, resume, suspend

Constructor Details

JacksonDataFormat

public JacksonDataFormat()

Use the default Jackson ObjectMapper and Object

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

JacksonDataFormat

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

Use a custom Jackson mapper and an 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

Method Details

getDataFormatName

public String getDataFormatName()

Specified by:

getDataFormatName in interface org.apache.camel.spi.DataFormatName

Specified by:

getDataFormatName in class AbstractJacksonDataFormat

createNewObjectMapper

protected com.fasterxml.jackson.databind.ObjectMapper createNewObjectMapper()

Specified by:

createNewObjectMapper in class AbstractJacksonDataFormat

getObjectMapperClass

protected Class<? extends com.fasterxml.jackson.databind.ObjectMapper> getObjectMapperClass()

Specified by:

getObjectMapperClass in class AbstractJacksonDataFormat

getDefaultContentType

protected String getDefaultContentType()

Specified by:

getDefaultContentType in class AbstractJacksonDataFormat