org.apache.camel.model.dataformat

Class JaxbDataFormat

java.lang.Object

org.apache.camel.model.IdentifiedType

org.apache.camel.model.DataFormatDefinition

org.apache.camel.model.dataformat.JaxbDataFormat

All Implemented Interfaces:

DefinitionPropertyPlaceholderConfigurer, OtherAttributesAware, org.apache.camel.spi.PropertyConfigurer, org.apache.camel.spi.PropertyPlaceholderConfigurer

@Metadata(firstVersion="1.0.0",
          label="dataformat,transformation,xml",
          title="JAXB")
public class JaxbDataFormat
extends DataFormatDefinition

JAXB data format uses the JAXB2 XML marshalling standard to unmarshal an XML payload into Java objects or to marshal Java objects into an XML payload.

Constructor Summary

Constructors

Constructor and Description
JaxbDataFormat()
JaxbDataFormat(boolean prettyPrint)

Method Summary

Modifier and Type	Method and Description
String	getContextPath()
String	getEncoding()
Boolean	getFilterNonXmlChars()
Boolean	getFragment()
Boolean	getIgnoreJAXBElement()
String	getJaxbProviderProperties()
Boolean	getMustBeJAXBElement()
String	getNamespacePrefixRef()
String	getNoNamespaceSchemaLocation()
Boolean	getObjectFactory()
String	getPartClass()
String	getPartNamespace()
Boolean	getPrettyPrint()
String	getSchema()
String	getSchemaLocation()
Integer	getSchemaSeverityLevel()
String	getXmlStreamWriterWrapper()
void	setContextPath(String contextPath) Package name where your JAXB classes are located.
void	setEncoding(String encoding) To overrule and use a specific encoding
void	setFilterNonXmlChars(Boolean filterNonXmlChars) To ignore non xml characheters and replace them with an empty space.
void	setFragment(Boolean fragment) To turn on marshalling XML fragment trees.
void	setIgnoreJAXBElement(Boolean ignoreJAXBElement) Whether to ignore JAXBElement elements - only needed to be set to false in very special use-cases.
void	setJaxbProviderProperties(String jaxbProviderProperties) Refers to a custom java.util.Map to lookup in the registry containing custom JAXB provider properties to be used with the JAXB marshaller.
void	setMustBeJAXBElement(Boolean mustBeJAXBElement) Whether marhsalling must be java objects with JAXB annotations.
void	setNamespacePrefixRef(String namespacePrefixRef) When marshalling using JAXB or SOAP then the JAXB implementation will automatic assign namespace prefixes, such as ns2, ns3, ns4 etc.
void	setNoNamespaceSchemaLocation(String schemaLocation) To define the location of the namespaceless schema
void	setObjectFactory(Boolean objectFactory) Whether to allow using ObjectFactory classes to create the POJO classes during marshalling.
void	setPartClass(String partClass) Name of class used for fragment parsing.
void	setPartNamespace(String partNamespace) XML namespace to use for fragment parsing.
void	setPrettyPrint(Boolean prettyPrint) To enable pretty printing output nicely formatted.
void	setSchema(String schema) To validate against an existing schema.
void	setSchemaLocation(String schemaLocation) To define the location of the schema
void	setSchemaSeverityLevel(Integer schemaSeverityLevel) Sets the schema severity level to use when validating against a schema.
void	setXmlStreamWriterWrapper(String xmlStreamWriterWrapperRef) To use a custom xml stream writer.

Methods inherited from class org.apache.camel.model.DataFormatDefinition

getContentTypeHeader, getDataFormat, getDataFormatName, getOtherAttributes, getShortName, setContentTypeHeader, setDataFormat, setDataFormatName, setOtherAttributes

Methods inherited from class org.apache.camel.model.IdentifiedType

getId, setId

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.model.DefinitionPropertyPlaceholderConfigurer

getReadPropertyPlaceholderOptions, getWritePropertyPlaceholderOptions

Constructor Detail

JaxbDataFormat

public JaxbDataFormat()

JaxbDataFormat

public JaxbDataFormat(boolean prettyPrint)

Method Detail

getContextPath

public String getContextPath()

setContextPath

public void setContextPath(String contextPath)

Package name where your JAXB classes are located.

getSchema

public String getSchema()

setSchema

public void setSchema(String schema)

To validate against an existing schema. Your can use the prefix classpath:, file:* or *http: to specify how the resource should by resolved. You can separate multiple schema files by using the ',' character.

getSchemaSeverityLevel

public Integer getSchemaSeverityLevel()

setSchemaSeverityLevel

public void setSchemaSeverityLevel(Integer schemaSeverityLevel)

Sets the schema severity level to use when validating against a schema. This level determines the minimum severity error that triggers JAXB to stop continue parsing. The default value of 0 (warning) means that any error (warning, error or fatal error) will trigger JAXB to stop. There are the following three levels: 0=warning, 1=error, 2=fatal error.

getPrettyPrint

public Boolean getPrettyPrint()

setPrettyPrint

public void setPrettyPrint(Boolean prettyPrint)

To enable pretty printing output nicely formatted.

Is by default false.

getObjectFactory

public Boolean getObjectFactory()

setObjectFactory

public void setObjectFactory(Boolean objectFactory)

Whether to allow using ObjectFactory classes to create the POJO classes during marshalling. This only applies to POJO classes that has not been annotated with JAXB and providing jaxb.index descriptor files.

getIgnoreJAXBElement

public Boolean getIgnoreJAXBElement()

setIgnoreJAXBElement

public void setIgnoreJAXBElement(Boolean ignoreJAXBElement)

Whether to ignore JAXBElement elements - only needed to be set to false in very special use-cases.

getMustBeJAXBElement

public Boolean getMustBeJAXBElement()

setMustBeJAXBElement

public void setMustBeJAXBElement(Boolean mustBeJAXBElement)

Whether marhsalling must be java objects with JAXB annotations. And if not then it fails. This option can be set to false to relax that, such as when the data is already in XML format.

setFragment

public void setFragment(Boolean fragment)

To turn on marshalling XML fragment trees. By default JAXB looks for @XmlRootElement annotation on given class to operate on whole XML tree. This is useful but not always - sometimes generated code does not have @XmlRootElement annotation, sometimes you need unmarshall only part of tree. In that case you can use partial unmarshalling. To enable this behaviours you need set property partClass. Camel will pass this class to JAXB's unmarshaler.

getFragment

public Boolean getFragment()

getFilterNonXmlChars

public Boolean getFilterNonXmlChars()

setFilterNonXmlChars

public void setFilterNonXmlChars(Boolean filterNonXmlChars)

To ignore non xml characheters and replace them with an empty space.

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encoding)

To overrule and use a specific encoding

getPartClass

public String getPartClass()

setPartClass

public void setPartClass(String partClass)

Name of class used for fragment parsing.

See more details at the fragment option.

getPartNamespace

public String getPartNamespace()

setPartNamespace

public void setPartNamespace(String partNamespace)

XML namespace to use for fragment parsing.

See more details at the fragment option.

getNamespacePrefixRef

public String getNamespacePrefixRef()

setNamespacePrefixRef

public void setNamespacePrefixRef(String namespacePrefixRef)

When marshalling using JAXB or SOAP then the JAXB implementation will automatic assign namespace prefixes, such as ns2, ns3, ns4 etc. To control this mapping, Camel allows you to refer to a map which contains the desired mapping.

getXmlStreamWriterWrapper

public String getXmlStreamWriterWrapper()

setXmlStreamWriterWrapper

public void setXmlStreamWriterWrapper(String xmlStreamWriterWrapperRef)

To use a custom xml stream writer.

getSchemaLocation

public String getSchemaLocation()

setSchemaLocation

public void setSchemaLocation(String schemaLocation)

To define the location of the schema

getNoNamespaceSchemaLocation

public String getNoNamespaceSchemaLocation()

setNoNamespaceSchemaLocation

public void setNoNamespaceSchemaLocation(String schemaLocation)

To define the location of the namespaceless schema

getJaxbProviderProperties

public String getJaxbProviderProperties()

setJaxbProviderProperties

public void setJaxbProviderProperties(String jaxbProviderProperties)

Refers to a custom java.util.Map to lookup in the registry containing custom JAXB provider properties to be used with the JAXB marshaller.