org.springframework.integration.xml.router

Class XPathRouter

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.router.AbstractMessageRouter

org.springframework.integration.router.AbstractMappingMessageRouter

org.springframework.integration.xml.router.XPathRouter

All Implemented Interfaces:

org.reactivestreams.Subscriber<org.springframework.messaging.Message<?>>, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered, ExpressionCapable, Orderable, MessageRouter, NamedComponent, ConfigurableMetricsAware<AbstractMessageHandlerMetrics>, IntegrationManagement, IntegrationStatsManagement, MappingMessageRouterManagement, MessageHandlerMetrics, TrackableComponent, org.springframework.messaging.MessageHandler, reactor.core.CoreSubscriber<org.springframework.messaging.Message<?>>

public class XPathRouter
extends AbstractMappingMessageRouter

Message Router that uses XPathExpression evaluation to determine channel names.

Author:

Jonas Partner, Oleg Zhurakousky

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class org.springframework.integration.router.AbstractMappingMessageRouter

channelMappings

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

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
XPathRouter(java.lang.String expression) Create a router that uses an XPath expression with no namespaces.
XPathRouter(java.lang.String expression, java.util.Map<java.lang.String,java.lang.String> namespaces) Create a router that uses an XPath expression.
XPathRouter(java.lang.String expression, java.lang.String prefix, java.lang.String namespace) Create a router uses an XPath expression with one namespace.
XPathRouter(org.springframework.xml.xpath.XPathExpression expression) Create a router that uses the provided XPath expression.

Method Summary

Modifier and Type	Method and Description
protected java.util.List<java.lang.Object>	getChannelKeys(org.springframework.messaging.Message<?> message) Subclasses must implement this method to return the channel keys.
java.lang.String	getComponentType() Subclasses may implement this method to provide component type information.
void	setConverter(XmlPayloadConverter converter) Specify the Converter to use when converting payloads prior to XPath evaluation.
void	setEvaluateAsString(boolean evaluateAsString)

Methods inherited from class org.springframework.integration.router.AbstractMappingMessageRouter

determineTargetChannels, getChannelMappings, getDynamicChannelNames, removeChannelMapping, replaceChannelMappings, setChannelMapping, setChannelMappings, setDynamicChannelLimit, setPrefix, setResolutionRequired, setSuffix

Methods inherited from class org.springframework.integration.router.AbstractMessageRouter

getDefaultOutputChannel, getMessagingTemplate, getRequiredConversionService, handleMessageInternal, onInit, setApplySequence, setDefaultOutputChannel, setDefaultOutputChannelName, setIgnoreSendFailures, setSendTimeout

Methods inherited from class org.springframework.integration.handler.AbstractMessageHandler

configureMetrics, destroy, getActiveCount, getActiveCountLong, getDuration, getErrorCount, getErrorCountLong, getHandleCount, getHandleCountLong, getManagedName, getManagedType, getMaxDuration, getMeanDuration, getMinDuration, getOrder, getOverrides, getStandardDeviationDuration, handleMessage, isCountsEnabled, isLoggingEnabled, isStatsEnabled, onComplete, onError, onNext, onSubscribe, registerMetricsCaptor, reset, setCountsEnabled, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, setStatsEnabled

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

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanFactory, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, 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

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getComponentName

Methods inherited from interface reactor.core.CoreSubscriber

currentContext

Constructor Detail

XPathRouter

public XPathRouter(java.lang.String expression,
                   java.util.Map<java.lang.String,java.lang.String> namespaces)

Create a router that uses an XPath expression. The expression may contain zero or more namespace prefixes.

Parameters:

expression - the XPath expression as a String

namespaces - map of namespaces with prefixes as the map keys

XPathRouter

public XPathRouter(java.lang.String expression,
                   java.lang.String prefix,
                   java.lang.String namespace)

Create a router uses an XPath expression with one namespace. For example, expression='/ns1:one/@type' prefix='ns1' namespace='www.example.org'

Parameters:

expression - the XPath expression as a String

prefix - namespace prefix

namespace - namespace uri

XPathRouter

public XPathRouter(java.lang.String expression)

Create a router that uses an XPath expression with no namespaces. For example '/one/@type'

Parameters:

expression - the XPath expression as a String

XPathRouter

public XPathRouter(org.springframework.xml.xpath.XPathExpression expression)

Create a router that uses the provided XPath expression.

Parameters:

expression - the XPath expression

Method Detail

setEvaluateAsString

public void setEvaluateAsString(boolean evaluateAsString)

setConverter

public void setConverter(XmlPayloadConverter converter)

Specify the Converter to use when converting payloads prior to XPath evaluation.

Parameters:

converter - The payload converter.

getComponentType

public java.lang.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 AbstractMessageRouter

getChannelKeys

protected java.util.List<java.lang.Object> getChannelKeys(org.springframework.messaging.Message<?> message)

Description copied from class: AbstractMappingMessageRouter

Subclasses must implement this method to return the channel keys. A "key" might be present in this router's "channelMappings", or it could be the channel's name or even the Message Channel instance itself.

Specified by:

getChannelKeys in class AbstractMappingMessageRouter

Parameters:

message - The message.

Returns:

The channel keys.