Spring Framework

org.springframework.oxm.jaxb
Class Jaxb2Marshaller

java.lang.Object
  extended by org.springframework.oxm.jaxb.Jaxb2Marshaller
All Implemented Interfaces:
Aware, BeanClassLoaderAware, InitializingBean, ResourceLoaderAware, GenericMarshaller, GenericUnmarshaller, Marshaller, MimeMarshaller, MimeUnmarshaller, Unmarshaller

public class Jaxb2Marshaller
extends java.lang.Object
implements MimeMarshaller, MimeUnmarshaller, GenericMarshaller, GenericUnmarshaller, BeanClassLoaderAware, ResourceLoaderAware, InitializingBean

Implementation of the Marshaller interface for JAXB 2.0.

The typical usage will be to set either the contextPath or the classesToBeBound property on this bean, possibly customize the marshaller and unmarshaller by setting properties, schemas, adapters, and listeners, and to refer to it.

Since:
3.0
Author:
Arjen Poutsma
See Also:
setContextPath(String), setClassesToBeBound(Class[]), setJaxbContextProperties(Map), setMarshallerProperties(Map), setUnmarshallerProperties(Map), setSchema(Resource), setSchemas(Resource[]), setMarshallerListener(javax.xml.bind.Marshaller.Listener), setUnmarshallerListener(javax.xml.bind.Unmarshaller.Listener), setAdapters(XmlAdapter[])

Field Summary
protected  org.apache.commons.logging.Log logger
          Logger available to subclasses.
 
Constructor Summary
Jaxb2Marshaller()
           
 
Method Summary
 void afterPropertiesSet()
          Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
protected  XmlMappingException convertJaxbException(javax.xml.bind.JAXBException ex)
          Convert the given JAXBException to an appropriate exception from the org.springframework.oxm hierarchy.
protected  javax.xml.bind.Marshaller createMarshaller()
          Return a newly created JAXB marshaller.
protected  javax.xml.bind.Unmarshaller createUnmarshaller()
          Return a newly created JAXB unmarshaller.
 java.lang.Class<?>[] getClassesToBeBound()
          Return the list of Java classes to be recognized by a newly created JAXBContext.
 java.lang.String getContextPath()
          Return the JAXB context path.
protected  javax.xml.bind.JAXBContext getJaxbContext()
           
 java.lang.String[] getPackagesToScan()
          Returns the packages to search for JAXB2 annotations.
protected  void initJaxbMarshaller(javax.xml.bind.Marshaller marshaller)
          Template method that can be overridden by concrete JAXB marshallers for custom initialization behavior.
protected  void initJaxbUnmarshaller(javax.xml.bind.Unmarshaller unmarshaller)
          Template method that can be overridden by concrete JAXB marshallers for custom initialization behavior.
 void marshal(java.lang.Object graph, javax.xml.transform.Result result)
          Marshals the object graph with the given root into the provided Result.
 void marshal(java.lang.Object graph, javax.xml.transform.Result result, MimeContainer mimeContainer)
          Marshals the object graph with the given root into the provided Result, writing binary data to a MimeContainer.
 void setAdapters(javax.xml.bind.annotation.adapters.XmlAdapter<?,?>[] adapters)
          Specify the XmlAdapters to be registered with the JAXB Marshaller and Unmarshaller
 void setBeanClassLoader(java.lang.ClassLoader classLoader)
          Callback that supplies the bean class loader to a bean instance.
 void setClassesToBeBound(java.lang.Class<?>... classesToBeBound)
          Set the list of Java classes to be recognized by a newly created JAXBContext.
 void setContextPath(java.lang.String contextPath)
          Set a JAXB context path.
 void setContextPaths(java.lang.String... contextPaths)
          Set multiple JAXB context paths.
 void setJaxbContextProperties(java.util.Map<java.lang.String,?> jaxbContextProperties)
          Set the JAXBContext properties.
 void setLazyInit(boolean lazyInit)
          Set whether to lazily initialize the JAXBContext for this marshaller.
 void setMarshallerListener(javax.xml.bind.Marshaller.Listener marshallerListener)
          Specify the Marshaller.Listener to be registered with the JAXB Marshaller.
 void setMarshallerProperties(java.util.Map<java.lang.String,?> properties)
          Set the JAXB Marshaller properties.
 void setMtomEnabled(boolean mtomEnabled)
          Specify whether MTOM support should be enabled or not.
 void setPackagesToScan(java.lang.String[] packagesToScan)
          Set the packages to search using Spring-based scanning for classes with JAXB2 annotations in the classpath.
 void setResourceLoader(ResourceLoader resourceLoader)
          Set the ResourceLoader that this object runs in.
 void setSchema(Resource schemaResource)
          Set the schema resource to use for validation.
 void setSchemaLanguage(java.lang.String schemaLanguage)
          Set the schema language.
 void setSchemaResourceResolver(org.w3c.dom.ls.LSResourceResolver schemaResourceResolver)
          Sets the resource resolver, as used to load the schema resources.
 void setSchemas(Resource[] schemaResources)
          Set the schema resources to use for validation.
 void setSupportJaxbElementClass(boolean supportJaxbElementClass)
          Specify whether the supports(Class) returns true for the JAXBElement class.
 void setUnmarshallerListener(javax.xml.bind.Unmarshaller.Listener unmarshallerListener)
          Set the Unmarshaller.Listener to be registered with the JAXB Unmarshaller.
 void setUnmarshallerProperties(java.util.Map<java.lang.String,?> properties)
          Set the JAXB Unmarshaller properties.
 void setValidationEventHandler(javax.xml.bind.ValidationEventHandler validationEventHandler)
          Set the JAXB validation event handler.
 boolean supports(java.lang.Class<?> clazz)
          Indicates whether this marshaller can marshal instances of the supplied type.
 boolean supports(java.lang.reflect.Type genericType)
          Indicates whether this marshaller can marshal instances of the supplied generic type.
 java.lang.Object unmarshal(javax.xml.transform.Source source)
          Unmarshals the given Source into an object graph.
 java.lang.Object unmarshal(javax.xml.transform.Source source, MimeContainer mimeContainer)
          Unmarshals the given provided Source into an object graph, reading binary attachments from a MimeContainer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

logger

protected final org.apache.commons.logging.Log logger
Logger available to subclasses.

Constructor Detail

Jaxb2Marshaller

public Jaxb2Marshaller()
Method Detail

setContextPaths

public void setContextPaths(java.lang.String... contextPaths)
Set multiple JAXB context paths. The given array of context paths is converted to a colon-delimited string, as supported by JAXB.


setContextPath

public void setContextPath(java.lang.String contextPath)
Set a JAXB context path.

Setting this property, "classesToBeBound", or "packagesToScan" is required.


getContextPath

public java.lang.String getContextPath()
Return the JAXB context path.


setClassesToBeBound

public void setClassesToBeBound(java.lang.Class<?>... classesToBeBound)
Set the list of Java classes to be recognized by a newly created JAXBContext.

Setting this property, "contextPath", or "packagesToScan" is required.


getClassesToBeBound

public java.lang.Class<?>[] getClassesToBeBound()
Return the list of Java classes to be recognized by a newly created JAXBContext.


setPackagesToScan

public void setPackagesToScan(java.lang.String[] packagesToScan)
Set the packages to search using Spring-based scanning for classes with JAXB2 annotations in the classpath.

Setting this property, "contextPath", or "classesToBeBound" is required. This is analogous to Spring's component-scan feature (ClassPathBeanDefinitionScanner).


getPackagesToScan

public java.lang.String[] getPackagesToScan()
Returns the packages to search for JAXB2 annotations.


setJaxbContextProperties

public void setJaxbContextProperties(java.util.Map<java.lang.String,?> jaxbContextProperties)
Set the JAXBContext properties. These implementation-specific properties will be set on the underlying JAXBContext.


setMarshallerProperties

public void setMarshallerProperties(java.util.Map<java.lang.String,?> properties)
Set the JAXB Marshaller properties. These properties will be set on the underlying JAXB Marshaller, and allow for features such as indentation.

Parameters:
properties - the properties
See Also:
Marshaller.setProperty(String,Object), Marshaller.JAXB_ENCODING, Marshaller.JAXB_FORMATTED_OUTPUT, Marshaller.JAXB_NO_NAMESPACE_SCHEMA_LOCATION, Marshaller.JAXB_SCHEMA_LOCATION

setUnmarshallerProperties

public void setUnmarshallerProperties(java.util.Map<java.lang.String,?> properties)
Set the JAXB Unmarshaller properties. These properties will be set on the underlying JAXB Unmarshaller.

Parameters:
properties - the properties
See Also:
Unmarshaller.setProperty(String,Object)

setMarshallerListener

public void setMarshallerListener(javax.xml.bind.Marshaller.Listener marshallerListener)
Specify the Marshaller.Listener to be registered with the JAXB Marshaller.


setUnmarshallerListener

public void setUnmarshallerListener(javax.xml.bind.Unmarshaller.Listener unmarshallerListener)
Set the Unmarshaller.Listener to be registered with the JAXB Unmarshaller.


setValidationEventHandler

public void setValidationEventHandler(javax.xml.bind.ValidationEventHandler validationEventHandler)
Set the JAXB validation event handler. This event handler will be called by JAXB if any validation errors are encountered during calls to any of the marshal APIs.


setAdapters

public void setAdapters(javax.xml.bind.annotation.adapters.XmlAdapter<?,?>[] adapters)
Specify the XmlAdapters to be registered with the JAXB Marshaller and Unmarshaller


setSchema

public void setSchema(Resource schemaResource)
Set the schema resource to use for validation.


setSchemas

public void setSchemas(Resource[] schemaResources)
Set the schema resources to use for validation.


setSchemaLanguage

public void setSchemaLanguage(java.lang.String schemaLanguage)
Set the schema language. Default is the W3C XML Schema: http://www.w3.org/2001/XMLSchema".

See Also:
XMLConstants.W3C_XML_SCHEMA_NS_URI, XMLConstants.RELAXNG_NS_URI

setSchemaResourceResolver

public void setSchemaResourceResolver(org.w3c.dom.ls.LSResourceResolver schemaResourceResolver)
Sets the resource resolver, as used to load the schema resources.

See Also:
SchemaFactory.setResourceResolver(org.w3c.dom.ls.LSResourceResolver), setSchema(Resource), setSchemas(Resource[])

setMtomEnabled

public void setMtomEnabled(boolean mtomEnabled)
Specify whether MTOM support should be enabled or not. Default is false: marshalling using XOP/MTOM not being enabled.


setLazyInit

public void setLazyInit(boolean lazyInit)
Set whether to lazily initialize the JAXBContext for this marshaller. Default is false to initialize on startup; can be switched to true.

Early initialization just applies if afterPropertiesSet() is called.


setSupportJaxbElementClass

public void setSupportJaxbElementClass(boolean supportJaxbElementClass)
Specify whether the supports(Class) returns true for the JAXBElement class.

Default is false, meaning that supports(Class) always returns false for JAXBElement classes (though supports(Type) can return true, since it can obtain the type parameters of JAXBElement).

This property is typically enabled in combination with usage of classes like MarshallingView, since the ModelAndView does not offer type parameter information at runtime.

See Also:
supports(Class), supports(Type)

setBeanClassLoader

public void setBeanClassLoader(java.lang.ClassLoader classLoader)
Description copied from interface: BeanClassLoaderAware
Callback that supplies the bean class loader to a bean instance.

Invoked after the population of normal bean properties but before an initialization callback such as InitializingBean's InitializingBean.afterPropertiesSet() method or a custom init-method.

Specified by:
setBeanClassLoader in interface BeanClassLoaderAware
Parameters:
classLoader - the owning class loader; may be null in which case a default ClassLoader must be used, for example the ClassLoader obtained via ClassUtils.getDefaultClassLoader()

setResourceLoader

public void setResourceLoader(ResourceLoader resourceLoader)
Description copied from interface: ResourceLoaderAware
Set the ResourceLoader that this object runs in.

This might be a ResourcePatternResolver, which can be checked through instanceof ResourcePatternResolver. See also the ResourcePatternUtils.getResourcePatternResolver method.

Invoked after population of normal bean properties but before an init callback like InitializingBean's afterPropertiesSet or a custom init-method. Invoked before ApplicationContextAware's setApplicationContext.

Specified by:
setResourceLoader in interface ResourceLoaderAware
Parameters:
resourceLoader - ResourceLoader object to be used by this object
See Also:
ResourcePatternResolver, ResourcePatternUtils.getResourcePatternResolver(org.springframework.core.io.ResourceLoader)

afterPropertiesSet

public final void afterPropertiesSet()
                              throws java.lang.Exception
Description copied from interface: InitializingBean
Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.

Specified by:
afterPropertiesSet in interface InitializingBean
Throws:
java.lang.Exception - in the event of misconfiguration (such as failure to set an essential property) or if initialization fails.

getJaxbContext

protected javax.xml.bind.JAXBContext getJaxbContext()

supports

public boolean supports(java.lang.Class<?> clazz)
Description copied from interface: Marshaller
Indicates whether this marshaller can marshal instances of the supplied type.

Specified by:
supports in interface Marshaller
Specified by:
supports in interface Unmarshaller
Parameters:
clazz - the class that this marshaller is being asked if it can marshal
Returns:
true if this marshaller can indeed marshal instances of the supplied class; false otherwise

supports

public boolean supports(java.lang.reflect.Type genericType)
Description copied from interface: GenericMarshaller
Indicates whether this marshaller can marshal instances of the supplied generic type.

Specified by:
supports in interface GenericMarshaller
Specified by:
supports in interface GenericUnmarshaller
Parameters:
genericType - the type that this marshaller is being asked if it can marshal
Returns:
true if this marshaller can indeed marshal instances of the supplied type; false otherwise

marshal

public void marshal(java.lang.Object graph,
                    javax.xml.transform.Result result)
             throws XmlMappingException
Description copied from interface: Marshaller
Marshals the object graph with the given root into the provided Result.

Specified by:
marshal in interface Marshaller
Parameters:
graph - the root of the object graph to marshal
result - the result to marshal to
Throws:
XmlMappingException - if the given object cannot be marshalled to the result

marshal

public void marshal(java.lang.Object graph,
                    javax.xml.transform.Result result,
                    MimeContainer mimeContainer)
             throws XmlMappingException
Description copied from interface: MimeMarshaller
Marshals the object graph with the given root into the provided Result, writing binary data to a MimeContainer.

Specified by:
marshal in interface MimeMarshaller
Parameters:
graph - the root of the object graph to marshal
result - the result to marshal to
mimeContainer - the MIME container to write extracted binary content to
Throws:
XmlMappingException - if the given object cannot be marshalled to the result

createMarshaller

protected javax.xml.bind.Marshaller createMarshaller()
Return a newly created JAXB marshaller. JAXB marshallers are not necessarily thread safe.


initJaxbMarshaller

protected void initJaxbMarshaller(javax.xml.bind.Marshaller marshaller)
                           throws javax.xml.bind.JAXBException
Template method that can be overridden by concrete JAXB marshallers for custom initialization behavior. Gets called after creation of JAXB Marshaller, and after the respective properties have been set.

The default implementation sets the defined properties, the validation event handler, the schemas, listener, and adapters.

Throws:
javax.xml.bind.JAXBException

unmarshal

public java.lang.Object unmarshal(javax.xml.transform.Source source)
                           throws XmlMappingException
Description copied from interface: Unmarshaller
Unmarshals the given Source into an object graph.

Specified by:
unmarshal in interface Unmarshaller
Parameters:
source - the source to marshal from
Returns:
the object graph
Throws:
XmlMappingException - if the given source cannot be mapped to an object

unmarshal

public java.lang.Object unmarshal(javax.xml.transform.Source source,
                                  MimeContainer mimeContainer)
                           throws XmlMappingException
Description copied from interface: MimeUnmarshaller
Unmarshals the given provided Source into an object graph, reading binary attachments from a MimeContainer.

Specified by:
unmarshal in interface MimeUnmarshaller
Parameters:
source - the source to marshal from
mimeContainer - the MIME container to read extracted binary content from
Returns:
the object graph
Throws:
XmlMappingException - if the given source cannot be mapped to an object

createUnmarshaller

protected javax.xml.bind.Unmarshaller createUnmarshaller()
Return a newly created JAXB unmarshaller. JAXB unmarshallers are not necessarily thread safe.


initJaxbUnmarshaller

protected void initJaxbUnmarshaller(javax.xml.bind.Unmarshaller unmarshaller)
                             throws javax.xml.bind.JAXBException
Template method that can be overridden by concrete JAXB marshallers for custom initialization behavior. Gets called after creation of JAXB Marshaller, and after the respective properties have been set.

The default implementation sets the defined properties, the validation event handler, the schemas, listener, and adapters.

Throws:
javax.xml.bind.JAXBException

convertJaxbException

protected XmlMappingException convertJaxbException(javax.xml.bind.JAXBException ex)
Convert the given JAXBException to an appropriate exception from the org.springframework.oxm hierarchy.

Parameters:
ex - JAXBException that occured
Returns:
the corresponding XmlMappingException

Spring Framework