Package org.springframework.integration.transformer

Class ClaimCheckOutTransformer

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.transformer.AbstractTransformer

org.springframework.integration.transformer.ClaimCheckOutTransformer

All Implemented Interfaces:

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

public class ClaimCheckOutTransformer
extends AbstractTransformer
implements IntegrationPattern

Transformer that accepts a Message whose payload is a UUID and retrieves the Message associated with that id from a MessageStore if available. An Exception will be thrown if no Message with that ID can be retrieved from the given MessageStore.

Since:

2.0

Author:

Mark Fisher, Oleg Zhurakousky, Nick Spacek, Artem Bilan, Trung Pham

Field Summary

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

EXPRESSION_PARSER, logger

Constructor Summary

Constructors

Constructor	Description
ClaimCheckOutTransformer(MessageStore messageStore)	Create a claim check-out transformer that will delegate to the provided MessageStore.

Method Summary

Modifier and Type	Method	Description
protected Object	doTransform(Message<?> message)	Subclasses must implement this method to provide the transformation logic.
String	getComponentType()	Subclasses may implement this method to provide component type information.
IntegrationPatternType	getIntegrationPatternType()	Return a pattern type this component implements.
void	setRemoveMessage(boolean removeMessage)

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, 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

ClaimCheckOutTransformer

public ClaimCheckOutTransformer(MessageStore messageStore)

Create a claim check-out transformer that will delegate to the provided MessageStore.

Parameters:

messageStore - The message store.

Method Details

setRemoveMessage

public void setRemoveMessage(boolean removeMessage)

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

getIntegrationPatternType

public IntegrationPatternType getIntegrationPatternType()

Description copied from interface: IntegrationPattern

Return a pattern type this component implements.

Specified by:

getIntegrationPatternType in interface IntegrationPattern

Returns:

the IntegrationPatternType this component implements.

doTransform

protected Object doTransform(Message<?> message)

Description copied from class: AbstractTransformer

Subclasses must implement this method to provide the transformation logic. If the return value is itself a Message, it will be used as the result. Otherwise, any non-null return value will be used as the payload of the result Message.

Specified by:

doTransform in class AbstractTransformer

Parameters:

message - The message.

Returns:

The result of the transformation.