org.springframework.oxm.jaxb
Class AbstractJaxbMarshaller

java.lang.Object
  org.springframework.oxm.jaxb.AbstractJaxbMarshaller

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean, Marshaller, Unmarshaller

Direct Known Subclasses:

Jaxb1Marshaller

public abstract class AbstractJaxbMarshaller
extends java.lang.Object
implements Marshaller, Unmarshaller, org.springframework.beans.factory.InitializingBean

Abstract base class for implementations of the Marshaller and Unmarshaller interfaces that use JAXB. This base class is responsible for creating JAXB marshallers from a JAXBContext.

JAXB 2.0 added breaking API changes, so specific subclasses must be used for JAXB 1.0 and 2.0 (Jaxb1Marshaller and Jaxb2Marshaller respectivaly).

Since:

1.0.0

Author:

Arjen Poutsma

See Also:

Jaxb1Marshaller, Jaxb2Marshaller

Field Summary

protected org.apache.commons.logging.Log

logger Logger available to subclasses.

Constructor Summary

AbstractJaxbMarshaller()

Method Summary

void	afterPropertiesSet()
protected XmlMappingException	convertJaxbException(javax.xml.bind.JAXBException ex) Convert the given JAXBException to an appropriate exception from the org.springframework.oxm hierarchy.
protected abstract javax.xml.bind.JAXBContext	createJaxbContext() Template method that returns a newly created JAXB context.
protected javax.xml.bind.Marshaller	createMarshaller() Returns a newly created JAXB marshaller.
protected javax.xml.bind.Unmarshaller	createUnmarshaller() Returns a newly created JAXB unmarshaller.
protected java.lang.String	getContextPath() Returns the JAXB Context path.
javax.xml.bind.JAXBContext	getJaxbContext() Returns the JAXBContext created in afterPropertiesSet().
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 overridden by concrete JAXB marshallers for custom initialization behavior.
void	setContextPath(java.lang.String contextPath) Sets the JAXB Context path.
void	setContextPaths(java.lang.String[] contextPaths) Sets multiple JAXB Context paths.
void	setMarshallerProperties(java.util.Map properties) Sets the JAXB Marshaller properties.
void	setUnmarshallerProperties(java.util.Map properties) Sets the JAXB Unmarshaller properties.
void	setValidationEventHandler(javax.xml.bind.ValidationEventHandler validationEventHandler) Sets the JAXB validation event handler.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.oxm.Marshaller

marshal, supports

Methods inherited from interface org.springframework.oxm.Unmarshaller

supports, unmarshal

Field Detail

logger

protected final org.apache.commons.logging.Log logger

Logger available to subclasses.

Constructor Detail

AbstractJaxbMarshaller

public AbstractJaxbMarshaller()

Method Detail

getContextPath

protected java.lang.String getContextPath()

Returns the JAXB Context path.

setContextPath

public void setContextPath(java.lang.String contextPath)

Sets the JAXB Context path.

setContextPaths

public void setContextPaths(java.lang.String[] contextPaths)

Sets multiple JAXB Context paths. The given array of context paths is converted to a colon-delimited string, as supported by JAXB.

setMarshallerProperties

public void setMarshallerProperties(java.util.Map properties)

Sets 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 properties)

Sets the JAXB Unmarshaller properties. These properties will be set on the underlying JAXB Unmarshaller.

Parameters:

properties - the properties

See Also:

Unmarshaller.setProperty(String,Object)

setValidationEventHandler

public void setValidationEventHandler(javax.xml.bind.ValidationEventHandler validationEventHandler)

Sets 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 API's.

Parameters:

validationEventHandler - the event handler

getJaxbContext

public javax.xml.bind.JAXBContext getJaxbContext()

Returns the JAXBContext created in afterPropertiesSet().

afterPropertiesSet

public final void afterPropertiesSet()
                              throws java.lang.Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

java.lang.Exception

convertJaxbException

protected XmlMappingException convertJaxbException(javax.xml.bind.JAXBException ex)

Convert the given JAXBException to an appropriate exception from the org.springframework.oxm hierarchy.

The default implementation delegates to JaxbUtils. Can be overridden in subclasses.

Parameters:

ex - JAXBException that occured

Returns:

the corresponding XmlMappingException instance

See Also:

JaxbUtils.convertJaxbException(javax.xml.bind.JAXBException)

createMarshaller

protected javax.xml.bind.Marshaller createMarshaller()

Returns a newly created JAXB marshaller. JAXB marshallers are not necessarily thread safe.

createUnmarshaller

protected javax.xml.bind.Unmarshaller createUnmarshaller()

Returns a newly created JAXB unmarshaller. JAXB unmarshallers 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.

Default implementation does nothing.

Throws:

javax.xml.bind.JAXBException

initJaxbUnmarshaller

protected void initJaxbUnmarshaller(javax.xml.bind.Unmarshaller unmarshaller)
                             throws javax.xml.bind.JAXBException

Template method that can overridden by concrete JAXB marshallers for custom initialization behavior. Gets called after creation of JAXB Unmarshaller, and after the respective properties have been set.

Default implementation does nothing.

Throws:

javax.xml.bind.JAXBException

createJaxbContext

protected abstract javax.xml.bind.JAXBContext createJaxbContext()
                                                         throws java.lang.Exception

Template method that returns a newly created JAXB context. Called from afterPropertiesSet().

Throws:

java.lang.Exception