JacksonXMLDataFormat (Camel :: Jackson XML 2.23.1 API)

java.lang.Object
- org.apache.camel.support.ServiceSupport
- - org.apache.camel.component.jacksonxml.JacksonXMLDataFormat

All Implemented Interfaces:

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

Direct Known Subclasses:

ListJacksonXMLDataFormat
```
public class JacksonXMLDataFormat
extends org.apache.camel.support.ServiceSupport
implements org.apache.camel.spi.DataFormat, org.apache.camel.spi.DataFormatName, org.apache.camel.CamelContextAware
```
A data format (DataFormat) using Jackson to marshal to and from XML.

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
`JacksonXMLDataFormat()` Use the default Jackson `XmlMapper` and `Map`
`JacksonXMLDataFormat(Class<?> unmarshalType)` Use the default Jackson `XmlMapper` and with a custom unmarshal type
`JacksonXMLDataFormat(Class<?> unmarshalType, Class<?> jsonView)` Use the default Jackson `XmlMapper` and with a custom unmarshal type and JSON view
`JacksonXMLDataFormat(Class<?> unmarshalType, Class<?> jsonView, boolean enableJaxbAnnotationModule)` Use the default Jackson `XmlMapper` and with a custom unmarshal type and JSON view
`JacksonXMLDataFormat(com.fasterxml.jackson.dataformat.xml.XmlMapper mapper, Class<?> unmarshalType)` Use a custom Jackson mapper and and unmarshal type
`JacksonXMLDataFormat(com.fasterxml.jackson.dataformat.xml.XmlMapper mapper, Class<?> unmarshalType, Class<?> jsonView)` Use a custom Jackson mapper, unmarshal type and JSON view

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addModule(com.fasterxml.jackson.databind.Module module)` To use the custom Jackson module
`void`	`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`	`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`	`getDataFormatName()`
`String`	`getDisableFeatures()`
`String`	`getEnableFeatures()`
`String`	`getInclude()`
`Class<?>`	`getJsonView()`
`String`	`getModuleClassNames()`
`String`	`getModuleRefs()`
`List<com.fasterxml.jackson.databind.Module>`	`getModules()`
`TimeZone`	`getTimezone()`
`Class<?>`	`getUnmarshalType()`
`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 POJO By default this option is `false`.
`void`	`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`	`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 Jackson `XmlMapper`.
`void`	`setEnableFeatures(String enableFeatures)` Set of features to enable on the Jackson `XmlMapper`.
`void`	`setEnableJacksonTypeConverter(boolean enableJacksonTypeConverter)` If enabled then Jackson is allowed to attempt to be used during Camels type converter as a `FallbackConverter` that attempts to convert POJOs to/from `Map`/`List` types.
`void`	`setEnableJaxbAnnotationModule(boolean enableJaxbAnnotationModule)`
`void`	`setInclude(String include)`
`void`	`setJsonView(Class<?> jsonView)`
`void`	`setModuleClassNames(String moduleClassNames)` To use custom Jackson `Module`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 Jackson `Module`s
`void`	`setPrettyPrint(boolean prettyPrint)`
`void`	`setTimezone(TimeZone timezone)` If set then Jackson will use the Timezone when marshalling/unmarshalling.
`void`	`setUnmarshalType(Class<?> unmarshalType)`
`void`	`setUseList(boolean useList)`
`void`	`setXmlMapper(com.fasterxml.jackson.dataformat.xml.XmlMapper xmlMapper)`
`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, 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 Jackson XmlMapper and Map
  - JacksonXMLDataFormat
```
public JacksonXMLDataFormat(Class<?> unmarshalType)
```
    Use the default Jackson XmlMapper and with a custom unmarshal type
    
    Parameters:
    
    unmarshalType - the custom unmarshal type
  - JacksonXMLDataFormat
```
public JacksonXMLDataFormat(Class<?> unmarshalType,
                            Class<?> jsonView)
```
    Use the default Jackson XmlMapper 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
  - JacksonXMLDataFormat
```
public JacksonXMLDataFormat(Class<?> unmarshalType,
                            Class<?> jsonView,
                            boolean enableJaxbAnnotationModule)
```
    Use the default Jackson XmlMapper 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
    
    enableJaxbAnnotationModule - 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 mapper
    
    unmarshalType - 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 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
  - getDataFormatName
```
public String getDataFormatName()
```
    Specified by:
    
    getDataFormatName in interface org.apache.camel.spi.DataFormatName
  - getCamelContext
```
public org.apache.camel.CamelContext getCamelContext()
```
    Specified by:
    
    getCamelContext in interface org.apache.camel.CamelContextAware
  - setCamelContext
```
public void setCamelContext(org.apache.camel.CamelContext camelContext)
```
    Specified by:
    
    setCamelContext in interface org.apache.camel.CamelContextAware
  - 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
  - getXmlMapper
```
public com.fasterxml.jackson.dataformat.xml.XmlMapper getXmlMapper()
```
  - setXmlMapper
```
public void setXmlMapper(com.fasterxml.jackson.dataformat.xml.XmlMapper xmlMapper)
```
  - 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)
```
  - 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 Jackson Modules
  - 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 Jackson Modules 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()
```
    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 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 a FallbackConverter that attempts to convert POJOs to/from Map/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.
  - 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 Jackson XmlMapper. The features should be a name that matches a enum from SerializationFeature, DeserializationFeature, or MapperFeature.
  - getDisableFeatures
```
public String getDisableFeatures()
```
  - setDisableFeatures
```
public void setDisableFeatures(String disableFeatures)
```
    Set of features to disable on the Jackson XmlMapper. The features should be a name that matches a enum from SerializationFeature, DeserializationFeature, or MapperFeature.
  - 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)
```
  - 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

Class JacksonXMLDataFormat

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

JacksonXMLDataFormat

JacksonXMLDataFormat

JacksonXMLDataFormat

JacksonXMLDataFormat

JacksonXMLDataFormat

JacksonXMLDataFormat

Method Detail

getDataFormatName

getCamelContext

setCamelContext

marshal

unmarshal

getXmlMapper

setXmlMapper

getUnmarshalType

setUnmarshalType

getCollectionType

setCollectionType

getJsonView

setJsonView

getInclude

setInclude

isAllowJmsType

isPrettyPrint

setPrettyPrint

isUseList

setUseList

isEnableJaxbAnnotationModule

setEnableJaxbAnnotationModule

getModules

setModules

getModuleClassNames

addModule

setModuleClassNames

getModuleRefs

setModuleRefs

useList

useMap

setAllowJmsType

isEnableJacksonTypeConverter

setEnableJacksonTypeConverter

isAllowUnmarshallType

setAllowUnmarshallType

isContentTypeHeader

setContentTypeHeader

getTimezone

setTimezone

getEnableFeatures

setEnableFeatures

getDisableFeatures

setDisableFeatures

enableFeature

enableFeature

enableFeature

disableFeature

disableFeature

disableFeature

doStart

doStop