Separated the OXM marshalling and unmarshalling transformer

Added source and result factories
This commit is contained in:
Jonas Partner
2008-07-03 19:54:55 +00:00
parent 25bcd05293
commit 36343b4e1d
10 changed files with 328 additions and 96 deletions

View File

@@ -0,0 +1,35 @@
/*
* Copyright 2002-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.integration.xml.result;
import javax.xml.transform.Result;
import javax.xml.transform.dom.DOMResult;
import org.springframework.integration.message.Message;
/**
*
* @author Jonas Partner
*
*/
public class DomResultFactory implements ResultFactory {
public Result getNewResult(Message<?> message) {
return new DOMResult();
}
}

View File

@@ -0,0 +1,33 @@
/*
* Copyright 2002-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.integration.xml.result;
import javax.xml.transform.Result;
import org.springframework.integration.message.Message;
/**
* Factory to create {@link ResultFactory} possibly taking into account the
* passed {@link Message} instance
* @author Jonas Partner
*
*/
public interface ResultFactory {
Result getNewResult(Message<?> message);
}

View File

@@ -0,0 +1,35 @@
/*
* Copyright 2002-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.integration.xml.result;
import javax.xml.transform.Result;
import org.springframework.integration.message.Message;
import org.springframework.xml.transform.StringResult;
/**
*
* @author Jonas Partner
*
*/
public class StringResultFactory implements ResultFactory {
public Result getNewResult(Message<?> message) {
return new StringResult();
}
}

View File

@@ -0,0 +1,33 @@
/*
* Copyright 2002-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.integration.xml.source;
import javax.xml.transform.Source;
import org.springframework.integration.message.Message;
/**
* Factory to create instances of {@link Source} possibly taking into account
* the contents of the passed {@link Message}
* @author Jonas Partner
*
*/
public interface SourceFactory {
Source getSourceForMessage(Message<?> message);
}

View File

@@ -19,21 +19,19 @@ package org.springframework.integration.xml.transformer;
import java.io.IOException;
import javax.xml.transform.Result;
import javax.xml.transform.Source;
import javax.xml.transform.dom.DOMResult;
import org.w3c.dom.Document;
import org.springframework.integration.message.Message;
import org.springframework.integration.message.MessageHandlingException;
import org.springframework.integration.transformer.MessageTransformer;
import org.springframework.integration.xml.result.DomResultFactory;
import org.springframework.integration.xml.result.ResultFactory;
import org.springframework.oxm.Marshaller;
import org.springframework.oxm.Unmarshaller;
import org.springframework.xml.transform.StringResult;
import org.springframework.util.Assert;
/**
* An implementation of {@link MessageTransformer} that delegates to an
* OXM {@link Marshaller} and/or {@link Unmarshaller}.
* An implementation of {@link MessageTransformer} that delegates to an OXM
* {@link Marshaller}
*
* @author Mark Fisher
*/
@@ -41,68 +39,37 @@ public class XmlPayloadMarshallingTransformer implements MessageTransformer {
private final Marshaller marshaller;
private final Unmarshaller unmarshaller;
public XmlPayloadMarshallingTransformer(Marshaller marshaller, Unmarshaller unmarshaller) {
this.marshaller = marshaller;
this.unmarshaller = unmarshaller;
}
private ResultFactory resultFactory = new DomResultFactory();
public XmlPayloadMarshallingTransformer(Marshaller marshaller) {
Assert.notNull(marshaller, " a marshaller is required");
this.marshaller = marshaller;
this.unmarshaller = (marshaller != null && marshaller instanceof Unmarshaller) ?
(Unmarshaller) marshaller : null;
}
public void setResultFactory(ResultFactory resultFactory) {
this.resultFactory = resultFactory;
}
@SuppressWarnings("unchecked")
public void transform(Message message) {
Object transformedPayload = null;
Object originalPayload = message.getPayload();
if (originalPayload instanceof Source) {
if (this.unmarshaller == null) {
throw new MessageHandlingException(message, "no Unmarshaller available");
}
try {
transformedPayload = this.unmarshaller.unmarshal((Source) originalPayload);
}
catch (IOException e) {
throw new MessageHandlingException(message, "failed to unmarshal payload", e);
}
Result result = this.resultFactory.getNewResult(message);
if (result == null) {
throw new MessageHandlingException(message, "Unable to marshall payload, ResultFactory returned null");
}
else {
if (this.marshaller == null) {
throw new MessageHandlingException(message, "no Marshaller available");
}
Result result = this.createResult(originalPayload);
if (result == null) {
throw new MessageHandlingException(message, "Unable to marshal payload; expected ["
+ String.class.getName() + "] or [" + Document.class.getName() + "] but received ["
+ originalPayload.getClass().getName() + "].");
}
try {
this.marshaller.marshal(originalPayload, result);
transformedPayload = result;
}
catch (IOException e) {
throw new MessageHandlingException(message, "failed to marshal payload", e);
}
try {
this.marshaller.marshal(originalPayload, result);
transformedPayload = result;
}
catch (IOException e) {
throw new MessageHandlingException(message, "failed to marshal payload", e);
}
if (transformedPayload == null) {
throw new MessageHandlingException(message, "failed to transform payload");
}
message.setPayload(transformedPayload);
}
protected Result createResult(Object objectToMarshal) {
if (objectToMarshal instanceof String) {
return new StringResult();
}
if (objectToMarshal instanceof Document) {
return new DOMResult();
}
return null;
}
}

View File

@@ -0,0 +1,74 @@
/*
* Copyright 2002-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.integration.xml.transformer;
import java.io.IOException;
import javax.xml.transform.Source;
import org.springframework.integration.message.Message;
import org.springframework.integration.message.MessagingException;
import org.springframework.integration.transformer.MessageTransformer;
import org.springframework.integration.xml.source.SourceFactory;
import org.springframework.oxm.Unmarshaller;
/**
* An implementation of {@link MessageTransformer} that delegates to an OXM
* {@link Unmarshaller}
*
* @author Jonas Partner
*/
public class XmlPayloadUnmarshallingTransfomer implements MessageTransformer {
private final Unmarshaller unmarshaller;
private SourceFactory sourceFactory;
public XmlPayloadUnmarshallingTransfomer(Unmarshaller unmarshaller) {
this.unmarshaller = unmarshaller;
}
public void setSourceFactory(SourceFactory sourceFactory) {
this.sourceFactory = sourceFactory;
}
@SuppressWarnings("unchecked")
public void transform(Message message) {
Source source = null;
if (Source.class.isAssignableFrom(message.getPayload().getClass())) {
source = (Source) message.getPayload();
}
else if (sourceFactory != null) {
source = sourceFactory.getSourceForMessage(message);
}
if (source == null) {
throw new MessagingException(message,
"Could not transform message payload not assignable from javax.xml.transform.Source and no conversion possible");
}
Object unmarshalled;
try {
unmarshalled = unmarshaller.unmarshal(source);
}
catch (IOException ioE) {
throw new MessagingException(message, "Exception unamrshalling payload", ioE);
}
message.setPayload(unmarshalled);
}
}

View File

@@ -43,17 +43,14 @@ public class XsltPayloadTransformer implements MessageTransformer {
private final Templates templates;
public XsltPayloadTransformer(Templates templates) {
this.templates = templates;
}
public XsltPayloadTransformer(Resource xslResource) throws Exception {
this.templates = TransformerFactory.newInstance().newTemplates(new StreamSource(xslResource.getInputStream()));
}
@SuppressWarnings("unchecked")
public void transform(Message message) {
try {
@@ -67,8 +64,8 @@ public class XsltPayloadTransformer implements MessageTransformer {
this.transformString(message);
}
else {
throw new MessagingException(message,
"Unsupported payload type for transformation: " + message.getPayload().getClass().getName());
throw new MessagingException(message, "Unsupported payload type for transformation: "
+ message.getPayload().getClass().getName());
}
}
catch (TransformerException e) {
@@ -92,7 +89,7 @@ public class XsltPayloadTransformer implements MessageTransformer {
@SuppressWarnings("unchecked")
protected void transformDocument(Message message) throws TransformerException {
Document doc = (Document)message.getPayload();
Document doc = (Document) message.getPayload();
DOMResult result = new DOMResult();
this.templates.newTransformer().transform(new DOMSource(doc), result);
message.setPayload(result.getNode());