MarshallingMessageConverter with no {@link Marshaller} set. The marshaller must be set
+ * after construction by invoking {@link #setMarshaller(Marshaller)}.
+ */
+ public MarshallingMessageConverter() {
+ }
+
+ /**
+ * Constructs a new MarshallingMessageConverter with the given {@link Marshaller} set. If the given
+ * {@link Marshaller} also implements the {@link Unmarshaller} interface, it is used for both marshalling and
+ * unmarshalling. Otherwise, an exception is thrown. Note that all {@link Marshaller} implementations in Spring-WS
+ * also implement the {@link Unmarshaller} interface, so that you can safely use this constructor.
+ *
+ * @param marshaller object used as marshaller and unmarshaller
+ * @throws IllegalArgumentException when marshaller does not implement the {@link Unmarshaller} interface
+ */
+ public MarshallingMessageConverter(Marshaller marshaller) {
+ Assert.notNull(marshaller, "marshaller must not be null");
+ if (!(marshaller instanceof Unmarshaller)) {
+ throw new IllegalArgumentException("Marshaller [" + marshaller + "] does not implement the Unmarshaller " +
+ "interface. Please set an Unmarshaller explicitely by using the " +
+ "AbstractMarshallingPayloadEndpoint(Marshaller, Unmarshaller) constructor.");
+ }
+ else {
+ this.marshaller = marshaller;
+ this.unmarshaller = (Unmarshaller) marshaller;
+ }
+ }
+
+ /**
+ * Creates a new MarshallingMessageConverter with the given marshaller and unmarshaller.
+ *
+ * @param marshaller the marshaller to use
+ * @param unmarshaller the unmarshaller to use
+ */
+ public MarshallingMessageConverter(Marshaller marshaller, Unmarshaller unmarshaller) {
+ Assert.notNull(marshaller, "marshaller must not be null");
+ Assert.notNull(unmarshaller, "unmarshaller must not be null");
+ this.marshaller = marshaller;
+ this.unmarshaller = unmarshaller;
+ }
+
+ /**
+ * Indicates whether {@link #toMessage(Object,Session)} should marshal to a {@link BytesMessage} or a {@link
+ * TextMessage}. The default is {@link #MARSHAL_TO_BYTES_MESSAGE}, i.e. this converter marshals to a {@link
+ * BytesMessage}.
+ *
+ * @see #MARSHAL_TO_BYTES_MESSAGE
+ * @see #MARSHAL_TO_TEXT_MESSAGE
+ */
+ public void setMarshalTo(int marshalTo) {
+ this.marshalTo = marshalTo;
+ }
+
+ /** Sets the {@link Marshaller} to be used by this message converter. */
+ public void setMarshaller(Marshaller marshaller) {
+ this.marshaller = marshaller;
+ }
+
+ /** Sets the {@link Unmarshaller} to be used by this message converter. */
+ public void setUnmarshaller(Unmarshaller unmarshaller) {
+ this.unmarshaller = unmarshaller;
+ }
+
+ public void afterPropertiesSet() throws Exception {
+ Assert.notNull(marshaller, "Property 'marshaller' is required");
+ Assert.notNull(unmarshaller, "Property 'unmarshaller' is required");
+ }
+
+ /**
+ * Marshals the given object to a {@link TextMessage} or {@link javax.jms.BytesMessage}. The desired message type can
+ * be defined by setting the {@link #setMarshalTo(int) marshalTo} property.
+ *
+ * @see #marshalToTextMessage
+ * @see #marshalToBytesMessage
+ */
+ public Message toMessage(Object object, Session session) throws JMSException, MessageConversionException {
+ try {
+ switch (marshalTo) {
+ case MARSHAL_TO_TEXT_MESSAGE:
+ return marshalToTextMessage(object, session, marshaller);
+ case MARSHAL_TO_BYTES_MESSAGE:
+ return marshalToBytesMessage(object, session, marshaller);
+ default:
+ return marshalToMessage(object, session, marshaller);
+ }
+ }
+ catch (MarshallingFailureException ex) {
+ throw new MessageConversionException("Could not marshal [" + object + "]", ex);
+ }
+ catch (IOException ex) {
+ throw new MessageConversionException("Could not marshal [" + object + "]", ex);
+ }
+ }
+
+ /**
+ * Unmarshals the given {@link Message} into an object.
+ *
+ * @see #unmarshalFromTextMessage
+ * @see #unmarshalFromBytesMessage
+ */
+ public Object fromMessage(Message message) throws JMSException, MessageConversionException {
+ try {
+ if (message instanceof TextMessage) {
+ TextMessage textMessage = (TextMessage) message;
+ return unmarshalFromTextMessage(textMessage, unmarshaller);
+ }
+ else if (message instanceof BytesMessage) {
+ BytesMessage bytesMessage = (BytesMessage) message;
+ return unmarshalFromBytesMessage(bytesMessage, unmarshaller);
+ }
+ else {
+ return unmarshalFromMessage(message, unmarshaller);
+ }
+ }
+ catch (UnmarshallingFailureException ex) {
+ throw new MessageConversionException("Could not unmarshal message [" + message + "]", ex);
+ }
+ catch (IOException ex) {
+ throw new MessageConversionException("Could not unmarshal message [" + message + "]", ex);
+ }
+ }
+
+ /**
+ * Marshals the given object to a {@link TextMessage}.
+ *
+ * @param object the object to be marshalled
+ * @param session current JMS session
+ * @param marshaller the marshaller to use
+ * @return the resulting message
+ * @throws JMSException if thrown by JMS methods
+ * @throws IOException in case of I/O errors
+ * @see Session#createTextMessage
+ * @see Marshaller#marshal(Object, Result)
+ */
+ protected TextMessage marshalToTextMessage(Object object, Session session, Marshaller marshaller)
+ throws JMSException, IOException {
+ StringWriter writer = new StringWriter();
+ Result result = new StreamResult(writer);
+ marshaller.marshal(object, result);
+ return session.createTextMessage(writer.toString());
+ }
+
+ /**
+ * Marshals the given object to a {@link BytesMessage}.
+ *
+ * @param object the object to be marshalled
+ * @param session current JMS session
+ * @param marshaller the marshaller to use
+ * @return the resulting message
+ * @throws JMSException if thrown by JMS methods
+ * @throws IOException in case of I/O errors
+ * @see Session#createBytesMessage
+ * @see Marshaller#marshal(Object, Result)
+ */
+ protected BytesMessage marshalToBytesMessage(Object object, Session session, Marshaller marshaller)
+ throws JMSException, IOException {
+ ByteArrayOutputStream bos = new ByteArrayOutputStream();
+ StreamResult streamResult = new StreamResult(bos);
+ marshaller.marshal(object, streamResult);
+ BytesMessage message = session.createBytesMessage();
+ message.writeBytes(bos.toByteArray());
+ return message;
+ }
+
+ /**
+ * Template method that allows for custom message marshalling. Invoked when {@link #setMarshalTo(int)} is not {@link
+ * #MARSHAL_TO_TEXT_MESSAGE} or {@link #MARSHAL_TO_BYTES_MESSAGE}. Default implemenetation throws a {@link
+ * MessageConversionException}.
+ *
+ * @param object the object to marshal
+ * @param session the JMS session
+ * @param marshaller the marshaller to use
+ * @return the resulting message
+ * @throws JMSException if thrown by JMS methods
+ * @throws IOException in case of I/O errors
+ */
+ protected Message marshalToMessage(Object object, Session session, Marshaller marshaller)
+ throws JMSException, IOException {
+ throw new MessageConversionException(
+ "Unknown 'marshalTo' value [" + marshalTo + "]. Cannot convert object to Message");
+ }
+
+ /**
+ * Unmarshals the given {@link TextMessage} into an object.
+ *
+ * @param message the message
+ * @param unmarshaller the unmarshaller to use
+ * @return the unmarshalled object
+ * @throws JMSException if thrown by JMS methods
+ * @throws IOException in case of I/O errors
+ * @see Unmarshaller#unmarshal(Source)
+ */
+ protected Object unmarshalFromTextMessage(TextMessage message, Unmarshaller unmarshaller)
+ throws JMSException, IOException {
+ Source source = new StreamSource(new StringReader(message.getText()));
+ return unmarshaller.unmarshal(source);
+ }
+
+ /**
+ * Unmarshals the given {@link BytesMessage} into an object.
+ *
+ * @param message the message
+ * @param unmarshaller the unmarshaller to use
+ * @return the unmarshalled object
+ * @throws JMSException if thrown by JMS methods
+ * @throws IOException in case of I/O errors
+ * @see Unmarshaller#unmarshal(Source)
+ */
+ protected Object unmarshalFromBytesMessage(BytesMessage message, Unmarshaller unmarshaller)
+ throws JMSException, IOException {
+ byte[] bytes = new byte[(int) message.getBodyLength()];
+ message.readBytes(bytes);
+ ByteArrayInputStream bis = new ByteArrayInputStream(bytes);
+ StreamSource source = new StreamSource(bis);
+ return unmarshaller.unmarshal(source);
+ }
+
+ /**
+ * Template method that allows for custom message unmarshalling. Invoked when {@link #fromMessage(Message)} is invoked
+ * with a message that is not a {@link TextMessage} or {@link BytesMessage}. Default implemenetation throws a
+ * {@link MessageConversionException}.
+ *
+ * @param message the message
+ * @param unmarshaller the unmarshaller to use
+ * @return the unmarshalled object
+ * @throws JMSException if thrown by JMS methods
+ * @throws IOException in case of I/O errors
+ */
+ protected Object unmarshalFromMessage(Message message, Unmarshaller unmarshaller) throws JMSException, IOException {
+ throw new MessageConversionException(
+ "MarshallingMessageConverter only supports TextMessages and BytesMessages");
+ }
+}
+
diff --git a/org.springframework.jms/src/test/java/org/springframework/jms/support/converter/MarshallingMessageConverterTests.java b/org.springframework.jms/src/test/java/org/springframework/jms/support/converter/MarshallingMessageConverterTests.java
new file mode 100644
index 0000000000..b6a562a3a9
--- /dev/null
+++ b/org.springframework.jms/src/test/java/org/springframework/jms/support/converter/MarshallingMessageConverterTests.java
@@ -0,0 +1,117 @@
+/*
+ * Copyright 2007 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.jms.support.converter;
+
+import javax.jms.BytesMessage;
+import javax.jms.Session;
+import javax.jms.TextMessage;
+import javax.xml.transform.Result;
+import javax.xml.transform.Source;
+
+import static org.easymock.EasyMock.*;
+import static org.junit.Assert.assertEquals;
+import org.junit.Before;
+import org.junit.Test;
+
+import org.springframework.oxm.Marshaller;
+import org.springframework.oxm.Unmarshaller;
+
+public class MarshallingMessageConverterTests {
+
+ private MarshallingMessageConverter converter;
+
+ private Marshaller marshallerMock;
+
+ private Unmarshaller unmarshallerMock;
+
+ private Session sessionMock;
+
+ @Before
+ public void setUp() throws Exception {
+ marshallerMock = createMock(Marshaller.class);
+ unmarshallerMock = createMock(Unmarshaller.class);
+ sessionMock = createMock(Session.class);
+ converter = new MarshallingMessageConverter(marshallerMock, unmarshallerMock);
+ }
+
+ @Test
+ public void toBytesMessage() throws Exception {
+ BytesMessage bytesMessageMock = createMock(BytesMessage.class);
+ Object toBeMarshalled = new Object();
+
+ expect(sessionMock.createBytesMessage()).andReturn(bytesMessageMock);
+ marshallerMock.marshal(eq(toBeMarshalled), isA(Result.class));
+ bytesMessageMock.writeBytes(isA(byte[].class));
+
+ replay(marshallerMock, unmarshallerMock, sessionMock, bytesMessageMock);
+
+ converter.toMessage(toBeMarshalled, sessionMock);
+
+ verify(marshallerMock, unmarshallerMock, sessionMock, bytesMessageMock);
+ }
+
+ @Test
+ public void fromBytesMessage() throws Exception {
+ BytesMessage bytesMessageMock = createMock(BytesMessage.class);
+ Object unmarshalled = new Object();
+
+ expect(bytesMessageMock.getBodyLength()).andReturn(10L);
+ expect(bytesMessageMock.readBytes(isA(byte[].class))).andReturn(0);
+ expect(unmarshallerMock.unmarshal(isA(Source.class))).andReturn(unmarshalled);
+
+ replay(marshallerMock, unmarshallerMock, sessionMock, bytesMessageMock);
+
+ Object result = converter.fromMessage(bytesMessageMock);
+ assertEquals("Invalid result", result, unmarshalled);
+
+ verify(marshallerMock, unmarshallerMock, sessionMock, bytesMessageMock);
+ }
+
+ @Test
+ public void toTextMessage() throws Exception {
+ converter.setMarshalTo(MarshallingMessageConverter.MARSHAL_TO_TEXT_MESSAGE);
+ TextMessage textMessageMock = createMock(TextMessage.class);
+ Object toBeMarshalled = new Object();
+
+ expect(sessionMock.createTextMessage(isA(String.class))).andReturn(textMessageMock);
+ marshallerMock.marshal(eq(toBeMarshalled), isA(Result.class));
+
+ replay(marshallerMock, unmarshallerMock, sessionMock, textMessageMock);
+
+ converter.toMessage(toBeMarshalled, sessionMock);
+
+ verify(marshallerMock, unmarshallerMock, sessionMock, textMessageMock);
+ }
+
+ @Test
+ public void fromTextMessage() throws Exception {
+ TextMessage textMessageMock = createMock(TextMessage.class);
+ Object unmarshalled = new Object();
+
+ String text = "foo";
+ expect(textMessageMock.getText()).andReturn(text);
+ expect(unmarshallerMock.unmarshal(isA(Source.class))).andReturn(unmarshalled);
+
+ replay(marshallerMock, unmarshallerMock, sessionMock, textMessageMock);
+
+ Object result = converter.fromMessage(textMessageMock);
+ assertEquals("Invalid result", result, unmarshalled);
+
+ verify(marshallerMock, unmarshallerMock, sessionMock, textMessageMock);
+ }
+
+}
\ No newline at end of file
diff --git a/org.springframework.oxm/ivy.xml b/org.springframework.oxm/ivy.xml
index 872ec24564..b4b0ffc275 100644
--- a/org.springframework.oxm/ivy.xml
+++ b/org.springframework.oxm/ivy.xml
@@ -17,7 +17,6 @@
Marshaller and Unmarshaller interface. This implementation
@@ -58,439 +57,434 @@ import org.springframework.xml.transform.TraxUtils;
* methods.
*
* @author Arjen Poutsma
- * @since 1.0.0
+ * @since 3.0
*/
public abstract class AbstractMarshaller implements Marshaller, Unmarshaller {
- /** Logger available to subclasses. */
- protected final Log logger = LogFactory.getLog(getClass());
+ /** Logger available to subclasses. */
+ protected final Log logger = LogFactory.getLog(getClass());
- private DocumentBuilderFactory documentBuilderFactory;
+ private DocumentBuilderFactory documentBuilderFactory;
- /**
- * Marshals the object graph with the given root into the provided javax.xml.transform.Result.
- *
- * This implementation inspects the given result, and calls marshalDomResult,
- * marshalSaxResult, or marshalStreamResult.
- *
- * @param graph the root of the object graph to marshal
- * @param result the result to marshal to
- * @throws XmlMappingException if the given object cannot be marshalled to the result
- * @throws IOException if an I/O exception occurs
- * @throws IllegalArgumentException if result if neither a DOMResult,
- * SAXResult, StreamResult
- * @see #marshalDomResult(Object,javax.xml.transform.dom.DOMResult)
- * @see #marshalSaxResult(Object,javax.xml.transform.sax.SAXResult)
- * @see #marshalStreamResult(Object,javax.xml.transform.stream.StreamResult)
- */
- public final void marshal(Object graph, Result result) throws XmlMappingException, IOException {
- if (result instanceof DOMResult) {
- marshalDomResult(graph, (DOMResult) result);
- }
- else if (TraxUtils.isStaxResult(result)) {
- marshalStaxResult(graph, result);
- }
- else if (result instanceof SAXResult) {
- marshalSaxResult(graph, (SAXResult) result);
- }
- else if (result instanceof StreamResult) {
- marshalStreamResult(graph, (StreamResult) result);
- }
- else {
- throw new IllegalArgumentException("Unknown Result type: " + result.getClass());
- }
- }
+ /**
+ * Marshals the object graph with the given root into the provided javax.xml.transform.Result. This
+ * implementation inspects the given result, and calls marshalDomResult, marshalSaxResult, or
+ * marshalStreamResult.
+ *
+ * @param graph the root of the object graph to marshal
+ * @param result the result to marshal to
+ * @throws XmlMappingException if the given object cannot be marshalled to the result
+ * @throws IOException if an I/O exception occurs
+ * @throws IllegalArgumentException if result if neither a DOMResult, SAXResult,
+ * StreamResult
+ * @see #marshalDomResult(Object,javax.xml.transform.dom.DOMResult)
+ * @see #marshalSaxResult(Object,javax.xml.transform.sax.SAXResult)
+ * @see #marshalStreamResult(Object,javax.xml.transform.stream.StreamResult)
+ */
+ public final void marshal(Object graph, Result result) throws XmlMappingException, IOException {
+ if (result instanceof DOMResult) {
+ marshalDomResult(graph, (DOMResult) result);
+ }
+ else if (StaxUtils.isStaxResult(result)) {
+ marshalStaxResult(graph, result);
+ }
+ else if (result instanceof SAXResult) {
+ marshalSaxResult(graph, (SAXResult) result);
+ }
+ else if (result instanceof StreamResult) {
+ marshalStreamResult(graph, (StreamResult) result);
+ }
+ else {
+ throw new IllegalArgumentException("Unknown Result type: " + result.getClass());
+ }
+ }
- /**
- * Unmarshals the given provided javax.xml.transform.Source into an object graph.
- *
- * This implementation inspects the given result, and calls unmarshalDomSource,
- * unmarshalSaxSource, or unmarshalStreamSource.
- *
- * @param source the source to marshal from
- * @return the object graph
- * @throws XmlMappingException if the given source cannot be mapped to an object
- * @throws IOException if an I/O Exception occurs
- * @throws IllegalArgumentException if source is neither a DOMSource, a
- * SAXSource, nor a StreamSource
- * @see #unmarshalDomSource(javax.xml.transform.dom.DOMSource)
- * @see #unmarshalSaxSource(javax.xml.transform.sax.SAXSource)
- * @see #unmarshalStreamSource(javax.xml.transform.stream.StreamSource)
- */
- public final Object unmarshal(Source source) throws XmlMappingException, IOException {
- if (source instanceof DOMSource) {
- return unmarshalDomSource((DOMSource) source);
- }
- else if (TraxUtils.isStaxSource(source)) {
- return unmarshalStaxSource(source);
- }
- else if (source instanceof SAXSource) {
- return unmarshalSaxSource((SAXSource) source);
- }
- else if (source instanceof StreamSource) {
- return unmarshalStreamSource((StreamSource) source);
- }
- else {
- throw new IllegalArgumentException("Unknown Source type: " + source.getClass());
- }
- }
+ /**
+ * Unmarshals the given provided javax.xml.transform.Source into an object graph. This implementation
+ * inspects the given result, and calls unmarshalDomSource, unmarshalSaxSource, or
+ * unmarshalStreamSource.
+ *
+ * @param source the source to marshal from
+ * @return the object graph
+ * @throws XmlMappingException if the given source cannot be mapped to an object
+ * @throws IOException if an I/O Exception occurs
+ * @throws IllegalArgumentException if source is neither a DOMSource, a
+ * SAXSource, nor a StreamSource
+ * @see #unmarshalDomSource(javax.xml.transform.dom.DOMSource)
+ * @see #unmarshalSaxSource(javax.xml.transform.sax.SAXSource)
+ * @see #unmarshalStreamSource(javax.xml.transform.stream.StreamSource)
+ */
+ public final Object unmarshal(Source source) throws XmlMappingException, IOException {
+ if (source instanceof DOMSource) {
+ return unmarshalDomSource((DOMSource) source);
+ }
+ else if (StaxUtils.isStaxSource(source)) {
+ return unmarshalStaxSource(source);
+ }
+ else if (source instanceof SAXSource) {
+ return unmarshalSaxSource((SAXSource) source);
+ }
+ else if (source instanceof StreamSource) {
+ return unmarshalStreamSource((StreamSource) source);
+ }
+ else {
+ throw new IllegalArgumentException("Unknown Source type: " + source.getClass());
+ }
+ }
- /**
- * Create a DocumentBuilder that this marshaller will use for creating DOM documents when passed an
- * empty DOMSource. Can be overridden in subclasses, adding further initialization of the builder.
- *
- * @param factory the DocumentBuilderFactory that the DocumentBuilder should be created with
- * @return the DocumentBuilder
- * @throws javax.xml.parsers.ParserConfigurationException
- * if thrown by JAXP methods
- */
- protected DocumentBuilder createDocumentBuilder(DocumentBuilderFactory factory)
- throws ParserConfigurationException {
- return factory.newDocumentBuilder();
- }
+ /**
+ * Create a DocumentBuilder that this marshaller will use for creating DOM documents when passed an empty
+ * DOMSource. Can be overridden in subclasses, adding further initialization of the builder.
+ *
+ * @param factory the DocumentBuilderFactory that the DocumentBuilder should be created with
+ * @return the DocumentBuilder
+ * @throws javax.xml.parsers.ParserConfigurationException
+ * if thrown by JAXP methods
+ */
+ protected DocumentBuilder createDocumentBuilder(DocumentBuilderFactory factory)
+ throws ParserConfigurationException {
+ return factory.newDocumentBuilder();
+ }
- /**
- * Create a DocumentBuilder that this marshaller will use for creating DOM documents when passed an
- * empty DOMSource. The resulting DocumentBuilderFactory is cached, so this method will
- * only be called once.
- *
- * @return the DocumentBuilderFactory
- * @throws ParserConfigurationException if thrown by JAXP methods
- */
- protected DocumentBuilderFactory createDocumentBuilderFactory() throws ParserConfigurationException {
- DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
- factory.setValidating(false);
- factory.setNamespaceAware(true);
- return factory;
- }
+ /**
+ * Create a DocumentBuilder that this marshaller will use for creating DOM documents when passed an empty
+ * DOMSource. The resulting DocumentBuilderFactory is cached, so this method will only be
+ * called once.
+ *
+ * @return the DocumentBuilderFactory
+ * @throws ParserConfigurationException if thrown by JAXP methods
+ */
+ protected DocumentBuilderFactory createDocumentBuilderFactory() throws ParserConfigurationException {
+ DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
+ factory.setValidating(false);
+ factory.setNamespaceAware(true);
+ return factory;
+ }
- /**
- * Create a XMLReader that this marshaller will when passed an empty SAXSource.
- *
- * @return the XMLReader
- * @throws SAXException if thrown by JAXP methods
- */
- protected XMLReader createXmlReader() throws SAXException {
- return XMLReaderFactory.createXMLReader();
- }
+ /**
+ * Create a XMLReader that this marshaller will when passed an empty SAXSource.
+ *
+ * @return the XMLReader
+ * @throws SAXException if thrown by JAXP methods
+ */
+ protected XMLReader createXmlReader() throws SAXException {
+ return XMLReaderFactory.createXMLReader();
+ }
- //
- // Marshalling
- //
+ //
+ // Marshalling
+ //
- /**
- * Template method for handling DOMResults. This implementation defers to marshalDomNode.
- *
- * @param graph the root of the object graph to marshal
- * @param domResult the DOMResult
- * @throws XmlMappingException if the given object cannot be marshalled to the result
- * @throws IllegalArgumentException if the domResult is empty
- * @see #marshalDomNode(Object,org.w3c.dom.Node)
- */
- protected void marshalDomResult(Object graph, DOMResult domResult) throws XmlMappingException {
- Assert.notNull(domResult.getNode(), "DOMResult does not contain Node");
- marshalDomNode(graph, domResult.getNode());
- }
+ /**
+ * Template method for handling DOMResults. This implementation defers to marshalDomNode.
+ *
+ * @param graph the root of the object graph to marshal
+ * @param domResult the DOMResult
+ * @throws XmlMappingException if the given object cannot be marshalled to the result
+ * @throws IllegalArgumentException if the domResult is empty
+ * @see #marshalDomNode(Object,org.w3c.dom.Node)
+ */
+ protected void marshalDomResult(Object graph, DOMResult domResult) throws XmlMappingException {
+ Assert.notNull(domResult.getNode(), "DOMResult does not contain Node");
+ marshalDomNode(graph, domResult.getNode());
+ }
- /**
- * Template method for handling StaxResults. This implementation defers to
- * marshalXMLSteamWriter, or marshalXMLEventConsumer, depending on what is contained in
- * the StaxResult.
- *
- * @param graph the root of the object graph to marshal
- * @param staxResult a Spring-WS {@link StaxSource} or JAXP 1.4 {@link StAXSource}
- * @throws XmlMappingException if the given object cannot be marshalled to the result
- * @throws IllegalArgumentException if the domResult is empty
- * @see #marshalDomNode(Object,org.w3c.dom.Node)
- */
- protected void marshalStaxResult(Object graph, Result staxResult) throws XmlMappingException {
- XMLStreamWriter streamWriter = TraxUtils.getXMLStreamWriter(staxResult);
- if (streamWriter != null) {
- marshalXmlStreamWriter(graph, streamWriter);
- }
- else {
- XMLEventWriter eventWriter = TraxUtils.getXMLEventWriter(staxResult);
- if (eventWriter != null) {
- marshalXmlEventWriter(graph, eventWriter);
- }
- else {
- throw new IllegalArgumentException("StaxResult contains neither XMLStreamWriter nor XMLEventConsumer");
- }
- }
- }
+ /**
+ * Template method for handling StaxResults. This implementation defers to
+ * marshalXMLSteamWriter, or marshalXMLEventConsumer, depending on what is contained in the
+ * StaxResult.
+ *
+ * @param graph the root of the object graph to marshal
+ * @param staxResult a Spring {@link org.springframework.util.xml.StaxSource} or JAXP 1.4 {@link StAXSource}
+ * @throws XmlMappingException if the given object cannot be marshalled to the result
+ * @throws IllegalArgumentException if the domResult is empty
+ * @see #marshalDomNode(Object,org.w3c.dom.Node)
+ */
+ protected void marshalStaxResult(Object graph, Result staxResult) throws XmlMappingException {
+ XMLStreamWriter streamWriter = StaxUtils.getXMLStreamWriter(staxResult);
+ if (streamWriter != null) {
+ marshalXmlStreamWriter(graph, streamWriter);
+ }
+ else {
+ XMLEventWriter eventWriter = StaxUtils.getXMLEventWriter(staxResult);
+ if (eventWriter != null) {
+ marshalXmlEventWriter(graph, eventWriter);
+ }
+ else {
+ throw new IllegalArgumentException("StaxResult contains neither XMLStreamWriter nor XMLEventConsumer");
+ }
+ }
+ }
- /**
- * Template method for handling SAXResults. This implementation defers to
- * marshalSaxHandlers.
- *
- * @param graph the root of the object graph to marshal
- * @param saxResult the SAXResult
- * @throws XmlMappingException if the given object cannot be marshalled to the result
- * @see #marshalSaxHandlers(Object,org.xml.sax.ContentHandler,org.xml.sax.ext.LexicalHandler)
- */
- protected void marshalSaxResult(Object graph, SAXResult saxResult) throws XmlMappingException {
- ContentHandler contentHandler = saxResult.getHandler();
- Assert.notNull(contentHandler, "ContentHandler not set on SAXResult");
- LexicalHandler lexicalHandler = saxResult.getLexicalHandler();
- marshalSaxHandlers(graph, contentHandler, lexicalHandler);
- }
+ /**
+ * Template method for handling SAXResults. This implementation defers to
+ * marshalSaxHandlers.
+ *
+ * @param graph the root of the object graph to marshal
+ * @param saxResult the SAXResult
+ * @throws XmlMappingException if the given object cannot be marshalled to the result
+ * @see #marshalSaxHandlers(Object,org.xml.sax.ContentHandler,org.xml.sax.ext.LexicalHandler)
+ */
+ protected void marshalSaxResult(Object graph, SAXResult saxResult) throws XmlMappingException {
+ ContentHandler contentHandler = saxResult.getHandler();
+ Assert.notNull(contentHandler, "ContentHandler not set on SAXResult");
+ LexicalHandler lexicalHandler = saxResult.getLexicalHandler();
+ marshalSaxHandlers(graph, contentHandler, lexicalHandler);
+ }
- /**
- * Template method for handling StreamResults. This implementation defers to
- * marshalOutputStream, or marshalWriter, depending on what is contained in the
- * StreamResult
- *
- * @param graph the root of the object graph to marshal
- * @param streamResult the StreamResult
- * @throws IOException if an I/O Exception occurs
- * @throws XmlMappingException if the given object cannot be marshalled to the result
- * @throws IllegalArgumentException if streamResult contains neither OutputStream nor
- * Writer.
- */
- protected void marshalStreamResult(Object graph, StreamResult streamResult)
- throws XmlMappingException, IOException {
- if (streamResult.getOutputStream() != null) {
- marshalOutputStream(graph, streamResult.getOutputStream());
- }
- else if (streamResult.getWriter() != null) {
- marshalWriter(graph, streamResult.getWriter());
- }
- else {
- throw new IllegalArgumentException("StreamResult contains neither OutputStream nor Writer");
- }
- }
+ /**
+ * Template method for handling StreamResults. This implementation defers to
+ * marshalOutputStream, or marshalWriter, depending on what is contained in the
+ * StreamResult
+ *
+ * @param graph the root of the object graph to marshal
+ * @param streamResult the StreamResult
+ * @throws IOException if an I/O Exception occurs
+ * @throws XmlMappingException if the given object cannot be marshalled to the result
+ * @throws IllegalArgumentException if streamResult contains neither OutputStream nor
+ * Writer.
+ */
+ protected void marshalStreamResult(Object graph, StreamResult streamResult)
+ throws XmlMappingException, IOException {
+ if (streamResult.getOutputStream() != null) {
+ marshalOutputStream(graph, streamResult.getOutputStream());
+ }
+ else if (streamResult.getWriter() != null) {
+ marshalWriter(graph, streamResult.getWriter());
+ }
+ else {
+ throw new IllegalArgumentException("StreamResult contains neither OutputStream nor Writer");
+ }
+ }
- //
- // Unmarshalling
- //
+ //
+ // Unmarshalling
+ //
- /**
- * Template method for handling DOMSources. This implementation defers to
- * unmarshalDomNode. If the given source is empty, an empty source Document will be
- * created as a placeholder.
- *
- * @param domSource the DOMSource
- * @return the object graph
- * @throws IllegalArgumentException if the domSource is empty
- * @throws XmlMappingException if the given source cannot be mapped to an object
- * @see #unmarshalDomNode(org.w3c.dom.Node)
- */
- protected Object unmarshalDomSource(DOMSource domSource) throws XmlMappingException {
- if (domSource.getNode() == null) {
- try {
- if (documentBuilderFactory == null) {
- documentBuilderFactory = createDocumentBuilderFactory();
- }
- DocumentBuilder documentBuilder = createDocumentBuilder(documentBuilderFactory);
- domSource.setNode(documentBuilder.newDocument());
- }
- catch (ParserConfigurationException ex) {
- throw new UnmarshallingFailureException(
- "Could not create document placeholder for DOMSource: " + ex.getMessage(), ex);
- }
- }
- return unmarshalDomNode(domSource.getNode());
- }
+ /**
+ * Template method for handling DOMSources. This implementation defers to unmarshalDomNode.
+ * If the given source is empty, an empty source Document will be created as a placeholder.
+ *
+ * @param domSource the DOMSource
+ * @return the object graph
+ * @throws IllegalArgumentException if the domSource is empty
+ * @throws XmlMappingException if the given source cannot be mapped to an object
+ * @see #unmarshalDomNode(org.w3c.dom.Node)
+ */
+ protected Object unmarshalDomSource(DOMSource domSource) throws XmlMappingException {
+ if (domSource.getNode() == null) {
+ try {
+ if (documentBuilderFactory == null) {
+ documentBuilderFactory = createDocumentBuilderFactory();
+ }
+ DocumentBuilder documentBuilder = createDocumentBuilder(documentBuilderFactory);
+ domSource.setNode(documentBuilder.newDocument());
+ }
+ catch (ParserConfigurationException ex) {
+ throw new UnmarshallingFailureException(
+ "Could not create document placeholder for DOMSource: " + ex.getMessage(), ex);
+ }
+ }
+ return unmarshalDomNode(domSource.getNode());
+ }
- /**
- * Template method for handling StaxSources. This implementation defers to
- * unmarshalXmlStreamReader, or unmarshalXmlEventReader.
- *
- * @param staxSource the StaxSource
- * @return the object graph
- * @throws XmlMappingException if the given source cannot be mapped to an object
- */
- protected Object unmarshalStaxSource(Source staxSource) throws XmlMappingException {
- XMLStreamReader streamReader = TraxUtils.getXMLStreamReader(staxSource);
- if (streamReader != null) {
- return unmarshalXmlStreamReader(streamReader);
- }
- else {
- XMLEventReader eventReader = TraxUtils.getXMLEventReader(staxSource);
- if (eventReader != null) {
- return unmarshalXmlEventReader(eventReader);
- }
- else {
- throw new IllegalArgumentException("StaxSource contains neither XMLStreamReader nor XMLEventReader");
- }
- }
- }
+ /**
+ * Template method for handling StaxSources. This implementation defers to
+ * unmarshalXmlStreamReader, or unmarshalXmlEventReader.
+ *
+ * @param staxSource the StaxSource
+ * @return the object graph
+ * @throws XmlMappingException if the given source cannot be mapped to an object
+ */
+ protected Object unmarshalStaxSource(Source staxSource) throws XmlMappingException {
+ XMLStreamReader streamReader = StaxUtils.getXMLStreamReader(staxSource);
+ if (streamReader != null) {
+ return unmarshalXmlStreamReader(streamReader);
+ }
+ else {
+ XMLEventReader eventReader = StaxUtils.getXMLEventReader(staxSource);
+ if (eventReader != null) {
+ return unmarshalXmlEventReader(eventReader);
+ }
+ else {
+ throw new IllegalArgumentException("StaxSource contains neither XMLStreamReader nor XMLEventReader");
+ }
+ }
+ }
- /**
- * Template method for handling SAXSources. This implementation defers to
- * unmarshalSaxReader.
- *
- * @param saxSource the SAXSource
- * @return the object graph
- * @throws XmlMappingException if the given source cannot be mapped to an object
- * @throws IOException if an I/O Exception occurs
- * @see #unmarshalSaxReader(org.xml.sax.XMLReader,org.xml.sax.InputSource)
- */
- protected Object unmarshalSaxSource(SAXSource saxSource) throws XmlMappingException, IOException {
- if (saxSource.getXMLReader() == null) {
- try {
- saxSource.setXMLReader(createXmlReader());
- }
- catch (SAXException ex) {
- throw new UnmarshallingFailureException("Could not create XMLReader for SAXSource: " + ex.getMessage(),
- ex);
- }
- }
- if (saxSource.getInputSource() == null) {
- saxSource.setInputSource(new InputSource());
- }
- return unmarshalSaxReader(saxSource.getXMLReader(), saxSource.getInputSource());
- }
+ /**
+ * Template method for handling SAXSources. This implementation defers to
+ * unmarshalSaxReader.
+ *
+ * @param saxSource the SAXSource
+ * @return the object graph
+ * @throws XmlMappingException if the given source cannot be mapped to an object
+ * @throws IOException if an I/O Exception occurs
+ * @see #unmarshalSaxReader(org.xml.sax.XMLReader,org.xml.sax.InputSource)
+ */
+ protected Object unmarshalSaxSource(SAXSource saxSource) throws XmlMappingException, IOException {
+ if (saxSource.getXMLReader() == null) {
+ try {
+ saxSource.setXMLReader(createXmlReader());
+ }
+ catch (SAXException ex) {
+ throw new UnmarshallingFailureException("Could not create XMLReader for SAXSource: " + ex.getMessage(),
+ ex);
+ }
+ }
+ if (saxSource.getInputSource() == null) {
+ saxSource.setInputSource(new InputSource());
+ }
+ return unmarshalSaxReader(saxSource.getXMLReader(), saxSource.getInputSource());
+ }
- /**
- * Template method for handling StreamSources. This implementation defers to
- * unmarshalInputStream, or unmarshalReader.
- *
- * @param streamSource the StreamSource
- * @return the object graph
- * @throws IOException if an I/O exception occurs
- * @throws XmlMappingException if the given source cannot be mapped to an object
- */
- protected Object unmarshalStreamSource(StreamSource streamSource) throws XmlMappingException, IOException {
- if (streamSource.getInputStream() != null) {
- return unmarshalInputStream(streamSource.getInputStream());
- }
- else if (streamSource.getReader() != null) {
- return unmarshalReader(streamSource.getReader());
- }
- else {
- throw new IllegalArgumentException("StreamSource contains neither InputStream nor Reader");
- }
- }
+ /**
+ * Template method for handling StreamSources. This implementation defers to
+ * unmarshalInputStream, or unmarshalReader.
+ *
+ * @param streamSource the StreamSource
+ * @return the object graph
+ * @throws IOException if an I/O exception occurs
+ * @throws XmlMappingException if the given source cannot be mapped to an object
+ */
+ protected Object unmarshalStreamSource(StreamSource streamSource) throws XmlMappingException, IOException {
+ if (streamSource.getInputStream() != null) {
+ return unmarshalInputStream(streamSource.getInputStream());
+ }
+ else if (streamSource.getReader() != null) {
+ return unmarshalReader(streamSource.getReader());
+ }
+ else {
+ throw new IllegalArgumentException("StreamSource contains neither InputStream nor Reader");
+ }
+ }
- //
- // Abstract template methods
- //
+ //
+ // Abstract template methods
+ //
- /**
- * Abstract template method for marshalling the given object graph to a DOM Node.
- *
- * In practice, node is be a Document node, a DocumentFragment node, or a
- * Element node. In other words, a node that accepts children.
- *
- * @param graph the root of the object graph to marshal
- * @param node The DOM node that will contain the result tree
- * @throws XmlMappingException if the given object cannot be marshalled to the DOM node
- * @see org.w3c.dom.Document
- * @see org.w3c.dom.DocumentFragment
- * @see org.w3c.dom.Element
- */
- protected abstract void marshalDomNode(Object graph, Node node) throws XmlMappingException;
+ /**
+ * Abstract template method for marshalling the given object graph to a DOM Node. In practice, node
+ * is be a Document node, a DocumentFragment node, or a Element node. In other
+ * words, a node that accepts children.
+ *
+ * @param graph the root of the object graph to marshal
+ * @param node The DOM node that will contain the result tree
+ * @throws XmlMappingException if the given object cannot be marshalled to the DOM node
+ * @see org.w3c.dom.Document
+ * @see org.w3c.dom.DocumentFragment
+ * @see org.w3c.dom.Element
+ */
+ protected abstract void marshalDomNode(Object graph, Node node) throws XmlMappingException;
- /**
- * Abstract template method for marshalling the given object to a StAX XMLEventWriter.
- *
- * @param graph the root of the object graph to marshal
- * @param eventWriter the XMLEventWriter to write to
- * @throws XmlMappingException if the given object cannot be marshalled to the DOM node
- */
- protected abstract void marshalXmlEventWriter(Object graph, XMLEventWriter eventWriter) throws XmlMappingException;
+ /**
+ * Abstract template method for marshalling the given object to a StAX XMLEventWriter.
+ *
+ * @param graph the root of the object graph to marshal
+ * @param eventWriter the XMLEventWriter to write to
+ * @throws XmlMappingException if the given object cannot be marshalled to the DOM node
+ */
+ protected abstract void marshalXmlEventWriter(Object graph, XMLEventWriter eventWriter) throws XmlMappingException;
- /**
- * Abstract template method for marshalling the given object to a StAX XMLStreamWriter.
- *
- * @param graph the root of the object graph to marshal
- * @param streamWriter the XMLStreamWriter to write to
- * @throws XmlMappingException if the given object cannot be marshalled to the DOM node
- */
- protected abstract void marshalXmlStreamWriter(Object graph, XMLStreamWriter streamWriter)
- throws XmlMappingException;
+ /**
+ * Abstract template method for marshalling the given object to a StAX XMLStreamWriter.
+ *
+ * @param graph the root of the object graph to marshal
+ * @param streamWriter the XMLStreamWriter to write to
+ * @throws XmlMappingException if the given object cannot be marshalled to the DOM node
+ */
+ protected abstract void marshalXmlStreamWriter(Object graph, XMLStreamWriter streamWriter)
+ throws XmlMappingException;
- /**
- * Abstract template method for marshalling the given object graph to a OutputStream.
- *
- * @param graph the root of the object graph to marshal
- * @param outputStream the OutputStream to write to
- * @throws XmlMappingException if the given object cannot be marshalled to the writer
- * @throws IOException if an I/O exception occurs
- */
- protected abstract void marshalOutputStream(Object graph, OutputStream outputStream)
- throws XmlMappingException, IOException;
+ /**
+ * Abstract template method for marshalling the given object graph to a OutputStream.
+ *
+ * @param graph the root of the object graph to marshal
+ * @param outputStream the OutputStream to write to
+ * @throws XmlMappingException if the given object cannot be marshalled to the writer
+ * @throws IOException if an I/O exception occurs
+ */
+ protected abstract void marshalOutputStream(Object graph, OutputStream outputStream)
+ throws XmlMappingException, IOException;
- /**
- * Abstract template method for marshalling the given object graph to a SAX ContentHandler.
- *
- * @param graph the root of the object graph to marshal
- * @param contentHandler the SAX ContentHandler
- * @param lexicalHandler the SAX2 LexicalHandler. Can be null.
- * @throws XmlMappingException if the given object cannot be marshalled to the handlers
- */
- protected abstract void marshalSaxHandlers(Object graph,
- ContentHandler contentHandler,
- LexicalHandler lexicalHandler) throws XmlMappingException;
+ /**
+ * Abstract template method for marshalling the given object graph to a SAX ContentHandler.
+ *
+ * @param graph the root of the object graph to marshal
+ * @param contentHandler the SAX ContentHandler
+ * @param lexicalHandler the SAX2 LexicalHandler. Can be null.
+ * @throws XmlMappingException if the given object cannot be marshalled to the handlers
+ */
+ protected abstract void marshalSaxHandlers(Object graph,
+ ContentHandler contentHandler,
+ LexicalHandler lexicalHandler) throws XmlMappingException;
- /**
- * Abstract template method for marshalling the given object graph to a Writer.
- *
- * @param graph the root of the object graph to marshal
- * @param writer the Writer to write to
- * @throws XmlMappingException if the given object cannot be marshalled to the writer
- * @throws IOException if an I/O exception occurs
- */
- protected abstract void marshalWriter(Object graph, Writer writer) throws XmlMappingException, IOException;
+ /**
+ * Abstract template method for marshalling the given object graph to a Writer.
+ *
+ * @param graph the root of the object graph to marshal
+ * @param writer the Writer to write to
+ * @throws XmlMappingException if the given object cannot be marshalled to the writer
+ * @throws IOException if an I/O exception occurs
+ */
+ protected abstract void marshalWriter(Object graph, Writer writer) throws XmlMappingException, IOException;
- /**
- * Abstract template method for unmarshalling from a given DOM Node.
- *
- * @param node The DOM node that contains the objects to be unmarshalled
- * @return the object graph
- * @throws XmlMappingException if the given DOM node cannot be mapped to an object
- */
- protected abstract Object unmarshalDomNode(Node node) throws XmlMappingException;
+ /**
+ * Abstract template method for unmarshalling from a given DOM Node.
+ *
+ * @param node The DOM node that contains the objects to be unmarshalled
+ * @return the object graph
+ * @throws XmlMappingException if the given DOM node cannot be mapped to an object
+ */
+ protected abstract Object unmarshalDomNode(Node node) throws XmlMappingException;
- /**
- * Abstract template method for unmarshalling from a given Stax XMLEventReader.
- *
- * @param eventReader The XMLEventReader to read from
- * @return the object graph
- * @throws XmlMappingException if the given event reader cannot be converted to an object
- */
- protected abstract Object unmarshalXmlEventReader(XMLEventReader eventReader) throws XmlMappingException;
+ /**
+ * Abstract template method for unmarshalling from a given Stax XMLEventReader.
+ *
+ * @param eventReader The XMLEventReader to read from
+ * @return the object graph
+ * @throws XmlMappingException if the given event reader cannot be converted to an object
+ */
+ protected abstract Object unmarshalXmlEventReader(XMLEventReader eventReader) throws XmlMappingException;
- /**
- * Abstract template method for unmarshalling from a given Stax XMLStreamReader.
- *
- * @param streamReader The XMLStreamReader to read from
- * @return the object graph
- * @throws XmlMappingException if the given stream reader cannot be converted to an object
- */
- protected abstract Object unmarshalXmlStreamReader(XMLStreamReader streamReader) throws XmlMappingException;
+ /**
+ * Abstract template method for unmarshalling from a given Stax XMLStreamReader.
+ *
+ * @param streamReader The XMLStreamReader to read from
+ * @return the object graph
+ * @throws XmlMappingException if the given stream reader cannot be converted to an object
+ */
+ protected abstract Object unmarshalXmlStreamReader(XMLStreamReader streamReader) throws XmlMappingException;
- /**
- * Abstract template method for unmarshalling from a given InputStream.
- *
- * @param inputStream the InputStreamStream to read from
- * @return the object graph
- * @throws XmlMappingException if the given stream cannot be converted to an object
- * @throws IOException if an I/O exception occurs
- */
- protected abstract Object unmarshalInputStream(InputStream inputStream) throws XmlMappingException, IOException;
+ /**
+ * Abstract template method for unmarshalling from a given InputStream.
+ *
+ * @param inputStream the InputStreamStream to read from
+ * @return the object graph
+ * @throws XmlMappingException if the given stream cannot be converted to an object
+ * @throws IOException if an I/O exception occurs
+ */
+ protected abstract Object unmarshalInputStream(InputStream inputStream) throws XmlMappingException, IOException;
- /**
- * Abstract template method for unmarshalling from a given Reader.
- *
- * @param reader the Reader to read from
- * @return the object graph
- * @throws XmlMappingException if the given reader cannot be converted to an object
- * @throws IOException if an I/O exception occurs
- */
- protected abstract Object unmarshalReader(Reader reader) throws XmlMappingException, IOException;
+ /**
+ * Abstract template method for unmarshalling from a given Reader.
+ *
+ * @param reader the Reader to read from
+ * @return the object graph
+ * @throws XmlMappingException if the given reader cannot be converted to an object
+ * @throws IOException if an I/O exception occurs
+ */
+ protected abstract Object unmarshalReader(Reader reader) throws XmlMappingException, IOException;
- /**
- * Abstract template method for unmarshalling using a given SAX XMLReader and
- * InputSource.
- *
- * @param xmlReader the SAX XMLReader to parse with
- * @param inputSource the input source to parse from
- * @return the object graph
- * @throws XmlMappingException if the given reader and input source cannot be converted to an object
- * @throws java.io.IOException if an I/O exception occurs
- */
- protected abstract Object unmarshalSaxReader(XMLReader xmlReader, InputSource inputSource)
- throws XmlMappingException, IOException;
+ /**
+ * Abstract template method for unmarshalling using a given SAX XMLReader and InputSource.
+ *
+ * @param xmlReader the SAX XMLReader to parse with
+ * @param inputSource the input source to parse from
+ * @return the object graph
+ * @throws XmlMappingException if the given reader and input source cannot be converted to an object
+ * @throws java.io.IOException if an I/O exception occurs
+ */
+ protected abstract Object unmarshalSaxReader(XMLReader xmlReader, InputSource inputSource)
+ throws XmlMappingException, IOException;
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/GenericMarshaller.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/GenericMarshaller.java
index 1acac5e541..102adde85f 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/GenericMarshaller.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/GenericMarshaller.java
@@ -25,16 +25,16 @@ import java.lang.reflect.Type;
* {@link Method#getGenericReturnType()}.
*
* @author Arjen Poutsma
- * @since 1.0.2
+ * @since 3.0
*/
public interface GenericMarshaller extends Marshaller {
- /**
- * Indicates whether this marshaller can marshal instances of the supplied type.
- *
- * @param type the type that this marshaller is being asked if it can marshal
- * @return true if this marshaller can indeed marshal instances of the supplied type;
- * false otherwise
- */
- boolean supports(Type type);
+ /**
+ * Indicates whether this marshaller can marshal instances of the supplied type.
+ *
+ * @param type the type that this marshaller is being asked if it can marshal
+ * @return true if this marshaller can indeed marshal instances of the supplied type; false
+ * otherwise
+ */
+ boolean supports(Type type);
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/GenericMarshallingFailureException.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/GenericMarshallingFailureException.java
index 9a3904eda9..ec1abe053d 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/GenericMarshallingFailureException.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/GenericMarshallingFailureException.java
@@ -21,18 +21,18 @@ package org.springframework.oxm;
* @author Arjen Poutsma
* @see MarshallingFailureException
* @see UnmarshallingFailureException
- * @since 1.0.0
+ * @since 3.0
*/
public abstract class GenericMarshallingFailureException extends XmlMappingException {
- /** Constructor for GenericMarshallingFailureException. */
- public GenericMarshallingFailureException(String msg) {
- super(msg);
- }
+ /** Constructor for GenericMarshallingFailureException. */
+ public GenericMarshallingFailureException(String msg) {
+ super(msg);
+ }
- /** Constructor for GenericMarshallingFailureException. */
- public GenericMarshallingFailureException(String msg, Throwable ex) {
- super(msg, ex);
- }
+ /** Constructor for GenericMarshallingFailureException. */
+ public GenericMarshallingFailureException(String msg, Throwable ex) {
+ super(msg, ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/GenericUnmarshaller.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/GenericUnmarshaller.java
index f9bdc6778f..e98f14b3d7 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/GenericUnmarshaller.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/GenericUnmarshaller.java
@@ -25,16 +25,16 @@ import java.lang.reflect.Type;
* Method#getGenericParameterTypes()} and {@link Method#getGenericReturnType()}.
*
* @author Arjen Poutsma
- * @since 1.0.2
+ * @since 3.0
*/
public interface GenericUnmarshaller extends Unmarshaller {
- /**
- * Indicates whether this unmarshaller can unmarshal instances of the supplied type.
- *
- * @param type the type that this unmarshaller is being asked if it can marshal
- * @return true if this unmarshaller can indeed unmarshal to the supplied type; false
- * otherwise
- */
- boolean supports(Type type);
+ /**
+ * Indicates whether this unmarshaller can unmarshal instances of the supplied type.
+ *
+ * @param type the type that this unmarshaller is being asked if it can marshal
+ * @return true if this unmarshaller can indeed unmarshal to the supplied type; false
+ * otherwise
+ */
+ boolean supports(Type type);
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/Marshaller.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/Marshaller.java
index 0f3e7ab688..60ea799485 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/Marshaller.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/Marshaller.java
@@ -20,34 +20,32 @@ import javax.xml.transform.Result;
/**
* Defines the contract for Object XML Mapping Marshallers. Implementations of this interface can serialize a given
- * Object to an XML Stream.
- *
- * Although the marshal method accepts a java.lang.Object as its first parameter, most
- * Marshaller implementations cannot handle arbitrary java.lang.Object. Instead, a object
- * class must be registered with the marshaller, or have a common base class.
+ * Object to an XML Stream. Although the marshal method accepts a java.lang.Object as its
+ * first parameter, most Marshaller implementations cannot handle arbitrary java.lang.Object.
+ * Instead, a object class must be registered with the marshaller, or have a common base class.
*
* @author Arjen Poutsma
- * @since 1.0.0
+ * @since 3.0
*/
public interface Marshaller {
- /**
- * Marshals the object graph with the given root into the provided {@link Result}.
- *
- * @param graph the root of the object graph to marshal
- * @param result the result to marshal to
- * @throws XmlMappingException if the given object cannot be marshalled to the result
- * @throws IOException if an I/O exception occurs
- */
- void marshal(Object graph, Result result) throws XmlMappingException, IOException;
+ /**
+ * Marshals the object graph with the given root into the provided {@link Result}.
+ *
+ * @param graph the root of the object graph to marshal
+ * @param result the result to marshal to
+ * @throws XmlMappingException if the given object cannot be marshalled to the result
+ * @throws IOException if an I/O exception occurs
+ */
+ void marshal(Object graph, Result result) throws XmlMappingException, IOException;
- /**
- * Indicates whether this marshaller can marshal instances of the supplied type.
- *
- * @param clazz the class that this marshaller is being asked if it can marshal
- * @return true if this marshaller can indeed marshal instances of the supplied class;
- * false otherwise
- */
- boolean supports(Class clazz);
+ /**
+ * Indicates whether this marshaller can marshal instances of the supplied type.
+ *
+ * @param clazz the class that this marshaller is being asked if it can marshal
+ * @return true if this marshaller can indeed marshal instances of the supplied class; false
+ * otherwise
+ */
+ boolean supports(Class clazz);
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/MarshallingFailureException.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/MarshallingFailureException.java
index 011d9573ba..995e0db8d1 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/MarshallingFailureException.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/MarshallingFailureException.java
@@ -19,26 +19,26 @@ package org.springframework.oxm;
* Exception thrown on marshalling failure.
*
* @author Arjen Poutsma
- * @since 1.0.0
+ * @since 3.0
*/
public class MarshallingFailureException extends GenericMarshallingFailureException {
- /**
- * Construct a MarshallingFailureException with the specified detail message.
- *
- * @param msg the detail message
- */
- public MarshallingFailureException(String msg) {
- super(msg);
- }
+ /**
+ * Construct a MarshallingFailureException with the specified detail message.
+ *
+ * @param msg the detail message
+ */
+ public MarshallingFailureException(String msg) {
+ super(msg);
+ }
- /**
- * Construct a MarshallingFailureException with the specified detail message and nested exception.
- *
- * @param msg the detail message
- * @param ex the nested exception
- */
- public MarshallingFailureException(String msg, Throwable ex) {
- super(msg, ex);
- }
+ /**
+ * Construct a MarshallingFailureException with the specified detail message and nested exception.
+ *
+ * @param msg the detail message
+ * @param ex the nested exception
+ */
+ public MarshallingFailureException(String msg, Throwable ex) {
+ super(msg, ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/UncategorizedXmlMappingException.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/UncategorizedXmlMappingException.java
index c19a77fe31..ea2d0d1b90 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/UncategorizedXmlMappingException.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/UncategorizedXmlMappingException.java
@@ -19,12 +19,12 @@ package org.springframework.oxm;
* Superclass for exceptions that cannot be distinguished further.
*
* @author Arjen Poutsma
- * @since 1.0.0
+ * @since 3.0
*/
public abstract class UncategorizedXmlMappingException extends XmlMappingException {
- /** Constructor for UncategorizedXmlMappingException. */
- protected UncategorizedXmlMappingException(String msg, Throwable ex) {
- super(msg, ex);
- }
+ /** Constructor for UncategorizedXmlMappingException. */
+ protected UncategorizedXmlMappingException(String msg, Throwable ex) {
+ super(msg, ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/Unmarshaller.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/Unmarshaller.java
index c12cbbef03..c346c16bd7 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/Unmarshaller.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/Unmarshaller.java
@@ -19,32 +19,31 @@ import java.io.IOException;
import javax.xml.transform.Source;
/**
- * Defines the contract for Object XML Mapping unmarshallers.
- *
- * Implementations of this interface can deserialize a given XML Stream to an Object graph. + * Defines the contract for Object XML Mapping unmarshallers.
Implementations of this interface can deserialize
+ * a given XML Stream to an Object graph.
*
* @author Arjen Poutsma
- * @since 1.0.0
+ * @since 3.0
*/
public interface Unmarshaller {
- /**
- * Unmarshals the given {@link Source} into an object graph.
- *
- * @param source the source to marshal from
- * @return the object graph
- * @throws XmlMappingException if the given source cannot be mapped to an object
- * @throws IOException if an I/O Exception occurs
- */
- Object unmarshal(Source source) throws XmlMappingException, IOException;
+ /**
+ * Unmarshals the given {@link Source} into an object graph.
+ *
+ * @param source the source to marshal from
+ * @return the object graph
+ * @throws XmlMappingException if the given source cannot be mapped to an object
+ * @throws IOException if an I/O Exception occurs
+ */
+ Object unmarshal(Source source) throws XmlMappingException, IOException;
- /**
- * Indicates whether this unmarshaller can unmarshal instances of the supplied type.
- *
- * @param clazz the class that this unmarshaller is being asked if it can marshal
- * @return true if this unmarshaller can indeed unmarshal to the supplied class; false
- * otherwise
- */
- boolean supports(Class clazz);
+ /**
+ * Indicates whether this unmarshaller can unmarshal instances of the supplied type.
+ *
+ * @param clazz the class that this unmarshaller is being asked if it can marshal
+ * @return true if this unmarshaller can indeed unmarshal to the supplied class; false
+ * otherwise
+ */
+ boolean supports(Class clazz);
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/UnmarshallingFailureException.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/UnmarshallingFailureException.java
index d6986f22c3..877c63eb28 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/UnmarshallingFailureException.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/UnmarshallingFailureException.java
@@ -19,17 +19,17 @@ package org.springframework.oxm;
* Exception thrown on unmarshalling failure.
*
* @author Arjen Poutsma
- * @since 1.0.0
+ * @since 3.0
*/
public class UnmarshallingFailureException extends GenericMarshallingFailureException {
- /** Constructor for UnmarshallingFailureException. */
- public UnmarshallingFailureException(String msg) {
- super(msg);
- }
+ /** Constructor for UnmarshallingFailureException. */
+ public UnmarshallingFailureException(String msg) {
+ super(msg);
+ }
- /** Constructor for UnmarshallingFailureException. */
- public UnmarshallingFailureException(String msg, Throwable ex) {
- super(msg, ex);
- }
+ /** Constructor for UnmarshallingFailureException. */
+ public UnmarshallingFailureException(String msg, Throwable ex) {
+ super(msg, ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/ValidationFailureException.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/ValidationFailureException.java
index 5e430ec381..addc48db5a 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/ValidationFailureException.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/ValidationFailureException.java
@@ -19,17 +19,17 @@ package org.springframework.oxm;
* Exception thrown on marshalling validation failure.
*
* @author Arjen Poutsma
- * @since 1.0.0
+ * @since 3.0
*/
public class ValidationFailureException extends XmlMappingException {
- /** Constructor for ValidationFailureException. */
- public ValidationFailureException(String msg) {
- super(msg);
- }
+ /** Constructor for ValidationFailureException. */
+ public ValidationFailureException(String msg) {
+ super(msg);
+ }
- /** Constructor for ValidationFailureException. */
- public ValidationFailureException(String msg, Throwable ex) {
- super(msg, ex);
- }
+ /** Constructor for ValidationFailureException. */
+ public ValidationFailureException(String msg, Throwable ex) {
+ super(msg, ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/castor/CastorMarshaller.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/castor/CastorMarshaller.java
index a1d8120914..8d9447b4a9 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/castor/CastorMarshaller.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/castor/CastorMarshaller.java
@@ -50,396 +50,386 @@ import org.springframework.oxm.AbstractMarshaller;
import org.springframework.oxm.XmlMappingException;
import org.springframework.util.ObjectUtils;
import org.springframework.util.StringUtils;
-import org.springframework.xml.dom.DomContentHandler;
-import org.springframework.xml.sax.SaxUtils;
-import org.springframework.xml.stream.StaxEventContentHandler;
-import org.springframework.xml.stream.StaxEventXmlReader;
-import org.springframework.xml.stream.StaxStreamContentHandler;
-import org.springframework.xml.stream.StaxStreamXmlReader;
+import org.springframework.util.xml.DomUtils;
+import org.springframework.util.xml.SaxUtils;
+import org.springframework.util.xml.StaxUtils;
/**
* Implementation of the Marshaller interface for Castor. By default, Castor does not require any further
* configuration, though setting a target class or providing a mapping file can be used to have more control over the
* behavior of Castor.
- *
setTargetClass, the CastorMarshaller can only be used
- * to unmarshall XML that represents that specific class. If you want to unmarshall multiple classes, you have to
+ *
+ * If a target class is specified using setTargetClass, the CastorMarshaller can only be
+ * used to unmarshall XML that represents that specific class. If you want to unmarshall multiple classes, you have to
* provide a mapping file using setMappingLocations.
- *
UTF-8.
+ *
+ * Due to limitations of Castor's API, it is required to set the encoding used for writing to output streams. It
+ * defaults to UTF-8.
*
* @author Arjen Poutsma
* @see #setEncoding(String)
* @see #setTargetClass(Class)
- * @see #setMappingLocation(org.springframework.core.io.Resource)
- * @see #setMappingLocations(org.springframework.core.io.Resource[])
- * @since 1.0.0
+ * @see #setMappingLocation(Resource)
+ * @see #setMappingLocations(Resource[])
+ * @since 3.0
*/
public class CastorMarshaller extends AbstractMarshaller implements InitializingBean {
- /** The default encoding used for stream access. */
- public static final String DEFAULT_ENCODING = "UTF-8";
+ /** The default encoding used for stream access. */
+ public static final String DEFAULT_ENCODING = "UTF-8";
- private Resource[] mappingLocations;
+ private Resource[] mappingLocations;
- private String encoding = DEFAULT_ENCODING;
+ private String encoding = DEFAULT_ENCODING;
- private Class targetClass;
+ private Class targetClass;
- private XMLContext xmlContext;
+ private XMLContext xmlContext;
- private boolean validating = false;
+ private boolean validating = false;
- private boolean whitespacePreserve = false;
+ private boolean whitespacePreserve = false;
- private boolean ignoreExtraAttributes = true;
+ private boolean ignoreExtraAttributes = true;
- private boolean ignoreExtraElements = false;
+ private boolean ignoreExtraElements = false;
- private Properties namespaceMappings;
+ private Properties namespaceMappings;
- /** Returns whether the Castor {@link Unmarshaller} should ignore attributes that do not match a specific field. */
- public boolean getIgnoreExtraAttributes() {
- return ignoreExtraAttributes;
- }
+ /** Returns whether the Castor {@link Unmarshaller} should ignore attributes that do not match a specific field. */
+ public boolean getIgnoreExtraAttributes() {
+ return ignoreExtraAttributes;
+ }
- /**
- * Sets whether the Castor {@link Unmarshaller} should ignore attributes that do not match a specific field.
- * Default is true: extra attributes are ignored.
- *
- * @see org.exolab.castor.xml.Unmarshaller#setIgnoreExtraAttributes(boolean)
- */
- public void setIgnoreExtraAttributes(boolean ignoreExtraAttributes) {
- this.ignoreExtraAttributes = ignoreExtraAttributes;
- }
+ /**
+ * Sets whether the Castor {@link Unmarshaller} should ignore attributes that do not match a specific field. Default
+ * is true: extra attributes are ignored.
+ *
+ * @see org.exolab.castor.xml.Unmarshaller#setIgnoreExtraAttributes(boolean)
+ */
+ public void setIgnoreExtraAttributes(boolean ignoreExtraAttributes) {
+ this.ignoreExtraAttributes = ignoreExtraAttributes;
+ }
- /** Returns whether the Castor {@link Unmarshaller} should ignore elements that do not match a specific field. */
- public boolean getIgnoreExtraElements() {
- return ignoreExtraElements;
- }
+ /** Returns whether the Castor {@link Unmarshaller} should ignore elements that do not match a specific field. */
+ public boolean getIgnoreExtraElements() {
+ return ignoreExtraElements;
+ }
- /**
- * Sets whether the Castor {@link Unmarshaller} should ignore elements that do not match a specific field. Default
- * is false, extra attributes are flagged as an error.
- *
- * @see org.exolab.castor.xml.Unmarshaller#setIgnoreExtraElements(boolean)
- */
- public void setIgnoreExtraElements(boolean ignoreExtraElements) {
- this.ignoreExtraElements = ignoreExtraElements;
- }
+ /**
+ * Sets whether the Castor {@link Unmarshaller} should ignore elements that do not match a specific field. Default is
+ * false, extra attributes are flagged as an error.
+ *
+ * @see org.exolab.castor.xml.Unmarshaller#setIgnoreExtraElements(boolean)
+ */
+ public void setIgnoreExtraElements(boolean ignoreExtraElements) {
+ this.ignoreExtraElements = ignoreExtraElements;
+ }
- /** Returns whether the Castor {@link Unmarshaller} should preserve "ignorable" whitespace. */
- public boolean getWhitespacePreserve() {
- return whitespacePreserve;
- }
+ /** Returns whether the Castor {@link Unmarshaller} should preserve "ignorable" whitespace. */
+ public boolean getWhitespacePreserve() {
+ return whitespacePreserve;
+ }
- /**
- * Sets whether the Castor {@link Unmarshaller} should preserve "ignorable" whitespace. Default is
- * false.
- *
- * @see org.exolab.castor.xml.Unmarshaller#setWhitespacePreserve(boolean)
- */
- public void setWhitespacePreserve(boolean whitespacePreserve) {
- this.whitespacePreserve = whitespacePreserve;
- }
+ /**
+ * Sets whether the Castor {@link Unmarshaller} should preserve "ignorable" whitespace. Default is false.
+ *
+ * @see org.exolab.castor.xml.Unmarshaller#setWhitespacePreserve(boolean)
+ */
+ public void setWhitespacePreserve(boolean whitespacePreserve) {
+ this.whitespacePreserve = whitespacePreserve;
+ }
- /** Returns whether this marshaller should validate in- and outgoing documents. */
- public boolean isValidating() {
- return validating;
- }
+ /** Returns whether this marshaller should validate in- and outgoing documents. */
+ public boolean isValidating() {
+ return validating;
+ }
- /**
- * Sets whether this marshaller should validate in- and outgoing documents. Default is false.
- *
- * @see Marshaller#setValidation(boolean)
- */
- public void setValidating(boolean validating) {
- this.validating = validating;
- }
+ /**
+ * Sets whether this marshaller should validate in- and outgoing documents. Default is false.
+ *
+ * @see Marshaller#setValidation(boolean)
+ */
+ public void setValidating(boolean validating) {
+ this.validating = validating;
+ }
- /** Returns the namespace mappings. Property names are interpreted as namespace prefixes; values are namespace URIs. */
- public Properties getNamespaceMappings() {
- return namespaceMappings;
- }
+ /** Returns the namespace mappings. Property names are interpreted as namespace prefixes; values are namespace URIs. */
+ public Properties getNamespaceMappings() {
+ return namespaceMappings;
+ }
- /**
- * Sets the namespace mappings. Property names are interpreted as namespace prefixes; values are namespace URIs.
- *
- * @see org.exolab.castor.xml.Marshaller#setNamespaceMapping(String, String)
- */
- public void setNamespaceMappings(Properties namespaceMappings) {
- this.namespaceMappings = namespaceMappings;
- }
+ /**
+ * Sets the namespace mappings. Property names are interpreted as namespace prefixes; values are namespace URIs.
+ *
+ * @see org.exolab.castor.xml.Marshaller#setNamespaceMapping(String, String)
+ */
+ public void setNamespaceMappings(Properties namespaceMappings) {
+ this.namespaceMappings = namespaceMappings;
+ }
- /**
- * Sets the encoding to be used for stream access. If this property is not set, the default encoding is used.
- *
- * @see #DEFAULT_ENCODING
- */
- public void setEncoding(String encoding) {
- this.encoding = encoding;
- }
+ /**
+ * Sets the encoding to be used for stream access. If this property is not set, the default encoding is used.
+ *
+ * @see #DEFAULT_ENCODING
+ */
+ public void setEncoding(String encoding) {
+ this.encoding = encoding;
+ }
- /** Sets the locations of the Castor XML Mapping files. */
- public void setMappingLocation(Resource mappingLocation) {
- mappingLocations = new Resource[]{mappingLocation};
- }
+ /** Sets the locations of the Castor XML Mapping files. */
+ public void setMappingLocation(Resource mappingLocation) {
+ mappingLocations = new Resource[]{mappingLocation};
+ }
- /** Sets the locations of the Castor XML Mapping files. */
- public void setMappingLocations(Resource[] mappingLocations) {
- this.mappingLocations = mappingLocations;
- }
+ /** Sets the locations of the Castor XML Mapping files. */
+ public void setMappingLocations(Resource[] mappingLocations) {
+ this.mappingLocations = mappingLocations;
+ }
- /**
- * Sets the Castor target class. If this property is set, this CastorMarshaller is tied to this one
- * specific class. Use a mapping file for unmarshalling multiple classes.
- *
CastorMarshaller is tied to this one
+ * specific class. Use a mapping file for unmarshalling multiple classes. You cannot set both this property and
+ * the mapping (location).
+ */
+ public void setTargetClass(Class targetClass) {
+ this.targetClass = targetClass;
+ }
- public final void afterPropertiesSet() throws IOException {
- if (mappingLocations != null && targetClass != null) {
- throw new IllegalArgumentException("Cannot set both the 'mappingLocations' and 'targetClass' property. " +
- "Set targetClass for unmarshalling a single class, and 'mappingLocations' for multiple classes'");
- }
- if (logger.isInfoEnabled()) {
- if (mappingLocations != null) {
- logger.info("Configured using " + StringUtils.arrayToCommaDelimitedString(mappingLocations));
- }
- else if (targetClass != null) {
- logger.info("Configured for target class [" + targetClass.getName() + "]");
- }
- else {
- logger.info("Using default configuration");
- }
- }
- try {
- xmlContext = createXMLContext(mappingLocations, targetClass);
- }
- catch (MappingException ex) {
- throw new CastorSystemException("Could not load Castor mapping: " + ex.getMessage(), ex);
- }
- catch (ResolverException rex) {
- throw new CastorSystemException("Could not load Castor mapping: " + rex.getMessage(), rex);
- }
- }
+ public final void afterPropertiesSet() throws IOException {
+ if (mappingLocations != null && targetClass != null) {
+ throw new IllegalArgumentException("Cannot set both the 'mappingLocations' and 'targetClass' property. " +
+ "Set targetClass for unmarshalling a single class, and 'mappingLocations' for multiple classes'");
+ }
+ if (logger.isInfoEnabled()) {
+ if (mappingLocations != null) {
+ logger.info("Configured using " + StringUtils.arrayToCommaDelimitedString(mappingLocations));
+ }
+ else if (targetClass != null) {
+ logger.info("Configured for target class [" + targetClass.getName() + "]");
+ }
+ else {
+ logger.info("Using default configuration");
+ }
+ }
+ try {
+ xmlContext = createXMLContext(mappingLocations, targetClass);
+ }
+ catch (MappingException ex) {
+ throw new CastorSystemException("Could not load Castor mapping: " + ex.getMessage(), ex);
+ }
+ catch (ResolverException rex) {
+ throw new CastorSystemException("Could not load Castor mapping: " + rex.getMessage(), rex);
+ }
+ }
- /** Returns true for all classes, i.e. Castor supports arbitrary classes. */
- public boolean supports(Class clazz) {
- return true;
- }
+ /** Returns true for all classes, i.e. Castor supports arbitrary classes. */
+ public boolean supports(Class clazz) {
+ return true;
+ }
- /**
- * Creates the Castor XMLContext. Subclasses can override this to create a custom context.
- *
- * The default implementation loads mapping files if defined, and the target class if not defined.
- *
- * @return the created resolver
- * @throws MappingException when the mapping file cannot be loaded
- * @throws IOException in case of I/O errors
- * @see XMLContext#addMapping(org.exolab.castor.mapping.Mapping)
- * @see XMLContext#addClass(Class)
- */
- protected XMLContext createXMLContext(Resource[] mappingLocations, Class targetClass)
- throws MappingException, IOException, ResolverException {
- XMLContext context = new XMLContext();
- if (!ObjectUtils.isEmpty(mappingLocations)) {
- Mapping mapping = new Mapping();
- for (int i = 0; i < mappingLocations.length; i++) {
- mapping.loadMapping(SaxUtils.createInputSource(mappingLocations[i]));
- }
- context.addMapping(mapping);
- }
- if (targetClass != null) {
- context.addClass(targetClass);
- }
- return context;
- }
+ /**
+ * Creates the Castor XMLContext. Subclasses can override this to create a custom context. The
+ * default implementation loads mapping files if defined, and the target class if not defined.
+ *
+ * @return the created resolver
+ * @throws MappingException when the mapping file cannot be loaded
+ * @throws IOException in case of I/O errors
+ * @see XMLContext#addMapping(org.exolab.castor.mapping.Mapping)
+ * @see XMLContext#addClass(Class)
+ */
+ protected XMLContext createXMLContext(Resource[] mappingLocations, Class targetClass)
+ throws MappingException, IOException, ResolverException {
+ XMLContext context = new XMLContext();
+ if (!ObjectUtils.isEmpty(mappingLocations)) {
+ Mapping mapping = new Mapping();
+ for (Resource mappingLocation : mappingLocations) {
+ mapping.loadMapping(SaxUtils.createInputSource(mappingLocation));
+ }
+ context.addMapping(mapping);
+ }
+ if (targetClass != null) {
+ context.addClass(targetClass);
+ }
+ return context;
+ }
- //
- // Marshalling
- //
+ //
+ // Marshalling
+ //
- @Override
+ @Override
protected final void marshalDomNode(Object graph, Node node) throws XmlMappingException {
- marshalSaxHandlers(graph, new DomContentHandler(node), null);
- }
+ marshalSaxHandlers(graph, DomUtils.createContentHandler(node), null);
+ }
- @Override
+ @Override
protected final void marshalSaxHandlers(Object graph, ContentHandler contentHandler, LexicalHandler lexicalHandler)
- throws XmlMappingException {
- Marshaller marshaller = xmlContext.createMarshaller();
- marshaller.setContentHandler(contentHandler);
- marshal(graph, marshaller);
- }
+ throws XmlMappingException {
+ Marshaller marshaller = xmlContext.createMarshaller();
+ marshaller.setContentHandler(contentHandler);
+ marshal(graph, marshaller);
+ }
- @Override
+ @Override
protected final void marshalOutputStream(Object graph, OutputStream outputStream)
- throws XmlMappingException, IOException {
- marshalWriter(graph, new OutputStreamWriter(outputStream, encoding));
- }
+ throws XmlMappingException, IOException {
+ marshalWriter(graph, new OutputStreamWriter(outputStream, encoding));
+ }
- @Override
+ @Override
protected final void marshalWriter(Object graph, Writer writer) throws XmlMappingException, IOException {
- Marshaller marshaller = xmlContext.createMarshaller();
- marshaller.setWriter(writer);
- marshal(graph, marshaller);
- }
+ Marshaller marshaller = xmlContext.createMarshaller();
+ marshaller.setWriter(writer);
+ marshal(graph, marshaller);
+ }
- @Override
+ @Override
protected final void marshalXmlEventWriter(Object graph, XMLEventWriter eventWriter) throws XmlMappingException {
- marshalSaxHandlers(graph, new StaxEventContentHandler(eventWriter), null);
- }
+ marshalSaxHandlers(graph, StaxUtils.createContentHandler(eventWriter), null);
+ }
- @Override
+ @Override
protected final void marshalXmlStreamWriter(Object graph, XMLStreamWriter streamWriter) throws XmlMappingException {
- marshalSaxHandlers(graph, new StaxStreamContentHandler(streamWriter), null);
- }
+ marshalSaxHandlers(graph, StaxUtils.createContentHandler(streamWriter), null);
+ }
- private void marshal(Object graph, Marshaller marshaller) {
- try {
- customizeMarshaller(marshaller);
- marshaller.marshal(graph);
- }
- catch (XMLException ex) {
- throw convertCastorException(ex, true);
- }
- }
+ private void marshal(Object graph, Marshaller marshaller) {
+ try {
+ customizeMarshaller(marshaller);
+ marshaller.marshal(graph);
+ }
+ catch (XMLException ex) {
+ throw convertCastorException(ex, true);
+ }
+ }
- /**
- * Template method that allows for customizing of the given Castor {@link Marshaller}.
- *
- * Default implementation invokes {@link Marshaller#setValidation(boolean)} with the property set on this
- * marshaller, and calls {@link Marshaller#setNamespaceMapping(String, String)} with the {@linkplain
- * #setNamespaceMappings(java.util.Properties) namespace mappings}.
- */
- protected void customizeMarshaller(Marshaller marshaller) {
- marshaller.setValidation(isValidating());
- Properties namespaceMappings = getNamespaceMappings();
- if (namespaceMappings != null) {
- for (Iterator iterator = namespaceMappings.keySet().iterator(); iterator.hasNext();) {
- String prefix = (String) iterator.next();
- String uri = namespaceMappings.getProperty(prefix);
- marshaller.setNamespaceMapping(prefix, uri);
- }
- }
- }
+ /**
+ * Template method that allows for customizing of the given Castor {@link Marshaller}. Default implementation
+ * invokes {@link Marshaller#setValidation(boolean)} with the property set on this marshaller, and calls {@link
+ * Marshaller#setNamespaceMapping(String, String)} with the {@linkplain #setNamespaceMappings(java.util.Properties)
+ * namespace mappings}.
+ */
+ protected void customizeMarshaller(Marshaller marshaller) {
+ marshaller.setValidation(isValidating());
+ Properties namespaceMappings = getNamespaceMappings();
+ if (namespaceMappings != null) {
+ for (Iterator iterator = namespaceMappings.keySet().iterator(); iterator.hasNext();) {
+ String prefix = (String) iterator.next();
+ String uri = namespaceMappings.getProperty(prefix);
+ marshaller.setNamespaceMapping(prefix, uri);
+ }
+ }
+ }
- //
- // Unmarshalling
- //
+ //
+ // Unmarshalling
+ //
- @Override
+ @Override
protected final Object unmarshalDomNode(Node node) throws XmlMappingException {
- try {
- return createUnmarshaller().unmarshal(node);
- }
- catch (XMLException ex) {
- throw convertCastorException(ex, false);
- }
- }
+ try {
+ return createUnmarshaller().unmarshal(node);
+ }
+ catch (XMLException ex) {
+ throw convertCastorException(ex, false);
+ }
+ }
- @Override
+ @Override
protected final Object unmarshalInputStream(InputStream inputStream) throws XmlMappingException, IOException {
- try {
- return createUnmarshaller().unmarshal(new InputSource(inputStream));
- }
- catch (XMLException ex) {
- throw convertCastorException(ex, false);
- }
- }
+ try {
+ return createUnmarshaller().unmarshal(new InputSource(inputStream));
+ }
+ catch (XMLException ex) {
+ throw convertCastorException(ex, false);
+ }
+ }
- @Override
+ @Override
protected final Object unmarshalReader(Reader reader) throws XmlMappingException, IOException {
- try {
- return createUnmarshaller().unmarshal(new InputSource(reader));
- }
- catch (XMLException ex) {
- throw convertCastorException(ex, false);
- }
- }
+ try {
+ return createUnmarshaller().unmarshal(new InputSource(reader));
+ }
+ catch (XMLException ex) {
+ throw convertCastorException(ex, false);
+ }
+ }
- @Override
+ @Override
protected final Object unmarshalXmlEventReader(XMLEventReader eventReader) {
- XMLReader reader = new StaxEventXmlReader(eventReader);
- try {
- return unmarshalSaxReader(reader, new InputSource());
- }
- catch (IOException ex) {
- throw new CastorUnmarshallingFailureException(new MarshalException(ex));
- }
- }
+ XMLReader reader = StaxUtils.createXMLReader(eventReader);
+ try {
+ return unmarshalSaxReader(reader, new InputSource());
+ }
+ catch (IOException ex) {
+ throw new CastorUnmarshallingFailureException(new MarshalException(ex));
+ }
+ }
- @Override
+ @Override
protected final Object unmarshalSaxReader(XMLReader xmlReader, InputSource inputSource)
- throws XmlMappingException, IOException {
- UnmarshalHandler unmarshalHandler = createUnmarshaller().createHandler();
- try {
- ContentHandler contentHandler = Unmarshaller.getContentHandler(unmarshalHandler);
- xmlReader.setContentHandler(contentHandler);
- xmlReader.parse(inputSource);
- return unmarshalHandler.getObject();
- }
- catch (SAXException ex) {
- throw new CastorUnmarshallingFailureException(ex);
- }
- }
+ throws XmlMappingException, IOException {
+ UnmarshalHandler unmarshalHandler = createUnmarshaller().createHandler();
+ try {
+ ContentHandler contentHandler = Unmarshaller.getContentHandler(unmarshalHandler);
+ xmlReader.setContentHandler(contentHandler);
+ xmlReader.parse(inputSource);
+ return unmarshalHandler.getObject();
+ }
+ catch (SAXException ex) {
+ throw new CastorUnmarshallingFailureException(ex);
+ }
+ }
- @Override
+ @Override
protected final Object unmarshalXmlStreamReader(XMLStreamReader streamReader) {
- XMLReader reader = new StaxStreamXmlReader(streamReader);
- try {
- return unmarshalSaxReader(reader, new InputSource());
- }
- catch (IOException ex) {
- throw new CastorUnmarshallingFailureException(new MarshalException(ex));
- }
- }
+ XMLReader reader = StaxUtils.createXMLReader(streamReader);
+ try {
+ return unmarshalSaxReader(reader, new InputSource());
+ }
+ catch (IOException ex) {
+ throw new CastorUnmarshallingFailureException(new MarshalException(ex));
+ }
+ }
- private Unmarshaller createUnmarshaller() {
- Unmarshaller unmarshaller = xmlContext.createUnmarshaller();
- if (targetClass != null) {
- unmarshaller.setClass(targetClass);
- unmarshaller.setClassLoader(targetClass.getClassLoader());
- }
- customizeUnmarshaller(unmarshaller);
- return unmarshaller;
- }
+ private Unmarshaller createUnmarshaller() {
+ Unmarshaller unmarshaller = xmlContext.createUnmarshaller();
+ if (targetClass != null) {
+ unmarshaller.setClass(targetClass);
+ unmarshaller.setClassLoader(targetClass.getClassLoader());
+ }
+ customizeUnmarshaller(unmarshaller);
+ return unmarshaller;
+ }
- /**
- * Template method that allows for customizing of the given Castor {@link Unmarshaller}.
- *
- * Default implementation invokes {@link Unmarshaller#setValidation(boolean)}, {@link
- * Unmarshaller#setWhitespacePreserve(boolean)}, {@link Unmarshaller#setIgnoreExtraAttributes(boolean)}, and {@link
- * Unmarshaller#setIgnoreExtraElements(boolean)} with the properties set on this marshaller.
- */
- protected void customizeUnmarshaller(Unmarshaller unmarshaller) {
- unmarshaller.setValidation(isValidating());
- unmarshaller.setWhitespacePreserve(getWhitespacePreserve());
- unmarshaller.setIgnoreExtraAttributes(getIgnoreExtraAttributes());
- unmarshaller.setIgnoreExtraElements(getIgnoreExtraElements());
- }
+ /**
+ * Template method that allows for customizing of the given Castor {@link Unmarshaller}. Default implementation
+ * invokes {@link Unmarshaller#setValidation(boolean)}, {@link Unmarshaller#setWhitespacePreserve(boolean)}, {@link
+ * Unmarshaller#setIgnoreExtraAttributes(boolean)}, and {@link Unmarshaller#setIgnoreExtraElements(boolean)} with the
+ * properties set on this marshaller.
+ */
+ protected void customizeUnmarshaller(Unmarshaller unmarshaller) {
+ unmarshaller.setValidation(isValidating());
+ unmarshaller.setWhitespacePreserve(getWhitespacePreserve());
+ unmarshaller.setIgnoreExtraAttributes(getIgnoreExtraAttributes());
+ unmarshaller.setIgnoreExtraElements(getIgnoreExtraElements());
+ }
- /**
- * Converts the given CastorException to an appropriate exception from the
- * org.springframework.oxm hierarchy.
- *
- * The default implementation delegates to CastorUtils. Can be overridden in subclasses.
- *
- * A boolean flag is used to indicate whether this exception occurs during marshalling or unmarshalling, since
- * Castor itself does not make this distinction in its exception hierarchy.
- *
- * @param ex Castor XMLException that occured
- * @param marshalling indicates whether the exception occurs during marshalling (true), or
- * unmarshalling (false)
- * @return the corresponding XmlMappingException
- * @see CastorUtils#convertXmlException
- */
- public XmlMappingException convertCastorException(XMLException ex, boolean marshalling) {
- return CastorUtils.convertXmlException(ex, marshalling);
- }
+ /**
+ * Converts the given CastorException to an appropriate exception from the
+ * org.springframework.oxm hierarchy. The default implementation delegates to
+ * CastorUtils. Can be overridden in subclasses. A boolean flag is used to indicate whether this
+ * exception occurs during marshalling or unmarshalling, since Castor itself does not make this distinction in its
+ * exception hierarchy.
+ *
+ * @param ex Castor XMLException that occured
+ * @param marshalling indicates whether the exception occurs during marshalling (true), or unmarshalling
+ * (false)
+ * @return the corresponding XmlMappingException
+ * @see CastorUtils#convertXmlException
+ */
+ public XmlMappingException convertCastorException(XMLException ex, boolean marshalling) {
+ return CastorUtils.convertXmlException(ex, marshalling);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/castor/CastorMarshallingFailureException.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/castor/CastorMarshallingFailureException.java
index 0a9987acfd..f225106095 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/castor/CastorMarshallingFailureException.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/castor/CastorMarshallingFailureException.java
@@ -16,6 +16,7 @@
package org.springframework.oxm.castor;
import org.exolab.castor.xml.MarshalException;
+
import org.springframework.oxm.MarshallingFailureException;
/**
@@ -23,12 +24,12 @@ import org.springframework.oxm.MarshallingFailureException;
*
* @author Arjen Poutsma
* @see CastorUtils#convertXmlException
- * @since 1.0.0
+ * @since 3.0
*/
public class CastorMarshallingFailureException extends MarshallingFailureException {
- public CastorMarshallingFailureException(MarshalException ex) {
- super("Castor marshalling exception: " + ex.getMessage(), ex);
- }
+ public CastorMarshallingFailureException(MarshalException ex) {
+ super("Castor marshalling exception: " + ex.getMessage(), ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/castor/CastorSystemException.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/castor/CastorSystemException.java
index 6e10d29a91..d8a84a945b 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/castor/CastorSystemException.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/castor/CastorSystemException.java
@@ -22,11 +22,11 @@ import org.springframework.oxm.UncategorizedXmlMappingException;
* distinguished further.
*
* @author Arjen Poutsma
- * @since 1.0.0
+ * @since 3.0
*/
public class CastorSystemException extends UncategorizedXmlMappingException {
- public CastorSystemException(String msg, Throwable ex) {
- super(msg, ex);
- }
+ public CastorSystemException(String msg, Throwable ex) {
+ super(msg, ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/castor/CastorUnmarshallingFailureException.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/castor/CastorUnmarshallingFailureException.java
index fbb4d20cd6..307cb69634 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/castor/CastorUnmarshallingFailureException.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/castor/CastorUnmarshallingFailureException.java
@@ -16,23 +16,24 @@
package org.springframework.oxm.castor;
import org.exolab.castor.xml.MarshalException;
-import org.springframework.oxm.UnmarshallingFailureException;
import org.xml.sax.SAXException;
+import org.springframework.oxm.UnmarshallingFailureException;
+
/**
* Castor-specific subclass of UnmarshallingFailureException.
*
* @author Arjen Poutsma
* @see CastorUtils#convertXmlException
- * @since 1.0.0
+ * @since 3.0
*/
public class CastorUnmarshallingFailureException extends UnmarshallingFailureException {
- public CastorUnmarshallingFailureException(MarshalException ex) {
- super("Castor unmarshalling exception: " + ex.getMessage(), ex);
- }
+ public CastorUnmarshallingFailureException(MarshalException ex) {
+ super("Castor unmarshalling exception: " + ex.getMessage(), ex);
+ }
- public CastorUnmarshallingFailureException(SAXException ex) {
- super("Castor unmarshalling exception: " + ex.getMessage(), ex);
- }
+ public CastorUnmarshallingFailureException(SAXException ex) {
+ super("Castor unmarshalling exception: " + ex.getMessage(), ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/castor/CastorUtils.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/castor/CastorUtils.java
index c503a08ce9..3515e97cd3 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/castor/CastorUtils.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/castor/CastorUtils.java
@@ -18,43 +18,43 @@ package org.springframework.oxm.castor;
import org.exolab.castor.xml.MarshalException;
import org.exolab.castor.xml.ValidationException;
import org.exolab.castor.xml.XMLException;
+
import org.springframework.oxm.XmlMappingException;
/**
* Generic utility methods for working with Castor. Mainly for internal use within the framework.
*
* @author Arjen Poutsma
- * @since 1.0.0
+ * @since 3.0
*/
public class CastorUtils {
- /**
- * Converts the given XMLException to an appropriate exception from the
- * org.springframework.oxm hierarchy.
- *
- * A boolean flag is used to indicate whether this exception occurs during marshalling or unmarshalling, since
- * Castor itself does not make this distinction in its exception hierarchy.
- *
- * @param ex Castor XMLException that occured
- * @param marshalling indicates whether the exception occurs during marshalling (true), or
- * unmarshalling (false)
- * @return the corresponding XmlMappingException
- */
- public static XmlMappingException convertXmlException(XMLException ex, boolean marshalling) {
- if (ex instanceof MarshalException) {
- MarshalException marshalException = (MarshalException) ex;
- if (marshalling) {
- return new CastorMarshallingFailureException(marshalException);
- }
- else {
- return new CastorUnmarshallingFailureException(marshalException);
- }
- }
- else if (ex instanceof ValidationException) {
- return new CastorValidationFailureException((ValidationException) ex);
- }
- // fallback
- return new CastorSystemException("Unknown Castor exception: " + ex.getMessage(), ex);
- }
+ /**
+ * Converts the given XMLException to an appropriate exception from the
+ * org.springframework.oxm hierarchy. A boolean flag is used to indicate whether this exception
+ * occurs during marshalling or unmarshalling, since Castor itself does not make this distinction in its exception
+ * hierarchy.
+ *
+ * @param ex Castor XMLException that occured
+ * @param marshalling indicates whether the exception occurs during marshalling (true), or unmarshalling
+ * (false)
+ * @return the corresponding XmlMappingException
+ */
+ public static XmlMappingException convertXmlException(XMLException ex, boolean marshalling) {
+ if (ex instanceof MarshalException) {
+ MarshalException marshalException = (MarshalException) ex;
+ if (marshalling) {
+ return new CastorMarshallingFailureException(marshalException);
+ }
+ else {
+ return new CastorUnmarshallingFailureException(marshalException);
+ }
+ }
+ else if (ex instanceof ValidationException) {
+ return new CastorValidationFailureException((ValidationException) ex);
+ }
+ // fallback
+ return new CastorSystemException("Unknown Castor exception: " + ex.getMessage(), ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/castor/CastorValidationFailureException.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/castor/CastorValidationFailureException.java
index a8842aaee6..e33fd7285e 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/castor/CastorValidationFailureException.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/castor/CastorValidationFailureException.java
@@ -16,6 +16,7 @@
package org.springframework.oxm.castor;
import org.exolab.castor.xml.ValidationException;
+
import org.springframework.oxm.ValidationFailureException;
/**
@@ -23,11 +24,11 @@ import org.springframework.oxm.ValidationFailureException;
*
* @author Arjen Poutsma
* @see CastorUtils#convertXmlException
- * @since 1.0.0
+ * @since 3.0
*/
public class CastorValidationFailureException extends ValidationFailureException {
- public CastorValidationFailureException(ValidationException ex) {
- super("Castor validation exception: " + ex.getMessage(), ex);
- }
+ public CastorValidationFailureException(ValidationException ex) {
+ super("Castor validation exception: " + ex.getMessage(), ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/config/Jaxb1MarshallerBeanDefinitionParser.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/config/Jaxb1MarshallerBeanDefinitionParser.java
deleted file mode 100644
index cc245dfda4..0000000000
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/config/Jaxb1MarshallerBeanDefinitionParser.java
+++ /dev/null
@@ -1,37 +0,0 @@
-/*
- * Copyright 2008 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.oxm.config;
-
-import org.w3c.dom.Element;
-
-import org.springframework.beans.factory.xml.AbstractSimpleBeanDefinitionParser;
-
-/**
- * Parser for the <oxm:jaxb1-marshaller/> element.
- *
- * @author Arjen Poutsma
- * @since 1.5.0
- */
-class Jaxb1MarshallerBeanDefinitionParser extends AbstractSimpleBeanDefinitionParser {
-
- public static final String JAXB1_MARSHALLER_CLASS_NAME = "org.springframework.oxm.jaxb.Jaxb1Marshaller";
-
- @Override
- protected String getBeanClassName(Element element) {
- return JAXB1_MARSHALLER_CLASS_NAME;
- }
-}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/config/Jaxb2MarshallerBeanDefinitionParser.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/config/Jaxb2MarshallerBeanDefinitionParser.java
index 3249ca5527..9172b87d9b 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/config/Jaxb2MarshallerBeanDefinitionParser.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/config/Jaxb2MarshallerBeanDefinitionParser.java
@@ -19,45 +19,46 @@ package org.springframework.oxm.config;
import java.util.Iterator;
import java.util.List;
+import org.w3c.dom.Element;
+
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.support.ManagedList;
import org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser;
import org.springframework.beans.factory.xml.ParserContext;
import org.springframework.util.StringUtils;
import org.springframework.util.xml.DomUtils;
-import org.w3c.dom.Element;
/**
* Parser for the <oxm:jaxb2-marshaller/> element.
*
* @author Arjen Poutsma
- * @since 1.5.0
+ * @since 3.0
*/
class Jaxb2MarshallerBeanDefinitionParser extends AbstractSingleBeanDefinitionParser {
- private static final String JAXB2_MARSHALLER_CLASS_NAME = "org.springframework.oxm.jaxb.Jaxb2Marshaller";
+ private static final String JAXB2_MARSHALLER_CLASS_NAME = "org.springframework.oxm.jaxb.Jaxb2Marshaller";
- @Override
+ @Override
protected String getBeanClassName(Element element) {
- return JAXB2_MARSHALLER_CLASS_NAME;
- }
+ return JAXB2_MARSHALLER_CLASS_NAME;
+ }
- @Override
+ @Override
protected void doParse(Element element, ParserContext parserContext, BeanDefinitionBuilder beanDefinitionBuilder) {
- String contextPath = element.getAttribute("contextPath");
- if (StringUtils.hasText(contextPath)) {
- beanDefinitionBuilder.addPropertyValue("contextPath", contextPath);
- }
- List classes = DomUtils.getChildElementsByTagName(element, "class-to-be-bound");
- if (!classes.isEmpty()) {
- ManagedList classesToBeBound = new ManagedList(classes.size());
- for (Iterator iterator = classes.iterator(); iterator.hasNext();) {
- Element classToBeBound = (Element) iterator.next();
- String className = classToBeBound.getAttribute("name");
- classesToBeBound.add(className);
- }
- beanDefinitionBuilder.addPropertyValue("classesToBeBound", classesToBeBound);
- }
- }
+ String contextPath = element.getAttribute("contextPath");
+ if (StringUtils.hasText(contextPath)) {
+ beanDefinitionBuilder.addPropertyValue("contextPath", contextPath);
+ }
+ List classes = DomUtils.getChildElementsByTagName(element, "class-to-be-bound");
+ if (!classes.isEmpty()) {
+ ManagedList classesToBeBound = new ManagedList(classes.size());
+ for (Iterator iterator = classes.iterator(); iterator.hasNext();) {
+ Element classToBeBound = (Element) iterator.next();
+ String className = classToBeBound.getAttribute("name");
+ classesToBeBound.add(className);
+ }
+ beanDefinitionBuilder.addPropertyValue("classesToBeBound", classesToBeBound);
+ }
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/config/JibxMarshallerBeanDefinitionParser.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/config/JibxMarshallerBeanDefinitionParser.java
index 710a86f67c..71faac2dc4 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/config/JibxMarshallerBeanDefinitionParser.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/config/JibxMarshallerBeanDefinitionParser.java
@@ -24,15 +24,15 @@ import org.springframework.beans.factory.xml.AbstractSimpleBeanDefinitionParser;
* Parser for the <oxm:jibx-marshaller/> element.
*
* @author Arjen Poutsma
- * @since 1.5.0
+ * @since 3.0
*/
class JibxMarshallerBeanDefinitionParser extends AbstractSimpleBeanDefinitionParser {
- private static final String JIBX_MARSHALLER_CLASS_NAME = "org.springframework.oxm.jibx.JibxMarshaller";
+ private static final String JIBX_MARSHALLER_CLASS_NAME = "org.springframework.oxm.jibx.JibxMarshaller";
- @Override
+ @Override
protected String getBeanClassName(Element element) {
- return JIBX_MARSHALLER_CLASS_NAME;
- }
+ return JIBX_MARSHALLER_CLASS_NAME;
+ }
}
\ No newline at end of file
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/config/OxmNamespaceHandler.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/config/OxmNamespaceHandler.java
index 7387b639e4..8f73923e61 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/config/OxmNamespaceHandler.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/config/OxmNamespaceHandler.java
@@ -23,14 +23,13 @@ import org.springframework.beans.factory.xml.NamespaceHandlerSupport;
* {@link NamespaceHandler} for the 'oxm' namespace.
*
* @author Arjen Poutsma
- * @since 1.5.0
+ * @since 3.0
*/
public class OxmNamespaceHandler extends NamespaceHandlerSupport {
- public void init() {
- registerBeanDefinitionParser("jaxb1-marshaller", new Jaxb1MarshallerBeanDefinitionParser());
- registerBeanDefinitionParser("jaxb2-marshaller", new Jaxb2MarshallerBeanDefinitionParser());
- registerBeanDefinitionParser("jibx-marshaller", new JibxMarshallerBeanDefinitionParser());
- registerBeanDefinitionParser("xmlbeans-marshaller", new XmlBeansMarshallerBeanDefinitionParser());
- }
+ public void init() {
+ registerBeanDefinitionParser("jaxb2-marshaller", new Jaxb2MarshallerBeanDefinitionParser());
+ registerBeanDefinitionParser("jibx-marshaller", new JibxMarshallerBeanDefinitionParser());
+ registerBeanDefinitionParser("xmlbeans-marshaller", new XmlBeansMarshallerBeanDefinitionParser());
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/config/XmlBeansMarshallerBeanDefinitionParser.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/config/XmlBeansMarshallerBeanDefinitionParser.java
index 067e42484f..075ea7b152 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/config/XmlBeansMarshallerBeanDefinitionParser.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/config/XmlBeansMarshallerBeanDefinitionParser.java
@@ -27,22 +27,22 @@ import org.springframework.util.StringUtils;
* Parser for the <oxm:xmlbeans-marshaller/> element.
*
* @author Arjen Poutsma
- * @since 1.5.0
+ * @since 3.0
*/
class XmlBeansMarshallerBeanDefinitionParser extends AbstractSingleBeanDefinitionParser {
- public static final String XML_BEANS_MARSHALLER_CLASS_NAME = "org.springframework.oxm.xmlbeans.XmlBeansMarshaller";
+ public static final String XML_BEANS_MARSHALLER_CLASS_NAME = "org.springframework.oxm.xmlbeans.XmlBeansMarshaller";
- @Override
+ @Override
protected String getBeanClassName(Element element) {
- return XML_BEANS_MARSHALLER_CLASS_NAME;
- }
+ return XML_BEANS_MARSHALLER_CLASS_NAME;
+ }
- @Override
+ @Override
protected void doParse(Element element, ParserContext parserContext, BeanDefinitionBuilder beanDefinitionBuilder) {
- String optionsName = element.getAttribute("options");
- if (StringUtils.hasText(optionsName)) {
- beanDefinitionBuilder.addPropertyReference("xmlOptions", optionsName);
- }
- }
+ String optionsName = element.getAttribute("options");
+ if (StringUtils.hasText(optionsName)) {
+ beanDefinitionBuilder.addPropertyReference("xmlOptions", optionsName);
+ }
+ }
}
\ No newline at end of file
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/AbstractJaxbMarshaller.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/AbstractJaxbMarshaller.java
index 2212f327aa..5b3f18f229 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/AbstractJaxbMarshaller.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/AbstractJaxbMarshaller.java
@@ -26,6 +26,7 @@ import javax.xml.bind.ValidationEventHandler;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
+
import org.springframework.beans.factory.InitializingBean;
import org.springframework.oxm.XmlMappingException;
import org.springframework.util.Assert;
@@ -33,176 +34,171 @@ import org.springframework.util.StringUtils;
/**
* 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).
+ * 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).
*
* @author Arjen Poutsma
- * @see Jaxb1Marshaller
* @see Jaxb2Marshaller
- * @since 1.0.0
+ * @since 3.0
*/
public abstract class AbstractJaxbMarshaller
- implements org.springframework.oxm.Marshaller, org.springframework.oxm.Unmarshaller, InitializingBean {
+ implements org.springframework.oxm.Marshaller, org.springframework.oxm.Unmarshaller, InitializingBean {
- /** Logger available to subclasses. */
- protected final Log logger = LogFactory.getLog(getClass());
+ /** Logger available to subclasses. */
+ protected final Log logger = LogFactory.getLog(getClass());
- private String contextPath;
+ private String contextPath;
- private Map marshallerProperties;
+ private Map marshallerProperties;
- private Map unmarshallerProperties;
+ private Map unmarshallerProperties;
- private JAXBContext jaxbContext;
+ private JAXBContext jaxbContext;
- private ValidationEventHandler validationEventHandler;
+ private ValidationEventHandler validationEventHandler;
- /** Returns the JAXB Context path. */
- protected String getContextPath() {
- return contextPath;
- }
+ /** Returns the JAXB Context path. */
+ protected String getContextPath() {
+ return contextPath;
+ }
- /** Sets the JAXB Context path. */
- public void setContextPath(String contextPath) {
- Assert.notNull(contextPath, "'contextPath' must not be null");
- this.contextPath = contextPath;
- }
+ /** Sets the JAXB Context path. */
+ public void setContextPath(String contextPath) {
+ Assert.notNull(contextPath, "'contextPath' must not be null");
+ this.contextPath = contextPath;
+ }
- /**
- * Sets multiple JAXB Context paths. The given array of context paths is converted to a colon-delimited string, as
- * supported by JAXB.
- */
- public void setContextPaths(String[] contextPaths) {
- Assert.notEmpty(contextPaths, "'contextPaths' must not be empty");
- this.contextPath = StringUtils.arrayToDelimitedString(contextPaths, ":");
- }
+ /**
+ * Sets multiple JAXB Context paths. The given array of context paths is converted to a colon-delimited string, as
+ * supported by JAXB.
+ */
+ public void setContextPaths(String[] contextPaths) {
+ Assert.notEmpty(contextPaths, "'contextPaths' must not be empty");
+ this.contextPath = StringUtils.arrayToDelimitedString(contextPaths, ":");
+ }
- /**
- * Sets the JAXB Marshaller properties. These properties will be set on the underlying JAXB
- * Marshaller, and allow for features such as indentation.
- *
- * @param properties the properties
- * @see javax.xml.bind.Marshaller#setProperty(String,Object)
- * @see javax.xml.bind.Marshaller#JAXB_ENCODING
- * @see javax.xml.bind.Marshaller#JAXB_FORMATTED_OUTPUT
- * @see javax.xml.bind.Marshaller#JAXB_NO_NAMESPACE_SCHEMA_LOCATION
- * @see javax.xml.bind.Marshaller#JAXB_SCHEMA_LOCATION
- */
- public void setMarshallerProperties(Map properties) {
- this.marshallerProperties = properties;
- }
+ /**
+ * Sets the JAXB Marshaller properties. These properties will be set on the underlying JAXB
+ * Marshaller, and allow for features such as indentation.
+ *
+ * @param properties the properties
+ * @see javax.xml.bind.Marshaller#setProperty(String,Object)
+ * @see javax.xml.bind.Marshaller#JAXB_ENCODING
+ * @see javax.xml.bind.Marshaller#JAXB_FORMATTED_OUTPUT
+ * @see javax.xml.bind.Marshaller#JAXB_NO_NAMESPACE_SCHEMA_LOCATION
+ * @see javax.xml.bind.Marshaller#JAXB_SCHEMA_LOCATION
+ */
+ public void setMarshallerProperties(Map properties) {
+ this.marshallerProperties = properties;
+ }
- /**
- * Sets the JAXB Unmarshaller properties. These properties will be set on the underlying JAXB
- * Unmarshaller.
- *
- * @param properties the properties
- * @see javax.xml.bind.Unmarshaller#setProperty(String,Object)
- */
- public void setUnmarshallerProperties(Map properties) {
- this.unmarshallerProperties = properties;
- }
+ /**
+ * Sets the JAXB Unmarshaller properties. These properties will be set on the underlying JAXB
+ * Unmarshaller.
+ *
+ * @param properties the properties
+ * @see javax.xml.bind.Unmarshaller#setProperty(String,Object)
+ */
+ public void setUnmarshallerProperties(Map properties) {
+ this.unmarshallerProperties = properties;
+ }
- /**
- * 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.
- *
- * @param validationEventHandler the event handler
- */
- public void setValidationEventHandler(ValidationEventHandler validationEventHandler) {
- this.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.
+ *
+ * @param validationEventHandler the event handler
+ */
+ public void setValidationEventHandler(ValidationEventHandler validationEventHandler) {
+ this.validationEventHandler = validationEventHandler;
+ }
- /** Returns the {@link JAXBContext} created in {@link #afterPropertiesSet()}. */
- public JAXBContext getJaxbContext() {
- return jaxbContext;
- }
+ /** Returns the {@link JAXBContext} created in {@link #afterPropertiesSet()}. */
+ public JAXBContext getJaxbContext() {
+ return jaxbContext;
+ }
- public final void afterPropertiesSet() throws Exception {
- try {
- jaxbContext = createJaxbContext();
- }
- catch (JAXBException ex) {
- throw convertJaxbException(ex);
- }
- }
+ public final void afterPropertiesSet() throws Exception {
+ try {
+ jaxbContext = createJaxbContext();
+ }
+ catch (JAXBException ex) {
+ throw convertJaxbException(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.
- *
- * @param ex JAXBException that occured
- * @return the corresponding XmlMappingException instance
- * @see JaxbUtils#convertJaxbException
- */
- protected XmlMappingException convertJaxbException(JAXBException ex) {
- return JaxbUtils.convertJaxbException(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.
+ *
+ * @param ex JAXBException that occured
+ * @return the corresponding XmlMappingException instance
+ * @see JaxbUtils#convertJaxbException
+ */
+ protected XmlMappingException convertJaxbException(JAXBException ex) {
+ return JaxbUtils.convertJaxbException(ex);
+ }
- /** Returns a newly created JAXB marshaller. JAXB marshallers are not necessarily thread safe. */
- protected Marshaller createMarshaller() {
- try {
- Marshaller marshaller = jaxbContext.createMarshaller();
- if (marshallerProperties != null) {
- for (Iterator iterator = marshallerProperties.keySet().iterator(); iterator.hasNext();) {
- String name = (String) iterator.next();
- marshaller.setProperty(name, marshallerProperties.get(name));
- }
- }
- if (validationEventHandler != null) {
- marshaller.setEventHandler(validationEventHandler);
- }
- initJaxbMarshaller(marshaller);
- return marshaller;
- }
- catch (JAXBException ex) {
- throw convertJaxbException(ex);
- }
- }
+ /** Returns a newly created JAXB marshaller. JAXB marshallers are not necessarily thread safe. */
+ protected Marshaller createMarshaller() {
+ try {
+ Marshaller marshaller = jaxbContext.createMarshaller();
+ if (marshallerProperties != null) {
+ for (Iterator iterator = marshallerProperties.keySet().iterator(); iterator.hasNext();) {
+ String name = (String) iterator.next();
+ marshaller.setProperty(name, marshallerProperties.get(name));
+ }
+ }
+ if (validationEventHandler != null) {
+ marshaller.setEventHandler(validationEventHandler);
+ }
+ initJaxbMarshaller(marshaller);
+ return marshaller;
+ }
+ catch (JAXBException ex) {
+ throw convertJaxbException(ex);
+ }
+ }
- /** Returns a newly created JAXB unmarshaller. JAXB unmarshallers are not necessarily thread safe. */
- protected Unmarshaller createUnmarshaller() {
- try {
- Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
- if (unmarshallerProperties != null) {
- for (Iterator iterator = unmarshallerProperties.keySet().iterator(); iterator.hasNext();) {
- String name = (String) iterator.next();
- unmarshaller.setProperty(name, unmarshallerProperties.get(name));
- }
- }
- if (validationEventHandler != null) {
- unmarshaller.setEventHandler(validationEventHandler);
- }
- initJaxbUnmarshaller(unmarshaller);
- return unmarshaller;
- }
- catch (JAXBException ex) {
- throw convertJaxbException(ex);
- }
- }
+ /** Returns a newly created JAXB unmarshaller. JAXB unmarshallers are not necessarily thread safe. */
+ protected Unmarshaller createUnmarshaller() {
+ try {
+ Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
+ if (unmarshallerProperties != null) {
+ for (Iterator iterator = unmarshallerProperties.keySet().iterator(); iterator.hasNext();) {
+ String name = (String) iterator.next();
+ unmarshaller.setProperty(name, unmarshallerProperties.get(name));
+ }
+ }
+ if (validationEventHandler != null) {
+ unmarshaller.setEventHandler(validationEventHandler);
+ }
+ initJaxbUnmarshaller(unmarshaller);
+ return unmarshaller;
+ }
+ catch (JAXBException ex) {
+ throw convertJaxbException(ex);
+ }
+ }
- /**
- * 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.
- */
- protected void initJaxbMarshaller(Marshaller marshaller) throws 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.
+ */
+ protected void initJaxbMarshaller(Marshaller marshaller) throws 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.
- */
- protected void initJaxbUnmarshaller(Unmarshaller unmarshaller) throws 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.
+ */
+ protected void initJaxbUnmarshaller(Unmarshaller unmarshaller) throws JAXBException {
+ }
- /** Template method that returns a newly created JAXB context. Called from afterPropertiesSet(). */
- protected abstract JAXBContext createJaxbContext() throws Exception;
+ /** Template method that returns a newly created JAXB context. Called from afterPropertiesSet(). */
+ protected abstract JAXBContext createJaxbContext() throws Exception;
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/Jaxb1Marshaller.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/Jaxb1Marshaller.java
deleted file mode 100644
index 40ecb9e2fc..0000000000
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/Jaxb1Marshaller.java
+++ /dev/null
@@ -1,154 +0,0 @@
-/*
- * Copyright 2005 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.springframework.oxm.jaxb;
-
-import javax.xml.bind.Element;
-import javax.xml.bind.JAXBContext;
-import javax.xml.bind.JAXBException;
-import javax.xml.bind.Unmarshaller;
-import javax.xml.stream.XMLEventReader;
-import javax.xml.stream.XMLEventWriter;
-import javax.xml.stream.XMLStreamReader;
-import javax.xml.stream.XMLStreamWriter;
-import javax.xml.transform.Result;
-import javax.xml.transform.Source;
-
-import org.springframework.beans.factory.BeanClassLoaderAware;
-import org.springframework.util.ClassUtils;
-import org.springframework.util.StringUtils;
-import org.springframework.xml.transform.StaxResult;
-import org.springframework.xml.transform.StaxSource;
-import org.springframework.xml.transform.TraxUtils;
-
-/**
- * Implementation of the Marshaller interface for JAXB 1.0.
- *
- * The typical usage will be to set the contextPath property on this bean, possibly customize the
- * marshaller and unmarshaller by setting properties, and validations, and to refer to it.
- *
- * @author Arjen Poutsma
- * @see #setContextPath(String)
- * @see #setMarshallerProperties(java.util.Map)
- * @see #setUnmarshallerProperties(java.util.Map)
- * @see #setValidating(boolean)
- * @since 1.0.0
- */
-public class Jaxb1Marshaller extends AbstractJaxbMarshaller implements BeanClassLoaderAware {
-
- private boolean validating = false;
-
- private ClassLoader classLoader;
-
- public void setBeanClassLoader(ClassLoader classLoader) {
- this.classLoader = classLoader;
- }
-
- /** Set if the JAXB Unmarshaller should validate the incoming document. Default is false. */
- public void setValidating(boolean validating) {
- this.validating = validating;
- }
-
- public boolean supports(Class clazz) {
- if (!Element.class.isAssignableFrom(clazz)) {
- return false;
- }
- if (StringUtils.hasLength(getContextPath())) {
- String className = ClassUtils.getQualifiedName(clazz);
- int lastDotIndex = className.lastIndexOf('.');
- if (lastDotIndex == -1) {
- return false;
- }
- String packageName = className.substring(0, lastDotIndex);
- String[] contextPaths = StringUtils.tokenizeToStringArray(getContextPath(), ":");
- for (int i = 0; i < contextPaths.length; i++) {
- if (contextPaths[i].equals(packageName)) {
- return true;
- }
- }
- return false;
- }
- return false;
-
- }
-
- @Override
- protected final JAXBContext createJaxbContext() throws JAXBException {
- if (!StringUtils.hasLength(getContextPath())) {
- throw new IllegalArgumentException("contextPath is required");
- }
- if (logger.isInfoEnabled()) {
- logger.info("Creating JAXBContext with context path [" + getContextPath() + "]");
- }
- return classLoader != null ? JAXBContext.newInstance(getContextPath(), classLoader) :
- JAXBContext.newInstance(getContextPath());
- }
-
- @Override
- protected void initJaxbUnmarshaller(Unmarshaller unmarshaller) throws JAXBException {
- unmarshaller.setValidating(validating);
- }
-
- public void marshal(Object graph, Result result) {
- if (TraxUtils.isStaxResult(result)) {
- XMLStreamWriter streamWriter = TraxUtils.getXMLStreamWriter(result);
- if (streamWriter != null) {
- result = new StaxResult(streamWriter);
- }
- else {
- XMLEventWriter eventWriter = TraxUtils.getXMLEventWriter(result);
- if (eventWriter != null) {
- result = new StaxResult(eventWriter);
- }
- else {
- throw new IllegalArgumentException(
- "StAXResult contains neither XMLStreamWriter nor XMLEventWriter");
- }
- }
- }
- try {
- createMarshaller().marshal(graph, result);
- }
- catch (JAXBException ex) {
- throw convertJaxbException(ex);
- }
- }
-
- public Object unmarshal(Source source) {
- if (TraxUtils.isStaxSource(source)) {
- XMLStreamReader streamReader = TraxUtils.getXMLStreamReader(source);
- if (streamReader != null) {
- source = new StaxSource(streamReader);
- }
- else {
- XMLEventReader eventReader = TraxUtils.getXMLEventReader(source);
- if (eventReader != null) {
- source = new StaxSource(eventReader);
- }
- else {
- throw new IllegalArgumentException(
- "StAXSource contains neither XMLStreamReader nor XMLEventReader");
- }
- }
- }
- try {
- return createUnmarshaller().unmarshal(source);
- }
- catch (JAXBException ex) {
- throw convertJaxbException(ex);
- }
- }
-
-}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/Jaxb2Marshaller.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/Jaxb2Marshaller.java
index 6305f0ab71..6b7565b48f 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/Jaxb2Marshaller.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/Jaxb2Marshaller.java
@@ -58,7 +58,14 @@ import javax.xml.stream.XMLStreamReader;
import javax.xml.stream.XMLStreamWriter;
import javax.xml.transform.Result;
import javax.xml.transform.Source;
+import javax.xml.transform.sax.SAXSource;
import javax.xml.validation.Schema;
+import javax.xml.validation.SchemaFactory;
+
+import org.xml.sax.InputSource;
+import org.xml.sax.SAXException;
+import org.xml.sax.XMLReader;
+import org.xml.sax.helpers.XMLReaderFactory;
import org.springframework.beans.factory.BeanClassLoaderAware;
import org.springframework.core.io.Resource;
@@ -73,15 +80,13 @@ import org.springframework.util.ClassUtils;
import org.springframework.util.FileCopyUtils;
import org.springframework.util.ObjectUtils;
import org.springframework.util.StringUtils;
-import org.springframework.xml.transform.TraxUtils;
-import org.springframework.xml.validation.SchemaLoaderUtils;
+import org.springframework.util.xml.SaxUtils;
+import org.springframework.util.xml.StaxUtils;
/**
- * 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.
+ * 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.
*
* @author Arjen Poutsma
* @see #setContextPath(String)
@@ -94,494 +99,509 @@ import org.springframework.xml.validation.SchemaLoaderUtils;
* @see #setMarshallerListener(javax.xml.bind.Marshaller.Listener)
* @see #setUnmarshallerListener(javax.xml.bind.Unmarshaller.Listener)
* @see #setAdapters(javax.xml.bind.annotation.adapters.XmlAdapter[])
- * @since 1.0.0
+ * @since 3.0
*/
public class Jaxb2Marshaller extends AbstractJaxbMarshaller
- implements MimeMarshaller, MimeUnmarshaller, GenericMarshaller, GenericUnmarshaller, BeanClassLoaderAware {
+ implements MimeMarshaller, MimeUnmarshaller, GenericMarshaller, GenericUnmarshaller, BeanClassLoaderAware {
- private ClassLoader classLoader;
+ private ClassLoader classLoader;
- private Resource[] schemaResources;
+ private Resource[] schemaResources;
- private String schemaLanguage = XMLConstants.W3C_XML_SCHEMA_NS_URI;
+ private String schemaLanguage = XMLConstants.W3C_XML_SCHEMA_NS_URI;
- private Marshaller.Listener marshallerListener;
+ private Marshaller.Listener marshallerListener;
- private Unmarshaller.Listener unmarshallerListener;
+ private Unmarshaller.Listener unmarshallerListener;
- private XmlAdapter[] adapters;
+ private XmlAdapter[] adapters;
- private Schema schema;
+ private Schema schema;
- private Class[] classesToBeBound;
+ private Class[] classesToBeBound;
- private Map jaxbContextProperties;
+ private Map jaxbContextProperties;
- private boolean mtomEnabled = false;
+ private boolean mtomEnabled = false;
- public void setBeanClassLoader(ClassLoader classLoader) {
- this.classLoader = classLoader;
- }
+ public void setBeanClassLoader(ClassLoader classLoader) {
+ this.classLoader = classLoader;
+ }
- /**
- * Sets the XmlAdapters to be registered with the JAXB Marshaller and
- * Unmarshaller
- */
- public void setAdapters(XmlAdapter[] adapters) {
- this.adapters = adapters;
- }
+ /**
+ * Sets the XmlAdapters to be registered with the JAXB Marshaller and
+ * Unmarshaller
+ */
+ public void setAdapters(XmlAdapter[] adapters) {
+ this.adapters = adapters;
+ }
- /**
- * Sets the list of java classes to be recognized by a newly created JAXBContext. Setting this property or
- * contextPath is required.
- *
- * @see #setContextPath(String)
- */
- public void setClassesToBeBound(Class[] classesToBeBound) {
- this.classesToBeBound = classesToBeBound;
- }
+ /**
+ * Sets the list of java classes to be recognized by a newly created JAXBContext. Setting this property or
+ * contextPath is required.
+ *
+ * @see #setContextPath(String)
+ */
+ public void setClassesToBeBound(Class[] classesToBeBound) {
+ this.classesToBeBound = classesToBeBound;
+ }
- /**
- * Sets the JAXBContext properties. These implementation-specific properties will be set on the
- * JAXBContext.
- */
- public void setJaxbContextProperties(Map jaxbContextProperties) {
- this.jaxbContextProperties = jaxbContextProperties;
- }
+ /**
+ * Sets the JAXBContext properties. These implementation-specific properties will be set on the
+ * JAXBContext.
+ */
+ public void setJaxbContextProperties(Map jaxbContextProperties) {
+ this.jaxbContextProperties = jaxbContextProperties;
+ }
- /** Sets the Marshaller.Listener to be registered with the JAXB Marshaller. */
- public void setMarshallerListener(Marshaller.Listener marshallerListener) {
- this.marshallerListener = marshallerListener;
- }
+ /** Sets the Marshaller.Listener to be registered with the JAXB Marshaller. */
+ public void setMarshallerListener(Marshaller.Listener marshallerListener) {
+ this.marshallerListener = marshallerListener;
+ }
- /**
- * Indicates whether MTOM support should be enabled or not. Default is false, marshalling using
- * XOP/MTOM is not enabled.
- */
- public void setMtomEnabled(boolean mtomEnabled) {
- this.mtomEnabled = mtomEnabled;
- }
+ /**
+ * Indicates whether MTOM support should be enabled or not. Default is false, marshalling using XOP/MTOM
+ * is not enabled.
+ */
+ public void setMtomEnabled(boolean mtomEnabled) {
+ this.mtomEnabled = mtomEnabled;
+ }
- /**
- * Sets the schema language. Default is the W3C XML Schema: http://www.w3.org/2001/XMLSchema".
- *
- * @see XMLConstants#W3C_XML_SCHEMA_NS_URI
- * @see XMLConstants#RELAXNG_NS_URI
- */
- public void setSchemaLanguage(String schemaLanguage) {
- this.schemaLanguage = schemaLanguage;
- }
+ /**
+ * Sets the schema language. Default is the W3C XML Schema: http://www.w3.org/2001/XMLSchema".
+ *
+ * @see XMLConstants#W3C_XML_SCHEMA_NS_URI
+ * @see XMLConstants#RELAXNG_NS_URI
+ */
+ public void setSchemaLanguage(String schemaLanguage) {
+ this.schemaLanguage = schemaLanguage;
+ }
- /** Sets the schema resource to use for validation. */
- public void setSchema(Resource schemaResource) {
- schemaResources = new Resource[]{schemaResource};
- }
+ /** Sets the schema resource to use for validation. */
+ public void setSchema(Resource schemaResource) {
+ schemaResources = new Resource[]{schemaResource};
+ }
- /** Sets the schema resources to use for validation. */
- public void setSchemas(Resource[] schemaResources) {
- this.schemaResources = schemaResources;
- }
+ /** Sets the schema resources to use for validation. */
+ public void setSchemas(Resource[] schemaResources) {
+ this.schemaResources = schemaResources;
+ }
- /** Sets the Unmarshaller.Listener to be registered with the JAXB Unmarshaller. */
- public void setUnmarshallerListener(Unmarshaller.Listener unmarshallerListener) {
- this.unmarshallerListener = unmarshallerListener;
- }
+ /** Sets the Unmarshaller.Listener to be registered with the JAXB Unmarshaller. */
+ public void setUnmarshallerListener(Unmarshaller.Listener unmarshallerListener) {
+ this.unmarshallerListener = unmarshallerListener;
+ }
- public boolean supports(Type type) {
- if (type instanceof Class) {
- return supportsInternal((Class) type, true);
- }
- else if (type instanceof ParameterizedType) {
- ParameterizedType parameterizedType = (ParameterizedType) type;
- if (JAXBElement.class.equals(parameterizedType.getRawType())) {
- Assert.isTrue(parameterizedType.getActualTypeArguments().length == 1,
- "Invalid amount of parameterized types in JAXBElement");
- Type typeArgument = parameterizedType.getActualTypeArguments()[0];
- if (typeArgument instanceof Class) {
- Class clazz = (Class) typeArgument;
- if (!isPrimitiveType(clazz) && !isStandardType(clazz) && !supportsInternal(clazz, false)) {
- return false;
- }
- }
- else if (typeArgument instanceof GenericArrayType) {
- GenericArrayType genericArrayType = (GenericArrayType) typeArgument;
- return genericArrayType.getGenericComponentType().equals(Byte.TYPE);
- }
- else if (!supports(typeArgument)) {
- return false;
- }
- return true;
- }
- }
- return false;
- }
+ public boolean supports(Type type) {
+ if (type instanceof Class) {
+ return supportsInternal((Class) type, true);
+ }
+ else if (type instanceof ParameterizedType) {
+ ParameterizedType parameterizedType = (ParameterizedType) type;
+ if (JAXBElement.class.equals(parameterizedType.getRawType())) {
+ Assert.isTrue(parameterizedType.getActualTypeArguments().length == 1,
+ "Invalid amount of parameterized types in JAXBElement");
+ Type typeArgument = parameterizedType.getActualTypeArguments()[0];
+ if (typeArgument instanceof Class) {
+ Class clazz = (Class) typeArgument;
+ if (!isPrimitiveType(clazz) && !isStandardType(clazz) && !supportsInternal(clazz, false)) {
+ return false;
+ }
+ }
+ else if (typeArgument instanceof GenericArrayType) {
+ GenericArrayType genericArrayType = (GenericArrayType) typeArgument;
+ return genericArrayType.getGenericComponentType().equals(Byte.TYPE);
+ }
+ else if (!supports(typeArgument)) {
+ return false;
+ }
+ return true;
+ }
+ }
+ return false;
+ }
- private boolean isPrimitiveType(Class clazz) {
- return (Boolean.class.equals(clazz) || Byte.class.equals(clazz) || Short.class.equals(clazz) ||
- Integer.class.equals(clazz) || Long.class.equals(clazz) || Float.class.equals(clazz) ||
- Double.class.equals(clazz) || byte[].class.equals(clazz));
- }
+ private boolean isPrimitiveType(Class clazz) {
+ return (Boolean.class.equals(clazz) || Byte.class.equals(clazz) || Short.class.equals(clazz) ||
+ Integer.class.equals(clazz) || Long.class.equals(clazz) || Float.class.equals(clazz) ||
+ Double.class.equals(clazz) || byte[].class.equals(clazz));
+ }
- private boolean isStandardType(Class clazz) {
- return (String.class.equals(clazz) || BigInteger.class.equals(clazz) || BigDecimal.class.equals(clazz) ||
- Calendar.class.isAssignableFrom(clazz) || Date.class.isAssignableFrom(clazz) ||
- QName.class.equals(clazz) || URI.class.equals(clazz) ||
- XMLGregorianCalendar.class.isAssignableFrom(clazz) || Duration.class.isAssignableFrom(clazz) ||
- Object.class.equals(clazz) || Image.class.isAssignableFrom(clazz) || DataHandler.class.equals(clazz) ||
- Source.class.isAssignableFrom(clazz) || UUID.class.equals(clazz));
- }
+ private boolean isStandardType(Class clazz) {
+ return (String.class.equals(clazz) || BigInteger.class.equals(clazz) || BigDecimal.class.equals(clazz) ||
+ Calendar.class.isAssignableFrom(clazz) || Date.class.isAssignableFrom(clazz) ||
+ QName.class.equals(clazz) || URI.class.equals(clazz) ||
+ XMLGregorianCalendar.class.isAssignableFrom(clazz) || Duration.class.isAssignableFrom(clazz) ||
+ Object.class.equals(clazz) || Image.class.isAssignableFrom(clazz) || DataHandler.class.equals(clazz) ||
+ Source.class.isAssignableFrom(clazz) || UUID.class.equals(clazz));
+ }
- public boolean supports(Class clazz) {
- return supportsInternal(clazz, true);
- }
+ public boolean supports(Class clazz) {
+ return supportsInternal(clazz, true);
+ }
- private boolean supportsInternal(Class clazz, boolean checkForXmlRootElement) {
- if (checkForXmlRootElement && clazz.getAnnotation(XmlRootElement.class) == null) {
- return false;
- }
- if (clazz.getAnnotation(XmlType.class) == null) {
- return false;
- }
- if (StringUtils.hasLength(getContextPath())) {
- String className = ClassUtils.getQualifiedName(clazz);
- int lastDotIndex = className.lastIndexOf('.');
- if (lastDotIndex == -1) {
- return false;
- }
- String packageName = className.substring(0, lastDotIndex);
- String[] contextPaths = StringUtils.tokenizeToStringArray(getContextPath(), ":");
- for (int i = 0; i < contextPaths.length; i++) {
- if (contextPaths[i].equals(packageName)) {
- return true;
- }
- }
- return false;
- }
- else if (!ObjectUtils.isEmpty(classesToBeBound)) {
- return Arrays.asList(classesToBeBound).contains(clazz);
- }
- return false;
- }
+ private boolean supportsInternal(Class clazz, boolean checkForXmlRootElement) {
+ if (checkForXmlRootElement && clazz.getAnnotation(XmlRootElement.class) == null) {
+ return false;
+ }
+ if (clazz.getAnnotation(XmlType.class) == null) {
+ return false;
+ }
+ if (StringUtils.hasLength(getContextPath())) {
+ String className = ClassUtils.getQualifiedName(clazz);
+ int lastDotIndex = className.lastIndexOf('.');
+ if (lastDotIndex == -1) {
+ return false;
+ }
+ String packageName = className.substring(0, lastDotIndex);
+ String[] contextPaths = StringUtils.tokenizeToStringArray(getContextPath(), ":");
+ for (String contextPath : contextPaths) {
+ if (contextPath.equals(packageName)) {
+ return true;
+ }
+ }
+ return false;
+ }
+ else if (!ObjectUtils.isEmpty(classesToBeBound)) {
+ return Arrays.asList(classesToBeBound).contains(clazz);
+ }
+ return false;
+ }
- /*
- * JAXBContext
- */
+ /*
+ * JAXBContext
+ */
- @Override
+ @Override
protected JAXBContext createJaxbContext() throws Exception {
- if (JaxbUtils.getJaxbVersion() < JaxbUtils.JAXB_2) {
- throw new IllegalStateException(
- "Cannot use Jaxb2Marshaller in combination with JAXB 1.0. Use Jaxb1Marshaller instead.");
- }
- if (StringUtils.hasLength(getContextPath()) && !ObjectUtils.isEmpty(classesToBeBound)) {
- throw new IllegalArgumentException("specify either contextPath or classesToBeBound property; not both");
- }
- if (!ObjectUtils.isEmpty(schemaResources)) {
- if (logger.isDebugEnabled()) {
- logger.debug(
- "Setting validation schema to " + StringUtils.arrayToCommaDelimitedString(schemaResources));
- }
- schema = SchemaLoaderUtils.loadSchema(schemaResources, schemaLanguage);
- }
- if (StringUtils.hasLength(getContextPath())) {
- return createJaxbContextFromContextPath();
- }
- else if (!ObjectUtils.isEmpty(classesToBeBound)) {
- return createJaxbContextFromClasses();
- }
- else {
- throw new IllegalArgumentException("setting either contextPath or classesToBeBound is required");
- }
- }
+ if (JaxbUtils.getJaxbVersion() < JaxbUtils.JAXB_2) {
+ throw new IllegalStateException(
+ "Cannot use Jaxb2Marshaller in combination with JAXB 1.0. Use Jaxb1Marshaller instead.");
+ }
+ if (StringUtils.hasLength(getContextPath()) && !ObjectUtils.isEmpty(classesToBeBound)) {
+ throw new IllegalArgumentException("specify either contextPath or classesToBeBound property; not both");
+ }
+ if (!ObjectUtils.isEmpty(schemaResources)) {
+ if (logger.isDebugEnabled()) {
+ logger.debug(
+ "Setting validation schema to " + StringUtils.arrayToCommaDelimitedString(schemaResources));
+ }
+ schema = loadSchema(schemaResources, schemaLanguage);
+ }
+ if (StringUtils.hasLength(getContextPath())) {
+ return createJaxbContextFromContextPath();
+ }
+ else if (!ObjectUtils.isEmpty(classesToBeBound)) {
+ return createJaxbContextFromClasses();
+ }
+ else {
+ throw new IllegalArgumentException("setting either contextPath or classesToBeBound is required");
+ }
+ }
- private JAXBContext createJaxbContextFromContextPath() throws JAXBException {
- if (logger.isInfoEnabled()) {
- logger.info("Creating JAXBContext with context path [" + getContextPath() + "]");
- }
- if (jaxbContextProperties != null) {
- if (classLoader != null) {
- return JAXBContext
- .newInstance(getContextPath(), classLoader, jaxbContextProperties);
- }
- else {
- return JAXBContext
- .newInstance(getContextPath(), ClassUtils.getDefaultClassLoader(), jaxbContextProperties);
- }
- }
- else {
- return classLoader != null ? JAXBContext.newInstance(getContextPath(), classLoader) :
- JAXBContext.newInstance(getContextPath());
- }
- }
+ private Schema loadSchema(Resource[] resources, String schemaLanguage) throws IOException, SAXException {
+ Assert.notEmpty(resources, "No resources given");
+ Assert.hasLength(schemaLanguage, "No schema language provided");
+ Source[] schemaSources = new Source[resources.length];
+ XMLReader xmlReader = XMLReaderFactory.createXMLReader();
+ xmlReader.setFeature("http://xml.org/sax/features/namespace-prefixes", true);
+ for (int i = 0; i < resources.length; i++) {
+ Assert.notNull(resources[i], "Resource is null");
+ Assert.isTrue(resources[i].exists(), "Resource " + resources[i] + " does not exist");
+ InputSource inputSource = SaxUtils.createInputSource(resources[i]);
+ schemaSources[i] = new SAXSource(xmlReader, inputSource);
+ }
+ SchemaFactory schemaFactory = SchemaFactory.newInstance(schemaLanguage);
+ return schemaFactory.newSchema(schemaSources);
+ }
- private JAXBContext createJaxbContextFromClasses() throws JAXBException {
- if (logger.isInfoEnabled()) {
- logger.info("Creating JAXBContext with classes to be bound [" +
- StringUtils.arrayToCommaDelimitedString(classesToBeBound) + "]");
- }
- if (jaxbContextProperties != null) {
- return JAXBContext.newInstance(classesToBeBound, jaxbContextProperties);
- }
- else {
- return JAXBContext.newInstance(classesToBeBound);
- }
- }
+ private JAXBContext createJaxbContextFromContextPath() throws JAXBException {
+ if (logger.isInfoEnabled()) {
+ logger.info("Creating JAXBContext with context path [" + getContextPath() + "]");
+ }
+ if (jaxbContextProperties != null) {
+ if (classLoader != null) {
+ return JAXBContext.newInstance(getContextPath(), classLoader, jaxbContextProperties);
+ }
+ else {
+ return JAXBContext
+ .newInstance(getContextPath(), ClassUtils.getDefaultClassLoader(), jaxbContextProperties);
+ }
+ }
+ else {
+ return classLoader != null ? JAXBContext.newInstance(getContextPath(), classLoader) :
+ JAXBContext.newInstance(getContextPath());
+ }
+ }
- /*
- * Marshaller/Unmarshaller
- */
+ private JAXBContext createJaxbContextFromClasses() throws JAXBException {
+ if (logger.isInfoEnabled()) {
+ logger.info("Creating JAXBContext with classes to be bound [" +
+ StringUtils.arrayToCommaDelimitedString(classesToBeBound) + "]");
+ }
+ if (jaxbContextProperties != null) {
+ return JAXBContext.newInstance(classesToBeBound, jaxbContextProperties);
+ }
+ else {
+ return JAXBContext.newInstance(classesToBeBound);
+ }
+ }
- @Override
+ /*
+ * Marshaller/Unmarshaller
+ */
+
+ @Override
protected void initJaxbMarshaller(Marshaller marshaller) throws JAXBException {
- if (schema != null) {
- marshaller.setSchema(schema);
- }
- if (marshallerListener != null) {
- marshaller.setListener(marshallerListener);
- }
- if (adapters != null) {
- for (int i = 0; i < adapters.length; i++) {
- marshaller.setAdapter(adapters[i]);
- }
- }
- }
+ if (schema != null) {
+ marshaller.setSchema(schema);
+ }
+ if (marshallerListener != null) {
+ marshaller.setListener(marshallerListener);
+ }
+ if (adapters != null) {
+ for (XmlAdapter adapter : adapters) {
+ marshaller.setAdapter(adapter);
+ }
+ }
+ }
- @Override
+ @Override
protected void initJaxbUnmarshaller(Unmarshaller unmarshaller) throws JAXBException {
- if (schema != null) {
- unmarshaller.setSchema(schema);
- }
- if (unmarshallerListener != null) {
- unmarshaller.setListener(unmarshallerListener);
- }
- if (adapters != null) {
- for (int i = 0; i < adapters.length; i++) {
- unmarshaller.setAdapter(adapters[i]);
- }
- }
- }
+ if (schema != null) {
+ unmarshaller.setSchema(schema);
+ }
+ if (unmarshallerListener != null) {
+ unmarshaller.setListener(unmarshallerListener);
+ }
+ if (adapters != null) {
+ for (XmlAdapter adapter : adapters) {
+ unmarshaller.setAdapter(adapter);
+ }
+ }
+ }
- /*
- * Marshalling
- */
+ /*
+ * Marshalling
+ */
- public void marshal(Object graph, Result result) throws XmlMappingException {
- marshal(graph, result, null);
- }
+ public void marshal(Object graph, Result result) throws XmlMappingException {
+ marshal(graph, result, null);
+ }
- public void marshal(Object graph, Result result, MimeContainer mimeContainer) throws XmlMappingException {
- try {
- Marshaller marshaller = createMarshaller();
- if (mtomEnabled && mimeContainer != null) {
- marshaller.setAttachmentMarshaller(new Jaxb2AttachmentMarshaller(mimeContainer));
- }
- if (TraxUtils.isStaxResult(result)) {
- marshalStaxResult(marshaller, graph, result);
- }
- else {
- marshaller.marshal(graph, result);
- }
- }
- catch (JAXBException ex) {
- throw convertJaxbException(ex);
- }
- }
+ public void marshal(Object graph, Result result, MimeContainer mimeContainer) throws XmlMappingException {
+ try {
+ Marshaller marshaller = createMarshaller();
+ if (mtomEnabled && mimeContainer != null) {
+ marshaller.setAttachmentMarshaller(new Jaxb2AttachmentMarshaller(mimeContainer));
+ }
+ if (StaxUtils.isStaxResult(result)) {
+ marshalStaxResult(marshaller, graph, result);
+ }
+ else {
+ marshaller.marshal(graph, result);
+ }
+ }
+ catch (JAXBException ex) {
+ throw convertJaxbException(ex);
+ }
+ }
- private void marshalStaxResult(Marshaller jaxbMarshaller, Object graph, Result staxResult) throws JAXBException {
- XMLStreamWriter streamWriter = TraxUtils.getXMLStreamWriter(staxResult);
- if (streamWriter != null) {
- jaxbMarshaller.marshal(graph, streamWriter);
- }
- else {
- XMLEventWriter eventWriter = TraxUtils.getXMLEventWriter(staxResult);
- if (eventWriter != null) {
- jaxbMarshaller.marshal(graph, eventWriter);
- }
- else {
- throw new IllegalArgumentException("StAX Result contains neither XMLStreamWriter nor XMLEventConsumer");
- }
- }
- }
+ private void marshalStaxResult(Marshaller jaxbMarshaller, Object graph, Result staxResult) throws JAXBException {
+ XMLStreamWriter streamWriter = StaxUtils.getXMLStreamWriter(staxResult);
+ if (streamWriter != null) {
+ jaxbMarshaller.marshal(graph, streamWriter);
+ }
+ else {
+ XMLEventWriter eventWriter = StaxUtils.getXMLEventWriter(staxResult);
+ if (eventWriter != null) {
+ jaxbMarshaller.marshal(graph, eventWriter);
+ }
+ else {
+ throw new IllegalArgumentException("StAX Result contains neither XMLStreamWriter nor XMLEventConsumer");
+ }
+ }
+ }
- /*
- * Unmarshalling
- */
+ /*
+ * Unmarshalling
+ */
- public Object unmarshal(Source source) throws XmlMappingException {
- return unmarshal(source, null);
- }
+ public Object unmarshal(Source source) throws XmlMappingException {
+ return unmarshal(source, null);
+ }
- public Object unmarshal(Source source, MimeContainer mimeContainer) throws XmlMappingException {
- try {
- Unmarshaller unmarshaller = createUnmarshaller();
- if (mtomEnabled && mimeContainer != null) {
- unmarshaller.setAttachmentUnmarshaller(new Jaxb2AttachmentUnmarshaller(mimeContainer));
- }
- if (TraxUtils.isStaxSource(source)) {
- return unmarshalStaxSource(unmarshaller, source);
- }
- else {
- return unmarshaller.unmarshal(source);
- }
- }
- catch (JAXBException ex) {
- throw convertJaxbException(ex);
- }
- }
+ public Object unmarshal(Source source, MimeContainer mimeContainer) throws XmlMappingException {
+ try {
+ Unmarshaller unmarshaller = createUnmarshaller();
+ if (mtomEnabled && mimeContainer != null) {
+ unmarshaller.setAttachmentUnmarshaller(new Jaxb2AttachmentUnmarshaller(mimeContainer));
+ }
+ if (StaxUtils.isStaxSource(source)) {
+ return unmarshalStaxSource(unmarshaller, source);
+ }
+ else {
+ return unmarshaller.unmarshal(source);
+ }
+ }
+ catch (JAXBException ex) {
+ throw convertJaxbException(ex);
+ }
+ }
- private Object unmarshalStaxSource(Unmarshaller jaxbUnmarshaller, Source staxSource) throws JAXBException {
- XMLStreamReader streamReader = TraxUtils.getXMLStreamReader(staxSource);
- if (streamReader != null) {
- return jaxbUnmarshaller.unmarshal(streamReader);
- }
- else {
- XMLEventReader eventReader = TraxUtils.getXMLEventReader(staxSource);
- if (eventReader != null) {
- return jaxbUnmarshaller.unmarshal(eventReader);
- }
- else {
- throw new IllegalArgumentException("StaxSource contains neither XMLStreamReader nor XMLEventReader");
- }
- }
- }
+ private Object unmarshalStaxSource(Unmarshaller jaxbUnmarshaller, Source staxSource) throws JAXBException {
+ XMLStreamReader streamReader = StaxUtils.getXMLStreamReader(staxSource);
+ if (streamReader != null) {
+ return jaxbUnmarshaller.unmarshal(streamReader);
+ }
+ else {
+ XMLEventReader eventReader = StaxUtils.getXMLEventReader(staxSource);
+ if (eventReader != null) {
+ return jaxbUnmarshaller.unmarshal(eventReader);
+ }
+ else {
+ throw new IllegalArgumentException("StaxSource contains neither XMLStreamReader nor XMLEventReader");
+ }
+ }
+ }
- /*
- * Inner classes
- */
+ /*
+ * Inner classes
+ */
- private static class Jaxb2AttachmentMarshaller extends AttachmentMarshaller {
+ private static class Jaxb2AttachmentMarshaller extends AttachmentMarshaller {
- private final MimeContainer mimeContainer;
+ private final MimeContainer mimeContainer;
- public Jaxb2AttachmentMarshaller(MimeContainer mimeContainer) {
- this.mimeContainer = mimeContainer;
- }
+ private Jaxb2AttachmentMarshaller(MimeContainer mimeContainer) {
+ this.mimeContainer = mimeContainer;
+ }
- @Override
+ @Override
public String addMtomAttachment(byte[] data,
- int offset,
- int length,
- String mimeType,
- String elementNamespace,
- String elementLocalName) {
- ByteArrayDataSource dataSource = new ByteArrayDataSource(mimeType, data, offset, length);
- return addMtomAttachment(new DataHandler(dataSource), elementNamespace, elementLocalName);
- }
+ int offset,
+ int length,
+ String mimeType,
+ String elementNamespace,
+ String elementLocalName) {
+ ByteArrayDataSource dataSource = new ByteArrayDataSource(mimeType, data, offset, length);
+ return addMtomAttachment(new DataHandler(dataSource), elementNamespace, elementLocalName);
+ }
- @Override
+ @Override
public String addMtomAttachment(DataHandler dataHandler, String elementNamespace, String elementLocalName) {
- String host = getHost(elementNamespace, dataHandler);
- String contentId = UUID.randomUUID() + "@" + host;
- mimeContainer.addAttachment("<" + contentId + ">", dataHandler);
- try {
- contentId = URLEncoder.encode(contentId, "UTF-8");
- }
- catch (UnsupportedEncodingException e) {
- // ignore
- }
- return "cid:" + contentId;
- }
+ String host = getHost(elementNamespace, dataHandler);
+ String contentId = UUID.randomUUID() + "@" + host;
+ mimeContainer.addAttachment("<" + contentId + ">", dataHandler);
+ try {
+ contentId = URLEncoder.encode(contentId, "UTF-8");
+ }
+ catch (UnsupportedEncodingException e) {
+ // ignore
+ }
+ return "cid:" + contentId;
+ }
- private String getHost(String elementNamespace, DataHandler dataHandler) {
- try {
- URI uri = new URI(elementNamespace);
- return uri.getHost();
- }
- catch (URISyntaxException e) {
- // ignore
- }
- return dataHandler.getName();
- }
+ private String getHost(String elementNamespace, DataHandler dataHandler) {
+ try {
+ URI uri = new URI(elementNamespace);
+ return uri.getHost();
+ }
+ catch (URISyntaxException e) {
+ // ignore
+ }
+ return dataHandler.getName();
+ }
- @Override
+ @Override
public String addSwaRefAttachment(DataHandler dataHandler) {
- String contentId = UUID.randomUUID() + "@" + dataHandler.getName();
- mimeContainer.addAttachment(contentId, dataHandler);
- return contentId;
- }
+ String contentId = UUID.randomUUID() + "@" + dataHandler.getName();
+ mimeContainer.addAttachment(contentId, dataHandler);
+ return contentId;
+ }
- @Override
- public boolean isXOPPackage() {
- return mimeContainer.convertToXopPackage();
- }
- }
+ @Override
+ public boolean isXOPPackage() {
+ return mimeContainer.convertToXopPackage();
+ }
+ }
- private static class Jaxb2AttachmentUnmarshaller extends AttachmentUnmarshaller {
+ private static class Jaxb2AttachmentUnmarshaller extends AttachmentUnmarshaller {
- private final MimeContainer mimeContainer;
+ private final MimeContainer mimeContainer;
- public Jaxb2AttachmentUnmarshaller(MimeContainer mimeContainer) {
- this.mimeContainer = mimeContainer;
- }
+ private Jaxb2AttachmentUnmarshaller(MimeContainer mimeContainer) {
+ this.mimeContainer = mimeContainer;
+ }
- @Override
+ @Override
public byte[] getAttachmentAsByteArray(String cid) {
- try {
- DataHandler dataHandler = getAttachmentAsDataHandler(cid);
- return FileCopyUtils.copyToByteArray(dataHandler.getInputStream());
- }
- catch (IOException ex) {
- throw new JaxbUnmarshallingFailureException(ex);
- }
- }
+ try {
+ DataHandler dataHandler = getAttachmentAsDataHandler(cid);
+ return FileCopyUtils.copyToByteArray(dataHandler.getInputStream());
+ }
+ catch (IOException ex) {
+ throw new JaxbUnmarshallingFailureException(ex);
+ }
+ }
- @Override
+ @Override
public DataHandler getAttachmentAsDataHandler(String contentId) {
- if (contentId.startsWith("cid:")) {
- contentId = contentId.substring("cid:".length());
- try {
- contentId = URLDecoder.decode(contentId, "UTF-8");
- }
- catch (UnsupportedEncodingException e) {
- // ignore
- }
- contentId = '<' + contentId + '>';
- }
- return mimeContainer.getAttachment(contentId);
- }
+ if (contentId.startsWith("cid:")) {
+ contentId = contentId.substring("cid:".length());
+ try {
+ contentId = URLDecoder.decode(contentId, "UTF-8");
+ }
+ catch (UnsupportedEncodingException e) {
+ // ignore
+ }
+ contentId = '<' + contentId + '>';
+ }
+ return mimeContainer.getAttachment(contentId);
+ }
- @Override
- public boolean isXOPPackage() {
- return mimeContainer.isXopPackage();
- }
- }
+ @Override
+ public boolean isXOPPackage() {
+ return mimeContainer.isXopPackage();
+ }
+ }
- /*
- * DataSource that wraps around a byte array
- */
- private static class ByteArrayDataSource implements DataSource {
+ /*
+ * DataSource that wraps around a byte array
+ */
+ private static class ByteArrayDataSource implements DataSource {
- private byte[] data;
+ private byte[] data;
- private String contentType;
+ private String contentType;
- private int offset;
+ private int offset;
- private int length;
+ private int length;
- public ByteArrayDataSource(String contentType, byte[] data, int offset, int length) {
- this.contentType = contentType;
- this.data = data;
- this.offset = offset;
- this.length = length;
- }
+ private ByteArrayDataSource(String contentType, byte[] data, int offset, int length) {
+ this.contentType = contentType;
+ this.data = data;
+ this.offset = offset;
+ this.length = length;
+ }
- public InputStream getInputStream() throws IOException {
- return new ByteArrayInputStream(data, offset, length);
- }
+ public InputStream getInputStream() throws IOException {
+ return new ByteArrayInputStream(data, offset, length);
+ }
- public OutputStream getOutputStream() throws IOException {
- throw new UnsupportedOperationException();
- }
+ public OutputStream getOutputStream() throws IOException {
+ throw new UnsupportedOperationException();
+ }
- public String getContentType() {
- return contentType;
- }
+ public String getContentType() {
+ return contentType;
+ }
- public String getName() {
- return "ByteArrayDataSource";
- }
- }
+ public String getName() {
+ return "ByteArrayDataSource";
+ }
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/JaxbMarshallingFailureException.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/JaxbMarshallingFailureException.java
index 8a0941b6e2..05ab8190fa 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/JaxbMarshallingFailureException.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/JaxbMarshallingFailureException.java
@@ -24,12 +24,12 @@ import org.springframework.oxm.MarshallingFailureException;
*
* @author Arjen Poutsma
* @see JaxbUtils#convertJaxbException
- * @since 1.0.0
+ * @since 3.0
*/
public class JaxbMarshallingFailureException extends MarshallingFailureException {
- public JaxbMarshallingFailureException(MarshalException ex) {
- super("JAXB marshalling exception: " + ex.getMessage(), ex);
- }
+ public JaxbMarshallingFailureException(MarshalException ex) {
+ super("JAXB marshalling exception: " + ex.getMessage(), ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/JaxbSystemException.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/JaxbSystemException.java
index 00a3fa2dee..c0bfccf6ac 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/JaxbSystemException.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/JaxbSystemException.java
@@ -25,11 +25,11 @@ import org.springframework.oxm.UncategorizedXmlMappingException;
*
* @author Arjen Poutsma
* @see JaxbUtils#convertJaxbException(javax.xml.bind.JAXBException)
- * @since 1.0.0
+ * @since 3.0
*/
public class JaxbSystemException extends UncategorizedXmlMappingException {
- public JaxbSystemException(JAXBException ex) {
- super(ex.getMessage(), ex);
- }
+ public JaxbSystemException(JAXBException ex) {
+ super(ex.getMessage(), ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/JaxbUnmarshallingFailureException.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/JaxbUnmarshallingFailureException.java
index 318fba8eb6..fb8e2e9384 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/JaxbUnmarshallingFailureException.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/JaxbUnmarshallingFailureException.java
@@ -24,15 +24,15 @@ import org.springframework.oxm.UnmarshallingFailureException;
* JAXB-specific subclass of UnmarshallingFailureException.
*
* @author Arjen Poutsma
- * @since 1.0.0
+ * @since 3.0
*/
public class JaxbUnmarshallingFailureException extends UnmarshallingFailureException {
- public JaxbUnmarshallingFailureException(UnmarshalException ex) {
- super("JAXB unmarshalling exception: " + ex.getMessage(), ex);
- }
+ public JaxbUnmarshallingFailureException(UnmarshalException ex) {
+ super("JAXB unmarshalling exception: " + ex.getMessage(), ex);
+ }
- public JaxbUnmarshallingFailureException(IOException ex) {
- super("JAXB unmarshalling exception: " + ex.getMessage(), ex);
- }
+ public JaxbUnmarshallingFailureException(IOException ex) {
+ super("JAXB unmarshalling exception: " + ex.getMessage(), ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/JaxbUtils.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/JaxbUtils.java
index 1a6ba154f5..9946a73d45 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/JaxbUtils.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/JaxbUtils.java
@@ -27,58 +27,58 @@ import org.springframework.util.ClassUtils;
* Generic utility methods for working with JAXB. Mainly for internal use within the framework.
*
* @author Arjen Poutsma
- * @since 1.0.0
+ * @since 3.0
*/
public abstract class JaxbUtils {
- public static final int JAXB_1 = 0;
+ public static final int JAXB_1 = 0;
- public static final int JAXB_2 = 1;
+ public static final int JAXB_2 = 1;
- private static final String JAXB_2_CLASS_NAME = "javax.xml.bind.Binder";
+ private static final String JAXB_2_CLASS_NAME = "javax.xml.bind.Binder";
- private static int jaxbVersion = JAXB_1;
+ private static int jaxbVersion = JAXB_1;
- static {
- try {
- ClassUtils.forName(JAXB_2_CLASS_NAME);
- jaxbVersion = JAXB_2;
- }
- catch (ClassNotFoundException ex1) {
- // leave JAXB 1 as default
- }
- }
+ static {
+ try {
+ ClassUtils.forName(JAXB_2_CLASS_NAME);
+ jaxbVersion = JAXB_2;
+ }
+ catch (ClassNotFoundException ex1) {
+ // leave JAXB 1 as default
+ }
+ }
- /**
- * Gets the major JAXB version. This means we can do things like if (getJaxbVersion() <= JAXB_2).
- *
- * @return a code comparable to the JAXP_XX codes in this class
- * @see #JAXB_1
- * @see #JAXB_2
- */
- public static int getJaxbVersion() {
- return jaxbVersion;
- }
+ /**
+ * Gets the major JAXB version. This means we can do things like if (getJaxbVersion() <= JAXB_2).
+ *
+ * @return a code comparable to the JAXP_XX codes in this class
+ * @see #JAXB_1
+ * @see #JAXB_2
+ */
+ public static int getJaxbVersion() {
+ return jaxbVersion;
+ }
- /**
- * Converts the given JAXBException to an appropriate exception from the
- * org.springframework.oxm hierarchy.
- *
- * @param ex JAXBException that occured
- * @return the corresponding XmlMappingException
- */
- public static XmlMappingException convertJaxbException(JAXBException ex) {
- if (ex instanceof MarshalException) {
- return new JaxbMarshallingFailureException((MarshalException) ex);
- }
- else if (ex instanceof UnmarshalException) {
- return new JaxbUnmarshallingFailureException((UnmarshalException) ex);
- }
- else if (ex instanceof ValidationException) {
- return new JaxbValidationFailureException((ValidationException) ex);
- }
- // fallback
- return new JaxbSystemException(ex);
- }
+ /**
+ * Converts the given JAXBException to an appropriate exception from the
+ * org.springframework.oxm hierarchy.
+ *
+ * @param ex JAXBException that occured
+ * @return the corresponding XmlMappingException
+ */
+ public static XmlMappingException convertJaxbException(JAXBException ex) {
+ if (ex instanceof MarshalException) {
+ return new JaxbMarshallingFailureException((MarshalException) ex);
+ }
+ else if (ex instanceof UnmarshalException) {
+ return new JaxbUnmarshallingFailureException((UnmarshalException) ex);
+ }
+ else if (ex instanceof ValidationException) {
+ return new JaxbValidationFailureException((ValidationException) ex);
+ }
+ // fallback
+ return new JaxbSystemException(ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/JaxbValidationFailureException.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/JaxbValidationFailureException.java
index e87256f50b..85cb639fa9 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/JaxbValidationFailureException.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/jaxb/JaxbValidationFailureException.java
@@ -24,12 +24,12 @@ import org.springframework.oxm.ValidationFailureException;
*
* @author Arjen Poutsma
* @see JaxbUtils#convertJaxbException
- * @since 1.0.0
+ * @since 3.0
*/
public class JaxbValidationFailureException extends ValidationFailureException {
- public JaxbValidationFailureException(ValidationException ex) {
- super("JAXB validation exception: " + ex.getMessage(), ex);
- }
+ public JaxbValidationFailureException(ValidationException ex) {
+ super("JAXB validation exception: " + ex.getMessage(), ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/jibx/JibxMarshaller.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/jibx/JibxMarshaller.java
index 789aecc2c7..f15bea3478 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/jibx/JibxMarshaller.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/jibx/JibxMarshaller.java
@@ -60,314 +60,309 @@ import org.springframework.oxm.AbstractMarshaller;
import org.springframework.oxm.XmlMappingException;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
-import org.springframework.xml.stream.StaxEventContentHandler;
-import org.springframework.xml.stream.XmlEventStreamReader;
+import org.springframework.util.xml.StaxUtils;
/**
- * Implementation of the Marshaller and Unmarshaller interfaces for JiBX.
- *
- * The typical usage will be to set the targetClass and optionally the bindingName property on
- * this bean, and to refer to it.
+ * Implementation of the Marshaller and Unmarshaller interfaces for JiBX. The typical
+ * usage will be to set the targetClass and optionally the bindingName property on this bean,
+ * and to refer to it.
*
* @author Arjen Poutsma
* @see org.jibx.runtime.IMarshallingContext
* @see org.jibx.runtime.IUnmarshallingContext
- * @since 1.0.0
+ * @since 3.0
*/
public class JibxMarshaller extends AbstractMarshaller implements InitializingBean {
- private Class targetClass;
+ private Class targetClass;
- private String bindingName;
+ private String bindingName;
- private IBindingFactory bindingFactory;
+ private IBindingFactory bindingFactory;
- private static TransformerFactory transformerFactory = TransformerFactory.newInstance();
+ private static TransformerFactory transformerFactory = TransformerFactory.newInstance();
- private int indent = -1;
+ private int indent = -1;
- private String encoding;
+ private String encoding;
- private Boolean standalone;
+ private Boolean standalone;
- /** Sets the optional binding name for this instance. */
- public void setBindingName(String bindingName) {
- this.bindingName = bindingName;
- }
+ /** Sets the optional binding name for this instance. */
+ public void setBindingName(String bindingName) {
+ this.bindingName = bindingName;
+ }
- /** Sets the target class for this instance. This property is required. */
- public void setTargetClass(Class targetClass) {
- this.targetClass = targetClass;
- }
+ /** Sets the target class for this instance. This property is required. */
+ public void setTargetClass(Class targetClass) {
+ this.targetClass = targetClass;
+ }
- /** Sets the number of nesting indent spaces. Default is -1, i.e. no indentation. */
- public void setIndent(int indent) {
- this.indent = indent;
- }
+ /** Sets the number of nesting indent spaces. Default is -1, i.e. no indentation. */
+ public void setIndent(int indent) {
+ this.indent = indent;
+ }
- /** Sets the document encoding using for marshalling. Default is UTF-8. */
- public void setEncoding(String encoding) {
- this.encoding = encoding;
- }
+ /** Sets the document encoding using for marshalling. Default is UTF-8. */
+ public void setEncoding(String encoding) {
+ this.encoding = encoding;
+ }
- /** Sets the document standalone flag for marshalling. By default, this flag is not present. */
- public void setStandalone(Boolean standalone) {
- this.standalone = standalone;
- }
+ /** Sets the document standalone flag for marshalling. By default, this flag is not present. */
+ public void setStandalone(Boolean standalone) {
+ this.standalone = standalone;
+ }
- public void afterPropertiesSet() throws Exception {
- Assert.notNull(targetClass, "targetClass is required");
- if (logger.isInfoEnabled()) {
- if (StringUtils.hasLength(bindingName)) {
- logger.info("Configured for target class [" + targetClass + "] using binding [" + bindingName + "]");
- }
- else {
- logger.info("Configured for target class [" + targetClass + "]");
- }
- }
- try {
- if (StringUtils.hasLength(bindingName)) {
- bindingFactory = BindingDirectory.getFactory(bindingName, targetClass);
- }
- else {
- bindingFactory = BindingDirectory.getFactory(targetClass);
- }
- }
- catch (JiBXException ex) {
- throw new JibxSystemException(ex);
- }
- }
+ public void afterPropertiesSet() throws Exception {
+ Assert.notNull(targetClass, "targetClass is required");
+ if (logger.isInfoEnabled()) {
+ if (StringUtils.hasLength(bindingName)) {
+ logger.info("Configured for target class [" + targetClass + "] using binding [" + bindingName + "]");
+ }
+ else {
+ logger.info("Configured for target class [" + targetClass + "]");
+ }
+ }
+ try {
+ if (StringUtils.hasLength(bindingName)) {
+ bindingFactory = BindingDirectory.getFactory(bindingName, targetClass);
+ }
+ else {
+ bindingFactory = BindingDirectory.getFactory(targetClass);
+ }
+ }
+ catch (JiBXException ex) {
+ throw new JibxSystemException(ex);
+ }
+ }
- public boolean supports(Class clazz) {
- Assert.notNull(clazz, "'clazz' must not be null");
- String[] mappedClasses = bindingFactory.getMappedClasses();
- String className = clazz.getName();
- for (int i = 0; i < mappedClasses.length; i++) {
- if (className.equals(mappedClasses[i])) {
- return true;
- }
- }
- return false;
- }
+ public boolean supports(Class clazz) {
+ Assert.notNull(clazz, "'clazz' must not be null");
+ String[] mappedClasses = bindingFactory.getMappedClasses();
+ String className = clazz.getName();
+ for (String mappedClass : mappedClasses) {
+ if (className.equals(mappedClass)) {
+ return true;
+ }
+ }
+ return false;
+ }
- /**
- * Convert the given JiBXException to an appropriate exception from the
- * org.springframework.oxm hierarchy.
- *
- * The default implementation delegates to JibxUtils. Can be overridden in subclasses.
- *
- * A boolean flag is used to indicate whether this exception occurs during marshalling or unmarshalling, since JiBX
- * itself does not make this distinction in its exception hierarchy.
- *
- * @param ex JiBXException that occured
- * @param marshalling indicates whether the exception occurs during marshalling (true), or
- * unmarshalling (false)
- * @return the corresponding XmlMappingException instance
- * @see JibxUtils#convertJibxException(org.jibx.runtime.JiBXException,boolean)
- */
- public XmlMappingException convertJibxException(JiBXException ex, boolean marshalling) {
- return JibxUtils.convertJibxException(ex, marshalling);
- }
+ /**
+ * Convert the given JiBXException to an appropriate exception from the
+ * org.springframework.oxm hierarchy. The default implementation delegates to JibxUtils.
+ * Can be overridden in subclasses. A boolean flag is used to indicate whether this exception occurs during
+ * marshalling or unmarshalling, since JiBX itself does not make this distinction in its exception hierarchy.
+ *
+ * @param ex JiBXException that occured
+ * @param marshalling indicates whether the exception occurs during marshalling (true), or unmarshalling
+ * (false)
+ * @return the corresponding XmlMappingException instance
+ * @see JibxUtils#convertJibxException(org.jibx.runtime.JiBXException,boolean)
+ */
+ public XmlMappingException convertJibxException(JiBXException ex, boolean marshalling) {
+ return JibxUtils.convertJibxException(ex, marshalling);
+ }
- //
- // Supported Marshalling
- //
+ //
+ // Supported Marshalling
+ //
- @Override
+ @Override
protected void marshalOutputStream(Object graph, OutputStream outputStream)
- throws XmlMappingException, IOException {
- try {
- IMarshallingContext marshallingContext = createMarshallingContext();
- marshallingContext.marshalDocument(graph, encoding, standalone, outputStream);
- }
- catch (JiBXException ex) {
- throw convertJibxException(ex, true);
- }
- }
+ throws XmlMappingException, IOException {
+ try {
+ IMarshallingContext marshallingContext = createMarshallingContext();
+ marshallingContext.marshalDocument(graph, encoding, standalone, outputStream);
+ }
+ catch (JiBXException ex) {
+ throw convertJibxException(ex, true);
+ }
+ }
- @Override
+ @Override
protected void marshalWriter(Object graph, Writer writer) throws XmlMappingException, IOException {
- try {
- IMarshallingContext marshallingContext = createMarshallingContext();
- marshallingContext.marshalDocument(graph, encoding, standalone, writer);
- }
- catch (JiBXException ex) {
- throw convertJibxException(ex, true);
- }
- }
+ try {
+ IMarshallingContext marshallingContext = createMarshallingContext();
+ marshallingContext.marshalDocument(graph, encoding, standalone, writer);
+ }
+ catch (JiBXException ex) {
+ throw convertJibxException(ex, true);
+ }
+ }
- @Override
+ @Override
protected void marshalXmlStreamWriter(Object graph, XMLStreamWriter streamWriter) throws XmlMappingException {
- try {
- MarshallingContext marshallingContext = (MarshallingContext) createMarshallingContext();
- IXMLWriter xmlWriter = new StAXWriter(marshallingContext.getNamespaces(), streamWriter);
- marshallingContext.setXmlWriter(xmlWriter);
- marshallingContext.marshalDocument(graph);
- }
- catch (JiBXException ex) {
- throw convertJibxException(ex, false);
- }
- }
+ try {
+ MarshallingContext marshallingContext = (MarshallingContext) createMarshallingContext();
+ IXMLWriter xmlWriter = new StAXWriter(marshallingContext.getNamespaces(), streamWriter);
+ marshallingContext.setXmlWriter(xmlWriter);
+ marshallingContext.marshalDocument(graph);
+ }
+ catch (JiBXException ex) {
+ throw convertJibxException(ex, false);
+ }
+ }
- //
- // Unsupported Marshalling
- //
+ //
+ // Unsupported Marshalling
+ //
- @Override
+ @Override
protected void marshalDomNode(Object graph, Node node) throws XmlMappingException {
- try {
- // JiBX does not support DOM natively, so we write to a buffer first, and transform that to the Node
- ByteArrayOutputStream os = new ByteArrayOutputStream();
- marshalOutputStream(graph, os);
- ByteArrayInputStream is = new ByteArrayInputStream(os.toByteArray());
- Transformer transformer = transformerFactory.newTransformer();
- transformer.transform(new StreamSource(is), new DOMResult(node));
- }
- catch (IOException ex) {
- throw new JibxSystemException(ex);
- }
- catch (TransformerException ex) {
- throw new JibxSystemException(ex);
- }
- }
+ try {
+ // JiBX does not support DOM natively, so we write to a buffer first, and transform that to the Node
+ ByteArrayOutputStream os = new ByteArrayOutputStream();
+ marshalOutputStream(graph, os);
+ ByteArrayInputStream is = new ByteArrayInputStream(os.toByteArray());
+ Transformer transformer = transformerFactory.newTransformer();
+ transformer.transform(new StreamSource(is), new DOMResult(node));
+ }
+ catch (IOException ex) {
+ throw new JibxSystemException(ex);
+ }
+ catch (TransformerException ex) {
+ throw new JibxSystemException(ex);
+ }
+ }
- @Override
+ @Override
protected void marshalSaxHandlers(Object graph, ContentHandler contentHandler, LexicalHandler lexicalHandler)
- throws XmlMappingException {
- try {
- // JiBX does not support SAX natively, so we write to a buffer first, and transform that to the handlers
- ByteArrayOutputStream os = new ByteArrayOutputStream();
- marshalOutputStream(graph, os);
- ByteArrayInputStream is = new ByteArrayInputStream(os.toByteArray());
- Transformer transformer = transformerFactory.newTransformer();
- SAXResult saxResult = new SAXResult(contentHandler);
- saxResult.setLexicalHandler(lexicalHandler);
- transformer.transform(new StreamSource(is), saxResult);
- }
- catch (IOException ex) {
- throw new JibxSystemException(ex);
- }
- catch (TransformerException ex) {
- throw new JibxSystemException(ex);
- }
- }
+ throws XmlMappingException {
+ try {
+ // JiBX does not support SAX natively, so we write to a buffer first, and transform that to the handlers
+ ByteArrayOutputStream os = new ByteArrayOutputStream();
+ marshalOutputStream(graph, os);
+ ByteArrayInputStream is = new ByteArrayInputStream(os.toByteArray());
+ Transformer transformer = transformerFactory.newTransformer();
+ SAXResult saxResult = new SAXResult(contentHandler);
+ saxResult.setLexicalHandler(lexicalHandler);
+ transformer.transform(new StreamSource(is), saxResult);
+ }
+ catch (IOException ex) {
+ throw new JibxSystemException(ex);
+ }
+ catch (TransformerException ex) {
+ throw new JibxSystemException(ex);
+ }
+ }
- @Override
+ @Override
protected void marshalXmlEventWriter(Object graph, XMLEventWriter eventWriter) {
- ContentHandler contentHandler = new StaxEventContentHandler(eventWriter);
- marshalSaxHandlers(graph, contentHandler, null);
- }
+ ContentHandler contentHandler = StaxUtils.createContentHandler(eventWriter);
+ marshalSaxHandlers(graph, contentHandler, null);
+ }
- //
- // Unmarshalling
- //
+ //
+ // Unmarshalling
+ //
- @Override
+ @Override
protected Object unmarshalInputStream(InputStream inputStream) throws XmlMappingException, IOException {
- try {
- IUnmarshallingContext unmarshallingContext = createUnmarshallingContext();
- return unmarshallingContext.unmarshalDocument(inputStream, null);
- }
- catch (JiBXException ex) {
- throw convertJibxException(ex, false);
- }
- }
+ try {
+ IUnmarshallingContext unmarshallingContext = createUnmarshallingContext();
+ return unmarshallingContext.unmarshalDocument(inputStream, null);
+ }
+ catch (JiBXException ex) {
+ throw convertJibxException(ex, false);
+ }
+ }
- @Override
+ @Override
protected Object unmarshalReader(Reader reader) throws XmlMappingException, IOException {
- try {
- IUnmarshallingContext unmarshallingContext = createUnmarshallingContext();
- return unmarshallingContext.unmarshalDocument(reader);
- }
- catch (JiBXException ex) {
- throw convertJibxException(ex, false);
- }
- }
+ try {
+ IUnmarshallingContext unmarshallingContext = createUnmarshallingContext();
+ return unmarshallingContext.unmarshalDocument(reader);
+ }
+ catch (JiBXException ex) {
+ throw convertJibxException(ex, false);
+ }
+ }
- @Override
+ @Override
protected Object unmarshalXmlStreamReader(XMLStreamReader streamReader) {
- try {
- UnmarshallingContext unmarshallingContext = (UnmarshallingContext) createUnmarshallingContext();
- IXMLReader xmlReader = new StAXReaderWrapper(streamReader, null, true);
- unmarshallingContext.setDocument(xmlReader);
- return unmarshallingContext.unmarshalElement();
- }
- catch (JiBXException ex) {
- throw convertJibxException(ex, false);
- }
- }
+ try {
+ UnmarshallingContext unmarshallingContext = (UnmarshallingContext) createUnmarshallingContext();
+ IXMLReader xmlReader = new StAXReaderWrapper(streamReader, null, true);
+ unmarshallingContext.setDocument(xmlReader);
+ return unmarshallingContext.unmarshalElement();
+ }
+ catch (JiBXException ex) {
+ throw convertJibxException(ex, false);
+ }
+ }
- @Override
+ @Override
protected Object unmarshalXmlEventReader(XMLEventReader eventReader) {
- try {
- XMLStreamReader streamReader = new XmlEventStreamReader(eventReader);
- return unmarshalXmlStreamReader(streamReader);
- }
- catch (XMLStreamException ex) {
- throw new JibxSystemException(ex);
- }
- }
+ try {
+ XMLStreamReader streamReader = StaxUtils.createEventStreamReader(eventReader);
+ return unmarshalXmlStreamReader(streamReader);
+ }
+ catch (XMLStreamException ex) {
+ throw new JibxSystemException(ex);
+ }
+ }
- //
- // Unsupported Unmarshalling
- //
+ //
+ // Unsupported Unmarshalling
+ //
- @Override
+ @Override
protected Object unmarshalDomNode(Node node) throws XmlMappingException {
- try {
- Transformer transformer = transformerFactory.newTransformer();
- ByteArrayOutputStream os = new ByteArrayOutputStream();
- transformer.transform(new DOMSource(node), new StreamResult(os));
- ByteArrayInputStream is = new ByteArrayInputStream(os.toByteArray());
- return unmarshalInputStream(is);
- }
- catch (IOException ex) {
- throw new JibxSystemException(ex);
- }
- catch (TransformerException ex) {
- throw new JibxSystemException(ex);
- }
- }
+ try {
+ Transformer transformer = transformerFactory.newTransformer();
+ ByteArrayOutputStream os = new ByteArrayOutputStream();
+ transformer.transform(new DOMSource(node), new StreamResult(os));
+ ByteArrayInputStream is = new ByteArrayInputStream(os.toByteArray());
+ return unmarshalInputStream(is);
+ }
+ catch (IOException ex) {
+ throw new JibxSystemException(ex);
+ }
+ catch (TransformerException ex) {
+ throw new JibxSystemException(ex);
+ }
+ }
- @Override
+ @Override
protected Object unmarshalSaxReader(XMLReader xmlReader, InputSource inputSource)
- throws XmlMappingException, IOException {
- try {
- Transformer transformer = transformerFactory.newTransformer();
- ByteArrayOutputStream os = new ByteArrayOutputStream();
- transformer.transform(new SAXSource(xmlReader, inputSource), new StreamResult(os));
- ByteArrayInputStream is = new ByteArrayInputStream(os.toByteArray());
- return unmarshalInputStream(is);
- }
- catch (IOException ex) {
- throw new JibxSystemException(ex);
- }
- catch (TransformerException ex) {
- throw new JibxSystemException(ex);
- }
- }
+ throws XmlMappingException, IOException {
+ try {
+ Transformer transformer = transformerFactory.newTransformer();
+ ByteArrayOutputStream os = new ByteArrayOutputStream();
+ transformer.transform(new SAXSource(xmlReader, inputSource), new StreamResult(os));
+ ByteArrayInputStream is = new ByteArrayInputStream(os.toByteArray());
+ return unmarshalInputStream(is);
+ }
+ catch (IOException ex) {
+ throw new JibxSystemException(ex);
+ }
+ catch (TransformerException ex) {
+ throw new JibxSystemException(ex);
+ }
+ }
- /**
- * Creates a new IMarshallingContext, set with the correct indentation.
- *
- * @return the created marshalling context
- * @throws JiBXException in case of errors
- */
- protected IMarshallingContext createMarshallingContext() throws JiBXException {
- IMarshallingContext marshallingContext = bindingFactory.createMarshallingContext();
- marshallingContext.setIndent(indent);
- return marshallingContext;
- }
+ /**
+ * Creates a new IMarshallingContext, set with the correct indentation.
+ *
+ * @return the created marshalling context
+ * @throws JiBXException in case of errors
+ */
+ protected IMarshallingContext createMarshallingContext() throws JiBXException {
+ IMarshallingContext marshallingContext = bindingFactory.createMarshallingContext();
+ marshallingContext.setIndent(indent);
+ return marshallingContext;
+ }
- /**
- * Creates a new IUnmarshallingContext, set with the correct indentation.
- *
- * @return the created unmarshalling context
- * @throws JiBXException in case of errors
- */
- protected IUnmarshallingContext createUnmarshallingContext() throws JiBXException {
- return bindingFactory.createUnmarshallingContext();
- }
+ /**
+ * Creates a new IUnmarshallingContext, set with the correct indentation.
+ *
+ * @return the created unmarshalling context
+ * @throws JiBXException in case of errors
+ */
+ protected IUnmarshallingContext createUnmarshallingContext() throws JiBXException {
+ return bindingFactory.createUnmarshallingContext();
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/jibx/JibxMarshallingFailureException.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/jibx/JibxMarshallingFailureException.java
index 4d9613e9f1..dae314b960 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/jibx/JibxMarshallingFailureException.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/jibx/JibxMarshallingFailureException.java
@@ -17,6 +17,7 @@
package org.springframework.oxm.jibx;
import org.jibx.runtime.JiBXException;
+
import org.springframework.oxm.MarshallingFailureException;
/**
@@ -24,11 +25,11 @@ import org.springframework.oxm.MarshallingFailureException;
*
* @author Arjen Poutsma
* @see JibxUtils#convertJibxException(org.jibx.runtime.JiBXException,boolean)
- * @since 1.0.0
+ * @since 3.0
*/
public class JibxMarshallingFailureException extends MarshallingFailureException {
- public JibxMarshallingFailureException(JiBXException ex) {
- super("JiBX marshalling exception: " + ex.getMessage(), ex);
- }
+ public JibxMarshallingFailureException(JiBXException ex) {
+ super("JiBX marshalling exception: " + ex.getMessage(), ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/jibx/JibxSystemException.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/jibx/JibxSystemException.java
index e8962e996c..ede06119d9 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/jibx/JibxSystemException.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/jibx/JibxSystemException.java
@@ -24,11 +24,11 @@ import org.springframework.oxm.UncategorizedXmlMappingException;
*
* @author Arjen Poutsma
* @see JibxUtils#convertJibxException(org.jibx.runtime.JiBXException,boolean)
- * @since 1.0.0
+ * @since 3.0
*/
public class JibxSystemException extends UncategorizedXmlMappingException {
- public JibxSystemException(Exception ex) {
- super(ex.getMessage(), ex);
- }
+ public JibxSystemException(Exception ex) {
+ super(ex.getMessage(), ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/jibx/JibxUnmarshallingFailureException.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/jibx/JibxUnmarshallingFailureException.java
index 797bbffdfc..421dc69c26 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/jibx/JibxUnmarshallingFailureException.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/jibx/JibxUnmarshallingFailureException.java
@@ -17,6 +17,7 @@
package org.springframework.oxm.jibx;
import org.jibx.runtime.JiBXException;
+
import org.springframework.oxm.UnmarshallingFailureException;
/**
@@ -24,12 +25,12 @@ import org.springframework.oxm.UnmarshallingFailureException;
*
* @author Arjen Poutsma
* @see JibxUtils#convertJibxException(org.jibx.runtime.JiBXException,boolean)
- * @since 1.0.0
+ * @since 3.0
*/
public class JibxUnmarshallingFailureException extends UnmarshallingFailureException {
- public JibxUnmarshallingFailureException(JiBXException ex) {
- super("JiBX unmarshalling exception: " + ex.getMessage(), ex);
- }
+ public JibxUnmarshallingFailureException(JiBXException ex) {
+ super("JiBX unmarshalling exception: " + ex.getMessage(), ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/jibx/JibxUtils.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/jibx/JibxUtils.java
index 56c1b9f03e..43bdc04037 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/jibx/JibxUtils.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/jibx/JibxUtils.java
@@ -18,39 +18,39 @@ package org.springframework.oxm.jibx;
import org.jibx.runtime.JiBXException;
import org.jibx.runtime.ValidationException;
+
import org.springframework.oxm.XmlMappingException;
/**
* Generic utility methods for working with JiBX. Mainly for internal use within the framework.
*
* @author Arjen Poutsma
- * @since 1.0.0
+ * @since 3.0
*/
public abstract class JibxUtils {
- /**
- * Converts the given JiBXException to an appropriate exception from the
- * org.springframework.oxm hierarchy.
- *
- * A boolean flag is used to indicate whether this exception occurs during marshalling or unmarshalling, since JiBX
- * itself does not make this distinction in its exception hierarchy.
- *
- * @param ex JiBXException that occured
- * @param marshalling indicates whether the exception occurs during marshalling (true), or
- * unmarshalling (false)
- * @return the corresponding XmlMappingException
- */
- public static XmlMappingException convertJibxException(JiBXException ex, boolean marshalling) {
- if (ex instanceof ValidationException) {
- return new JibxValidationFailureException((ValidationException) ex);
- }
- else {
- if (marshalling) {
- return new JibxMarshallingFailureException(ex);
- }
- else {
- return new JibxUnmarshallingFailureException(ex);
- }
- }
- }
+ /**
+ * Converts the given JiBXException to an appropriate exception from the
+ * org.springframework.oxm hierarchy. A boolean flag is used to indicate whether this exception
+ * occurs during marshalling or unmarshalling, since JiBX itself does not make this distinction in its exception
+ * hierarchy.
+ *
+ * @param ex JiBXException that occured
+ * @param marshalling indicates whether the exception occurs during marshalling (true), or unmarshalling
+ * (false)
+ * @return the corresponding XmlMappingException
+ */
+ public static XmlMappingException convertJibxException(JiBXException ex, boolean marshalling) {
+ if (ex instanceof ValidationException) {
+ return new JibxValidationFailureException((ValidationException) ex);
+ }
+ else {
+ if (marshalling) {
+ return new JibxMarshallingFailureException(ex);
+ }
+ else {
+ return new JibxUnmarshallingFailureException(ex);
+ }
+ }
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/jibx/JibxValidationFailureException.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/jibx/JibxValidationFailureException.java
index 23952b21b5..69132a5d05 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/jibx/JibxValidationFailureException.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/jibx/JibxValidationFailureException.java
@@ -17,6 +17,7 @@
package org.springframework.oxm.jibx;
import org.jibx.runtime.ValidationException;
+
import org.springframework.oxm.ValidationFailureException;
/**
@@ -24,12 +25,12 @@ import org.springframework.oxm.ValidationFailureException;
*
* @author Arjen Poutsma
* @see JibxUtils#convertJibxException(org.jibx.runtime.JiBXException,boolean)
- * @since 1.0.0
+ * @since 3.0
*/
public class JibxValidationFailureException extends ValidationFailureException {
- public JibxValidationFailureException(ValidationException ex) {
- super("JiBX validation exception: " + ex.getMessage(), ex);
- }
+ public JibxValidationFailureException(ValidationException ex) {
+ super("JiBX validation exception: " + ex.getMessage(), ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/mime/MimeContainer.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/mime/MimeContainer.java
index 81767e5d04..3887a093b0 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/mime/MimeContainer.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/mime/MimeContainer.java
@@ -23,40 +23,40 @@ import javax.activation.DataHandler;
*
* @author Arjen Poutsma
* @see XML-binary Optimized Packaging
- * @since 1.0.0
+ * @since 3.0
*/
public interface MimeContainer {
- /**
- * Indicates whether this container is a XOP package.
- *
- * @return true when the constraints specified in Identifying
- * XOP Documents are met.
- * @see XOP Packages
- */
- boolean isXopPackage();
+ /**
+ * Indicates whether this container is a XOP package.
+ *
+ * @return true when the constraints specified in Identifying
+ * XOP Documents are met.
+ * @see XOP Packages
+ */
+ boolean isXopPackage();
- /**
- * Turns this message into a XOP package.
- *
- * @return true when the message is a XOP package
- * @see XOP Packages
- */
- boolean convertToXopPackage();
+ /**
+ * Turns this message into a XOP package.
+ *
+ * @return true when the message is a XOP package
+ * @see XOP Packages
+ */
+ boolean convertToXopPackage();
- /**
- * Adds the given data handler as an attachment to this container.
- *
- * @param contentId the content id of the attachment
- * @param dataHandler the data handler containing the data of the attachment
- */
- void addAttachment(String contentId, DataHandler dataHandler);
+ /**
+ * Adds the given data handler as an attachment to this container.
+ *
+ * @param contentId the content id of the attachment
+ * @param dataHandler the data handler containing the data of the attachment
+ */
+ void addAttachment(String contentId, DataHandler dataHandler);
- /**
- * Returns the attachment with the given content id, or null if not found.
- *
- * @param contentId the content id
- * @return the attachment, as a data handler
- */
- DataHandler getAttachment(String contentId);
+ /**
+ * Returns the attachment with the given content id, or null if not found.
+ *
+ * @param contentId the content id
+ * @return the attachment, as a data handler
+ */
+ DataHandler getAttachment(String contentId);
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/mime/MimeMarshaller.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/mime/MimeMarshaller.java
index c7a1e6ee7a..d692453fe9 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/mime/MimeMarshaller.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/mime/MimeMarshaller.java
@@ -30,21 +30,21 @@ import org.springframework.oxm.XmlMappingException;
* @see SOAP Message Transmission Optimization
* Mechanism
* @see XML-binary Optimized Packaging
- * @since 1.0.0
+ * @since 3.0
*/
public interface MimeMarshaller extends Marshaller {
- /**
- * Marshals the object graph with the given root into the provided {@link Result}, writing binary data to a {@link
- * MimeContainer}.
- *
- * @param graph the root of the object graph to marshal
- * @param result the result to marshal to
- * @param mimeContainer the MIME container to write extracted binary content to
- * @throws XmlMappingException if the given object cannot be marshalled to the result
- * @throws IOException if an I/O exception occurs
- */
- void marshal(Object graph, Result result, MimeContainer mimeContainer) throws XmlMappingException, IOException;
+ /**
+ * Marshals the object graph with the given root into the provided {@link Result}, writing binary data to a {@link
+ * MimeContainer}.
+ *
+ * @param graph the root of the object graph to marshal
+ * @param result the result to marshal to
+ * @param mimeContainer the MIME container to write extracted binary content to
+ * @throws XmlMappingException if the given object cannot be marshalled to the result
+ * @throws IOException if an I/O exception occurs
+ */
+ void marshal(Object graph, Result result, MimeContainer mimeContainer) throws XmlMappingException, IOException;
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/mime/MimeUnmarshaller.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/mime/MimeUnmarshaller.java
index e6a3edede9..1e880d65f8 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/mime/MimeUnmarshaller.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/mime/MimeUnmarshaller.java
@@ -30,19 +30,19 @@ import org.springframework.oxm.XmlMappingException;
* @see SOAP Message Transmission Optimization
* Mechanism
* @see XML-binary Optimized Packaging
- * @since 1.0.0
+ * @since 3.0
*/
public interface MimeUnmarshaller extends Unmarshaller {
- /**
- * Unmarshals the given provided {@link Source} into an object graph, reading binary attachments from a {@link
- * MimeContainer}.
- *
- * @param source the source to marshal from
- * @param mimeContainer the MIME container to read extracted binary content from
- * @return the object graph
- * @throws XmlMappingException if the given source cannot be mapped to an object
- * @throws IOException if an I/O Exception occurs
- */
- Object unmarshal(Source source, MimeContainer mimeContainer) throws XmlMappingException, IOException;
+ /**
+ * Unmarshals the given provided {@link Source} into an object graph, reading binary attachments from a {@link
+ * MimeContainer}.
+ *
+ * @param source the source to marshal from
+ * @param mimeContainer the MIME container to read extracted binary content from
+ * @return the object graph
+ * @throws XmlMappingException if the given source cannot be mapped to an object
+ * @throws IOException if an I/O Exception occurs
+ */
+ Object unmarshal(Source source, MimeContainer mimeContainer) throws XmlMappingException, IOException;
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/support/MarshallingMessageConverter.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/support/MarshallingMessageConverter.java
deleted file mode 100644
index 26a2e78798..0000000000
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/support/MarshallingMessageConverter.java
+++ /dev/null
@@ -1,306 +0,0 @@
-/*
- * Copyright 2007 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.oxm.support;
-
-import java.io.ByteArrayInputStream;
-import java.io.ByteArrayOutputStream;
-import java.io.IOException;
-import java.io.StringReader;
-import java.io.StringWriter;
-import javax.jms.BytesMessage;
-import javax.jms.JMSException;
-import javax.jms.Message;
-import javax.jms.Session;
-import javax.jms.TextMessage;
-import javax.xml.transform.Result;
-import javax.xml.transform.Source;
-import javax.xml.transform.stream.StreamResult;
-import javax.xml.transform.stream.StreamSource;
-
-import org.springframework.beans.factory.InitializingBean;
-import org.springframework.jms.support.converter.MessageConversionException;
-import org.springframework.jms.support.converter.MessageConverter;
-import org.springframework.oxm.Marshaller;
-import org.springframework.oxm.MarshallingFailureException;
-import org.springframework.oxm.Unmarshaller;
-import org.springframework.oxm.UnmarshallingFailureException;
-import org.springframework.util.Assert;
-
-/**
- * Spring JMS {@link MessageConverter} that uses a {@link Marshaller} and {@link Unmarshaller}. Marshals an object to a
- * {@link BytesMessage}, or to a {@link TextMessage} if the {@link #setMarshalTo marshalTo} is set to {@link
- * #MARSHAL_TO_TEXT_MESSAGE}. Unmarshals from a {@link TextMessage} or {@link BytesMessage} to an object.
- *
- * @author Arjen Poutsma
- * @see org.springframework.jms.core.JmsTemplate#convertAndSend
- * @see org.springframework.jms.core.JmsTemplate#receiveAndConvert
- * @since 1.5.1
- */
-public class MarshallingMessageConverter implements MessageConverter, InitializingBean {
-
- /** Constant that indicates that {@link #toMessage(Object, Session)} should marshal to a {@link BytesMessage}. */
- public static final int MARSHAL_TO_BYTES_MESSAGE = 1;
-
- /** Constant that indicates that {@link #toMessage(Object, Session)} should marshal to a {@link TextMessage}. */
- public static final int MARSHAL_TO_TEXT_MESSAGE = 2;
-
- private Marshaller marshaller;
-
- private Unmarshaller unmarshaller;
-
- private int marshalTo = MARSHAL_TO_BYTES_MESSAGE;
-
- /**
- * Constructs a new MarshallingMessageConverter with no {@link Marshaller} set. The marshaller must be
- * set after construction by invoking {@link #setMarshaller(Marshaller)}.
- */
- public MarshallingMessageConverter() {
- }
-
- /**
- * Constructs a new MarshallingMessageConverter with the given {@link Marshaller} set. If the given
- * {@link Marshaller} also implements the {@link Unmarshaller} interface, it is used for both marshalling and
- * unmarshalling. Otherwise, an exception is thrown.
- *
- * Note that all {@link Marshaller} implementations in Spring-WS also implement the {@link Unmarshaller} interface,
- * so that you can safely use this constructor.
- *
- * @param marshaller object used as marshaller and unmarshaller
- * @throws IllegalArgumentException when marshaller does not implement the {@link Unmarshaller}
- * interface
- */
- public MarshallingMessageConverter(Marshaller marshaller) {
- Assert.notNull(marshaller, "marshaller must not be null");
- if (!(marshaller instanceof Unmarshaller)) {
- throw new IllegalArgumentException("Marshaller [" + marshaller + "] does not implement the Unmarshaller " +
- "interface. Please set an Unmarshaller explicitely by using the " +
- "AbstractMarshallingPayloadEndpoint(Marshaller, Unmarshaller) constructor.");
- }
- else {
- this.marshaller = marshaller;
- this.unmarshaller = (Unmarshaller) marshaller;
- }
- }
-
- /**
- * Creates a new MarshallingMessageConverter with the given marshaller and unmarshaller.
- *
- * @param marshaller the marshaller to use
- * @param unmarshaller the unmarshaller to use
- */
- public MarshallingMessageConverter(Marshaller marshaller, Unmarshaller unmarshaller) {
- Assert.notNull(marshaller, "marshaller must not be null");
- Assert.notNull(unmarshaller, "unmarshaller must not be null");
- this.marshaller = marshaller;
- this.unmarshaller = unmarshaller;
- }
-
- /**
- * Indicates whether {@link #toMessage(Object,Session)} should marshal to a {@link BytesMessage} or a {@link
- * TextMessage}. The default is {@link #MARSHAL_TO_BYTES_MESSAGE}, i.e. this converter marshals to a {@link
- * BytesMessage}.
- *
- * @see #MARSHAL_TO_BYTES_MESSAGE
- * @see #MARSHAL_TO_TEXT_MESSAGE
- */
- public void setMarshalTo(int marshalTo) {
- this.marshalTo = marshalTo;
- }
-
- /** Sets the {@link Marshaller} to be used by this message converter. */
- public void setMarshaller(Marshaller marshaller) {
- this.marshaller = marshaller;
- }
-
- /** Sets the {@link Unmarshaller} to be used by this message converter. */
- public void setUnmarshaller(Unmarshaller unmarshaller) {
- this.unmarshaller = unmarshaller;
- }
-
- public void afterPropertiesSet() throws Exception {
- Assert.notNull(marshaller, "Property 'marshaller' is required");
- Assert.notNull(unmarshaller, "Property 'unmarshaller' is required");
- }
-
- /**
- * Marshals the given object to a {@link TextMessage} or {@link javax.jms.BytesMessage}. The desired message type
- * can be defined by setting the {@link #setMarshalTo(int) marshalTo} property.
- *
- * @see #marshalToTextMessage
- * @see #marshalToBytesMessage
- */
- public Message toMessage(Object object, Session session) throws JMSException, MessageConversionException {
- try {
- switch (marshalTo) {
- case MARSHAL_TO_TEXT_MESSAGE:
- return marshalToTextMessage(object, session, marshaller);
- case MARSHAL_TO_BYTES_MESSAGE:
- return marshalToBytesMessage(object, session, marshaller);
- default:
- return marshalToMessage(object, session, marshaller);
- }
- }
- catch (MarshallingFailureException ex) {
- throw new MessageConversionException("Could not marshal [" + object + "]", ex);
- }
- catch (IOException ex) {
- throw new MessageConversionException("Could not marshal [" + object + "]", ex);
- }
- }
-
- /**
- * Unmarshals the given {@link Message} into an object.
- *
- * @see #unmarshalFromTextMessage
- * @see #unmarshalFromBytesMessage
- */
- public Object fromMessage(Message message) throws JMSException, MessageConversionException {
- try {
- if (message instanceof TextMessage) {
- TextMessage textMessage = (TextMessage) message;
- return unmarshalFromTextMessage(textMessage, unmarshaller);
- }
- else if (message instanceof BytesMessage) {
- BytesMessage bytesMessage = (BytesMessage) message;
- return unmarshalFromBytesMessage(bytesMessage, unmarshaller);
- }
- else {
- return unmarshalFromMessage(message, unmarshaller);
- }
- }
- catch (UnmarshallingFailureException ex) {
- throw new MessageConversionException("Could not unmarshal message [" + message + "]", ex);
- }
- catch (IOException ex) {
- throw new MessageConversionException("Could not unmarshal message [" + message + "]", ex);
- }
- }
-
- /**
- * Marshals the given object to a {@link TextMessage}.
- *
- * @param object the object to be marshalled
- * @param session current JMS session
- * @param marshaller the marshaller to use
- * @return the resulting message
- * @throws JMSException if thrown by JMS methods
- * @throws IOException in case of I/O errors
- * @see Session#createTextMessage
- * @see Marshaller#marshal(Object, Result)
- */
- protected TextMessage marshalToTextMessage(Object object, Session session, Marshaller marshaller)
- throws JMSException, IOException {
- StringWriter writer = new StringWriter();
- Result result = new StreamResult(writer);
- marshaller.marshal(object, result);
- return session.createTextMessage(writer.toString());
- }
-
- /**
- * Marshals the given object to a {@link BytesMessage}.
- *
- * @param object the object to be marshalled
- * @param session current JMS session
- * @param marshaller the marshaller to use
- * @return the resulting message
- * @throws JMSException if thrown by JMS methods
- * @throws IOException in case of I/O errors
- * @see Session#createBytesMessage
- * @see Marshaller#marshal(Object, Result)
- */
- protected BytesMessage marshalToBytesMessage(Object object, Session session, Marshaller marshaller)
- throws JMSException, IOException {
- ByteArrayOutputStream bos = new ByteArrayOutputStream();
- StreamResult streamResult = new StreamResult(bos);
- marshaller.marshal(object, streamResult);
- BytesMessage message = session.createBytesMessage();
- message.writeBytes(bos.toByteArray());
- return message;
- }
-
- /**
- * Template method that allows for custom message marshalling. Invoked when {@link #setMarshalTo(int)} is not {@link
- * #MARSHAL_TO_TEXT_MESSAGE} or {@link #MARSHAL_TO_BYTES_MESSAGE}.
- *
- * Default implemenetation throws a {@link MessageConversionException}.
- *
- * @param object the object to marshal
- * @param session the JMS session
- * @param marshaller the marshaller to use
- * @return the resulting message
- * @throws JMSException if thrown by JMS methods
- * @throws IOException in case of I/O errors
- */
- protected Message marshalToMessage(Object object, Session session, Marshaller marshaller)
- throws JMSException, IOException {
- throw new MessageConversionException(
- "Unknown 'marshalTo' value [" + marshalTo + "]. Cannot convert object to Message");
- }
-
- /**
- * Unmarshals the given {@link TextMessage} into an object.
- *
- * @param message the message
- * @param unmarshaller the unmarshaller to use
- * @return the unmarshalled object
- * @throws JMSException if thrown by JMS methods
- * @throws IOException in case of I/O errors
- * @see Unmarshaller#unmarshal(Source)
- */
- protected Object unmarshalFromTextMessage(TextMessage message, Unmarshaller unmarshaller)
- throws JMSException, IOException {
- Source source = new StreamSource(new StringReader(message.getText()));
- return unmarshaller.unmarshal(source);
- }
-
- /**
- * Unmarshals the given {@link BytesMessage} into an object.
- *
- * @param message the message
- * @param unmarshaller the unmarshaller to use
- * @return the unmarshalled object
- * @throws JMSException if thrown by JMS methods
- * @throws IOException in case of I/O errors
- * @see Unmarshaller#unmarshal(Source)
- */
- protected Object unmarshalFromBytesMessage(BytesMessage message, Unmarshaller unmarshaller)
- throws JMSException, IOException {
- byte[] bytes = new byte[(int) message.getBodyLength()];
- message.readBytes(bytes);
- ByteArrayInputStream bis = new ByteArrayInputStream(bytes);
- StreamSource source = new StreamSource(bis);
- return unmarshaller.unmarshal(source);
- }
-
- /**
- * Template method that allows for custom message unmarshalling. Invoked when {@link #fromMessage(Message)} is
- * invoked with a message that is not a {@link TextMessage} or {@link BytesMessage}.
- *
- * Default implemenetation throws a {@link MessageConversionException}.
- *
- * @param message the message
- * @param unmarshaller the unmarshaller to use
- * @return the unmarshalled object
- * @throws JMSException if thrown by JMS methods
- * @throws IOException in case of I/O errors
- */
- protected Object unmarshalFromMessage(Message message, Unmarshaller unmarshaller) throws JMSException, IOException {
- throw new MessageConversionException(
- "MarshallingMessageConverter only supports TextMessages and BytesMessages");
- }
-}
-
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/support/MarshallingSource.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/support/MarshallingSource.java
index b0d4c2bd11..a563ac0eda 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/support/MarshallingSource.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/support/MarshallingSource.java
@@ -1,5 +1,5 @@
/*
- * Copyright 2007 the original author or authors.
+ * Copyright 2002-2009 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -21,84 +21,194 @@ import javax.xml.transform.Source;
import javax.xml.transform.sax.SAXResult;
import javax.xml.transform.sax.SAXSource;
-import org.springframework.oxm.Marshaller;
-import org.springframework.util.Assert;
-import org.springframework.xml.sax.AbstractXmlReader;
+import org.xml.sax.ContentHandler;
+import org.xml.sax.DTDHandler;
+import org.xml.sax.EntityResolver;
+import org.xml.sax.ErrorHandler;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
+import org.xml.sax.SAXNotRecognizedException;
+import org.xml.sax.SAXNotSupportedException;
import org.xml.sax.SAXParseException;
+import org.xml.sax.XMLReader;
+import org.xml.sax.ext.LexicalHandler;
+
+import org.springframework.oxm.Marshaller;
+import org.springframework.util.Assert;
/**
* {@link Source} implementation that uses a {@link Marshaller}.Can be constructed with a Marshaller and an
* object to be marshalled.
- *
- * Even though StaxSource extends from SAXSource, calling the methods of
+ *
+ * Even though MarshallingSource extends from SAXSource, calling the methods of
* SAXSource is not supported. In general, the only supported operation on this class is
* to use the XMLReader obtained via {@link #getXMLReader()} to parse the input source obtained via {@link
- * #getInputSource()}. Calling {@link #setXMLReader(org.xml.sax.XMLReader)} or {@link
- * #setInputSource(org.xml.sax.InputSource)} will result in UnsupportedOperationExceptions.
+ * #getInputSource()}. Calling {@link #setXMLReader(XMLReader)} or {@link #setInputSource(InputSource)} will result in
+ * UnsupportedOperationExceptions.
*
* @author Arjen Poutsma
* @see javax.xml.transform.Transformer
- * @since 1.0.0
+ * @since 3.0
*/
public class MarshallingSource extends SAXSource {
- private final Marshaller marshaller;
+ private final Marshaller marshaller;
- private final Object content;
+ private final Object content;
- /**
- * Creates a new MarshallingSource with the given marshaller and content.
- *
- * @param marshaller the marshaller to use
- * @param content the object to be marshalled
- */
- public MarshallingSource(Marshaller marshaller, Object content) {
- Assert.notNull(marshaller, "'marshaller' must not be null");
- Assert.notNull(content, "'content' must not be null");
- this.marshaller = marshaller;
- this.content = content;
- setXMLReader(new MarshallingXmlReader());
- setInputSource(new InputSource());
- }
+ /**
+ * Creates a new MarshallingSource with the given marshaller and content.
+ *
+ * @param marshaller the marshaller to use
+ * @param content the object to be marshalled
+ */
+ public MarshallingSource(Marshaller marshaller, Object content) {
+ super(new MarshallingXMLReader(marshaller, content), new InputSource());
+ Assert.notNull(marshaller, "'marshaller' must not be null");
+ Assert.notNull(content, "'content' must not be null");
+ this.marshaller = marshaller;
+ this.content = content;
+ }
- /** Returns the Marshaller used by this MarshallingSource. */
- public Marshaller getMarshaller() {
- return marshaller;
- }
+ /** Returns the Marshaller used by this MarshallingSource. */
+ public Marshaller getMarshaller() {
+ return marshaller;
+ }
- /** Returns the object to be marshalled. */
- public Object getContent() {
- return content;
- }
+ /** Returns the object to be marshalled. */
+ public Object getContent() {
+ return content;
+ }
- private class MarshallingXmlReader extends AbstractXmlReader {
+ /**
+ * Throws a UnsupportedOperationException.
+ *
+ * @throws UnsupportedOperationException always
+ */
+ @Override
+ public void setInputSource(InputSource inputSource) {
+ throw new UnsupportedOperationException("setInputSource is not supported");
+ }
- public void parse(InputSource input) throws IOException, SAXException {
- parse();
- }
+ /**
+ * Throws a UnsupportedOperationException.
+ *
+ * @throws UnsupportedOperationException always
+ */
+ @Override
+ public void setXMLReader(XMLReader reader) {
+ throw new UnsupportedOperationException("setXMLReader is not supported");
+ }
- public void parse(String systemId) throws IOException, SAXException {
- parse();
- }
+ private static class MarshallingXMLReader implements XMLReader {
- private void parse() throws SAXException {
- SAXResult result = new SAXResult(getContentHandler());
- result.setLexicalHandler(getLexicalHandler());
- try {
- marshaller.marshal(content, result);
- }
- catch (IOException ex) {
- SAXParseException saxException = new SAXParseException(ex.getMessage(), null, null, -1, -1, ex);
- if (getErrorHandler() != null) {
- getErrorHandler().fatalError(saxException);
- }
- else {
- throw saxException;
- }
- }
- }
+ private final Marshaller marshaller;
- }
+ private final Object content;
+
+ private DTDHandler dtdHandler;
+
+ private ContentHandler contentHandler;
+
+ private EntityResolver entityResolver;
+
+ private ErrorHandler errorHandler;
+
+ private LexicalHandler lexicalHandler;
+
+ private MarshallingXMLReader(Marshaller marshaller, Object content) {
+ Assert.notNull(marshaller, "'marshaller' must not be null");
+ Assert.notNull(content, "'content' must not be null");
+ this.marshaller = marshaller;
+ this.content = content;
+ }
+
+ public ContentHandler getContentHandler() {
+ return contentHandler;
+ }
+
+ public void setContentHandler(ContentHandler contentHandler) {
+ this.contentHandler = contentHandler;
+ }
+
+ public void setDTDHandler(DTDHandler dtdHandler) {
+ this.dtdHandler = dtdHandler;
+ }
+
+ public DTDHandler getDTDHandler() {
+ return dtdHandler;
+ }
+
+ public EntityResolver getEntityResolver() {
+ return entityResolver;
+ }
+
+ public void setEntityResolver(EntityResolver entityResolver) {
+ this.entityResolver = entityResolver;
+ }
+
+ public ErrorHandler getErrorHandler() {
+ return errorHandler;
+ }
+
+ public void setErrorHandler(ErrorHandler errorHandler) {
+ this.errorHandler = errorHandler;
+ }
+
+ protected LexicalHandler getLexicalHandler() {
+ return lexicalHandler;
+ }
+
+ public boolean getFeature(String name) throws SAXNotRecognizedException, SAXNotSupportedException {
+ throw new SAXNotRecognizedException(name);
+ }
+
+ public void setFeature(String name, boolean value) throws SAXNotRecognizedException, SAXNotSupportedException {
+ throw new SAXNotRecognizedException(name);
+ }
+
+ public Object getProperty(String name) throws SAXNotRecognizedException, SAXNotSupportedException {
+ if ("http://xml.org/sax/properties/lexical-handler".equals(name)) {
+ return lexicalHandler;
+ }
+ else {
+ throw new SAXNotRecognizedException(name);
+ }
+ }
+
+ public void setProperty(String name, Object value) throws SAXNotRecognizedException, SAXNotSupportedException {
+ if ("http://xml.org/sax/properties/lexical-handler".equals(name)) {
+ lexicalHandler = (LexicalHandler) value;
+ }
+ else {
+ throw new SAXNotRecognizedException(name);
+ }
+ }
+
+ public void parse(InputSource input) throws IOException, SAXException {
+ parse();
+ }
+
+ public void parse(String systemId) throws IOException, SAXException {
+ parse();
+ }
+
+ private void parse() throws SAXException {
+ SAXResult result = new SAXResult(getContentHandler());
+ result.setLexicalHandler(getLexicalHandler());
+ try {
+ marshaller.marshal(content, result);
+ }
+ catch (IOException ex) {
+ SAXParseException saxException = new SAXParseException(ex.getMessage(), null, null, -1, -1, ex);
+ if (getErrorHandler() != null) {
+ getErrorHandler().fatalError(saxException);
+ }
+ else {
+ throw saxException;
+ }
+ }
+ }
+
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/support/MarshallingView.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/support/MarshallingView.java
deleted file mode 100644
index 9b4ef99361..0000000000
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/support/MarshallingView.java
+++ /dev/null
@@ -1,134 +0,0 @@
-/*
- * Copyright 2007 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.oxm.support;
-
-import java.io.ByteArrayOutputStream;
-import java.util.Map;
-import javax.servlet.ServletException;
-import javax.servlet.ServletOutputStream;
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
-import javax.xml.transform.stream.StreamResult;
-
-import org.springframework.beans.BeansException;
-import org.springframework.oxm.Marshaller;
-import org.springframework.util.Assert;
-import org.springframework.web.servlet.View;
-import org.springframework.web.servlet.view.AbstractUrlBasedView;
-
-/**
- * Spring-MVC {@link View} that allows for response context to be rendered as the result of marshalling by a {@link
- * Marshaller}.
- *
- * The Object to be marshalled is supplied as a parameter in the model and then {@linkplain #locateToBeMarshalled(Map)
- * detected} during response rendering. Users can either specify a specific entry in the model via the {@link
- * #setModelKey(String) sourceKey} property or have Spring locate the Source object.
- *
- * @author Arjen Poutsma
- * @since 1.5.1
- */
-public class MarshallingView extends AbstractUrlBasedView {
-
- /** Default content type. Overridable as bean property. */
- public static final String DEFAULT_CONTENT_TYPE = "application/xml";
-
- private Marshaller marshaller;
-
- private String modelKey;
-
- /**
- * Constructs a new MarshallingView with no {@link Marshaller} set. The marshaller must be set after
- * construction by invoking {@link #setMarshaller(Marshaller)}.
- */
- public MarshallingView() {
- setContentType(DEFAULT_CONTENT_TYPE);
- }
-
- /** Constructs a new MarshallingView with the given {@link Marshaller} set. */
- public MarshallingView(Marshaller marshaller) {
- Assert.notNull(marshaller, "'marshaller' must not be null");
- setContentType(DEFAULT_CONTENT_TYPE);
- this.marshaller = marshaller;
- }
-
- /** Sets the {@link Marshaller} to be used by this view. */
- public void setMarshaller(Marshaller marshaller) {
- Assert.notNull(marshaller, "'marshaller' must not be null");
- this.marshaller = marshaller;
- }
-
- /**
- * Set the name of the model key that represents the object to be marshalled. If not specified, the model map will
- * be searched for a supported value type.
- *
- * @see Marshaller#supports(Class)
- */
- public void setModelKey(String modelKey) {
- this.modelKey = modelKey;
- }
-
- @Override
- protected void initApplicationContext() throws BeansException {
- Assert.notNull(marshaller, "Property 'marshaller' is required");
- }
-
- @Override
- protected void renderMergedOutputModel(Map model, HttpServletRequest request, HttpServletResponse response)
- throws Exception {
- Object toBeMarshalled = locateToBeMarshalled(model);
- if (toBeMarshalled == null) {
- throw new ServletException("Unable to locate object to be marshalled in model: " + model);
- }
- ByteArrayOutputStream bos = new ByteArrayOutputStream(2048);
- marshaller.marshal(toBeMarshalled, new StreamResult(bos));
-
- response.setContentType(getContentType());
- response.setContentLength(bos.size());
-
- ServletOutputStream out = response.getOutputStream();
- bos.writeTo(out);
- out.flush();
- }
-
- /**
- * Locates the object to be marshalled. The default implementation first attempts to look under the configured
- * {@linkplain #setModelKey(String) model key}, if any, before attempting to locate an object of {@linkplain
- * Marshaller#supports(Class) supported type}.
- *
- * @param model the model Map
- * @return the Object to be marshalled (or null if none found)
- * @throws ServletException if the model object specified by the {@linkplain #setModelKey(String) model key} is not
- * supported by the marshaller
- * @see #setModelKey(String)
- */
- protected Object locateToBeMarshalled(Map model) throws ServletException {
- if (this.modelKey != null) {
- Object o = model.get(this.modelKey);
- if (!this.marshaller.supports(o.getClass())) {
- throw new ServletException("Model object [" + o + "] retrieved via key [" + modelKey +
- "] is not supported by the Marshaller");
- }
- return o;
- }
- for (Object o : model.values()) {
- if (this.marshaller.supports(o.getClass())) {
- return o;
- }
- }
- return null;
- }
-}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlBeansMarshaller.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlBeansMarshaller.java
index 9baf037633..cf25a21569 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlBeansMarshaller.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlBeansMarshaller.java
@@ -19,12 +19,6 @@ import org.apache.xmlbeans.XmlObject;
import org.apache.xmlbeans.XmlOptions;
import org.apache.xmlbeans.XmlSaxHandler;
import org.apache.xmlbeans.XmlValidationError;
-import org.springframework.oxm.AbstractMarshaller;
-import org.springframework.oxm.Marshaller;
-import org.springframework.oxm.XmlMappingException;
-import org.springframework.xml.stream.StaxEventContentHandler;
-import org.springframework.xml.stream.StaxEventXmlReader;
-import org.springframework.xml.stream.StaxStreamContentHandler;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
@@ -36,234 +30,233 @@ import org.xml.sax.SAXNotSupportedException;
import org.xml.sax.XMLReader;
import org.xml.sax.ext.LexicalHandler;
+import org.springframework.oxm.AbstractMarshaller;
+import org.springframework.oxm.Marshaller;
+import org.springframework.oxm.XmlMappingException;
+import org.springframework.util.xml.StaxUtils;
+
/**
* Implementation of the {@link Marshaller} interface for XMLBeans. Further options can be set by setting the
* xmlOptions property. The {@link XmlOptionsFactoryBean} is provided to easily wire up {@link XmlOptions}
- * instances.
- *
- * Unmarshalled objects can be validated by setting the validating property, or by calling the {@link
- * #validate(XmlObject)} method directly. Invalid objects will result in an {@link XmlBeansValidationFailureException}.
- *
- * Note that due to the nature of XMLBeans, this marshaller requires all passed objects to be of type
- * {@link XmlObject}.
+ * instances. Unmarshalled objects can be validated by setting the validating property, or by calling
+ * the {@link #validate(XmlObject)} method directly. Invalid objects will result in an {@link
+ * XmlBeansValidationFailureException}. Note that due to the nature of XMLBeans, this marshaller
+ * requires all passed objects to be of type {@link XmlObject}.
*
* @author Arjen Poutsma
* @see #setXmlOptions(org.apache.xmlbeans.XmlOptions)
* @see XmlOptionsFactoryBean
* @see #setValidating(boolean)
- * @since 1.0.0
+ * @since 3.0
*/
public class XmlBeansMarshaller extends AbstractMarshaller {
- private XmlOptions xmlOptions;
+ private XmlOptions xmlOptions;
- private boolean validating = false;
+ private boolean validating = false;
- /** Returns the XmlOptions. */
- public XmlOptions getXmlOptions() {
- return xmlOptions;
- }
+ /** Returns the XmlOptions. */
+ public XmlOptions getXmlOptions() {
+ return xmlOptions;
+ }
- /**
- * Sets the XmlOptions.
- *
- * @see XmlOptionsFactoryBean
- */
- public void setXmlOptions(XmlOptions xmlOptions) {
- this.xmlOptions = xmlOptions;
- }
+ /**
+ * Sets the XmlOptions.
+ *
+ * @see XmlOptionsFactoryBean
+ */
+ public void setXmlOptions(XmlOptions xmlOptions) {
+ this.xmlOptions = xmlOptions;
+ }
- /** Returns whether this marshaller should validate in- and outgoing documents. */
- public boolean isValidating() {
- return validating;
- }
+ /** Returns whether this marshaller should validate in- and outgoing documents. */
+ public boolean isValidating() {
+ return validating;
+ }
- /** Sets whether this marshaller should validate in- and outgoing documents. Default is false. */
- public void setValidating(boolean validating) {
- this.validating = validating;
- }
+ /** Sets whether this marshaller should validate in- and outgoing documents. Default is false. */
+ public void setValidating(boolean validating) {
+ this.validating = validating;
+ }
- /** Returns true if the given class is an implementation of {@link XmlObject}. */
- public boolean supports(Class clazz) {
- return XmlObject.class.isAssignableFrom(clazz);
- }
+ /** Returns true if the given class is an implementation of {@link XmlObject}. */
+ public boolean supports(Class clazz) {
+ return XmlObject.class.isAssignableFrom(clazz);
+ }
- @Override
+ @Override
protected final void marshalDomNode(Object graph, Node node) throws XmlMappingException {
- Document document = node.getNodeType() == Node.DOCUMENT_NODE ? (Document) node : node.getOwnerDocument();
- Node xmlBeansNode = ((XmlObject) graph).newDomNode(getXmlOptions());
- NodeList xmlBeansChildNodes = xmlBeansNode.getChildNodes();
- for (int i = 0; i < xmlBeansChildNodes.getLength(); i++) {
- Node xmlBeansChildNode = xmlBeansChildNodes.item(i);
- Node importedNode = document.importNode(xmlBeansChildNode, true);
- node.appendChild(importedNode);
- }
- }
+ Document document = node.getNodeType() == Node.DOCUMENT_NODE ? (Document) node : node.getOwnerDocument();
+ Node xmlBeansNode = ((XmlObject) graph).newDomNode(getXmlOptions());
+ NodeList xmlBeansChildNodes = xmlBeansNode.getChildNodes();
+ for (int i = 0; i < xmlBeansChildNodes.getLength(); i++) {
+ Node xmlBeansChildNode = xmlBeansChildNodes.item(i);
+ Node importedNode = document.importNode(xmlBeansChildNode, true);
+ node.appendChild(importedNode);
+ }
+ }
- @Override
+ @Override
protected final void marshalOutputStream(Object graph, OutputStream outputStream)
- throws XmlMappingException, IOException {
- ((XmlObject) graph).save(outputStream, getXmlOptions());
- }
+ throws XmlMappingException, IOException {
+ ((XmlObject) graph).save(outputStream, getXmlOptions());
+ }
- @Override
+ @Override
protected final void marshalSaxHandlers(Object graph, ContentHandler contentHandler, LexicalHandler lexicalHandler)
- throws XmlMappingException {
- try {
- ((XmlObject) graph).save(contentHandler, lexicalHandler, getXmlOptions());
- }
- catch (SAXException ex) {
- throw convertXmlBeansException(ex, true);
- }
- }
+ throws XmlMappingException {
+ try {
+ ((XmlObject) graph).save(contentHandler, lexicalHandler, getXmlOptions());
+ }
+ catch (SAXException ex) {
+ throw convertXmlBeansException(ex, true);
+ }
+ }
- @Override
+ @Override
protected final void marshalWriter(Object graph, Writer writer) throws XmlMappingException, IOException {
- ((XmlObject) graph).save(writer, getXmlOptions());
- }
+ ((XmlObject) graph).save(writer, getXmlOptions());
+ }
- @Override
+ @Override
protected final void marshalXmlEventWriter(Object graph, XMLEventWriter eventWriter) {
- ContentHandler contentHandler = new StaxEventContentHandler(eventWriter);
- marshalSaxHandlers(graph, contentHandler, null);
- }
+ ContentHandler contentHandler = StaxUtils.createContentHandler(eventWriter);
+ marshalSaxHandlers(graph, contentHandler, null);
+ }
- @Override
+ @Override
protected final void marshalXmlStreamWriter(Object graph, XMLStreamWriter streamWriter) throws XmlMappingException {
- ContentHandler contentHandler = new StaxStreamContentHandler(streamWriter);
- marshalSaxHandlers(graph, contentHandler, null);
- }
+ ContentHandler contentHandler = StaxUtils.createContentHandler(streamWriter);
+ marshalSaxHandlers(graph, contentHandler, null);
+ }
- @Override
+ @Override
protected final Object unmarshalDomNode(Node node) throws XmlMappingException {
- try {
- XmlObject object = XmlObject.Factory.parse(node, getXmlOptions());
- validate(object);
- return object;
- }
- catch (XmlException ex) {
- throw convertXmlBeansException(ex, false);
- }
- }
+ try {
+ XmlObject object = XmlObject.Factory.parse(node, getXmlOptions());
+ validate(object);
+ return object;
+ }
+ catch (XmlException ex) {
+ throw convertXmlBeansException(ex, false);
+ }
+ }
- @Override
+ @Override
protected final Object unmarshalInputStream(InputStream inputStream) throws XmlMappingException, IOException {
- try {
- XmlObject object = XmlObject.Factory.parse(inputStream, getXmlOptions());
- validate(object);
- return object;
- }
- catch (XmlException ex) {
- throw convertXmlBeansException(ex, false);
- }
- }
+ try {
+ XmlObject object = XmlObject.Factory.parse(inputStream, getXmlOptions());
+ validate(object);
+ return object;
+ }
+ catch (XmlException ex) {
+ throw convertXmlBeansException(ex, false);
+ }
+ }
- @Override
+ @Override
protected final Object unmarshalReader(Reader reader) throws XmlMappingException, IOException {
- try {
- XmlObject object = XmlObject.Factory.parse(reader, getXmlOptions());
- validate(object);
- return object;
- }
- catch (XmlException ex) {
- throw convertXmlBeansException(ex, false);
- }
- }
+ try {
+ XmlObject object = XmlObject.Factory.parse(reader, getXmlOptions());
+ validate(object);
+ return object;
+ }
+ catch (XmlException ex) {
+ throw convertXmlBeansException(ex, false);
+ }
+ }
- @Override
+ @Override
protected final Object unmarshalSaxReader(XMLReader xmlReader, InputSource inputSource)
- throws XmlMappingException, IOException {
- XmlSaxHandler saxHandler = XmlObject.Factory.newXmlSaxHandler(getXmlOptions());
- xmlReader.setContentHandler(saxHandler.getContentHandler());
- try {
- xmlReader.setProperty("http://xml.org/sax/properties/lexical-handler", saxHandler.getLexicalHandler());
- }
- catch (SAXNotRecognizedException e) {
- // ignore
- }
- catch (SAXNotSupportedException e) {
- // ignore
- }
- try {
- xmlReader.parse(inputSource);
- XmlObject object = saxHandler.getObject();
- validate(object);
- return object;
- }
- catch (SAXException ex) {
- throw convertXmlBeansException(ex, false);
- }
- catch (XmlException ex) {
- throw convertXmlBeansException(ex, false);
- }
- }
+ throws XmlMappingException, IOException {
+ XmlSaxHandler saxHandler = XmlObject.Factory.newXmlSaxHandler(getXmlOptions());
+ xmlReader.setContentHandler(saxHandler.getContentHandler());
+ try {
+ xmlReader.setProperty("http://xml.org/sax/properties/lexical-handler", saxHandler.getLexicalHandler());
+ }
+ catch (SAXNotRecognizedException e) {
+ // ignore
+ }
+ catch (SAXNotSupportedException e) {
+ // ignore
+ }
+ try {
+ xmlReader.parse(inputSource);
+ XmlObject object = saxHandler.getObject();
+ validate(object);
+ return object;
+ }
+ catch (SAXException ex) {
+ throw convertXmlBeansException(ex, false);
+ }
+ catch (XmlException ex) {
+ throw convertXmlBeansException(ex, false);
+ }
+ }
- @Override
+ @Override
protected final Object unmarshalXmlEventReader(XMLEventReader eventReader) throws XmlMappingException {
- XMLReader reader = new StaxEventXmlReader(eventReader);
- try {
- return unmarshalSaxReader(reader, new InputSource());
- }
- catch (IOException ex) {
- throw convertXmlBeansException(ex, false);
- }
- }
+ XMLReader reader = StaxUtils.createXMLReader(eventReader);
+ try {
+ return unmarshalSaxReader(reader, new InputSource());
+ }
+ catch (IOException ex) {
+ throw convertXmlBeansException(ex, false);
+ }
+ }
- @Override
+ @Override
protected final Object unmarshalXmlStreamReader(XMLStreamReader streamReader) throws XmlMappingException {
- try {
- XmlObject object = XmlObject.Factory.parse(streamReader, getXmlOptions());
- validate(object);
- return object;
- }
- catch (XmlException ex) {
- throw convertXmlBeansException(ex, false);
- }
- }
+ try {
+ XmlObject object = XmlObject.Factory.parse(streamReader, getXmlOptions());
+ validate(object);
+ return object;
+ }
+ catch (XmlException ex) {
+ throw convertXmlBeansException(ex, false);
+ }
+ }
- /**
- * Converts the given XMLBeans exception to an appropriate exception from the org.springframework.oxm
- * hierarchy.
- *
- * The default implementation delegates to XmlBeansUtils. Can be overridden in subclasses.
- *
- * A boolean flag is used to indicate whether this exception occurs during marshalling or unmarshalling, since
- * XMLBeans itself does not make this distinction in its exception hierarchy.
- *
- * @param ex XMLBeans Exception that occured
- * @param marshalling indicates whether the exception occurs during marshalling (true), or
- * unmarshalling (false)
- * @return the corresponding XmlMappingException
- * @see XmlBeansUtils#convertXmlBeansException(Exception,boolean)
- */
- public XmlMappingException convertXmlBeansException(Exception ex, boolean marshalling) {
- return XmlBeansUtils.convertXmlBeansException(ex, marshalling);
- }
+ /**
+ * Converts the given XMLBeans exception to an appropriate exception from the org.springframework.oxm
+ * hierarchy. The default implementation delegates to XmlBeansUtils. Can be overridden in subclasses.
+ * A boolean flag is used to indicate whether this exception occurs during marshalling or unmarshalling, since
+ * XMLBeans itself does not make this distinction in its exception hierarchy.
+ *
+ * @param ex XMLBeans Exception that occured
+ * @param marshalling indicates whether the exception occurs during marshalling (true), or unmarshalling
+ * (false)
+ * @return the corresponding XmlMappingException
+ * @see XmlBeansUtils#convertXmlBeansException(Exception,boolean)
+ */
+ public XmlMappingException convertXmlBeansException(Exception ex, boolean marshalling) {
+ return XmlBeansUtils.convertXmlBeansException(ex, marshalling);
+ }
- /**
- * Validates the given XmlObject.
- *
- * @param object the xml object to validate
- * @throws XmlBeansValidationFailureException
- * if the given object is not valid
- */
- public void validate(XmlObject object) throws XmlBeansValidationFailureException {
- if (isValidating() && object != null) {
- // create a temporary xmlOptions just for validation
- XmlOptions validateOptions = getXmlOptions() != null ? getXmlOptions() : new XmlOptions();
- List errorsList = new ArrayList();
- validateOptions.setErrorListener(errorsList);
- if (!object.validate(validateOptions)) {
- StringBuffer buffer = new StringBuffer("Could not validate XmlObject :");
- for (Iterator iterator = errorsList.iterator(); iterator.hasNext();) {
- XmlError xmlError = (XmlError) iterator.next();
- if (xmlError instanceof XmlValidationError) {
- buffer.append(xmlError.toString());
- }
- }
- XmlException ex = new XmlException(buffer.toString(), null, errorsList);
- throw new XmlBeansValidationFailureException(ex);
- }
- }
- }
+ /**
+ * Validates the given XmlObject.
+ *
+ * @param object the xml object to validate
+ * @throws XmlBeansValidationFailureException
+ * if the given object is not valid
+ */
+ public void validate(XmlObject object) throws XmlBeansValidationFailureException {
+ if (isValidating() && object != null) {
+ // create a temporary xmlOptions just for validation
+ XmlOptions validateOptions = getXmlOptions() != null ? getXmlOptions() : new XmlOptions();
+ List errorsList = new ArrayList();
+ validateOptions.setErrorListener(errorsList);
+ if (!object.validate(validateOptions)) {
+ StringBuilder builder = new StringBuilder("Could not validate XmlObject :");
+ for (Iterator iterator = errorsList.iterator(); iterator.hasNext();) {
+ XmlError xmlError = (XmlError) iterator.next();
+ if (xmlError instanceof XmlValidationError) {
+ builder.append(xmlError.toString());
+ }
+ }
+ XmlException ex = new XmlException(builder.toString(), null, errorsList);
+ throw new XmlBeansValidationFailureException(ex);
+ }
+ }
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlBeansMarshallingFailureException.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlBeansMarshallingFailureException.java
index 1f205d75bd..ecaa82a899 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlBeansMarshallingFailureException.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlBeansMarshallingFailureException.java
@@ -16,24 +16,25 @@
package org.springframework.oxm.xmlbeans;
import org.apache.xmlbeans.XmlException;
-import org.springframework.oxm.MarshallingFailureException;
import org.xml.sax.SAXException;
+import org.springframework.oxm.MarshallingFailureException;
+
/**
* XMLBeans-specific subclass of MarshallingFailureException.
*
* @author Arjen Poutsma
* @see XmlBeansUtils#convertXmlBeansException(Exception,boolean)
- * @since 1.0.0
+ * @since 3.0
*/
public class XmlBeansMarshallingFailureException extends MarshallingFailureException {
- public XmlBeansMarshallingFailureException(XmlException ex) {
- super("XMLBeans marshalling exception: " + ex.getMessage(), ex);
- }
+ public XmlBeansMarshallingFailureException(XmlException ex) {
+ super("XMLBeans marshalling exception: " + ex.getMessage(), ex);
+ }
- public XmlBeansMarshallingFailureException(SAXException ex) {
- super("XMLBeans marshalling exception: " + ex.getMessage(), ex);
- }
+ public XmlBeansMarshallingFailureException(SAXException ex) {
+ super("XMLBeans marshalling exception: " + ex.getMessage(), ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlBeansSystemException.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlBeansSystemException.java
index 7288e74592..cef8c5a880 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlBeansSystemException.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlBeansSystemException.java
@@ -22,12 +22,12 @@ import org.springframework.oxm.UncategorizedXmlMappingException;
* distinguished further.
*
* @author Arjen Poutsma
- * @since 1.0.0
+ * @since 3.0
*/
public class XmlBeansSystemException extends UncategorizedXmlMappingException {
- public XmlBeansSystemException(Exception e) {
- super(e.getMessage(), e);
- }
+ public XmlBeansSystemException(Exception e) {
+ super(e.getMessage(), e);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlBeansUnmarshallingFailureException.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlBeansUnmarshallingFailureException.java
index 6393462f61..edd9cb4fd1 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlBeansUnmarshallingFailureException.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlBeansUnmarshallingFailureException.java
@@ -16,24 +16,25 @@
package org.springframework.oxm.xmlbeans;
import org.apache.xmlbeans.XmlException;
-import org.springframework.oxm.UnmarshallingFailureException;
import org.xml.sax.SAXException;
+import org.springframework.oxm.UnmarshallingFailureException;
+
/**
* XMLBeans-specific subclass of UnmarshallingFailureException.
*
* @author Arjen Poutsma
* @see XmlBeansUtils#convertXmlBeansException(Exception,boolean)
- * @since 1.0.0
+ * @since 3.0
*/
public class XmlBeansUnmarshallingFailureException extends UnmarshallingFailureException {
- public XmlBeansUnmarshallingFailureException(XmlException ex) {
- super("XMLBeans unmarshalling exception: " + ex.getMessage(), ex);
- }
+ public XmlBeansUnmarshallingFailureException(XmlException ex) {
+ super("XMLBeans unmarshalling exception: " + ex.getMessage(), ex);
+ }
- public XmlBeansUnmarshallingFailureException(SAXException ex) {
- super("XMLBeans unmarshalling exception: " + ex.getMessage(), ex);
- }
+ public XmlBeansUnmarshallingFailureException(SAXException ex) {
+ super("XMLBeans unmarshalling exception: " + ex.getMessage(), ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlBeansUtils.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlBeansUtils.java
index 3f78442ad0..d84c813b96 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlBeansUtils.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlBeansUtils.java
@@ -17,53 +17,52 @@ package org.springframework.oxm.xmlbeans;
import org.apache.xmlbeans.XMLStreamValidationException;
import org.apache.xmlbeans.XmlException;
-import org.springframework.oxm.XmlMappingException;
import org.xml.sax.SAXException;
+import org.springframework.oxm.XmlMappingException;
+
/**
* Generic utility methods for working with XMLBeans. Mainly for internal use within the framework.
*
* @author Arjen Poutsma
- * @since 1.0.0
+ * @since 3.0
*/
public class XmlBeansUtils {
- /**
- * Converts the given XMLBeans exception to an appropriate exception from the org.springframework.oxm
- * hierarchy.
- *
- * A boolean flag is used to indicate whether this exception occurs during marshalling or unmarshalling, since
- * XMLBeans itself does not make this distinction in its exception hierarchy.
- *
- * @param ex XMLBeans Exception that occured
- * @param marshalling indicates whether the exception occurs during marshalling (true), or
- * unmarshalling (false)
- * @return the corresponding XmlMappingException
- */
- public static XmlMappingException convertXmlBeansException(Exception ex, boolean marshalling) {
- if (ex instanceof XMLStreamValidationException) {
- return new XmlBeansValidationFailureException((XMLStreamValidationException) ex);
- }
- else if (ex instanceof XmlException) {
- XmlException xmlException = (XmlException) ex;
- if (marshalling) {
- return new XmlBeansMarshallingFailureException(xmlException);
- }
- else {
- return new XmlBeansUnmarshallingFailureException(xmlException);
- }
- }
- else if (ex instanceof SAXException) {
- SAXException saxException = (SAXException) ex;
- if (marshalling) {
- return new XmlBeansMarshallingFailureException(saxException);
- }
- else {
- return new XmlBeansUnmarshallingFailureException(saxException);
- }
- }
- // fallback
- return new XmlBeansSystemException(ex);
- }
+ /**
+ * Converts the given XMLBeans exception to an appropriate exception from the org.springframework.oxm
+ * hierarchy. A boolean flag is used to indicate whether this exception occurs during marshalling or
+ * unmarshalling, since XMLBeans itself does not make this distinction in its exception hierarchy.
+ *
+ * @param ex XMLBeans Exception that occured
+ * @param marshalling indicates whether the exception occurs during marshalling (true), or unmarshalling
+ * (false)
+ * @return the corresponding XmlMappingException
+ */
+ public static XmlMappingException convertXmlBeansException(Exception ex, boolean marshalling) {
+ if (ex instanceof XMLStreamValidationException) {
+ return new XmlBeansValidationFailureException((XMLStreamValidationException) ex);
+ }
+ else if (ex instanceof XmlException) {
+ XmlException xmlException = (XmlException) ex;
+ if (marshalling) {
+ return new XmlBeansMarshallingFailureException(xmlException);
+ }
+ else {
+ return new XmlBeansUnmarshallingFailureException(xmlException);
+ }
+ }
+ else if (ex instanceof SAXException) {
+ SAXException saxException = (SAXException) ex;
+ if (marshalling) {
+ return new XmlBeansMarshallingFailureException(saxException);
+ }
+ else {
+ return new XmlBeansUnmarshallingFailureException(saxException);
+ }
+ }
+ // fallback
+ return new XmlBeansSystemException(ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlBeansValidationFailureException.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlBeansValidationFailureException.java
index 346b7bc898..c589985075 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlBeansValidationFailureException.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlBeansValidationFailureException.java
@@ -17,6 +17,7 @@ package org.springframework.oxm.xmlbeans;
import org.apache.xmlbeans.XMLStreamValidationException;
import org.apache.xmlbeans.XmlException;
+
import org.springframework.oxm.ValidationFailureException;
/**
@@ -24,15 +25,15 @@ import org.springframework.oxm.ValidationFailureException;
*
* @author Arjen Poutsma
* @see org.springframework.oxm.xmlbeans.XmlBeansUtils#convertXmlBeansException
- * @since 1.0.0
+ * @since 3.0
*/
public class XmlBeansValidationFailureException extends ValidationFailureException {
- public XmlBeansValidationFailureException(XMLStreamValidationException ex) {
- super("XmlBeans validation exception: " + ex.getMessage(), ex);
- }
+ public XmlBeansValidationFailureException(XMLStreamValidationException ex) {
+ super("XmlBeans validation exception: " + ex.getMessage(), ex);
+ }
- public XmlBeansValidationFailureException(XmlException ex) {
- super("XmlBeans validation exception: " + ex.getMessage(), ex);
- }
+ public XmlBeansValidationFailureException(XmlException ex) {
+ super("XmlBeans validation exception: " + ex.getMessage(), ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlOptionsFactoryBean.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlOptionsFactoryBean.java
index 9322303146..001d751a62 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlOptionsFactoryBean.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/xmlbeans/XmlOptionsFactoryBean.java
@@ -20,60 +20,60 @@ import java.util.Iterator;
import java.util.Map;
import org.apache.xmlbeans.XmlOptions;
+
import org.springframework.beans.factory.FactoryBean;
import org.springframework.beans.factory.InitializingBean;
/**
- * Factory bean that configures an XMLBeans XmlOptions object and provides it as a bean reference.
- *
+ * Factory bean that configures an XMLBeans XmlOptions object and provides it as a bean reference.
* Typical usage will be to set XMLBeans options on this bean, and refer to it in the XmlBeansMarshaller.
*
* @author Arjen Poutsma
* @see XmlOptions
* @see #setOptions(java.util.Map)
* @see XmlBeansMarshaller#setXmlOptions(org.apache.xmlbeans.XmlOptions)
- * @since 1.0.0
+ * @since 3.0
*/
public class XmlOptionsFactoryBean implements FactoryBean, InitializingBean {
- private XmlOptions xmlOptions;
+ private XmlOptions xmlOptions;
- private Map options;
+ private Map options;
- /** Returns the singleton XmlOptions. */
- public Object getObject() throws Exception {
- return xmlOptions;
- }
+ /** Returns the singleton XmlOptions. */
+ public Object getObject() throws Exception {
+ return xmlOptions;
+ }
- /** Returns the class of XmlOptions. */
- public Class getObjectType() {
- return XmlOptions.class;
- }
+ /** Returns the class of XmlOptions. */
+ public Class getObjectType() {
+ return XmlOptions.class;
+ }
- /** Returns true. */
- public boolean isSingleton() {
- return true;
- }
+ /** Returns true. */
+ public boolean isSingleton() {
+ return true;
+ }
- /**
- * Sets options on the underlying XmlOptions object. The keys of the supplied map should be one of the
- * string constants defined in XmlOptions, the values vary per option.
- *
- * @see XmlOptions#put(Object,Object)
- * @see XmlOptions#SAVE_PRETTY_PRINT
- * @see XmlOptions#LOAD_STRIP_COMMENTS
- */
- public void setOptions(Map options) {
- this.options = options;
- }
+ /**
+ * Sets options on the underlying XmlOptions object. The keys of the supplied map should be one of the
+ * string constants defined in XmlOptions, the values vary per option.
+ *
+ * @see XmlOptions#put(Object,Object)
+ * @see XmlOptions#SAVE_PRETTY_PRINT
+ * @see XmlOptions#LOAD_STRIP_COMMENTS
+ */
+ public void setOptions(Map options) {
+ this.options = options;
+ }
- public void afterPropertiesSet() throws Exception {
- xmlOptions = new XmlOptions();
- if (options != null) {
- for (Iterator iterator = options.keySet().iterator(); iterator.hasNext();) {
- Object option = iterator.next();
- xmlOptions.put(option, options.get(option));
- }
- }
- }
+ public void afterPropertiesSet() throws Exception {
+ xmlOptions = new XmlOptions();
+ if (options != null) {
+ for (Iterator iterator = options.keySet().iterator(); iterator.hasNext();) {
+ Object option = iterator.next();
+ xmlOptions.put(option, options.get(option));
+ }
+ }
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/xstream/AnnotationXStreamMarshaller.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/xstream/AnnotationXStreamMarshaller.java
deleted file mode 100644
index 6fa2452bd5..0000000000
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/xstream/AnnotationXStreamMarshaller.java
+++ /dev/null
@@ -1,53 +0,0 @@
-/*
- * Copyright 2007 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.oxm.xstream;
-
-import com.thoughtworks.xstream.XStream;
-import com.thoughtworks.xstream.annotations.Annotations;
-import com.thoughtworks.xstream.annotations.XStreamAlias;
-import org.springframework.util.Assert;
-
-/**
- * Subclass of the {@link XStreamMarshaller} that supports JDK 1.5+ annotation metadata for aliases.
- *
- * @author Arjen Poutsma
- * @see XStreamAlias
- * @since 1.0.2
- */
-public class AnnotationXStreamMarshaller extends XStreamMarshaller {
-
- /**
- * Sets the classes, for which mappings will be read from class-level JDK 1.5+ annotation metadata.
- *
- * @see Annotations#configureAliases(XStream, Class[])
- */
- public void setAnnotatedClass(Class annotatedClass) {
- Assert.notNull(annotatedClass, "'annotatedClass' must not be null");
- Annotations.configureAliases(getXStream(), annotatedClass);
- }
-
- /**
- * Sets annotated classes, for which aliases will be read from class-level JDK 1.5+ annotation metadata.
- *
- * @see Annotations#configureAliases(XStream, Class[])
- */
- public void setAnnotatedClasses(Class[] annotatedClasses) {
- Assert.notEmpty(annotatedClasses, "'annotatedClasses' must not be empty");
- Annotations.configureAliases(getXStream(), annotatedClasses);
- }
-
-}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/xstream/XStreamMarshaller.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/xstream/XStreamMarshaller.java
index 4b95c015a1..c9b9d5eb2f 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/xstream/XStreamMarshaller.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/xstream/XStreamMarshaller.java
@@ -58,20 +58,17 @@ import org.xml.sax.ext.LexicalHandler;
import org.springframework.beans.propertyeditors.ClassEditor;
import org.springframework.oxm.AbstractMarshaller;
import org.springframework.oxm.XmlMappingException;
+import org.springframework.util.Assert;
import org.springframework.util.ObjectUtils;
import org.springframework.util.StringUtils;
-import org.springframework.xml.stream.StaxEventContentHandler;
-import org.springframework.xml.stream.XmlEventStreamReader;
+import org.springframework.util.xml.StaxUtils;
/**
* Implementation of the Marshaller interface for XStream. By default, XStream does not require any further
- * configuration, though class aliases can be used to have more control over the behavior of XStream.
- *
- * Due to XStream's API, it is required to set the encoding used for writing to outputstreams. It defaults to
- * UTF-8.
- *
- * Note that XStream is an XML serialization library, not a data binding library. Therefore, it has limited
- * namespace support. As such, it is rather unsuitable for usage within Web services.
+ * configuration, though class aliases can be used to have more control over the behavior of XStream. Due to
+ * XStream's API, it is required to set the encoding used for writing to outputstreams. It defaults to
+ * UTF-8. Note that XStream is an XML serialization library, not a data binding library.
+ * Therefore, it has limited namespace support. As such, it is rather unsuitable for usage within Web services.
*
* @author Peter Meijer
* @author Arjen Poutsma
@@ -79,395 +76,411 @@ import org.springframework.xml.stream.XmlEventStreamReader;
* @see #DEFAULT_ENCODING
* @see #setAliases(Map)
* @see #setConverters(ConverterMatcher[])
- * @since 1.0.0
+ * @since 3.0
*/
public class XStreamMarshaller extends AbstractMarshaller {
- /** The default encoding used for stream access. */
- public static final String DEFAULT_ENCODING = "UTF-8";
+ /** The default encoding used for stream access. */
+ public static final String DEFAULT_ENCODING = "UTF-8";
- private XStream xstream = new XStream();
+ private XStream xstream = new XStream();
- private String encoding;
+ private String encoding;
- private Class[] supportedClasses;
+ private Class[] supportedClasses;
- /** Specialized driver to be used with stream readers and writers */
- private HierarchicalStreamDriver streamDriver;
+ /** Specialized driver to be used with stream readers and writers */
+ private HierarchicalStreamDriver streamDriver;
- /**
- * Returns the encoding to be used for stream access. If this property is not set, the default encoding is used.
- *
- * @see #DEFAULT_ENCODING
- */
- public String getEncoding() {
- return encoding != null ? encoding : DEFAULT_ENCODING;
- }
+ /**
+ * Returns the encoding to be used for stream access. If this property is not set, the default encoding is used.
+ *
+ * @see #DEFAULT_ENCODING
+ */
+ public String getEncoding() {
+ return encoding != null ? encoding : DEFAULT_ENCODING;
+ }
- /**
- * Sets the encoding to be used for stream access. If this property is not set, the default encoding is used.
- *
- * @see #DEFAULT_ENCODING
- */
- public void setEncoding(String encoding) {
- this.encoding = encoding;
- }
+ /**
+ * Sets the encoding to be used for stream access. If this property is not set, the default encoding is used.
+ *
+ * @see #DEFAULT_ENCODING
+ */
+ public void setEncoding(String encoding) {
+ this.encoding = encoding;
+ }
- /** Returns the XStream instance used by this marshaller. */
- public XStream getXStream() {
- return xstream;
- }
+ /** Returns the XStream instance used by this marshaller. */
+ public XStream getXStream() {
+ return xstream;
+ }
- /**
- * Sets the XStream mode.
- *
- * @see XStream#XPATH_REFERENCES
- * @see XStream#ID_REFERENCES
- * @see XStream#NO_REFERENCES
- */
- public void setMode(int mode) {
- getXStream().setMode(mode);
- }
+ /**
+ * Sets the XStream mode.
+ *
+ * @see XStream#XPATH_REFERENCES
+ * @see XStream#ID_REFERENCES
+ * @see XStream#NO_REFERENCES
+ */
+ public void setMode(int mode) {
+ getXStream().setMode(mode);
+ }
- /**
- * Sets the classes supported by this marshaller. If this property is empty (the default), all classes are
- * supported.
- *
- * @see #supports(Class)
- */
- public void setSupportedClasses(Class[] supportedClasses) {
- this.supportedClasses = supportedClasses;
- }
+ /**
+ * Sets the classes supported by this marshaller. If this property is empty (the default), all classes are supported.
+ *
+ * @see #supports(Class)
+ */
+ public void setSupportedClasses(Class[] supportedClasses) {
+ this.supportedClasses = supportedClasses;
+ }
- /**
- * Sets the Converters or SingleValueConverters to be registered with the
- * XStream instance.
- *
- * @see Converter
- * @see SingleValueConverter
- */
- public void setConverters(ConverterMatcher[] converters) {
- for (int i = 0; i < converters.length; i++) {
- if (converters[i] instanceof Converter) {
- getXStream().registerConverter((Converter) converters[i], i);
- }
- else if (converters[i] instanceof SingleValueConverter) {
- getXStream().registerConverter((SingleValueConverter) converters[i], i);
- }
- else {
- throw new IllegalArgumentException("Invalid ConverterMatcher [" + converters[i] + "]");
- }
- }
- }
+ /**
+ * Sets the Converters or SingleValueConverters to be registered with the
+ * XStream instance.
+ *
+ * @see Converter
+ * @see SingleValueConverter
+ */
+ public void setConverters(ConverterMatcher[] converters) {
+ for (int i = 0; i < converters.length; i++) {
+ if (converters[i] instanceof Converter) {
+ getXStream().registerConverter((Converter) converters[i], i);
+ }
+ else if (converters[i] instanceof SingleValueConverter) {
+ getXStream().registerConverter((SingleValueConverter) converters[i], i);
+ }
+ else {
+ throw new IllegalArgumentException("Invalid ConverterMatcher [" + converters[i] + "]");
+ }
+ }
+ }
- /** Sets the XStream hierarchical stream driver to be used with stream readers and writers */
- public void setStreamDriver(HierarchicalStreamDriver streamDriver) {
- this.streamDriver = streamDriver;
- }
+ /** Sets the XStream hierarchical stream driver to be used with stream readers and writers */
+ public void setStreamDriver(HierarchicalStreamDriver streamDriver) {
+ this.streamDriver = streamDriver;
+ }
- /**
- * Set a alias/type map, consisting of string aliases mapped to Class instances (or Strings to be
- * converted to Class instances).
- *
- * @see org.springframework.beans.propertyeditors.ClassEditor
- */
- public void setAliases(Map aliases) {
- for (Iterator iterator = aliases.entrySet().iterator(); iterator.hasNext();) {
- Map.Entry entry = (Map.Entry) iterator.next();
- // Check whether we need to convert from String to Class.
- Class type;
- if (entry.getValue() instanceof Class) {
- type = (Class) entry.getValue();
- }
- else {
- ClassEditor editor = new ClassEditor();
- editor.setAsText(String.valueOf(entry.getValue()));
- type = (Class) editor.getValue();
- }
- addAlias((String) entry.getKey(), type);
- }
- }
+ /**
+ * Set a alias/type map, consisting of string aliases mapped to Class instances (or Strings to be
+ * converted to Class instances).
+ *
+ * @see org.springframework.beans.propertyeditors.ClassEditor
+ */
+ public void setAliases(Map aliases) {
+ for (Iterator iterator = aliases.entrySet().iterator(); iterator.hasNext();) {
+ Map.Entry entry = (Map.Entry) iterator.next();
+ // Check whether we need to convert from String to Class.
+ Class type;
+ if (entry.getValue() instanceof Class) {
+ type = (Class) entry.getValue();
+ }
+ else {
+ ClassEditor editor = new ClassEditor();
+ editor.setAsText(String.valueOf(entry.getValue()));
+ type = (Class) editor.getValue();
+ }
+ addAlias((String) entry.getKey(), type);
+ }
+ }
- /**
- * Adds an alias for the given type.
- *
- * @param name alias to be used for the type
- * @param type the type to be aliased
- */
- public void addAlias(String name, Class type) {
- getXStream().alias(name, type);
- }
+ /**
+ * Adds an alias for the given type.
+ *
+ * @param name alias to be used for the type
+ * @param type the type to be aliased
+ */
+ public void addAlias(String name, Class type) {
+ getXStream().alias(name, type);
+ }
- /**
- * Sets types to use XML attributes for.
- *
- * @see XStream#useAttributeFor(Class)
- */
- public void setUseAttributeForTypes(Class[] types) {
- for (int i = 0; i < types.length; i++) {
- getXStream().useAttributeFor(types[i]);
- }
- }
+ /**
+ * Sets types to use XML attributes for.
+ *
+ * @see XStream#useAttributeFor(Class)
+ */
+ public void setUseAttributeForTypes(Class[] types) {
+ for (Class type : types) {
+ getXStream().useAttributeFor(type);
+ }
+ }
- /**
- * Sets the types to use XML attributes for. The given map can contain either <String, Class>
- * pairs, in which case {@link XStream#useAttributeFor(String,Class)} is called, or <Class,
- * String> pairs, which results in {@link XStream#useAttributeFor(Class,String)}.
- */
- public void setUseAttributeFor(Map attributes) {
- for (Iterator iterator = attributes.entrySet().iterator(); iterator.hasNext();) {
- Map.Entry entry = (Map.Entry) iterator.next();
- if (entry.getKey() instanceof String && entry.getValue() instanceof Class) {
- getXStream().useAttributeFor((String) entry.getKey(), (Class) entry.getValue());
- }
- else if (entry.getKey() instanceof Class && entry.getValue() instanceof String) {
- getXStream().useAttributeFor((Class) entry.getKey(), (String) entry.getValue());
- }
- else {
- throw new IllegalArgumentException("Invalid attribute key and value pair. " +
- "'useAttributesFor' property takes either a map or a map");
- }
- }
- }
+ /**
+ * Sets the types to use XML attributes for. The given map can contain either <String, Class> pairs,
+ * in which case {@link XStream#useAttributeFor(String,Class)} is called, or <Class, String> pairs,
+ * which results in {@link XStream#useAttributeFor(Class,String)}.
+ */
+ public void setUseAttributeFor(Map attributes) {
+ for (Iterator iterator = attributes.entrySet().iterator(); iterator.hasNext();) {
+ Map.Entry entry = (Map.Entry) iterator.next();
+ if (entry.getKey() instanceof String && entry.getValue() instanceof Class) {
+ getXStream().useAttributeFor((String) entry.getKey(), (Class) entry.getValue());
+ }
+ else if (entry.getKey() instanceof Class && entry.getValue() instanceof String) {
+ getXStream().useAttributeFor((Class) entry.getKey(), (String) entry.getValue());
+ }
+ else {
+ throw new IllegalArgumentException("Invalid attribute key and value pair. " +
+ "'useAttributesFor' property takes either a map or a map");
+ }
+ }
+ }
- /**
- * Adds an implicit Collection for the given type.
- *
- * @see XStream#addImplicitCollection(Class, String)
- */
- public void addImplicitCollection(String name, Class type) {
- getXStream().addImplicitCollection(type, name);
- }
+ /**
+ * Adds an implicit Collection for the given type.
+ *
+ * @see XStream#addImplicitCollection(Class, String)
+ */
+ public void addImplicitCollection(String name, Class type) {
+ getXStream().addImplicitCollection(type, name);
+ }
- /**
- * Set a implicit colletion/type map, consisting of string implicit collection mapped to Class
- * instances (or Strings to be converted to Class instances).
- *
- * @see XStream#addImplicitCollection(Class, String)
- */
- public void setImplicitCollection(Map implicitCollection) {
- for (Iterator iterator = implicitCollection.entrySet().iterator(); iterator.hasNext();) {
- Map.Entry entry = (Map.Entry) iterator.next();
- // Check whether we need to convert from String to Class.
- Class type;
- if (entry.getValue() instanceof Class) {
- type = (Class) entry.getValue();
- }
- else {
- ClassEditor editor = new ClassEditor();
- editor.setAsText(String.valueOf(entry.getValue()));
- type = (Class) editor.getValue();
- }
- addImplicitCollection((String) entry.getKey(), type);
- }
- }
+ /**
+ * Set a implicit colletion/type map, consisting of string implicit collection mapped to Class instances
+ * (or Strings to be converted to Class instances).
+ *
+ * @see XStream#addImplicitCollection(Class, String)
+ */
+ public void setImplicitCollection(Map implicitCollection) {
+ for (Iterator iterator = implicitCollection.entrySet().iterator(); iterator.hasNext();) {
+ Map.Entry entry = (Map.Entry) iterator.next();
+ // Check whether we need to convert from String to Class.
+ Class type;
+ if (entry.getValue() instanceof Class) {
+ type = (Class) entry.getValue();
+ }
+ else {
+ ClassEditor editor = new ClassEditor();
+ editor.setAsText(String.valueOf(entry.getValue()));
+ type = (Class) editor.getValue();
+ }
+ addImplicitCollection((String) entry.getKey(), type);
+ }
+ }
- /**
- * Adds an omitted field for the given type.
- *
- * @param type the type to be containing the field
- * @param fieldName field to omitt
- * @see XStream#omitField(Class, String)
- */
- public void addOmittedField(Class type, String fieldName) {
- getXStream().omitField(type, fieldName);
- }
+ /**
+ * Adds an omitted field for the given type.
+ *
+ * @param type the type to be containing the field
+ * @param fieldName field to omitt
+ * @see XStream#omitField(Class, String)
+ */
+ public void addOmittedField(Class type, String fieldName) {
+ getXStream().omitField(type, fieldName);
+ }
- /**
- * Sets a ommited field map, consisting of Class instances (or Strings to be converted to
- * Class instances) mapped to comma separated field names.
- *
- * @see XStream#omitField(Class, String)
- */
- public void setOmittedFields(Map omittedFields) {
- for (Iterator iterator = omittedFields.entrySet().iterator(); iterator.hasNext();) {
- Map.Entry entry = (Map.Entry) iterator.next();
- // Check whether we need to convert from String to Class.
- Class type;
- if (entry.getKey() instanceof Class) {
- type = (Class) entry.getKey();
- }
- else {
- ClassEditor editor = new ClassEditor();
- editor.setAsText(String.valueOf(entry.getKey()));
- type = (Class) editor.getValue();
- }
- // add each omitted field for the current type
- String fieldsString = (String) entry.getValue();
- String[] fields = StringUtils.commaDelimitedListToStringArray(fieldsString);
- for (int i = 0; i < fields.length; i++) {
- addOmittedField(type, fields[i]);
- }
- }
- }
+ /**
+ * Sets a ommited field map, consisting of Class instances (or Strings to be converted to
+ * Class instances) mapped to comma separated field names.
+ *
+ * @see XStream#omitField(Class, String)
+ */
+ public void setOmittedFields(Map omittedFields) {
+ for (Iterator iterator = omittedFields.entrySet().iterator(); iterator.hasNext();) {
+ Map.Entry entry = (Map.Entry) iterator.next();
+ // Check whether we need to convert from String to Class.
+ Class type;
+ if (entry.getKey() instanceof Class) {
+ type = (Class) entry.getKey();
+ }
+ else {
+ ClassEditor editor = new ClassEditor();
+ editor.setAsText(String.valueOf(entry.getKey()));
+ type = (Class) editor.getValue();
+ }
+ // add each omitted field for the current type
+ String fieldsString = (String) entry.getValue();
+ String[] fields = StringUtils.commaDelimitedListToStringArray(fieldsString);
+ for (String field : fields) {
+ addOmittedField(type, field);
+ }
+ }
+ }
- public boolean supports(Class clazz) {
- if (ObjectUtils.isEmpty(supportedClasses)) {
- return true;
- }
- else {
- for (int i = 0; i < supportedClasses.length; i++) {
- if (supportedClasses[i].isAssignableFrom(clazz)) {
- return true;
- }
- }
- return false;
- }
- }
+ /**
+ * Sets the classes, for which mappings will be read from class-level JDK 1.5+ annotation metadata.
+ *
+ * @see com.thoughtworks.xstream.annotations.Annotations#configureAliases(com.thoughtworks.xstream.XStream, Class[])
+ */
+ public void setAnnotatedClass(Class annotatedClass) {
+ Assert.notNull(annotatedClass, "'annotatedClass' must not be null");
+ getXStream().processAnnotations(annotatedClass);
+ }
- /**
- * Convert the given XStream exception to an appropriate exception from the org.springframework.oxm
- * hierarchy.
- *
- * The default implementation delegates to XStreamUtils. Can be overridden in subclasses.
- *
- * @param ex exception that occured
- * @param marshalling indicates whether the exception occurs during marshalling (true), or
- * unmarshalling (false)
- * @return the corresponding XmlMappingException instance
- * @see XStreamUtils#convertXStreamException(Exception,boolean)
- */
- public XmlMappingException convertXStreamException(Exception ex, boolean marshalling) {
- return XStreamUtils.convertXStreamException(ex, marshalling);
- }
+ /**
+ * Sets annotated classes, for which aliases will be read from class-level JDK 1.5+ annotation metadata.
+ *
+ * @see com.thoughtworks.xstream.annotations.Annotations#configureAliases(com.thoughtworks.xstream.XStream, Class[])
+ */
+ public void setAnnotatedClasses(Class[] annotatedClasses) {
+ Assert.notEmpty(annotatedClasses, "'annotatedClasses' must not be empty");
+ getXStream().processAnnotations(annotatedClasses);
+ }
- //
- // Marshalling
- //
+ public boolean supports(Class clazz) {
+ if (ObjectUtils.isEmpty(supportedClasses)) {
+ return true;
+ }
+ else {
+ for (Class supportedClass : supportedClasses) {
+ if (supportedClass.isAssignableFrom(clazz)) {
+ return true;
+ }
+ }
+ return false;
+ }
+ }
- /**
- * Marshals the given graph to the given XStream HierarchicalStreamWriter. Converts exceptions using
- * convertXStreamException.
- */
- private void marshal(Object graph, HierarchicalStreamWriter streamWriter) {
- try {
- getXStream().marshal(graph, streamWriter);
- }
- catch (Exception ex) {
- throw convertXStreamException(ex, true);
- }
- }
+ /**
+ * Convert the given XStream exception to an appropriate exception from the org.springframework.oxm
+ * hierarchy. The default implementation delegates to XStreamUtils. Can be overridden in subclasses.
+ *
+ * @param ex exception that occured
+ * @param marshalling indicates whether the exception occurs during marshalling (true), or unmarshalling
+ * (false)
+ * @return the corresponding XmlMappingException instance
+ * @see XStreamUtils#convertXStreamException(Exception,boolean)
+ */
+ public XmlMappingException convertXStreamException(Exception ex, boolean marshalling) {
+ return XStreamUtils.convertXStreamException(ex, marshalling);
+ }
- @Override
+ //
+ // Marshalling
+ //
+
+ /**
+ * Marshals the given graph to the given XStream HierarchicalStreamWriter. Converts exceptions using
+ * convertXStreamException.
+ */
+ private void marshal(Object graph, HierarchicalStreamWriter streamWriter) {
+ try {
+ getXStream().marshal(graph, streamWriter);
+ }
+ catch (Exception ex) {
+ throw convertXStreamException(ex, true);
+ }
+ }
+
+ @Override
protected void marshalDomNode(Object graph, Node node) throws XmlMappingException {
- HierarchicalStreamWriter streamWriter;
- if (node instanceof Document) {
- streamWriter = new DomWriter((Document) node);
- }
- else if (node instanceof Element) {
- streamWriter = new DomWriter((Element) node, node.getOwnerDocument(), new XmlFriendlyReplacer());
- }
- else {
- throw new IllegalArgumentException("DOMResult contains neither Document nor Element");
- }
- marshal(graph, streamWriter);
- }
+ HierarchicalStreamWriter streamWriter;
+ if (node instanceof Document) {
+ streamWriter = new DomWriter((Document) node);
+ }
+ else if (node instanceof Element) {
+ streamWriter = new DomWriter((Element) node, node.getOwnerDocument(), new XmlFriendlyReplacer());
+ }
+ else {
+ throw new IllegalArgumentException("DOMResult contains neither Document nor Element");
+ }
+ marshal(graph, streamWriter);
+ }
- @Override
+ @Override
protected void marshalXmlEventWriter(Object graph, XMLEventWriter eventWriter) throws XmlMappingException {
- ContentHandler contentHandler = new StaxEventContentHandler(eventWriter);
- marshalSaxHandlers(graph, contentHandler, null);
- }
+ ContentHandler contentHandler = StaxUtils.createContentHandler(eventWriter);
+ marshalSaxHandlers(graph, contentHandler, null);
+ }
- @Override
+ @Override
protected void marshalXmlStreamWriter(Object graph, XMLStreamWriter streamWriter) throws XmlMappingException {
- try {
- marshal(graph, new StaxWriter(new QNameMap(), streamWriter));
- }
- catch (XMLStreamException ex) {
- throw convertXStreamException(ex, true);
- }
- }
+ try {
+ marshal(graph, new StaxWriter(new QNameMap(), streamWriter));
+ }
+ catch (XMLStreamException ex) {
+ throw convertXStreamException(ex, true);
+ }
+ }
- @Override
+ @Override
protected void marshalOutputStream(Object graph, OutputStream outputStream)
- throws XmlMappingException, IOException {
- marshalWriter(graph, new OutputStreamWriter(outputStream, getEncoding()));
- }
+ throws XmlMappingException, IOException {
+ marshalWriter(graph, new OutputStreamWriter(outputStream, getEncoding()));
+ }
- @Override
+ @Override
protected void marshalSaxHandlers(Object graph, ContentHandler contentHandler, LexicalHandler lexicalHandler)
- throws XmlMappingException {
- SaxWriter saxWriter = new SaxWriter();
- saxWriter.setContentHandler(contentHandler);
- marshal(graph, saxWriter);
- }
+ throws XmlMappingException {
+ SaxWriter saxWriter = new SaxWriter();
+ saxWriter.setContentHandler(contentHandler);
+ marshal(graph, saxWriter);
+ }
- @Override
+ @Override
protected void marshalWriter(Object graph, Writer writer) throws XmlMappingException, IOException {
- if (streamDriver != null) {
- marshal(graph, streamDriver.createWriter(writer));
- }
- else {
- marshal(graph, new CompactWriter(writer));
- }
- }
+ if (streamDriver != null) {
+ marshal(graph, streamDriver.createWriter(writer));
+ }
+ else {
+ marshal(graph, new CompactWriter(writer));
+ }
+ }
- //
- // Unmarshalling
- //
+ //
+ // Unmarshalling
+ //
- private Object unmarshal(HierarchicalStreamReader streamReader) {
- try {
- return getXStream().unmarshal(streamReader);
- }
- catch (Exception ex) {
- throw convertXStreamException(ex, false);
- }
- }
+ private Object unmarshal(HierarchicalStreamReader streamReader) {
+ try {
+ return getXStream().unmarshal(streamReader);
+ }
+ catch (Exception ex) {
+ throw convertXStreamException(ex, false);
+ }
+ }
- @Override
+ @Override
protected Object unmarshalDomNode(Node node) throws XmlMappingException {
- HierarchicalStreamReader streamReader;
- if (node instanceof Document) {
- streamReader = new DomReader((Document) node);
- }
- else if (node instanceof Element) {
- streamReader = new DomReader((Element) node);
- }
- else {
- throw new IllegalArgumentException("DOMSource contains neither Document nor Element");
- }
- return unmarshal(streamReader);
- }
+ HierarchicalStreamReader streamReader;
+ if (node instanceof Document) {
+ streamReader = new DomReader((Document) node);
+ }
+ else if (node instanceof Element) {
+ streamReader = new DomReader((Element) node);
+ }
+ else {
+ throw new IllegalArgumentException("DOMSource contains neither Document nor Element");
+ }
+ return unmarshal(streamReader);
+ }
- @Override
+ @Override
protected Object unmarshalXmlEventReader(XMLEventReader eventReader) throws XmlMappingException {
- try {
- XMLStreamReader streamReader = new XmlEventStreamReader(eventReader);
- return unmarshalXmlStreamReader(streamReader);
- }
- catch (XMLStreamException ex) {
- throw convertXStreamException(ex, false);
- }
- }
+ try {
+ XMLStreamReader streamReader = StaxUtils.createEventStreamReader(eventReader);
+ return unmarshalXmlStreamReader(streamReader);
+ }
+ catch (XMLStreamException ex) {
+ throw convertXStreamException(ex, false);
+ }
+ }
- @Override
+ @Override
protected Object unmarshalXmlStreamReader(XMLStreamReader streamReader) throws XmlMappingException {
- return unmarshal(new StaxReader(new QNameMap(), streamReader));
- }
+ return unmarshal(new StaxReader(new QNameMap(), streamReader));
+ }
- @Override
+ @Override
protected Object unmarshalInputStream(InputStream inputStream) throws XmlMappingException, IOException {
- return unmarshalReader(new InputStreamReader(inputStream, getEncoding()));
- }
+ return unmarshalReader(new InputStreamReader(inputStream, getEncoding()));
+ }
- @Override
+ @Override
protected Object unmarshalReader(Reader reader) throws XmlMappingException, IOException {
- if (streamDriver != null) {
- return unmarshal(streamDriver.createReader(reader));
- }
- else {
- return unmarshal(new XppReader(reader));
- }
- }
+ if (streamDriver != null) {
+ return unmarshal(streamDriver.createReader(reader));
+ }
+ else {
+ return unmarshal(new XppReader(reader));
+ }
+ }
- @Override
+ @Override
protected Object unmarshalSaxReader(XMLReader xmlReader, InputSource inputSource)
- throws XmlMappingException, IOException {
- throw new UnsupportedOperationException(
- "XStreamMarshaller does not support unmarshalling using SAX XMLReaders");
- }
-
+ throws XmlMappingException, IOException {
+ throw new UnsupportedOperationException(
+ "XStreamMarshaller does not support unmarshalling using SAX XMLReaders");
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/xstream/XStreamMarshallingFailureException.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/xstream/XStreamMarshallingFailureException.java
index 931d006875..2dc30f234c 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/xstream/XStreamMarshallingFailureException.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/xstream/XStreamMarshallingFailureException.java
@@ -19,31 +19,32 @@ package org.springframework.oxm.xstream;
import com.thoughtworks.xstream.alias.CannotResolveClassException;
import com.thoughtworks.xstream.converters.ConversionException;
import com.thoughtworks.xstream.io.StreamException;
+
import org.springframework.oxm.MarshallingFailureException;
/**
* XStream-specific subclass of MarshallingFailureException.
*
* @author Arjen Poutsma
- * @since 1.0.0
+ * @since 3.0
*/
public class XStreamMarshallingFailureException extends MarshallingFailureException {
- public XStreamMarshallingFailureException(String msg) {
- super(msg);
- }
+ public XStreamMarshallingFailureException(String msg) {
+ super(msg);
+ }
- public XStreamMarshallingFailureException(StreamException ex) {
- super("XStream marshalling exception: " + ex.getMessage(), ex);
+ public XStreamMarshallingFailureException(StreamException ex) {
+ super("XStream marshalling exception: " + ex.getMessage(), ex);
- }
+ }
- public XStreamMarshallingFailureException(CannotResolveClassException ex) {
- super("XStream resolving exception: " + ex.getMessage(), ex);
- }
+ public XStreamMarshallingFailureException(CannotResolveClassException ex) {
+ super("XStream resolving exception: " + ex.getMessage(), ex);
+ }
- public XStreamMarshallingFailureException(ConversionException ex) {
- super("XStream conversion exception: " + ex.getMessage(), ex);
- }
+ public XStreamMarshallingFailureException(ConversionException ex) {
+ super("XStream conversion exception: " + ex.getMessage(), ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/xstream/XStreamSystemException.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/xstream/XStreamSystemException.java
index a4e48a0bb9..31dd3565bd 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/xstream/XStreamSystemException.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/xstream/XStreamSystemException.java
@@ -23,12 +23,12 @@ import org.springframework.oxm.UncategorizedXmlMappingException;
* distinguished further.
*
* @author Arjen Poutsma
- * @since 1.0.0
+ * @since 3.0
*/
public class XStreamSystemException extends UncategorizedXmlMappingException {
- public XStreamSystemException(String msg, Throwable ex) {
- super(msg, ex);
- }
+ public XStreamSystemException(String msg, Throwable ex) {
+ super(msg, ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/xstream/XStreamUnmarshallingFailureException.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/xstream/XStreamUnmarshallingFailureException.java
index e293c9029d..7b7671fde5 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/xstream/XStreamUnmarshallingFailureException.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/xstream/XStreamUnmarshallingFailureException.java
@@ -21,34 +21,35 @@ import javax.xml.stream.XMLStreamException;
import com.thoughtworks.xstream.alias.CannotResolveClassException;
import com.thoughtworks.xstream.converters.ConversionException;
import com.thoughtworks.xstream.io.StreamException;
+
import org.springframework.oxm.UnmarshallingFailureException;
/**
* XStream-specific subclass of UnmarshallingFailureException.
*
* @author Arjen Poutsma
- * @since 1.0.0
+ * @since 3.0
*/
public class XStreamUnmarshallingFailureException extends UnmarshallingFailureException {
- public XStreamUnmarshallingFailureException(StreamException ex) {
- super("XStream unmarshalling exception: " + ex.getMessage(), ex);
- }
+ public XStreamUnmarshallingFailureException(StreamException ex) {
+ super("XStream unmarshalling exception: " + ex.getMessage(), ex);
+ }
- public XStreamUnmarshallingFailureException(CannotResolveClassException ex) {
- super("XStream resolving exception: " + ex.getMessage(), ex);
- }
+ public XStreamUnmarshallingFailureException(CannotResolveClassException ex) {
+ super("XStream resolving exception: " + ex.getMessage(), ex);
+ }
- public XStreamUnmarshallingFailureException(ConversionException ex) {
- super("XStream conversion exception: " + ex.getMessage(), ex);
- }
+ public XStreamUnmarshallingFailureException(ConversionException ex) {
+ super("XStream conversion exception: " + ex.getMessage(), ex);
+ }
- public XStreamUnmarshallingFailureException(String msg) {
- super(msg);
- }
+ public XStreamUnmarshallingFailureException(String msg) {
+ super(msg);
+ }
- public XStreamUnmarshallingFailureException(String msg, XMLStreamException ex) {
- super(msg, ex);
- }
+ public XStreamUnmarshallingFailureException(String msg, XMLStreamException ex) {
+ super(msg, ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/java/org/springframework/oxm/xstream/XStreamUtils.java b/org.springframework.oxm/src/main/java/org/springframework/oxm/xstream/XStreamUtils.java
index 929a66263a..5c4ab5c66c 100644
--- a/org.springframework.oxm/src/main/java/org/springframework/oxm/xstream/XStreamUtils.java
+++ b/org.springframework.oxm/src/main/java/org/springframework/oxm/xstream/XStreamUtils.java
@@ -19,55 +19,54 @@ package org.springframework.oxm.xstream;
import com.thoughtworks.xstream.alias.CannotResolveClassException;
import com.thoughtworks.xstream.converters.ConversionException;
import com.thoughtworks.xstream.io.StreamException;
+
import org.springframework.oxm.XmlMappingException;
/**
* Generic utility methods for working with XStream. Mainly for internal use within the framework.
*
* @author Arjen Poutsma
- * @since 1.0.0
+ * @since 3.0
*/
public abstract class XStreamUtils {
- /**
- * Converts the given XStream exception to an appropriate exception from the org.springframework.oxm
- * hierarchy.
- *
- * A boolean flag is used to indicate whether this exception occurs during marshalling or unmarshalling, since
- * XStream itself does not make this distinction in its exception hierarchy.
- *
- * @param ex XStream exception that occured
- * @param marshalling indicates whether the exception occurs during marshalling (true), or
- * unmarshalling (false)
- * @return the corresponding XmlMappingException
- */
- public static XmlMappingException convertXStreamException(Exception ex, boolean marshalling) {
- if (ex instanceof StreamException) {
- if (marshalling) {
- return new XStreamMarshallingFailureException((StreamException) ex);
- }
- else {
- return new XStreamUnmarshallingFailureException((StreamException) ex);
- }
- }
- else if (ex instanceof CannotResolveClassException) {
- if (marshalling) {
- return new XStreamMarshallingFailureException((CannotResolveClassException) ex);
- }
- else {
- return new XStreamUnmarshallingFailureException((CannotResolveClassException) ex);
- }
- }
- else if (ex instanceof ConversionException) {
- if (marshalling) {
- return new XStreamMarshallingFailureException((ConversionException) ex);
- }
- else {
- return new XStreamUnmarshallingFailureException((ConversionException) ex);
- }
- }
- // fallback
- return new XStreamSystemException("Unknown XStream exception: " + ex.getMessage(), ex);
- }
+ /**
+ * Converts the given XStream exception to an appropriate exception from the org.springframework.oxm
+ * hierarchy. A boolean flag is used to indicate whether this exception occurs during marshalling or
+ * unmarshalling, since XStream itself does not make this distinction in its exception hierarchy.
+ *
+ * @param ex XStream exception that occured
+ * @param marshalling indicates whether the exception occurs during marshalling (true), or unmarshalling
+ * (false)
+ * @return the corresponding XmlMappingException
+ */
+ public static XmlMappingException convertXStreamException(Exception ex, boolean marshalling) {
+ if (ex instanceof StreamException) {
+ if (marshalling) {
+ return new XStreamMarshallingFailureException((StreamException) ex);
+ }
+ else {
+ return new XStreamUnmarshallingFailureException((StreamException) ex);
+ }
+ }
+ else if (ex instanceof CannotResolveClassException) {
+ if (marshalling) {
+ return new XStreamMarshallingFailureException((CannotResolveClassException) ex);
+ }
+ else {
+ return new XStreamUnmarshallingFailureException((CannotResolveClassException) ex);
+ }
+ }
+ else if (ex instanceof ConversionException) {
+ if (marshalling) {
+ return new XStreamMarshallingFailureException((ConversionException) ex);
+ }
+ else {
+ return new XStreamUnmarshallingFailureException((ConversionException) ex);
+ }
+ }
+ // fallback
+ return new XStreamSystemException("Unknown XStream exception: " + ex.getMessage(), ex);
+ }
}
diff --git a/org.springframework.oxm/src/main/resources/META-INF/spring.schemas b/org.springframework.oxm/src/main/resources/META-INF/spring.schemas
index 43b7186b4f..b3812d69f1 100644
--- a/org.springframework.oxm/src/main/resources/META-INF/spring.schemas
+++ b/org.springframework.oxm/src/main/resources/META-INF/spring.schemas
@@ -1 +1 @@
-http\://www.springframework.org/schema/oxm/spring-oxm-1.5.xsd=/org/springframework/oxm/config/spring-oxm-1.5.xsd
\ No newline at end of file
+http\://www.springframework.org/schema/oxm/spring-oxm-3.0.xsd=/org/springframework/oxm/config/spring-oxm-3.0.xsd
\ No newline at end of file
diff --git a/org.springframework.oxm/src/main/resources/org/springframework/oxm/config/spring-oxm-1.5.xsd b/org.springframework.oxm/src/main/resources/org/springframework/oxm/config/spring-oxm-3.0.xsd
similarity index 75%
rename from org.springframework.oxm/src/main/resources/org/springframework/oxm/config/spring-oxm-1.5.xsd
rename to org.springframework.oxm/src/main/resources/org/springframework/oxm/config/spring-oxm-3.0.xsd
index a81a43a5fd..bf64758b58 100644
--- a/org.springframework.oxm/src/main/resources/org/springframework/oxm/config/spring-oxm-1.5.xsd
+++ b/org.springframework.oxm/src/main/resources/org/springframework/oxm/config/spring-oxm-3.0.xsd
@@ -1,9 +1,9 @@
+ xmlns:beans="http://www.springframework.org/schema/beans"
+ xmlns:tool="http://www.springframework.org/schema/tool"
+ targetNamespace="http://www.springframework.org/schema/oxm" elementFormDefault="qualified"
+ attributeFormDefault="unqualified">
-
-
-
- Defines a JAXB1 Marshaller.
-
-
-
-
-
-
-
-
-
-
- The JAXB Context path
-
-
-
-
- Whether incoming XML should be validated.
-
-
-
-
-
-
-
diff --git a/org.springframework.oxm/src/test/java/org/springframework/oxm/AbstractMarshallerTestCase.java b/org.springframework.oxm/src/test/java/org/springframework/oxm/AbstractMarshallerTestCase.java
index 033ddc83a4..15c8319148 100644
--- a/org.springframework.oxm/src/test/java/org/springframework/oxm/AbstractMarshallerTestCase.java
+++ b/org.springframework.oxm/src/test/java/org/springframework/oxm/AbstractMarshallerTestCase.java
@@ -22,109 +22,120 @@ import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.stream.XMLEventWriter;
import javax.xml.stream.XMLOutputFactory;
import javax.xml.stream.XMLStreamWriter;
+import javax.xml.transform.Result;
import javax.xml.transform.dom.DOMResult;
import javax.xml.transform.stax.StAXResult;
import javax.xml.transform.stream.StreamResult;
-import org.custommonkey.xmlunit.XMLTestCase;
+import static org.custommonkey.xmlunit.XMLAssert.assertXMLEqual;
import org.custommonkey.xmlunit.XMLUnit;
+import org.junit.Before;
+import org.junit.Test;
import org.w3c.dom.Attr;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Text;
-import org.springframework.xml.transform.StaxResult;
+import org.springframework.util.xml.StaxUtils;
-public abstract class AbstractMarshallerTestCase extends XMLTestCase {
+public abstract class AbstractMarshallerTestCase {
- protected Marshaller marshaller;
+ protected Marshaller marshaller;
- protected Object flights;
+ protected Object flights;
- protected static final String EXPECTED_STRING =
- "" +
- "42 ";
+ protected static final String EXPECTED_STRING =
+ "" +
+ "42 ";
- protected final void setUp() throws Exception {
- marshaller = createMarshaller();
- flights = createFlights();
- XMLUnit.setIgnoreWhitespace(true);
- }
+ @Before
+ public final void setUp() throws Exception {
+ marshaller = createMarshaller();
+ flights = createFlights();
+ XMLUnit.setIgnoreWhitespace(true);
+ }
- protected abstract Marshaller createMarshaller() throws Exception;
+ protected abstract Marshaller createMarshaller() throws Exception;
- protected abstract Object createFlights();
+ protected abstract Object createFlights();
- public void testMarshalDOMResult() throws Exception {
- DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
- documentBuilderFactory.setNamespaceAware(true);
- DocumentBuilder builder = documentBuilderFactory.newDocumentBuilder();
- Document result = builder.newDocument();
- DOMResult domResult = new DOMResult(result);
- marshaller.marshal(flights, domResult);
- Document expected = builder.newDocument();
- Element flightsElement = expected.createElementNS("http://samples.springframework.org/flight", "tns:flights");
- Attr namespace = expected.createAttributeNS("http://www.w3.org/2000/xmlns/", "xmlns:tns");
- namespace.setNodeValue("http://samples.springframework.org/flight");
- flightsElement.setAttributeNode(namespace);
- expected.appendChild(flightsElement);
- Element flightElement = expected.createElementNS("http://samples.springframework.org/flight", "tns:flight");
- flightsElement.appendChild(flightElement);
- Element numberElement = expected.createElementNS("http://samples.springframework.org/flight", "tns:number");
- flightElement.appendChild(numberElement);
- Text text = expected.createTextNode("42");
- numberElement.appendChild(text);
- assertXMLEqual("Marshaller writes invalid DOMResult", expected, result);
- }
+ @Test
+ public void marshalDOMResult() throws Exception {
+ DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
+ documentBuilderFactory.setNamespaceAware(true);
+ DocumentBuilder builder = documentBuilderFactory.newDocumentBuilder();
+ Document result = builder.newDocument();
+ DOMResult domResult = new DOMResult(result);
+ marshaller.marshal(flights, domResult);
+ Document expected = builder.newDocument();
+ Element flightsElement = expected.createElementNS("http://samples.springframework.org/flight", "tns:flights");
+ Attr namespace = expected.createAttributeNS("http://www.w3.org/2000/xmlns/", "xmlns:tns");
+ namespace.setNodeValue("http://samples.springframework.org/flight");
+ flightsElement.setAttributeNode(namespace);
+ expected.appendChild(flightsElement);
+ Element flightElement = expected.createElementNS("http://samples.springframework.org/flight", "tns:flight");
+ flightsElement.appendChild(flightElement);
+ Element numberElement = expected.createElementNS("http://samples.springframework.org/flight", "tns:number");
+ flightElement.appendChild(numberElement);
+ Text text = expected.createTextNode("42");
+ numberElement.appendChild(text);
+ assertXMLEqual("Marshaller writes invalid DOMResult", expected, result);
+ }
- public void testMarshalStreamResultWriter() throws Exception {
- StringWriter writer = new StringWriter();
- StreamResult result = new StreamResult(writer);
- marshaller.marshal(flights, result);
- assertXMLEqual("Marshaller writes invalid StreamResult", EXPECTED_STRING, writer.toString());
- }
+ @Test
+ public void marshalStreamResultWriter() throws Exception {
+ StringWriter writer = new StringWriter();
+ StreamResult result = new StreamResult(writer);
+ marshaller.marshal(flights, result);
+ assertXMLEqual("Marshaller writes invalid StreamResult", EXPECTED_STRING, writer.toString());
+ }
- public void testMarshalStreamResultOutputStream() throws Exception {
- ByteArrayOutputStream os = new ByteArrayOutputStream();
- StreamResult result = new StreamResult(os);
- marshaller.marshal(flights, result);
- assertXMLEqual("Marshaller writes invalid StreamResult", EXPECTED_STRING,
- new String(os.toByteArray(), "UTF-8"));
- }
+ @Test
+ public void marshalStreamResultOutputStream() throws Exception {
+ ByteArrayOutputStream os = new ByteArrayOutputStream();
+ StreamResult result = new StreamResult(os);
+ marshaller.marshal(flights, result);
+ assertXMLEqual("Marshaller writes invalid StreamResult", EXPECTED_STRING,
+ new String(os.toByteArray(), "UTF-8"));
+ }
- public void testMarshalStaxResultStreamWriter() throws Exception {
- XMLOutputFactory outputFactory = XMLOutputFactory.newInstance();
- StringWriter writer = new StringWriter();
- XMLStreamWriter streamWriter = outputFactory.createXMLStreamWriter(writer);
- StaxResult result = new StaxResult(streamWriter);
- marshaller.marshal(flights, result);
- assertXMLEqual("Marshaller writes invalid StreamResult", EXPECTED_STRING, writer.toString());
- }
+ @Test
+ public void marshalStaxResultStreamWriter() throws Exception {
+ XMLOutputFactory outputFactory = XMLOutputFactory.newInstance();
+ StringWriter writer = new StringWriter();
+ XMLStreamWriter streamWriter = outputFactory.createXMLStreamWriter(writer);
+ Result result = StaxUtils.createStaxResult(streamWriter);
+ marshaller.marshal(flights, result);
+ assertXMLEqual("Marshaller writes invalid StreamResult", EXPECTED_STRING, writer.toString());
+ }
- public void testMarshalStaxResultEventWriter() throws Exception {
- XMLOutputFactory outputFactory = XMLOutputFactory.newInstance();
- StringWriter writer = new StringWriter();
- XMLEventWriter eventWriter = outputFactory.createXMLEventWriter(writer);
- StaxResult result = new StaxResult(eventWriter);
- marshaller.marshal(flights, result);
- assertXMLEqual("Marshaller writes invalid StreamResult", EXPECTED_STRING, writer.toString());
- }
+ @Test
+ public void marshalStaxResultEventWriter() throws Exception {
+ XMLOutputFactory outputFactory = XMLOutputFactory.newInstance();
+ StringWriter writer = new StringWriter();
+ XMLEventWriter eventWriter = outputFactory.createXMLEventWriter(writer);
+ Result result = StaxUtils.createStaxResult(eventWriter);
+ marshaller.marshal(flights, result);
+ assertXMLEqual("Marshaller writes invalid StreamResult", EXPECTED_STRING, writer.toString());
+ }
- public void testMarshalJaxp14StaxResultStreamWriter() throws Exception {
- XMLOutputFactory outputFactory = XMLOutputFactory.newInstance();
- StringWriter writer = new StringWriter();
- XMLStreamWriter streamWriter = outputFactory.createXMLStreamWriter(writer);
- StAXResult result = new StAXResult(streamWriter);
- marshaller.marshal(flights, result);
- assertXMLEqual("Marshaller writes invalid StreamResult", EXPECTED_STRING, writer.toString());
- }
+ @Test
+ public void marshalJaxp14StaxResultStreamWriter() throws Exception {
+ XMLOutputFactory outputFactory = XMLOutputFactory.newInstance();
+ StringWriter writer = new StringWriter();
+ XMLStreamWriter streamWriter = outputFactory.createXMLStreamWriter(writer);
+ StAXResult result = new StAXResult(streamWriter);
+ marshaller.marshal(flights, result);
+ assertXMLEqual("Marshaller writes invalid StreamResult", EXPECTED_STRING, writer.toString());
+ }
- public void testMarshalJaxp14StaxResultEventWriter() throws Exception {
- XMLOutputFactory outputFactory = XMLOutputFactory.newInstance();
- StringWriter writer = new StringWriter();
- XMLEventWriter eventWriter = outputFactory.createXMLEventWriter(writer);
- StAXResult result = new StAXResult(eventWriter);
- marshaller.marshal(flights, result);
- assertXMLEqual("Marshaller writes invalid StreamResult", EXPECTED_STRING, writer.toString());
- }
+ @Test
+ public void marshalJaxp14StaxResultEventWriter() throws Exception {
+ XMLOutputFactory outputFactory = XMLOutputFactory.newInstance();
+ StringWriter writer = new StringWriter();
+ XMLEventWriter eventWriter = outputFactory.createXMLEventWriter(writer);
+ StAXResult result = new StAXResult(eventWriter);
+ marshaller.marshal(flights, result);
+ assertXMLEqual("Marshaller writes invalid StreamResult", EXPECTED_STRING, writer.toString());
+ }
}
diff --git a/org.springframework.oxm/src/test/java/org/springframework/oxm/AbstractUnmarshallerTestCase.java b/org.springframework.oxm/src/test/java/org/springframework/oxm/AbstractUnmarshallerTestCase.java
index a9b0a665ab..d2158f415a 100644
--- a/org.springframework.oxm/src/test/java/org/springframework/oxm/AbstractUnmarshallerTestCase.java
+++ b/org.springframework.oxm/src/test/java/org/springframework/oxm/AbstractUnmarshallerTestCase.java
@@ -23,12 +23,15 @@ import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.stream.XMLEventReader;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamReader;
+import javax.xml.transform.Source;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.sax.SAXSource;
import javax.xml.transform.stax.StAXSource;
import javax.xml.transform.stream.StreamSource;
-import junit.framework.TestCase;
+import static org.junit.Assert.assertEquals;
+import org.junit.Before;
+import org.junit.Test;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Text;
@@ -36,104 +39,114 @@ import org.xml.sax.InputSource;
import org.xml.sax.XMLReader;
import org.xml.sax.helpers.XMLReaderFactory;
-import org.springframework.xml.transform.StaxSource;
+import org.springframework.util.xml.StaxUtils;
-public abstract class AbstractUnmarshallerTestCase extends TestCase {
+public abstract class AbstractUnmarshallerTestCase {
- protected Unmarshaller unmarshaller;
+ protected Unmarshaller unmarshaller;
- protected static final String INPUT_STRING =
- "" +
- "42 ";
+ protected static final String INPUT_STRING =
+ "" +
+ "42 ";
- protected final void setUp() throws Exception {
- unmarshaller = createUnmarshaller();
- }
+ @Before
+ public final void setUp() throws Exception {
+ unmarshaller = createUnmarshaller();
+ }
- protected abstract Unmarshaller createUnmarshaller() throws Exception;
+ protected abstract Unmarshaller createUnmarshaller() throws Exception;
- protected abstract void testFlights(Object o);
+ protected abstract void testFlights(Object o);
- protected abstract void testFlight(Object o);
+ protected abstract void testFlight(Object o);
- public void testUnmarshalDomSource() throws Exception {
- DocumentBuilder builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
- Document document = builder.newDocument();
- Element flightsElement = document.createElementNS("http://samples.springframework.org/flight", "tns:flights");
- document.appendChild(flightsElement);
- Element flightElement = document.createElementNS("http://samples.springframework.org/flight", "tns:flight");
- flightsElement.appendChild(flightElement);
- Element numberElement = document.createElementNS("http://samples.springframework.org/flight", "tns:number");
- flightElement.appendChild(numberElement);
- Text text = document.createTextNode("42");
- numberElement.appendChild(text);
- DOMSource source = new DOMSource(document);
- Object flights = unmarshaller.unmarshal(source);
- testFlights(flights);
- }
+ @Test
+ public void unmarshalDomSource() throws Exception {
+ DocumentBuilder builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
+ Document document = builder.newDocument();
+ Element flightsElement = document.createElementNS("http://samples.springframework.org/flight", "tns:flights");
+ document.appendChild(flightsElement);
+ Element flightElement = document.createElementNS("http://samples.springframework.org/flight", "tns:flight");
+ flightsElement.appendChild(flightElement);
+ Element numberElement = document.createElementNS("http://samples.springframework.org/flight", "tns:number");
+ flightElement.appendChild(numberElement);
+ Text text = document.createTextNode("42");
+ numberElement.appendChild(text);
+ DOMSource source = new DOMSource(document);
+ Object flights = unmarshaller.unmarshal(source);
+ testFlights(flights);
+ }
- public void testUnmarshalStreamSourceReader() throws Exception {
- StreamSource source = new StreamSource(new StringReader(INPUT_STRING));
- Object flights = unmarshaller.unmarshal(source);
- testFlights(flights);
- }
+ @Test
+ public void unmarshalStreamSourceReader() throws Exception {
+ StreamSource source = new StreamSource(new StringReader(INPUT_STRING));
+ Object flights = unmarshaller.unmarshal(source);
+ testFlights(flights);
+ }
- public void testUnmarshalStreamSourceInputStream() throws Exception {
- StreamSource source = new StreamSource(new ByteArrayInputStream(INPUT_STRING.getBytes("UTF-8")));
- Object flights = unmarshaller.unmarshal(source);
- testFlights(flights);
- }
+ @Test
+ public void unmarshalStreamSourceInputStream() throws Exception {
+ StreamSource source = new StreamSource(new ByteArrayInputStream(INPUT_STRING.getBytes("UTF-8")));
+ Object flights = unmarshaller.unmarshal(source);
+ testFlights(flights);
+ }
- public void testUnmarshalSAXSource() throws Exception {
- XMLReader reader = XMLReaderFactory.createXMLReader();
- SAXSource source = new SAXSource(reader, new InputSource(new StringReader(INPUT_STRING)));
- Object flights = unmarshaller.unmarshal(source);
- testFlights(flights);
- }
+ @Test
+ public void unmarshalSAXSource() throws Exception {
+ XMLReader reader = XMLReaderFactory.createXMLReader();
+ SAXSource source = new SAXSource(reader, new InputSource(new StringReader(INPUT_STRING)));
+ Object flights = unmarshaller.unmarshal(source);
+ testFlights(flights);
+ }
- public void testUnmarshalStaxSourceXmlStreamReader() throws Exception {
- XMLInputFactory inputFactory = XMLInputFactory.newInstance();
- XMLStreamReader streamReader = inputFactory.createXMLStreamReader(new StringReader(INPUT_STRING));
- StaxSource source = new StaxSource(streamReader);
- Object flights = unmarshaller.unmarshal(source);
- testFlights(flights);
- }
+ @Test
+ public void unmarshalStaxSourceXmlStreamReader() throws Exception {
+ XMLInputFactory inputFactory = XMLInputFactory.newInstance();
+ XMLStreamReader streamReader = inputFactory.createXMLStreamReader(new StringReader(INPUT_STRING));
+ Source source = StaxUtils.createStaxSource(streamReader);
+ Object flights = unmarshaller.unmarshal(source);
+ testFlights(flights);
+ }
- public void testUnmarshalStaxSourceXmlEventReader() throws Exception {
- XMLInputFactory inputFactory = XMLInputFactory.newInstance();
- XMLEventReader eventReader = inputFactory.createXMLEventReader(new StringReader(INPUT_STRING));
- StaxSource source = new StaxSource(eventReader);
- Object flights = unmarshaller.unmarshal(source);
- testFlights(flights);
- }
+ @Test
+ public void unmarshalStaxSourceXmlEventReader() throws Exception {
+ XMLInputFactory inputFactory = XMLInputFactory.newInstance();
+ XMLEventReader eventReader = inputFactory.createXMLEventReader(new StringReader(INPUT_STRING));
+ Source source = StaxUtils.createStaxSource(eventReader);
+ Object flights = unmarshaller.unmarshal(source);
+ testFlights(flights);
+ }
- public void testUnmarshalJaxp14StaxSourceXmlStreamReader() throws Exception {
- XMLInputFactory inputFactory = XMLInputFactory.newInstance();
- XMLStreamReader streamReader = inputFactory.createXMLStreamReader(new StringReader(INPUT_STRING));
- StAXSource source = new StAXSource(streamReader);
- Object flights = unmarshaller.unmarshal(source);
- testFlights(flights);
- }
+ @Test
+ public void unmarshalJaxp14StaxSourceXmlStreamReader() throws Exception {
+ XMLInputFactory inputFactory = XMLInputFactory.newInstance();
+ XMLStreamReader streamReader = inputFactory.createXMLStreamReader(new StringReader(INPUT_STRING));
+ StAXSource source = new StAXSource(streamReader);
+ Object flights = unmarshaller.unmarshal(source);
+ testFlights(flights);
+ }
- public void testUnmarshalJaxp14StaxSourceXmlEventReader() throws Exception {
- XMLInputFactory inputFactory = XMLInputFactory.newInstance();
- XMLEventReader eventReader = inputFactory.createXMLEventReader(new StringReader(INPUT_STRING));
- StAXSource source = new StAXSource(eventReader);
- Object flights = unmarshaller.unmarshal(source);
- testFlights(flights);
- }
+ @Test
+ public void unmarshalJaxp14StaxSourceXmlEventReader() throws Exception {
+ XMLInputFactory inputFactory = XMLInputFactory.newInstance();
+ XMLEventReader eventReader = inputFactory.createXMLEventReader(new StringReader(INPUT_STRING));
+ StAXSource source = new StAXSource(eventReader);
+ Object flights = unmarshaller.unmarshal(source);
+ testFlights(flights);
+ }
- public void testUnmarshalPartialStaxSourceXmlStreamReader() throws Exception {
- XMLInputFactory inputFactory = XMLInputFactory.newInstance();
- XMLStreamReader streamReader = inputFactory.createXMLStreamReader(new StringReader(INPUT_STRING));
- streamReader.nextTag(); // skip to flights
- assertEquals("Invalid element", new QName("http://samples.springframework.org/flight", "flights"),
- streamReader.getName());
- streamReader.nextTag(); // skip to flight
- assertEquals("Invalid element", new QName("http://samples.springframework.org/flight", "flight"),
- streamReader.getName());
- StaxSource source = new StaxSource(streamReader);
- Object flight = unmarshaller.unmarshal(source);
- testFlight(flight);
- }
+ @Test
+ public void unmarshalPartialStaxSourceXmlStreamReader() throws Exception {
+ XMLInputFactory inputFactory = XMLInputFactory.newInstance();
+ XMLStreamReader streamReader = inputFactory.createXMLStreamReader(new StringReader(INPUT_STRING));
+ streamReader.nextTag(); // skip to flights
+ assertEquals("Invalid element", new QName("http://samples.springframework.org/flight", "flights"),
+ streamReader.getName());
+ streamReader.nextTag(); // skip to flight
+ assertEquals("Invalid element", new QName("http://samples.springframework.org/flight", "flight"),
+ streamReader.getName());
+ Source source = StaxUtils.createStaxSource(streamReader);
+ Object flight = unmarshaller.unmarshal(source);
+ testFlight(flight);
+ }
}
diff --git a/org.springframework.oxm/src/test/java/org/springframework/oxm/castor/CastorMarshallerTest.java b/org.springframework.oxm/src/test/java/org/springframework/oxm/castor/CastorMarshallerTest.java
index 5122bc0c7d..870d56b5f4 100644
--- a/org.springframework.oxm/src/test/java/org/springframework/oxm/castor/CastorMarshallerTest.java
+++ b/org.springframework.oxm/src/test/java/org/springframework/oxm/castor/CastorMarshallerTest.java
@@ -17,61 +17,65 @@ package org.springframework.oxm.castor;
import javax.xml.transform.sax.SAXResult;
-import org.easymock.MockControl;
+import static org.easymock.EasyMock.*;
+import static org.junit.Assert.assertTrue;
+import org.junit.Test;
+import org.xml.sax.Attributes;
+import org.xml.sax.ContentHandler;
+
import org.springframework.core.io.ClassPathResource;
import org.springframework.oxm.AbstractMarshallerTestCase;
import org.springframework.oxm.Marshaller;
-import org.xml.sax.ContentHandler;
public class CastorMarshallerTest extends AbstractMarshallerTestCase {
- @Override
+ @Override
protected Marshaller createMarshaller() throws Exception {
- CastorMarshaller marshaller = new CastorMarshaller();
- ClassPathResource mappingLocation = new ClassPathResource("mapping.xml", CastorMarshaller.class);
- marshaller.setMappingLocation(mappingLocation);
- marshaller.afterPropertiesSet();
- return marshaller;
- }
+ CastorMarshaller marshaller = new CastorMarshaller();
+ ClassPathResource mappingLocation = new ClassPathResource("mapping.xml", CastorMarshaller.class);
+ marshaller.setMappingLocation(mappingLocation);
+ marshaller.afterPropertiesSet();
+ return marshaller;
+ }
- @Override
+ @Override
protected Object createFlights() {
- Flight flight = new Flight();
- flight.setNumber(42L);
- Flights flights = new Flights();
- flights.addFlight(flight);
- return flights;
- }
+ Flight flight = new Flight();
+ flight.setNumber(42L);
+ Flights flights = new Flights();
+ flights.addFlight(flight);
+ return flights;
+ }
- public void testMarshalSaxResult() throws Exception {
- MockControl handlerControl = MockControl.createControl(ContentHandler.class);
- ContentHandler handlerMock = (ContentHandler) handlerControl.getMock();
- handlerMock.startDocument();
- handlerMock.startPrefixMapping("tns", "http://samples.springframework.org/flight");
- handlerMock.startElement("http://samples.springframework.org/flight", "flights", "tns:flights", null);
- handlerControl.setMatcher(MockControl.ALWAYS_MATCHER);
- handlerMock.startElement("http://samples.springframework.org/flight", "flight", "tns:flight", null);
- handlerControl.setMatcher(MockControl.ALWAYS_MATCHER);
- handlerMock.startElement("http://samples.springframework.org/flight", "number", "tns:number", null);
- handlerControl.setMatcher(MockControl.ALWAYS_MATCHER);
- handlerMock.characters(new char[]{'4', '2'}, 0, 2);
- handlerControl.setMatcher(MockControl.ARRAY_MATCHER);
- handlerMock.endElement("http://samples.springframework.org/flight", "number", "tns:number");
- handlerMock.endElement("http://samples.springframework.org/flight", "flight", "tns:flight");
- handlerMock.endElement("http://samples.springframework.org/flight", "flights", "tns:flights");
- handlerMock.endPrefixMapping("tns");
- handlerMock.endDocument();
+ @Test
+ public void marshalSaxResult() throws Exception {
+ ContentHandler handlerMock = createMock(ContentHandler.class);
+ handlerMock.startDocument();
+ handlerMock.startPrefixMapping("tns", "http://samples.springframework.org/flight");
+ handlerMock.startElement(eq("http://samples.springframework.org/flight"), eq("flights"), eq("tns:flights"),
+ isA(Attributes.class));
+ handlerMock.startElement(eq("http://samples.springframework.org/flight"), eq("flight"), eq("tns:flight"),
+ isA(Attributes.class));
+ handlerMock.startElement(eq("http://samples.springframework.org/flight"), eq("number"), eq("tns:number"),
+ isA(Attributes.class));
+ handlerMock.characters(aryEq(new char[]{'4', '2'}), eq(0), eq(2));
+ handlerMock.endElement("http://samples.springframework.org/flight", "number", "tns:number");
+ handlerMock.endElement("http://samples.springframework.org/flight", "flight", "tns:flight");
+ handlerMock.endElement("http://samples.springframework.org/flight", "flights", "tns:flights");
+ handlerMock.endPrefixMapping("tns");
+ handlerMock.endDocument();
- handlerControl.replay();
- SAXResult result = new SAXResult(handlerMock);
- marshaller.marshal(flights, result);
- handlerControl.verify();
- }
+ replay(handlerMock);
+ SAXResult result = new SAXResult(handlerMock);
+ marshaller.marshal(flights, result);
+ verify(handlerMock);
+ }
- public void testSupports() throws Exception {
- assertTrue("CastorMarshaller does not support Flights", marshaller.supports(Flights.class));
- assertTrue("CastorMarshaller does not support Flight", marshaller.supports(Flight.class));
- }
+ @Test
+ public void supports() throws Exception {
+ assertTrue("CastorMarshaller does not support Flights", marshaller.supports(Flights.class));
+ assertTrue("CastorMarshaller does not support Flight", marshaller.supports(Flight.class));
+ }
}
diff --git a/org.springframework.oxm/src/test/java/org/springframework/oxm/castor/CastorUnmarshallerTest.java b/org.springframework.oxm/src/test/java/org/springframework/oxm/castor/CastorUnmarshallerTest.java
index 26b93a9179..4789bf03af 100644
--- a/org.springframework.oxm/src/test/java/org/springframework/oxm/castor/CastorUnmarshallerTest.java
+++ b/org.springframework.oxm/src/test/java/org/springframework/oxm/castor/CastorUnmarshallerTest.java
@@ -19,56 +19,56 @@ import java.io.ByteArrayInputStream;
import java.io.IOException;
import javax.xml.transform.stream.StreamSource;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import org.junit.Test;
+
import org.springframework.core.io.ClassPathResource;
import org.springframework.oxm.AbstractUnmarshallerTestCase;
import org.springframework.oxm.Unmarshaller;
public class CastorUnmarshallerTest extends AbstractUnmarshallerTestCase {
- @Override
+ @Override
protected void testFlights(Object o) {
- Flights flights = (Flights) o;
- assertNotNull("Flights is null", flights);
- assertEquals("Invalid amount of flight elements", 1, flights.getFlightCount());
- testFlight(flights.getFlight()[0]);
- }
+ Flights flights = (Flights) o;
+ assertNotNull("Flights is null", flights);
+ assertEquals("Invalid amount of flight elements", 1, flights.getFlightCount());
+ testFlight(flights.getFlight()[0]);
+ }
- @Override
+ @Override
protected void testFlight(Object o) {
- Flight flight = (Flight) o;
- assertNotNull("Flight is null", flight);
- assertEquals("Number is invalid", 42L, flight.getNumber());
- }
+ Flight flight = (Flight) o;
+ assertNotNull("Flight is null", flight);
+ assertEquals("Number is invalid", 42L, flight.getNumber());
+ }
- @Override
+ @Override
protected Unmarshaller createUnmarshaller() throws Exception {
- CastorMarshaller marshaller = new CastorMarshaller();
- ClassPathResource mappingLocation = new ClassPathResource("mapping.xml", CastorMarshaller.class);
- marshaller.setMappingLocation(mappingLocation);
- marshaller.afterPropertiesSet();
- return marshaller;
- }
+ CastorMarshaller marshaller = new CastorMarshaller();
+ ClassPathResource mappingLocation = new ClassPathResource("mapping.xml", CastorMarshaller.class);
+ marshaller.setMappingLocation(mappingLocation);
+ marshaller.afterPropertiesSet();
+ return marshaller;
+ }
- public void testUnmarshalTargetClass() throws Exception {
- CastorMarshaller unmarshaller = new CastorMarshaller();
- unmarshaller.setTargetClass(Flights.class);
- unmarshaller.afterPropertiesSet();
- StreamSource source = new StreamSource(new ByteArrayInputStream(INPUT_STRING.getBytes("UTF-8")));
- Object flights = unmarshaller.unmarshal(source);
- testFlights(flights);
- }
+ @Test
+ public void unmarshalTargetClass() throws Exception {
+ CastorMarshaller unmarshaller = new CastorMarshaller();
+ unmarshaller.setTargetClass(Flights.class);
+ unmarshaller.afterPropertiesSet();
+ StreamSource source = new StreamSource(new ByteArrayInputStream(INPUT_STRING.getBytes("UTF-8")));
+ Object flights = unmarshaller.unmarshal(source);
+ testFlights(flights);
+ }
- public void testSetBothTargetClassAndMapping() throws IOException {
- try {
- CastorMarshaller marshaller = new CastorMarshaller();
- marshaller.setMappingLocation(new ClassPathResource("mapping.xml", CastorMarshaller.class));
- marshaller.setTargetClass(getClass());
- marshaller.afterPropertiesSet();
- fail("IllegalArgumentException expected");
- }
- catch (IllegalArgumentException ex) {
- // expected
- }
- }
+ @Test(expected = IllegalArgumentException.class)
+ public void testSetBothTargetClassAndMapping() throws IOException {
+ CastorMarshaller marshaller = new CastorMarshaller();
+ marshaller.setMappingLocation(new ClassPathResource("mapping.xml", CastorMarshaller.class));
+ marshaller.setTargetClass(getClass());
+ marshaller.afterPropertiesSet();
+ }
}
diff --git a/org.springframework.oxm/src/test/java/org/springframework/oxm/config/Jaxb2OxmNamespaceHandlerTest.java b/org.springframework.oxm/src/test/java/org/springframework/oxm/config/Jaxb2OxmNamespaceHandlerTest.java
deleted file mode 100644
index c7a4548ea9..0000000000
--- a/org.springframework.oxm/src/test/java/org/springframework/oxm/config/Jaxb2OxmNamespaceHandlerTest.java
+++ /dev/null
@@ -1,41 +0,0 @@
-/*
- * Copyright ${YEAR} the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.springframework.oxm.config;
-
-import org.springframework.context.ApplicationContext;
-import org.springframework.context.support.ClassPathXmlApplicationContext;
-import org.springframework.oxm.jaxb.Jaxb2Marshaller;
-
-import junit.framework.TestCase;
-
-public class Jaxb2OxmNamespaceHandlerTest extends TestCase {
-
- private ApplicationContext applicationContext;
-
- protected void setUp() throws Exception {
- applicationContext = new ClassPathXmlApplicationContext("jaxb2OxmNamespaceHandlerTest.xml", getClass());
- }
-
- public void testContextPathMarshaller() throws Exception {
- applicationContext.getBean("contextPathMarshaller", Jaxb2Marshaller.class);
- }
-
- public void testClassesToBeBoundMarshaller() throws Exception {
- applicationContext.getBean("classesMarshaller", Jaxb2Marshaller.class);
- }
-
-}
\ No newline at end of file
diff --git a/org.springframework.oxm/src/test/java/org/springframework/oxm/config/OxmNamespaceHandlerTest.java b/org.springframework.oxm/src/test/java/org/springframework/oxm/config/OxmNamespaceHandlerTest.java
index aa81c6ae91..f01c230b20 100644
--- a/org.springframework.oxm/src/test/java/org/springframework/oxm/config/OxmNamespaceHandlerTest.java
+++ b/org.springframework.oxm/src/test/java/org/springframework/oxm/config/OxmNamespaceHandlerTest.java
@@ -16,37 +16,50 @@
package org.springframework.oxm.config;
+import org.apache.xmlbeans.XmlOptions;
+import static org.junit.Assert.*;
+import org.junit.Before;
+import org.junit.Ignore;
+import org.junit.Test;
+
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
-import org.springframework.oxm.jaxb.Jaxb1Marshaller;
+import org.springframework.oxm.jaxb.Jaxb2Marshaller;
import org.springframework.oxm.jibx.JibxMarshaller;
import org.springframework.oxm.xmlbeans.XmlBeansMarshaller;
-import junit.framework.TestCase;
-import org.apache.xmlbeans.XmlOptions;
+public class OxmNamespaceHandlerTest {
-public class OxmNamespaceHandlerTest extends TestCase {
+ private ApplicationContext applicationContext;
- private ApplicationContext applicationContext;
+ @Before
+ public void createAppContext() throws Exception {
+ applicationContext = new ClassPathXmlApplicationContext("oxmNamespaceHandlerTest.xml", getClass());
+ }
- protected void setUp() throws Exception {
- applicationContext = new ClassPathXmlApplicationContext("oxmNamespaceHandlerTest.xml", getClass());
- }
+ @Test
+ @Ignore
+ public void jibxMarshaller() throws Exception {
+ applicationContext.getBean("jibxMarshaller", JibxMarshaller.class);
+ }
- public void testJaxb1Marshaller() throws Exception {
- applicationContext.getBean("jaxb1Marshaller", Jaxb1Marshaller.class);
- }
+ @Test
+ public void xmlBeansMarshaller() throws Exception {
+ XmlBeansMarshaller marshaller = applicationContext.getBean("xmlBeansMarshaller", XmlBeansMarshaller.class);
+ XmlOptions options = marshaller.getXmlOptions();
+ assertNotNull("Options not set", options);
+ assertTrue("option not set", options.hasOption("SAVE_PRETTY_PRINT"));
+ assertEquals("option not set", "true", options.get("SAVE_PRETTY_PRINT"));
+ }
- public void testJibxMarshaller() throws Exception {
- applicationContext.getBean("jibxMarshaller", JibxMarshaller.class);
- }
+ @Test
+ public void jaxb2ContextPathMarshaller() throws Exception {
+ applicationContext.getBean("contextPathMarshaller", Jaxb2Marshaller.class);
+ }
+
+ @Test
+ public void jaxb2ClassesToBeBoundMarshaller() throws Exception {
+ applicationContext.getBean("classesMarshaller", Jaxb2Marshaller.class);
+ }
- public void testXmlBeansMarshaller() throws Exception {
- XmlBeansMarshaller marshaller =
- (XmlBeansMarshaller) applicationContext.getBean("xmlBeansMarshaller", XmlBeansMarshaller.class);
- XmlOptions options = marshaller.getXmlOptions();
- assertNotNull("Options not set", options);
- assertTrue("option not set", options.hasOption("SAVE_PRETTY_PRINT"));
- assertEquals("option not set", "true", options.get("SAVE_PRETTY_PRINT"));
- }
}
\ No newline at end of file
diff --git a/org.springframework.oxm/src/test/java/org/springframework/oxm/jaxb/FlightType.java b/org.springframework.oxm/src/test/java/org/springframework/oxm/jaxb/FlightType.java
new file mode 100644
index 0000000000..6853387fad
--- /dev/null
+++ b/org.springframework.oxm/src/test/java/org/springframework/oxm/jaxb/FlightType.java
@@ -0,0 +1,47 @@
+//
+// This file was generated by the JavaTM Architecture for XML Binding(JAXB) Reference Implementation, v2.0.3-b01-fcs
+// See http://java.sun.com/xml/jaxb
+// Any modifications to this file will be lost upon recompilation of the source schema.
+// Generated on: 2009.01.08 at 12:41:36 PM CET
+//
+
+package org.springframework.oxm.jaxb;
+
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlType;
+
+/**
+ * Java class for flightType complex type.
+ *
+ *
The following schema fragment specifies the expected content contained within this class.
+ *
+ *
+ * <complexType name="flightType">
+ * <complexContent>
+ * <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
+ * <sequence>
+ * <element name="number" type="{http://www.w3.org/2001/XMLSchema}long"/>
+ * </sequence>
+ * </restriction>
+ * </complexContent>
+ * </complexType>
+ *
+ */
+@XmlAccessorType(XmlAccessType.FIELD)
+@XmlType(name = "flightType", propOrder = {"number"})
+public class FlightType {
+
+ protected long number;
+
+ /** Gets the value of the number property. */
+ public long getNumber() {
+ return number;
+ }
+
+ /** Sets the value of the number property. */
+ public void setNumber(long value) {
+ this.number = value;
+ }
+
+}
diff --git a/org.springframework.oxm/src/test/java/org/springframework/oxm/jaxb/Flights.java b/org.springframework.oxm/src/test/java/org/springframework/oxm/jaxb/Flights.java
new file mode 100644
index 0000000000..4122d2598d
--- /dev/null
+++ b/org.springframework.oxm/src/test/java/org/springframework/oxm/jaxb/Flights.java
@@ -0,0 +1,66 @@
+//
+// This file was generated by the JavaTM Architecture for XML Binding(JAXB) Reference Implementation, v2.0.3-b01-fcs
+// See http://java.sun.com/xml/jaxb
+// Any modifications to this file will be lost upon recompilation of the source schema.
+// Generated on: 2009.01.08 at 12:41:36 PM CET
+//
+
+package org.springframework.oxm.jaxb;
+
+import java.util.ArrayList;
+import java.util.List;
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlRootElement;
+import javax.xml.bind.annotation.XmlType;
+
+/**
+ * Java class for anonymous complex type.
+ *
+ *
The following schema fragment specifies the expected content contained within this class.
+ *
+ *
+ * <complexType>
+ * <complexContent>
+ * <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
+ * <sequence>
+ * <element name="flight" type="{http://samples.springframework.org/flight}flightType"
+ * maxOccurs="unbounded"/>
+ * </sequence>
+ * </restriction>
+ * </complexContent>
+ * </complexType>
+ *
+ */
+@XmlAccessorType(XmlAccessType.FIELD)
+@XmlType(name = "", propOrder = {"flight"})
+@XmlRootElement(name = "flights")
+public class Flights {
+
+ @XmlElement(required = true)
+ protected List flight;
+
+ /**
+ * Gets the value of the flight property.
+ *
+ * This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make
+ * to the returned list will be present inside the JAXB object. This is why there is not a set method for
+ * the flight property.
+ *
+ *
For example, to add a new item, do as follows:
+ *
+ * getFlight().add(newItem);
+ *
+ *
+ *
+ * Objects of the following type(s) are allowed in the list {@link FlightType }
+ */
+ public List getFlight() {
+ if (flight == null) {
+ flight = new ArrayList();
+ }
+ return this.flight;
+ }
+
+}
diff --git a/org.springframework.oxm/src/test/java/org/springframework/oxm/jaxb/Jaxb1MarshallerTest.java b/org.springframework.oxm/src/test/java/org/springframework/oxm/jaxb/Jaxb1MarshallerTest.java
deleted file mode 100644
index 189cd89f1e..0000000000
--- a/org.springframework.oxm/src/test/java/org/springframework/oxm/jaxb/Jaxb1MarshallerTest.java
+++ /dev/null
@@ -1,84 +0,0 @@
-/*
- * Copyright 2005 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.springframework.oxm.jaxb;
-
-import java.util.Collections;
-
-import org.springframework.oxm.Marshaller;
-import org.springframework.oxm.XmlMappingException;
-import org.springframework.oxm.jaxb1.FlightType;
-import org.springframework.oxm.jaxb1.Flights;
-import org.springframework.oxm.jaxb1.FlightsType;
-import org.springframework.oxm.jaxb1.impl.FlightTypeImpl;
-import org.springframework.oxm.jaxb1.impl.FlightsImpl;
-
-public class Jaxb1MarshallerTest extends AbstractJaxbMarshallerTestCase {
-
- private static final String CONTEXT_PATH = "org.springframework.oxm.jaxb1";
-
- @Override
- protected final Marshaller createMarshaller() throws Exception {
- Jaxb1Marshaller marshaller = new Jaxb1Marshaller();
- marshaller.setContextPaths(new String[]{CONTEXT_PATH});
- marshaller.afterPropertiesSet();
- return marshaller;
- }
-
- @Override
- protected Object createFlights() {
- FlightType flight = new FlightTypeImpl();
- flight.setNumber(42L);
- Flights flights = new FlightsImpl();
- flights.getFlight().add(flight);
- return flights;
- }
-
- public void testProperties() throws Exception {
- Jaxb1Marshaller marshaller = new Jaxb1Marshaller();
- marshaller.setContextPath(CONTEXT_PATH);
- marshaller.setMarshallerProperties(
- Collections.singletonMap(javax.xml.bind.Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE));
- marshaller.afterPropertiesSet();
- }
-
- public void testNoContextPath() throws Exception {
- try {
- Jaxb1Marshaller marshaller = new Jaxb1Marshaller();
- marshaller.afterPropertiesSet();
- fail("Should have thrown an IllegalArgumentException");
- }
- catch (IllegalArgumentException e) {
- }
- }
-
- public void testInvalidContextPath() throws Exception {
- try {
- Jaxb1Marshaller marshaller = new Jaxb1Marshaller();
- marshaller.setContextPath("ab");
- marshaller.afterPropertiesSet();
- fail("Should have thrown an XmlMappingException");
- }
- catch (XmlMappingException ex) {
- }
- }
-
- public void testSupports() throws Exception {
- assertTrue("Jaxb1Marshaller does not support Flights", marshaller.supports(Flights.class));
- assertFalse("Jaxb1Marshaller supports FlightsType", marshaller.supports(FlightsType.class));
- }
-
-
-}
diff --git a/org.springframework.oxm/src/test/java/org/springframework/oxm/jaxb/Jaxb1UnmarshallerTest.java b/org.springframework.oxm/src/test/java/org/springframework/oxm/jaxb/Jaxb1UnmarshallerTest.java
deleted file mode 100644
index 6beeaf6f78..0000000000
--- a/org.springframework.oxm/src/test/java/org/springframework/oxm/jaxb/Jaxb1UnmarshallerTest.java
+++ /dev/null
@@ -1,49 +0,0 @@
-/*
- * Copyright 2005 the original author or authors.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.springframework.oxm.jaxb;
-
-import org.springframework.oxm.AbstractUnmarshallerTestCase;
-import org.springframework.oxm.Unmarshaller;
-import org.springframework.oxm.jaxb1.FlightType;
-import org.springframework.oxm.jaxb1.Flights;
-
-public class Jaxb1UnmarshallerTest extends AbstractUnmarshallerTestCase {
-
- @Override
- protected Unmarshaller createUnmarshaller() throws Exception {
- Jaxb1Marshaller marshaller = new Jaxb1Marshaller();
- marshaller.setContextPath("org.springframework.oxm.jaxb1");
- marshaller.setValidating(true);
- marshaller.afterPropertiesSet();
- return marshaller;
- }
-
- @Override
- protected void testFlights(Object o) {
- Flights flights = (Flights) o;
- assertNotNull("Flights is null", flights);
- assertEquals("Invalid amount of flight elements", 1, flights.getFlight().size());
- testFlight(flights.getFlight().get(0));
- }
-
- @Override
- protected void testFlight(Object o) {
- FlightType flight = (FlightType) o;
- assertNotNull("Flight is null", flight);
- assertEquals("Number is invalid", 42L, flight.getNumber());
- }
-
-}
diff --git a/org.springframework.oxm/src/test/java/org/springframework/oxm/jaxb/Jaxb2MarshallerTest.java b/org.springframework.oxm/src/test/java/org/springframework/oxm/jaxb/Jaxb2MarshallerTest.java
index 9172e67d30..cccf427f3c 100644
--- a/org.springframework.oxm/src/test/java/org/springframework/oxm/jaxb/Jaxb2MarshallerTest.java
+++ b/org.springframework.oxm/src/test/java/org/springframework/oxm/jaxb/Jaxb2MarshallerTest.java
@@ -20,7 +20,6 @@ import java.awt.*;
import java.io.ByteArrayOutputStream;
import java.io.StringWriter;
import java.lang.reflect.Method;
-import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.math.BigDecimal;
import java.math.BigInteger;
@@ -47,8 +46,12 @@ import javax.xml.transform.sax.SAXResult;
import javax.xml.transform.stax.StAXResult;
import javax.xml.transform.stream.StreamResult;
-import org.custommonkey.xmlunit.XMLTestCase;
+import static org.custommonkey.xmlunit.XMLAssert.assertXMLEqual;
import static org.easymock.EasyMock.*;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+import org.junit.Before;
+import org.junit.Test;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Text;
@@ -59,271 +62,268 @@ import org.xml.sax.Locator;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;
import org.springframework.oxm.XmlMappingException;
-import org.springframework.oxm.jaxb2.FlightType;
-import org.springframework.oxm.jaxb2.Flights;
-import org.springframework.oxm.jaxb2.ObjectFactory;
import org.springframework.oxm.mime.MimeContainer;
import org.springframework.util.FileCopyUtils;
-import org.springframework.xml.transform.StaxResult;
-import org.springframework.xml.transform.StringResult;
+import org.springframework.util.xml.StaxUtils;
-public class Jaxb2MarshallerTest extends XMLTestCase {
+public class Jaxb2MarshallerTest {
- private static final String CONTEXT_PATH = "org.springframework.oxm.jaxb2";
+ private static final String CONTEXT_PATH = "org.springframework.oxm.jaxb";
- private static final String EXPECTED_STRING =
- "" +
- "42 ";
+ private static final String EXPECTED_STRING =
+ "" +
+ "42 ";
- private Jaxb2Marshaller marshaller;
+ private Jaxb2Marshaller marshaller;
- private Flights flights;
+ private Flights flights;
- protected void setUp() throws Exception {
- marshaller = new Jaxb2Marshaller();
- marshaller.setContextPath(CONTEXT_PATH);
- marshaller.afterPropertiesSet();
- FlightType flight = new FlightType();
- flight.setNumber(42L);
- flights = new Flights();
- flights.getFlight().add(flight);
- }
+ @Before
+ public void createMarshaller() throws Exception {
+ marshaller = new Jaxb2Marshaller();
+ marshaller.setContextPath(CONTEXT_PATH);
+ marshaller.afterPropertiesSet();
+ FlightType flight = new FlightType();
+ flight.setNumber(42L);
+ flights = new Flights();
+ flights.getFlight().add(flight);
+ }
- public void testMarshalDOMResult() throws Exception {
- DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
- DocumentBuilder builder = documentBuilderFactory.newDocumentBuilder();
- Document document = builder.newDocument();
- DOMResult domResult = new DOMResult(document);
- marshaller.marshal(flights, domResult);
- Document expected = builder.newDocument();
- Element flightsElement = expected.createElementNS("http://samples.springframework.org/flight", "tns:flights");
- expected.appendChild(flightsElement);
- Element flightElement = expected.createElementNS("http://samples.springframework.org/flight", "tns:flight");
- flightsElement.appendChild(flightElement);
- Element numberElement = expected.createElementNS("http://samples.springframework.org/flight", "tns:number");
- flightElement.appendChild(numberElement);
- Text text = expected.createTextNode("42");
- numberElement.appendChild(text);
- assertXMLEqual("Marshaller writes invalid DOMResult", expected, document);
- }
+ @Test
+ public void marshalDOMResult() throws Exception {
+ DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
+ DocumentBuilder builder = documentBuilderFactory.newDocumentBuilder();
+ Document document = builder.newDocument();
+ DOMResult domResult = new DOMResult(document);
+ marshaller.marshal(flights, domResult);
+ Document expected = builder.newDocument();
+ Element flightsElement = expected.createElementNS("http://samples.springframework.org/flight", "tns:flights");
+ expected.appendChild(flightsElement);
+ Element flightElement = expected.createElementNS("http://samples.springframework.org/flight", "tns:flight");
+ flightsElement.appendChild(flightElement);
+ Element numberElement = expected.createElementNS("http://samples.springframework.org/flight", "tns:number");
+ flightElement.appendChild(numberElement);
+ Text text = expected.createTextNode("42");
+ numberElement.appendChild(text);
+ assertXMLEqual("Marshaller writes invalid DOMResult", expected, document);
+ }
- public void testMarshalStreamResultWriter() throws Exception {
- StringWriter writer = new StringWriter();
- StreamResult result = new StreamResult(writer);
- marshaller.marshal(flights, result);
- assertXMLEqual("Marshaller writes invalid StreamResult", EXPECTED_STRING, writer.toString());
- }
+ @Test
+ public void marshalStreamResultWriter() throws Exception {
+ StringWriter writer = new StringWriter();
+ StreamResult result = new StreamResult(writer);
+ marshaller.marshal(flights, result);
+ assertXMLEqual("Marshaller writes invalid StreamResult", EXPECTED_STRING, writer.toString());
+ }
- public void testMarshalStreamResultOutputStream() throws Exception {
- ByteArrayOutputStream os = new ByteArrayOutputStream();
- StreamResult result = new StreamResult(os);
- marshaller.marshal(flights, result);
- assertXMLEqual("Marshaller writes invalid StreamResult", EXPECTED_STRING,
- new String(os.toByteArray(), "UTF-8"));
- }
+ @Test
+ public void marshalStreamResultOutputStream() throws Exception {
+ ByteArrayOutputStream os = new ByteArrayOutputStream();
+ StreamResult result = new StreamResult(os);
+ marshaller.marshal(flights, result);
+ assertXMLEqual("Marshaller writes invalid StreamResult", EXPECTED_STRING,
+ new String(os.toByteArray(), "UTF-8"));
+ }
- public void testMarshalStaxResultXMLStreamWriter() throws Exception {
- XMLOutputFactory outputFactory = XMLOutputFactory.newInstance();
- StringWriter writer = new StringWriter();
- XMLStreamWriter streamWriter = outputFactory.createXMLStreamWriter(writer);
- StaxResult result = new StaxResult(streamWriter);
- marshaller.marshal(flights, result);
- assertXMLEqual("Marshaller writes invalid StreamResult", EXPECTED_STRING, writer.toString());
- }
+ @Test
+ public void marshalStaxResultXMLStreamWriter() throws Exception {
+ XMLOutputFactory outputFactory = XMLOutputFactory.newInstance();
+ StringWriter writer = new StringWriter();
+ XMLStreamWriter streamWriter = outputFactory.createXMLStreamWriter(writer);
+ Result result = StaxUtils.createStaxResult(streamWriter);
+ marshaller.marshal(flights, result);
+ assertXMLEqual("Marshaller writes invalid StreamResult", EXPECTED_STRING, writer.toString());
+ }
- public void testMarshalStaxResultXMLEventWriter() throws Exception {
- XMLOutputFactory outputFactory = XMLOutputFactory.newInstance();
- StringWriter writer = new StringWriter();
- XMLEventWriter eventWriter = outputFactory.createXMLEventWriter(writer);
- StaxResult result = new StaxResult(eventWriter);
- marshaller.marshal(flights, result);
- assertXMLEqual("Marshaller writes invalid StreamResult", EXPECTED_STRING, writer.toString());
- }
+ @Test
+ public void marshalStaxResultXMLEventWriter() throws Exception {
+ XMLOutputFactory outputFactory = XMLOutputFactory.newInstance();
+ StringWriter writer = new StringWriter();
+ XMLEventWriter eventWriter = outputFactory.createXMLEventWriter(writer);
+ Result result = StaxUtils.createStaxResult(eventWriter);
+ marshaller.marshal(flights, result);
+ assertXMLEqual("Marshaller writes invalid StreamResult", EXPECTED_STRING, writer.toString());
+ }
- public void testMarshalStaxResultXMLStreamWriterJaxp14() throws Exception {
- XMLOutputFactory outputFactory = XMLOutputFactory.newInstance();
- StringWriter writer = new StringWriter();
- XMLStreamWriter streamWriter = outputFactory.createXMLStreamWriter(writer);
- StAXResult result = new StAXResult(streamWriter);
- marshaller.marshal(flights, result);
- assertXMLEqual("Marshaller writes invalid StreamResult", EXPECTED_STRING, writer.toString());
- }
+ @Test
+ public void marshalStaxResultXMLStreamWriterJaxp14() throws Exception {
+ XMLOutputFactory outputFactory = XMLOutputFactory.newInstance();
+ StringWriter writer = new StringWriter();
+ XMLStreamWriter streamWriter = outputFactory.createXMLStreamWriter(writer);
+ StAXResult result = new StAXResult(streamWriter);
+ marshaller.marshal(flights, result);
+ assertXMLEqual("Marshaller writes invalid StreamResult", EXPECTED_STRING, writer.toString());
+ }
- public void testMarshalStaxResultXMLEventWriterJaxp14() throws Exception {
- XMLOutputFactory outputFactory = XMLOutputFactory.newInstance();
- StringWriter writer = new StringWriter();
- XMLEventWriter eventWriter = outputFactory.createXMLEventWriter(writer);
- StAXResult result = new StAXResult(eventWriter);
- marshaller.marshal(flights, result);
- assertXMLEqual("Marshaller writes invalid StreamResult", EXPECTED_STRING, writer.toString());
- }
+ @Test
+ public void marshalStaxResultXMLEventWriterJaxp14() throws Exception {
+ XMLOutputFactory outputFactory = XMLOutputFactory.newInstance();
+ StringWriter writer = new StringWriter();
+ XMLEventWriter eventWriter = outputFactory.createXMLEventWriter(writer);
+ StAXResult result = new StAXResult(eventWriter);
+ marshaller.marshal(flights, result);
+ assertXMLEqual("Marshaller writes invalid StreamResult", EXPECTED_STRING, writer.toString());
+ }
- public void testProperties() throws Exception {
- Jaxb2Marshaller marshaller = new Jaxb2Marshaller();
- marshaller.setContextPath(CONTEXT_PATH);
- marshaller.setMarshallerProperties(
- Collections.singletonMap(javax.xml.bind.Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE));
- marshaller.afterPropertiesSet();
- }
+ @Test
+ public void properties() throws Exception {
+ Jaxb2Marshaller marshaller = new Jaxb2Marshaller();
+ marshaller.setContextPath(CONTEXT_PATH);
+ marshaller.setMarshallerProperties(
+ Collections.singletonMap(javax.xml.bind.Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE));
+ marshaller.afterPropertiesSet();
+ }
- public void testNoContextPathOrClassesToBeBound() throws Exception {
- try {
- Jaxb2Marshaller marshaller = new Jaxb2Marshaller();
- marshaller.afterPropertiesSet();
- fail("Should have thrown an IllegalArgumentException");
- }
- catch (IllegalArgumentException e) {
- }
- }
+ @Test(expected = IllegalArgumentException.class)
+ public void noContextPathOrClassesToBeBound() throws Exception {
+ Jaxb2Marshaller marshaller = new Jaxb2Marshaller();
+ marshaller.afterPropertiesSet();
+ }
- public void testInvalidContextPath() throws Exception {
- try {
- Jaxb2Marshaller marshaller = new Jaxb2Marshaller();
- marshaller.setContextPath("ab");
- marshaller.afterPropertiesSet();
- fail("Should have thrown an XmlMappingException");
- }
- catch (XmlMappingException ex) {
- }
- }
+ @Test(expected = XmlMappingException.class)
+ public void testInvalidContextPath() throws Exception {
+ Jaxb2Marshaller marshaller = new Jaxb2Marshaller();
+ marshaller.setContextPath("ab");
+ marshaller.afterPropertiesSet();
+ }
- public void testMarshalInvalidClass() throws Exception {
- Jaxb2Marshaller marshaller = new Jaxb2Marshaller();
- marshaller.setClassesToBeBound(new Class[]{FlightType.class});
- marshaller.afterPropertiesSet();
- Result result = new StreamResult(new StringWriter());
- Flights flights = new Flights();
- try {
- marshaller.marshal(flights, result);
- fail("Should have thrown an MarshallingFailureException");
- }
- catch (XmlMappingException ex) {
- // expected
- }
- }
+ @Test(expected = XmlMappingException.class)
+ public void marshalInvalidClass() throws Exception {
+ Jaxb2Marshaller marshaller = new Jaxb2Marshaller();
+ marshaller.setClassesToBeBound(new Class[]{FlightType.class});
+ marshaller.afterPropertiesSet();
+ Result result = new StreamResult(new StringWriter());
+ Flights flights = new Flights();
+ marshaller.marshal(flights, result);
+ }
- public void testMarshalSaxResult() throws Exception {
- ContentHandler handlerMock = createStrictMock(ContentHandler.class);
- handlerMock.setDocumentLocator(isA(Locator.class));
- handlerMock.startDocument();
- handlerMock.startPrefixMapping("", "http://samples.springframework.org/flight");
- handlerMock.startElement(eq("http://samples.springframework.org/flight"), eq("flights"), eq("flights"),
- isA(Attributes.class));
- handlerMock.startElement(eq("http://samples.springframework.org/flight"), eq("flight"), eq("flight"),
- isA(Attributes.class));
- handlerMock.startElement(eq("http://samples.springframework.org/flight"), eq("number"), eq("number"),
- isA(Attributes.class));
- handlerMock.characters(isA(char[].class), eq(0), eq(2));
- handlerMock.endElement("http://samples.springframework.org/flight", "number", "number");
- handlerMock.endElement("http://samples.springframework.org/flight", "flight", "flight");
- handlerMock.endElement("http://samples.springframework.org/flight", "flights", "flights");
- handlerMock.endPrefixMapping("");
- handlerMock.endDocument();
- replay(handlerMock);
+ @Test
+ public void marshalSaxResult() throws Exception {
+ ContentHandler handlerMock = createStrictMock(ContentHandler.class);
+ handlerMock.setDocumentLocator(isA(Locator.class));
+ handlerMock.startDocument();
+ handlerMock.startPrefixMapping("", "http://samples.springframework.org/flight");
+ handlerMock.startElement(eq("http://samples.springframework.org/flight"), eq("flights"), eq("flights"),
+ isA(Attributes.class));
+ handlerMock.startElement(eq("http://samples.springframework.org/flight"), eq("flight"), eq("flight"),
+ isA(Attributes.class));
+ handlerMock.startElement(eq("http://samples.springframework.org/flight"), eq("number"), eq("number"),
+ isA(Attributes.class));
+ handlerMock.characters(isA(char[].class), eq(0), eq(2));
+ handlerMock.endElement("http://samples.springframework.org/flight", "number", "number");
+ handlerMock.endElement("http://samples.springframework.org/flight", "flight", "flight");
+ handlerMock.endElement("http://samples.springframework.org/flight", "flights", "flights");
+ handlerMock.endPrefixMapping("");
+ handlerMock.endDocument();
+ replay(handlerMock);
- SAXResult result = new SAXResult(handlerMock);
- marshaller.marshal(flights, result);
- verify(handlerMock);
- }
+ SAXResult result = new SAXResult(handlerMock);
+ marshaller.marshal(flights, result);
+ verify(handlerMock);
+ }
- public void testSupportsContextPath() throws Exception {
- Method createFlights = ObjectFactory.class.getDeclaredMethod("createFlights");
- assertTrue("Jaxb2Marshaller does not support Flights",
- marshaller.supports(createFlights.getGenericReturnType()));
- Method createFlight = ObjectFactory.class.getDeclaredMethod("createFlight", FlightType.class);
- assertTrue("Jaxb2Marshaller does not support JAXBElement",
- marshaller.supports(createFlight.getGenericReturnType()));
- assertFalse("Jaxb2Marshaller supports non-parameterized JAXBElement", marshaller.supports(JAXBElement.class));
- JAXBElement testElement =
- new JAXBElement(new QName("something"), Jaxb2MarshallerTest.class, null, this);
- assertFalse("Jaxb2Marshaller supports wrong JAXBElement", marshaller.supports(testElement.getClass()));
- }
+ @Test
+ public void supportsContextPath() throws Exception {
+ Method createFlights = ObjectFactory.class.getDeclaredMethod("createFlights");
+ assertTrue("Jaxb2Marshaller does not support Flights",
+ marshaller.supports(createFlights.getGenericReturnType()));
+ Method createFlight = ObjectFactory.class.getDeclaredMethod("createFlight", FlightType.class);
+ assertTrue("Jaxb2Marshaller does not support JAXBElement",
+ marshaller.supports(createFlight.getGenericReturnType()));
+ assertFalse("Jaxb2Marshaller supports non-parameterized JAXBElement", marshaller.supports(JAXBElement.class));
+ JAXBElement testElement =
+ new JAXBElement(new QName("something"), Jaxb2MarshallerTest.class, null, this);
+ assertFalse("Jaxb2Marshaller supports wrong JAXBElement", marshaller.supports(testElement.getClass()));
+ }
- public void testSupportsClassesToBeBound() throws Exception {
- marshaller = new Jaxb2Marshaller();
- marshaller.setClassesToBeBound(new Class[]{Flights.class, FlightType.class});
- marshaller.afterPropertiesSet();
- Method createFlights = ObjectFactory.class.getDeclaredMethod("createFlights");
- assertTrue("Jaxb2Marshaller does not support Flights",
- marshaller.supports(createFlights.getGenericReturnType()));
- Method createFlight = ObjectFactory.class.getDeclaredMethod("createFlight", FlightType.class);
- assertTrue("Jaxb2Marshaller does not support JAXBElement",
- marshaller.supports(createFlight.getGenericReturnType()));
- assertFalse("Jaxb2Marshaller supports non-parameterized JAXBElement", marshaller.supports(JAXBElement.class));
- JAXBElement testElement =
- new JAXBElement(new QName("something"), Jaxb2MarshallerTest.class, null, this);
- assertFalse("Jaxb2Marshaller supports wrong JAXBElement", marshaller.supports(testElement.getClass()));
- }
+ @Test
+ public void supportsClassesToBeBound() throws Exception {
+ marshaller = new Jaxb2Marshaller();
+ marshaller.setClassesToBeBound(new Class[]{Flights.class, FlightType.class});
+ marshaller.afterPropertiesSet();
+ Method createFlights = ObjectFactory.class.getDeclaredMethod("createFlights");
+ assertTrue("Jaxb2Marshaller does not support Flights",
+ marshaller.supports(createFlights.getGenericReturnType()));
+ Method createFlight = ObjectFactory.class.getDeclaredMethod("createFlight", FlightType.class);
+ assertTrue("Jaxb2Marshaller does not support JAXBElement",
+ marshaller.supports(createFlight.getGenericReturnType()));
+ assertFalse("Jaxb2Marshaller supports non-parameterized JAXBElement", marshaller.supports(JAXBElement.class));
+ JAXBElement testElement =
+ new JAXBElement(new QName("something"), Jaxb2MarshallerTest.class, null, this);
+ assertFalse("Jaxb2Marshaller supports wrong JAXBElement", marshaller.supports(testElement.getClass()));
+ }
- public void testSupportsPrimitives() throws Exception {
- Method primitives = getClass().getDeclaredMethod("primitives", JAXBElement.class, JAXBElement.class,
- JAXBElement.class, JAXBElement.class, JAXBElement.class, JAXBElement.class, JAXBElement.class,
- JAXBElement.class);
- Type[] types = primitives.getGenericParameterTypes();
- for (int i = 0; i < types.length; i++) {
- ParameterizedType type = (ParameterizedType) types[i];
- assertTrue("Jaxb2Marshaller does not support " + type, marshaller.supports(types[i]));
- }
- }
+ @Test
+ public void supportsPrimitives() throws Exception {
+ Method primitives = getClass()
+ .getDeclaredMethod("primitives", JAXBElement.class, JAXBElement.class, JAXBElement.class,
+ JAXBElement.class, JAXBElement.class, JAXBElement.class, JAXBElement.class, JAXBElement.class);
+ Type[] types = primitives.getGenericParameterTypes();
+ for (Type type : types) {
+ assertTrue("Jaxb2Marshaller does not support " + type, marshaller.supports(type));
+ }
+ }
- public void testSupportsStandards() throws Exception {
- Method standards = getClass().getDeclaredMethod("standards", JAXBElement.class, JAXBElement.class,
- JAXBElement.class, JAXBElement.class, JAXBElement.class, JAXBElement.class, JAXBElement.class,
- JAXBElement.class, JAXBElement.class, JAXBElement.class, JAXBElement.class, JAXBElement.class,
- JAXBElement.class, JAXBElement.class);
- Type[] types = standards.getGenericParameterTypes();
- for (int i = 0; i < types.length; i++) {
- ParameterizedType type = (ParameterizedType) types[i];
- assertTrue("Jaxb2Marshaller does not support " + type, marshaller.supports(types[i]));
- }
- }
+ @Test
+ public void supportsStandards() throws Exception {
+ Method standards = getClass()
+ .getDeclaredMethod("standards", JAXBElement.class, JAXBElement.class, JAXBElement.class,
+ JAXBElement.class, JAXBElement.class, JAXBElement.class, JAXBElement.class, JAXBElement.class,
+ JAXBElement.class, JAXBElement.class, JAXBElement.class, JAXBElement.class, JAXBElement.class,
+ JAXBElement.class);
+ Type[] types = standards.getGenericParameterTypes();
+ for (Type type : types) {
+ assertTrue("Jaxb2Marshaller does not support " + type, marshaller.supports(type));
+ }
+ }
- public void testMarshalAttachments() throws Exception {
- marshaller = new Jaxb2Marshaller();
- marshaller.setClassesToBeBound(new Class[]{BinaryObject.class});
- marshaller.setMtomEnabled(true);
- marshaller.afterPropertiesSet();
- MimeContainer mimeContainer = createMock(MimeContainer.class);
+ @Test
+ public void marshalAttachments() throws Exception {
+ marshaller = new Jaxb2Marshaller();
+ marshaller.setClassesToBeBound(new Class[]{BinaryObject.class});
+ marshaller.setMtomEnabled(true);
+ marshaller.afterPropertiesSet();
+ MimeContainer mimeContainer = createMock(MimeContainer.class);
- Resource logo = new ClassPathResource("spring-ws.png", getClass());
- DataHandler dataHandler = new DataHandler(new FileDataSource(logo.getFile()));
+ Resource logo = new ClassPathResource("spring-ws.png", getClass());
+ DataHandler dataHandler = new DataHandler(new FileDataSource(logo.getFile()));
- expect(mimeContainer.convertToXopPackage()).andReturn(true);
- mimeContainer.addAttachment(isA(String.class), isA(DataHandler.class));
- expectLastCall().times(3);
+ expect(mimeContainer.convertToXopPackage()).andReturn(true);
+ mimeContainer.addAttachment(isA(String.class), isA(DataHandler.class));
+ expectLastCall().times(3);
- replay(mimeContainer);
- byte[] bytes = FileCopyUtils.copyToByteArray(logo.getInputStream());
- BinaryObject object = new BinaryObject(bytes, dataHandler);
- Result result = new StringResult();
- marshaller.marshal(object, result, mimeContainer);
- verify(mimeContainer);
- assertTrue("No XML written", result.toString().length() > 0);
- }
+ replay(mimeContainer);
+ byte[] bytes = FileCopyUtils.copyToByteArray(logo.getInputStream());
+ BinaryObject object = new BinaryObject(bytes, dataHandler);
+ StringWriter writer = new StringWriter();
+ marshaller.marshal(object, new StreamResult(writer), mimeContainer);
+ verify(mimeContainer);
+ assertTrue("No XML written", writer.toString().length() > 0);
+ }
- private void primitives(JAXBElement bool,
- JAXBElement aByte,
- JAXBElement aShort,
- JAXBElement anInteger,
- JAXBElement aLong,
- JAXBElement aFloat,
- JAXBElement aDouble,
- JAXBElement byteArray) {
- }
+ private void primitives(JAXBElement bool,
+ JAXBElement aByte,
+ JAXBElement aShort,
+ JAXBElement anInteger,
+ JAXBElement aLong,
+ JAXBElement aFloat,
+ JAXBElement aDouble,
+ JAXBElement byteArray) {
+ }
- private void standards(JAXBElement string,
- JAXBElement integer,
- JAXBElement decimal,
- JAXBElement calendar,
- JAXBElement date,
- JAXBElement qName,
- JAXBElement uri,
- JAXBElement xmlGregorianCalendar,
- JAXBElement duration,
- JAXBElement
The Object to be marshalled is supplied as a parameter in the model and then {@linkplain
+ * #locateToBeMarshalled(Map) detected} during response rendering. Users can either specify a specific entry in the
+ * model via the {@link #setModelKey(String) sourceKey} property or have Spring locate the Source object.
+ *
+ * @author Arjen Poutsma
+ * @since 3.0
+ */
+public class MarshallingView extends AbstractUrlBasedView {
+
+ /** Default content type. Overridable as bean property. */
+ public static final String DEFAULT_CONTENT_TYPE = "application/xml";
+
+ private Marshaller marshaller;
+
+ private String modelKey;
+
+ /**
+ * Constructs a new MarshallingView with no {@link Marshaller} set. The marshaller must be set after
+ * construction by invoking {@link #setMarshaller(Marshaller)}.
+ */
+ public MarshallingView() {
+ setContentType(DEFAULT_CONTENT_TYPE);
+ }
+
+ /** Constructs a new MarshallingView with the given {@link Marshaller} set. */
+ public MarshallingView(Marshaller marshaller) {
+ Assert.notNull(marshaller, "'marshaller' must not be null");
+ setContentType(DEFAULT_CONTENT_TYPE);
+ this.marshaller = marshaller;
+ }
+
+ /** Sets the {@link Marshaller} to be used by this view. */
+ public void setMarshaller(Marshaller marshaller) {
+ Assert.notNull(marshaller, "'marshaller' must not be null");
+ this.marshaller = marshaller;
+ }
+
+ /**
+ * Set the name of the model key that represents the object to be marshalled. If not specified, the model map will be
+ * searched for a supported value type.
+ *
+ * @see Marshaller#supports(Class)
+ */
+ public void setModelKey(String modelKey) {
+ this.modelKey = modelKey;
+ }
+
+ @Override
+ protected void initApplicationContext() throws BeansException {
+ Assert.notNull(marshaller, "Property 'marshaller' is required");
+ }
+
+ @Override
+ protected void renderMergedOutputModel(Map model, HttpServletRequest request, HttpServletResponse response)
+ throws Exception {
+ Object toBeMarshalled = locateToBeMarshalled(model);
+ if (toBeMarshalled == null) {
+ throw new ServletException("Unable to locate object to be marshalled in model: " + model);
+ }
+ ByteArrayOutputStream bos = new ByteArrayOutputStream(2048);
+ marshaller.marshal(toBeMarshalled, new StreamResult(bos));
+
+ response.setContentType(getContentType());
+ response.setContentLength(bos.size());
+
+ ServletOutputStream out = response.getOutputStream();
+ bos.writeTo(out);
+ out.flush();
+ }
+
+ /**
+ * Locates the object to be marshalled. The default implementation first attempts to look under the configured
+ * {@linkplain #setModelKey(String) model key}, if any, before attempting to locate an object of {@linkplain
+ * Marshaller#supports(Class) supported type}.
+ *
+ * @param model the model Map
+ * @return the Object to be marshalled (or null if none found)
+ * @throws ServletException if the model object specified by the {@linkplain #setModelKey(String) model key} is not
+ * supported by the marshaller
+ * @see #setModelKey(String)
+ */
+ protected Object locateToBeMarshalled(Map model) throws ServletException {
+ if (this.modelKey != null) {
+ Object o = model.get(this.modelKey);
+ if (!this.marshaller.supports(o.getClass())) {
+ throw new ServletException("Model object [" + o + "] retrieved via key [" + modelKey +
+ "] is not supported by the Marshaller");
+ }
+ return o;
+ }
+ for (Object o : model.values()) {
+ if (this.marshaller.supports(o.getClass())) {
+ return o;
+ }
+ }
+ return null;
+ }
+}
diff --git a/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/xml/package.html b/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/xml/package.html
new file mode 100644
index 0000000000..eccc908c42
--- /dev/null
+++ b/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/xml/package.html
@@ -0,0 +1,7 @@
+
+