|
Spring Integration | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.integration.context.IntegrationObjectSupport org.springframework.integration.handler.AbstractMessageHandler org.springframework.integration.handler.AbstractReplyProducingMessageHandler org.springframework.integration.filter.MessageFilter
public class MessageFilter
Message Handler that delegates to a MessageSelector
. If and only if
the selector accepts
the Message, it
will be passed to this filter's output channel. Otherwise the message will
either be silently dropped (the default) or will trigger the throwing of a
MessageRejectedException
depending on the value of its
throwExceptionOnRejection
property. If a discard channel is
provided, the rejected Messages will be sent to that channel.
Field Summary |
---|
Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport |
---|
logger |
Fields inherited from interface org.springframework.core.Ordered |
---|
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE |
Constructor Summary | |
---|---|
MessageFilter(MessageSelector selector)
Create a MessageFilter that will delegate to the given MessageSelector . |
Method Summary | |
---|---|
java.lang.String |
getComponentType()
Subclasses may implement this method to provide component type information. |
protected java.lang.Object |
handleRequestMessage(Message<?> message)
Subclasses must implement this method to handle the request Message. |
void |
onInit()
Subclasses may implement this for initialization logic. |
void |
setDiscardChannel(MessageChannel discardChannel)
Specify a channel where rejected Messages should be sent. |
void |
setThrowExceptionOnRejection(boolean throwExceptionOnRejection)
Specify whether this filter should throw a MessageRejectedException when its selector does not accept a
Message. |
protected boolean |
shouldCopyRequestHeaders()
Subclasses may override this. |
Methods inherited from class org.springframework.integration.handler.AbstractReplyProducingMessageHandler |
---|
getMessagingTemplate, handleMessageInternal, setChannelResolver, setOutputChannel, setRequiresReply, setSendTimeout |
Methods inherited from class org.springframework.integration.handler.AbstractMessageHandler |
---|
getOrder, handleMessage, setOrder, setShouldTrack |
Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport |
---|
afterPropertiesSet, getBeanFactory, getComponentName, getConversionService, getTaskScheduler, setBeanFactory, setBeanName, setComponentName, setConversionService, setTaskScheduler, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.springframework.integration.context.NamedComponent |
---|
getComponentName |
Constructor Detail |
---|
public MessageFilter(MessageSelector selector)
MessageSelector
.
Method Detail |
---|
public void setThrowExceptionOnRejection(boolean throwExceptionOnRejection)
MessageRejectedException
when its selector does not accept a
Message. The default value is false
meaning that rejected
Messages will be quietly dropped or sent to the discard channel if
available. Typically this value would not be true
when
a discard channel is provided, but if so, it will still apply
(in such a case, the Message will be sent to the discard channel,
and
setDiscardChannel(MessageChannel)
public void setDiscardChannel(MessageChannel discardChannel)
setThrowExceptionOnRejection(boolean)
public java.lang.String getComponentType()
IntegrationObjectSupport
getComponentType
in interface NamedComponent
getComponentType
in class AbstractMessageHandler
public final void onInit()
IntegrationObjectSupport
onInit
in class AbstractReplyProducingMessageHandler
protected java.lang.Object handleRequestMessage(Message<?> message)
AbstractReplyProducingMessageHandler
handleRequestMessage
in class AbstractReplyProducingMessageHandler
protected boolean shouldCopyRequestHeaders()
AbstractReplyProducingMessageHandler
shouldCopyRequestHeaders
in class AbstractReplyProducingMessageHandler
|
Spring Integration | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |