Class JacksonXMLDataFormat
- java.lang.Object
-
- org.apache.camel.support.service.BaseService
-
- org.apache.camel.support.service.ServiceSupport
-
- org.apache.camel.component.jacksonxml.JacksonXMLDataFormat
-
- 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.StatefulService
,org.apache.camel.SuspendableService
- Direct Known Subclasses:
ListJacksonXMLDataFormat
@Dataformat("jacksonxml") public class JacksonXMLDataFormat extends org.apache.camel.support.service.ServiceSupport implements org.apache.camel.spi.DataFormat, org.apache.camel.spi.DataFormatName, org.apache.camel.spi.DataFormatContentTypeHeader, org.apache.camel.CamelContextAware
-
-
Constructor Summary
Constructors Constructor Description JacksonXMLDataFormat()
Use the default JacksonXmlMapper
andMap
JacksonXMLDataFormat(com.fasterxml.jackson.dataformat.xml.XmlMapper mapper, Class<?> unmarshalType)
Use a custom Jackson mapper and and unmarshal typeJacksonXMLDataFormat(com.fasterxml.jackson.dataformat.xml.XmlMapper mapper, Class<?> unmarshalType, Class<?> jsonView)
Use a custom Jackson mapper, unmarshal type and JSON viewJacksonXMLDataFormat(Class<?> unmarshalType)
Use the default JacksonXmlMapper
and with a custom unmarshal typeJacksonXMLDataFormat(Class<?> unmarshalType, Class<?> jsonView)
Use the default JacksonXmlMapper
and with a custom unmarshal type and JSON viewJacksonXMLDataFormat(Class<?> unmarshalType, Class<?> jsonView, boolean enableJaxbAnnotationModule)
Use the default JacksonXmlMapper
and with a custom unmarshal type and JSON view
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addModule(com.fasterxml.jackson.databind.Module module)
To use the custom Jackson modulevoid
disableFeature(com.fasterxml.jackson.databind.DeserializationFeature feature)
void
disableFeature(com.fasterxml.jackson.databind.MapperFeature feature)
void
disableFeature(com.fasterxml.jackson.databind.SerializationFeature feature)
protected void
doInit()
protected void
doStart()
protected void
doStop()
void
enableFeature(com.fasterxml.jackson.databind.DeserializationFeature feature)
void
enableFeature(com.fasterxml.jackson.databind.MapperFeature feature)
void
enableFeature(com.fasterxml.jackson.databind.SerializationFeature feature)
org.apache.camel.CamelContext
getCamelContext()
Class<? extends Collection>
getCollectionType()
String
getCollectionTypeName()
String
getDataFormatName()
String
getDisableFeatures()
String
getEnableFeatures()
String
getInclude()
Class<?>
getJsonView()
String
getJsonViewTypeName()
String
getModuleClassNames()
String
getModuleRefs()
List<com.fasterxml.jackson.databind.Module>
getModules()
TimeZone
getTimezone()
Class<?>
getUnmarshalType()
String
getUnmarshalTypeName()
com.fasterxml.jackson.dataformat.xml.XmlMapper
getXmlMapper()
boolean
isAllowJmsType()
boolean
isAllowUnmarshallType()
boolean
isContentTypeHeader()
boolean
isEnableJacksonTypeConverter()
boolean
isEnableJaxbAnnotationModule()
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 XML content to POJOvoid
setAllowUnmarshallType(boolean allowJacksonUnmarshallType)
If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling.void
setCamelContext(org.apache.camel.CamelContext camelContext)
void
setCollectionType(Class<? extends Collection> collectionType)
void
setCollectionTypeName(String collectionTypeName)
void
setContentTypeHeader(boolean contentTypeHeader)
If enabled then Jackson will set the Content-Type header to application/xml when marshalling.void
setDisableFeatures(String disableFeatures)
Set of features to disable on the JacksonXmlMapper
.void
setEnableFeatures(String enableFeatures)
Set of features to enable on the JacksonXmlMapper
.void
setEnableJacksonTypeConverter(boolean enableJacksonTypeConverter)
If enabled then Jackson is allowed to attempt to be used during Camels type converter as aFallbackConverter
that attempts to convert POJOs to/fromMap
/List
types.void
setEnableJaxbAnnotationModule(boolean enableJaxbAnnotationModule)
void
setInclude(String include)
void
setJsonView(Class<?> jsonView)
void
setJsonViewTypeName(String jsonViewTypeName)
void
setModuleClassNames(String moduleClassNames)
To use custom JacksonModule
s specified as a String with FQN class names.void
setModuleRefs(String moduleRefs)
To use custom Jackson modules referred from the Camel registry.void
setModules(List<com.fasterxml.jackson.databind.Module> modules)
To use custom JacksonModule
svoid
setPrettyPrint(boolean prettyPrint)
void
setTimezone(TimeZone timezone)
If set then Jackson will use the Timezone when marshalling/unmarshalling.void
setUnmarshalType(Class<?> unmarshalType)
void
setUnmarshalTypeName(String unmarshalTypeName)
void
setUseList(boolean useList)
void
setXmlMapper(com.fasterxml.jackson.dataformat.xml.XmlMapper xmlMapper)
Object
unmarshal(org.apache.camel.Exchange exchange, InputStream stream)
void
useList()
UsesArrayList
when unmarshalling.void
useMap()
UsesHashMap
when unmarshalling.-
Methods inherited from class org.apache.camel.support.service.BaseService
build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, doSuspend, fail, 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
-
-
-
-
Constructor Detail
-
JacksonXMLDataFormat
public JacksonXMLDataFormat()
Use the default JacksonXmlMapper
andMap
-
JacksonXMLDataFormat
public JacksonXMLDataFormat(Class<?> unmarshalType)
Use the default JacksonXmlMapper
and with a custom unmarshal type- Parameters:
unmarshalType
- the custom unmarshal type
-
JacksonXMLDataFormat
public JacksonXMLDataFormat(Class<?> unmarshalType, Class<?> jsonView)
Use the default JacksonXmlMapper
and with a custom unmarshal type and JSON view- Parameters:
unmarshalType
- the custom unmarshal typejsonView
- marker class to specify properties to be included during marshalling. See also http://wiki.fasterxml.com/JacksonJsonViews
-
JacksonXMLDataFormat
public JacksonXMLDataFormat(Class<?> unmarshalType, Class<?> jsonView, boolean enableJaxbAnnotationModule)
Use the default JacksonXmlMapper
and with a custom unmarshal type and JSON view- Parameters:
unmarshalType
- the custom unmarshal typejsonView
- marker class to specify properties to be included during marshalling. See also http://wiki.fasterxml.com/JacksonJsonViewsenableJaxbAnnotationModule
- if it is true, will enable the JaxbAnnotationModule.
-
JacksonXMLDataFormat
public JacksonXMLDataFormat(com.fasterxml.jackson.dataformat.xml.XmlMapper mapper, Class<?> unmarshalType)
Use a custom Jackson mapper and and unmarshal type- Parameters:
mapper
- the custom mapperunmarshalType
- the custom unmarshal type
-
JacksonXMLDataFormat
public JacksonXMLDataFormat(com.fasterxml.jackson.dataformat.xml.XmlMapper mapper, Class<?> unmarshalType, Class<?> jsonView)
Use a custom Jackson mapper, unmarshal type and JSON view- Parameters:
mapper
- the custom mapperunmarshalType
- the custom unmarshal typejsonView
- marker class to specify properties to be included during marshalling. See also http://wiki.fasterxml.com/JacksonJsonViews
-
-
Method Detail
-
getDataFormatName
public String getDataFormatName()
- Specified by:
getDataFormatName
in interfaceorg.apache.camel.spi.DataFormatName
-
getCamelContext
public org.apache.camel.CamelContext getCamelContext()
- Specified by:
getCamelContext
in interfaceorg.apache.camel.CamelContextAware
-
setCamelContext
public void setCamelContext(org.apache.camel.CamelContext camelContext)
- Specified by:
setCamelContext
in interfaceorg.apache.camel.CamelContextAware
-
marshal
public void marshal(org.apache.camel.Exchange exchange, Object graph, OutputStream stream) throws Exception
- Specified by:
marshal
in interfaceorg.apache.camel.spi.DataFormat
- Throws:
Exception
-
unmarshal
public Object unmarshal(org.apache.camel.Exchange exchange, InputStream stream) throws Exception
- Specified by:
unmarshal
in interfaceorg.apache.camel.spi.DataFormat
- Throws:
Exception
-
getXmlMapper
public com.fasterxml.jackson.dataformat.xml.XmlMapper getXmlMapper()
-
setXmlMapper
public void setXmlMapper(com.fasterxml.jackson.dataformat.xml.XmlMapper xmlMapper)
-
getUnmarshalTypeName
public String getUnmarshalTypeName()
-
setUnmarshalTypeName
public void setUnmarshalTypeName(String unmarshalTypeName)
-
getUnmarshalType
public Class<?> getUnmarshalType()
-
setUnmarshalType
public void setUnmarshalType(Class<?> unmarshalType)
-
getCollectionTypeName
public String getCollectionTypeName()
-
setCollectionTypeName
public void setCollectionTypeName(String collectionTypeName)
-
getCollectionType
public Class<? extends Collection> getCollectionType()
-
setCollectionType
public void setCollectionType(Class<? extends Collection> collectionType)
-
getJsonViewTypeName
public String getJsonViewTypeName()
-
setJsonViewTypeName
public void setJsonViewTypeName(String jsonViewTypeName)
-
getJsonView
public Class<?> getJsonView()
-
setJsonView
public void setJsonView(Class<?> jsonView)
-
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)
-
isEnableJaxbAnnotationModule
public boolean isEnableJaxbAnnotationModule()
-
setEnableJaxbAnnotationModule
public void setEnableJaxbAnnotationModule(boolean enableJaxbAnnotationModule)
-
getModules
public List<com.fasterxml.jackson.databind.Module> getModules()
-
setModules
public void setModules(List<com.fasterxml.jackson.databind.Module> modules)
To use custom JacksonModule
s
-
getModuleClassNames
public String getModuleClassNames()
-
addModule
public void addModule(com.fasterxml.jackson.databind.Module module)
To use the custom Jackson module
-
setModuleClassNames
public void setModuleClassNames(String moduleClassNames)
To use custom JacksonModule
s specified as a String with FQN class names. Multiple classes can be separated by comma.
-
getModuleRefs
public String getModuleRefs()
-
setModuleRefs
public void setModuleRefs(String moduleRefs)
To use custom Jackson modules referred from the Camel registry. Multiple modules can be separated by comma.
-
useList
public void useList()
UsesArrayList
when unmarshalling.
-
useMap
public void useMap()
UsesHashMap
when unmarshalling.
-
setAllowJmsType
public void setAllowJmsType(boolean allowJmsType)
Allows jackson to use the JMSType header as an indicator what the classname is for unmarshaling XML content to POJO By default this option is false.
-
isEnableJacksonTypeConverter
public boolean isEnableJacksonTypeConverter()
-
setEnableJacksonTypeConverter
public void setEnableJacksonTypeConverter(boolean enableJacksonTypeConverter)
If enabled then Jackson is allowed to attempt to be used during Camels type converter as aFallbackConverter
that attempts to convert POJOs to/fromMap
/List
types. This should only be enabled when desired to be used.
-
isAllowUnmarshallType
public boolean isAllowUnmarshallType()
-
setAllowUnmarshallType
public void setAllowUnmarshallType(boolean allowJacksonUnmarshallType)
If enabled then Jackson is allowed to attempt to use the CamelJacksonUnmarshalType header during the unmarshalling. This should only be enabled when desired to be used.
-
isContentTypeHeader
public boolean isContentTypeHeader()
-
setContentTypeHeader
public void setContentTypeHeader(boolean contentTypeHeader)
If enabled then Jackson will set the Content-Type header to application/xml when marshalling.- Specified by:
setContentTypeHeader
in interfaceorg.apache.camel.spi.DataFormatContentTypeHeader
-
getTimezone
public TimeZone getTimezone()
-
setTimezone
public void setTimezone(TimeZone timezone)
If set then Jackson will use the Timezone when marshalling/unmarshalling.
-
getEnableFeatures
public String getEnableFeatures()
-
setEnableFeatures
public void setEnableFeatures(String enableFeatures)
Set of features to enable on the JacksonXmlMapper
. The features should be a name that matches a enum fromSerializationFeature
,DeserializationFeature
, orMapperFeature
.
-
getDisableFeatures
public String getDisableFeatures()
-
setDisableFeatures
public void setDisableFeatures(String disableFeatures)
Set of features to disable on the JacksonXmlMapper
. The features should be a name that matches a enum fromSerializationFeature
,DeserializationFeature
, orMapperFeature
.
-
enableFeature
public void enableFeature(com.fasterxml.jackson.databind.SerializationFeature feature)
-
enableFeature
public void enableFeature(com.fasterxml.jackson.databind.DeserializationFeature feature)
-
enableFeature
public void enableFeature(com.fasterxml.jackson.databind.MapperFeature feature)
-
disableFeature
public void disableFeature(com.fasterxml.jackson.databind.SerializationFeature feature)
-
disableFeature
public void disableFeature(com.fasterxml.jackson.databind.DeserializationFeature feature)
-
disableFeature
public void disableFeature(com.fasterxml.jackson.databind.MapperFeature feature)
-
doInit
protected void doInit() throws Exception
- Overrides:
doInit
in classorg.apache.camel.support.service.BaseService
- Throws:
Exception
-
doStart
protected void doStart() throws Exception
- Overrides:
doStart
in classorg.apache.camel.support.service.BaseService
- Throws:
Exception
-
-