Class AbstractJmsChannel

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.channel.AbstractMessageChannel

org.springframework.integration.jms.channel.AbstractJmsChannel

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, ComponentSourceAware, ExpressionCapable, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent, MessageChannel, InterceptableChannel

Direct Known Subclasses:

PollableJmsChannel, SubscribableJmsChannel

public abstract class AbstractJmsChannel
extends AbstractMessageChannel

A base AbstractMessageChannel implementation for JMS-backed message channels.

Since:

7.0

Author:

Mark Fisher, Gary Russell, Artem Bilan, Glenn Renfro

See Also:

• PollableJmsChannel
• SubscribableJmsChannel

Nested Class Summary

Nested classes/interfaces inherited from class AbstractMessageChannel

AbstractMessageChannel.ChannelInterceptorList

Nested classes/interfaces inherited from interface IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields

Modifier and Type	Field	Description
protected final JmsTemplate	jmsTemplate

Fields inherited from class AbstractMessageChannel

interceptors, meters

Fields inherited from class IntegrationObjectSupport

EXPRESSION_PARSER, logger

Fields inherited from interface IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Fields inherited from interface MessageChannel

INDEFINITE_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
AbstractJmsChannel(JmsTemplate jmsTemplate)

Method Summary

Modifier and Type	Method	Description
protected boolean	doSend(Message<?> message, long timeout)	Subclasses must implement this method.
protected Message<?>	fromJmsMessage(Message message)
protected JmsHeaderMapper	getHeaderMapper()	Get the mapper for the channel.
void	setHeaderMapper(JmsHeaderMapper headerMapper)	Set the mapper for the channel.

Methods inherited from class AbstractMessageChannel

addInterceptor, addInterceptor, destroy, getComponentType, getFullChannelName, getIChannelInterceptorList, getIntegrationPatternType, getInterceptors, getMetricsCaptor, getOverrides, isApplicationRunning, isLoggingEnabled, isObserved, onInit, registerMetricsCaptor, registerObservationRegistry, removeInterceptor, removeInterceptor, send, send, setDatatypes, setInterceptors, setLoggingEnabled, setMessageConverter, setObservationConvention, setShouldTrack

Methods inherited from class IntegrationObjectSupport

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

Methods inherited from class Object

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

Methods inherited from interface IntegrationManagement

getManagedName, getManagedType, getThisAs, setManagedName, setManagedType

Methods inherited from interface NamedComponent

getBeanName, getComponentName

Field Details

jmsTemplate

protected final JmsTemplate jmsTemplate

Constructor Details

AbstractJmsChannel

public AbstractJmsChannel(JmsTemplate jmsTemplate)

Method Details

setHeaderMapper

public void setHeaderMapper(JmsHeaderMapper headerMapper)

Set the mapper for the channel.

Parameters:

headerMapper - the JmsHeaderMapper to use

Since:

5.5.22

getHeaderMapper

protected JmsHeaderMapper getHeaderMapper()

Get the mapper for the channel.

Returns:

headerMapper

Since:

5.5.22

doSend

protected boolean doSend(Message<?> message,
 long timeout)

Description copied from class: AbstractMessageChannel

Subclasses must implement this method. A non-negative timeout indicates how long to wait if the channel is at capacity (if the value is 0, it must return immediately with or without success). A negative timeout value indicates that the method should block until either the message is accepted or the blocking thread is interrupted.

Specified by:

doSend in class AbstractMessageChannel

Parameters:

message - The message.

timeout - The timeout.

Returns:

true if the send was successful.

fromJmsMessage

protected Message<?> fromJmsMessage(Message message)