Package org.springframework.integration.xml.transformer

Class UnmarshallingTransformer

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.transformer.AbstractTransformer

org.springframework.integration.transformer.AbstractPayloadTransformer<Object,Object>

org.springframework.integration.xml.transformer.UnmarshallingTransformer

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, ExpressionCapable, NamedComponent, GenericTransformer<Message<?>,Message<?>>, Transformer

public class UnmarshallingTransformer
extends AbstractPayloadTransformer<Object,Object>

An implementation of Transformer that delegates to an OXM Unmarshaller. Expects the payload to be of type Document, String, File, Source or to have an instance of SourceFactory that can convert to a Source. If alwaysUseSourceFactory is set to true, then the SourceFactory will be used to create the Source regardless of payload type.

The alwaysUseSourceFactory is ignored if payload is MimeMessage.

The Unmarshaller may return a Message, but if the return value is not already a Message instance, a new Message will be created with that return value as its payload.

Author:

Jonas Partner, Artem Bilan, Gary Russell

Field Summary

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

EXPRESSION_PARSER, logger

Constructor Summary

Constructors

Constructor	Description
UnmarshallingTransformer(Unmarshaller unmarshaller)

Method Summary

Modifier and Type	Method	Description
String	getComponentType()	Subclasses may implement this method to provide component type information.
void	setAlwaysUseSourceFactory(boolean alwaysUseSourceFactory)	If true always delegate to the SourceFactory.
void	setSourceFactory(SourceFactory sourceFactory)	Provide the SourceFactory to be used.
Object	transformPayload(Object payload)

Methods inherited from class org.springframework.integration.transformer.AbstractPayloadTransformer

doTransform

Methods inherited from class org.springframework.integration.transformer.AbstractTransformer

transform

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, onInit, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

Constructor Details

UnmarshallingTransformer

public UnmarshallingTransformer(Unmarshaller unmarshaller)

Method Details

setSourceFactory

public void setSourceFactory(SourceFactory sourceFactory)

Provide the SourceFactory to be used. Must not be null.

Parameters:

sourceFactory - The source factory.

setAlwaysUseSourceFactory

public void setAlwaysUseSourceFactory(boolean alwaysUseSourceFactory)

If true always delegate to the SourceFactory.

Parameters:

alwaysUseSourceFactory - true to always use the source factory.

getComponentType

public String getComponentType()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this method to provide component type information.

Specified by:

getComponentType in interface NamedComponent

Overrides:

getComponentType in class IntegrationObjectSupport

transformPayload

public Object transformPayload(Object payload)

Specified by:

transformPayload in class AbstractPayloadTransformer<Object,Object>