@IntegrationManagedResource public abstract class AbstractMessageChannel extends IntegrationObjectSupport implements MessageChannel, TrackableComponent, InterceptableChannel, MessageChannelMetrics, ConfigurableMetricsAware<AbstractMessageChannelMetrics>, IntegrationPattern
MessageChannel
implementations providing common
properties such as the channel name. Also provides the common functionality
for sending and receiving Messages
including the invocation
of any ChannelInterceptors
.Modifier and Type | Class and Description |
---|---|
protected static class |
AbstractMessageChannel.ChannelInterceptorList
A convenience wrapper class for the list of ChannelInterceptors.
|
IntegrationManagement.ManagementOverrides
Modifier and Type | Field and Description |
---|---|
protected AbstractMessageChannel.ChannelInterceptorList |
interceptors |
protected Set<MeterFacade> |
meters |
EXPRESSION_PARSER, logger
INDEFINITE_TIMEOUT
METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME
Constructor and Description |
---|
AbstractMessageChannel() |
Modifier and Type | Method and Description |
---|---|
void |
addInterceptor(ChannelInterceptor interceptor)
Add a channel interceptor to the end of the list.
|
void |
addInterceptor(int index,
ChannelInterceptor interceptor)
Add a channel interceptor to the specified index of the list.
|
void |
configureMetrics(AbstractMessageChannelMetrics metrics)
Deprecated.
in favor of Micrometer metrics.
|
void |
destroy() |
protected abstract boolean |
doSend(Message<?> message,
long timeout)
Subclasses must implement this method.
|
String |
getComponentType()
Subclasses may implement this method to provide component type information.
|
Statistics |
getErrorRate()
Deprecated.
in favor of Micrometer metrics.
|
String |
getFullChannelName()
Returns the fully qualified channel name including the application context
id, if available.
|
protected AbstractMessageChannel.ChannelInterceptorList |
getIChannelInterceptorList()
Exposes the interceptor list instance for subclasses.
|
IntegrationPatternType |
getIntegrationPatternType()
Return a pattern type this component implements.
|
List<ChannelInterceptor> |
getInterceptors()
Return a read-only list of the configured interceptors.
|
double |
getMaxSendDuration()
Deprecated.
in favor of Micrometer metrics.
|
double |
getMeanErrorRate()
Deprecated.
in favor of Micrometer metrics.
|
double |
getMeanErrorRatio()
Deprecated.
in favor of Micrometer metrics.
|
double |
getMeanSendDuration()
Deprecated.
in favor of Micrometer metrics.
|
double |
getMeanSendRate()
Deprecated.
in favor of Micrometer metrics.
|
protected AbstractMessageChannelMetrics |
getMetrics()
Deprecated.
in favor of Micrometer metrics.
|
protected MetricsCaptor |
getMetricsCaptor() |
double |
getMinSendDuration()
Deprecated.
in favor of Micrometer metrics.
|
IntegrationManagement.ManagementOverrides |
getOverrides()
Return the overrides.
|
int |
getSendCount()
Deprecated.
in favor of Micrometer metrics.
|
long |
getSendCountLong()
Deprecated.
in favor of Micrometer metrics.
|
Statistics |
getSendDuration()
Deprecated.
in favor of Micrometer metrics.
|
int |
getSendErrorCount()
Deprecated.
in favor of Micrometer metrics.
|
long |
getSendErrorCountLong()
Deprecated.
in favor of Micrometer metrics.
|
Statistics |
getSendRate()
Deprecated.
in favor of Micrometer metrics.
|
double |
getStandardDeviationSendDuration()
Deprecated.
in favor of Micrometer metrics.
|
double |
getTimeSinceLastSend()
Deprecated.
in favor of Micrometer metrics.
|
boolean |
isCountsEnabled()
Deprecated.
|
boolean |
isLoggingEnabled() |
boolean |
isStatsEnabled() |
protected void |
onInit()
Subclasses may implement this for initialization logic.
|
void |
registerMetricsCaptor(MetricsCaptor metricsCaptorToRegister)
Inject a
MetricsCaptor |
boolean |
removeInterceptor(ChannelInterceptor interceptor) |
ChannelInterceptor |
removeInterceptor(int index) |
void |
reset()
Deprecated.
in favor of Micrometer metrics.
|
boolean |
send(Message<?> message)
Send a message on this channel.
|
boolean |
send(Message<?> messageArg,
long timeout)
Send a message on this channel.
|
void |
setCountsEnabled(boolean countsEnabled)
Deprecated.
|
void |
setDatatypes(Class<?>... datatypes)
Specify the Message payload datatype(s) supported by this channel.
|
void |
setInterceptors(List<ChannelInterceptor> interceptors)
Set the list of channel interceptors.
|
void |
setLoggingEnabled(boolean loggingEnabled) |
void |
setMessageConverter(MessageConverter messageConverter)
Specify the
MessageConverter to use when trying to convert to
one of this channel's supported datatypes (in order) for a Message whose payload
does not already match. |
void |
setShouldTrack(boolean shouldTrack) |
void |
setStatsEnabled(boolean statsEnabled) |
afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getBeanName, getComponentName
sendCount, sendErrorCount
protected final AbstractMessageChannel.ChannelInterceptorList interceptors
protected final Set<MeterFacade> meters
public String getComponentType()
IntegrationObjectSupport
getComponentType
in interface NamedComponent
getComponentType
in class IntegrationObjectSupport
public IntegrationPatternType getIntegrationPatternType()
IntegrationPattern
getIntegrationPatternType
in interface IntegrationPattern
IntegrationPatternType
this component implements.public void setShouldTrack(boolean shouldTrack)
setShouldTrack
in interface TrackableComponent
public void registerMetricsCaptor(MetricsCaptor metricsCaptorToRegister)
IntegrationManagement
MetricsCaptor
registerMetricsCaptor
in interface IntegrationManagement
metricsCaptorToRegister
- the captor.@Nullable protected MetricsCaptor getMetricsCaptor()
public void setCountsEnabled(boolean countsEnabled)
IntegrationManagement
setCountsEnabled
in interface IntegrationManagement
countsEnabled
- the countsEnabledpublic boolean isCountsEnabled()
IntegrationManagement
isCountsEnabled
in interface IntegrationManagement
public void setStatsEnabled(boolean statsEnabled)
setStatsEnabled
in interface IntegrationStatsManagement
public boolean isStatsEnabled()
isStatsEnabled
in interface IntegrationStatsManagement
public boolean isLoggingEnabled()
isLoggingEnabled
in interface IntegrationManagement
public void setLoggingEnabled(boolean loggingEnabled)
setLoggingEnabled
in interface IntegrationManagement
@Deprecated protected AbstractMessageChannelMetrics getMetrics()
@Deprecated public void configureMetrics(AbstractMessageChannelMetrics metrics)
configureMetrics
in interface ConfigurableMetricsAware<AbstractMessageChannelMetrics>
metrics
- the metricspublic void setDatatypes(Class<?>... datatypes)
If this property is not set explicitly, any Message payload type will be accepted.
datatypes
- The supported data types.setMessageConverter(MessageConverter)
public void setInterceptors(List<ChannelInterceptor> interceptors)
setInterceptors
in interface InterceptableChannel
interceptors
- The list of interceptors.public void addInterceptor(ChannelInterceptor interceptor)
addInterceptor
in interface InterceptableChannel
interceptor
- The interceptor.public void addInterceptor(int index, ChannelInterceptor interceptor)
addInterceptor
in interface InterceptableChannel
index
- The index to add interceptor.interceptor
- The interceptor.public void setMessageConverter(MessageConverter messageConverter)
MessageConverter
to use when trying to convert to
one of this channel's supported datatypes (in order) for a Message whose payload
does not already match.
Note: only the MessageConverter.fromMessage(Message, Class)
method is used. If the returned object is not a Message
, the inbound
headers will be copied; if the returned object is a Message
, it is
expected that the converter will have fully populated the headers; no
further action is performed by the channel. If null
is returned,
conversion to the next datatype (if any) will be attempted.
Defaults to a
DefaultDatatypeChannelMessageConverter
.
messageConverter
- The message converter.public List<ChannelInterceptor> getInterceptors()
getInterceptors
in interface InterceptableChannel
public boolean removeInterceptor(ChannelInterceptor interceptor)
removeInterceptor
in interface InterceptableChannel
@Nullable public ChannelInterceptor removeInterceptor(int index)
removeInterceptor
in interface InterceptableChannel
protected AbstractMessageChannel.ChannelInterceptorList getIChannelInterceptorList()
@Deprecated public void reset()
reset
in interface IntegrationManagement
@Deprecated public int getSendCount()
getSendCount
in interface MessageChannelMetrics
@Deprecated public long getSendCountLong()
getSendCountLong
in interface MessageChannelMetrics
@Deprecated public int getSendErrorCount()
getSendErrorCount
in interface MessageChannelMetrics
@Deprecated public long getSendErrorCountLong()
getSendErrorCountLong
in interface MessageChannelMetrics
@Deprecated public double getTimeSinceLastSend()
getTimeSinceLastSend
in interface MessageChannelMetrics
@Deprecated public double getMeanSendRate()
getMeanSendRate
in interface MessageChannelMetrics
@Deprecated public double getMeanErrorRate()
getMeanErrorRate
in interface MessageChannelMetrics
@Deprecated public double getMeanErrorRatio()
getMeanErrorRatio
in interface MessageChannelMetrics
@Deprecated public double getMeanSendDuration()
getMeanSendDuration
in interface MessageChannelMetrics
@Deprecated public double getMinSendDuration()
getMinSendDuration
in interface MessageChannelMetrics
@Deprecated public double getMaxSendDuration()
getMaxSendDuration
in interface MessageChannelMetrics
@Deprecated public double getStandardDeviationSendDuration()
getStandardDeviationSendDuration
in interface MessageChannelMetrics
@Deprecated public Statistics getSendDuration()
getSendDuration
in interface MessageChannelMetrics
@Deprecated public Statistics getSendRate()
getSendRate
in interface MessageChannelMetrics
@Deprecated public Statistics getErrorRate()
getErrorRate
in interface MessageChannelMetrics
public IntegrationManagement.ManagementOverrides getOverrides()
IntegrationManagement
getOverrides
in interface IntegrationManagement
protected void onInit()
IntegrationObjectSupport
onInit
in class IntegrationObjectSupport
public String getFullChannelName()
public boolean send(Message<?> message)
send
in interface MessageChannel
message
- the Message to sendtrue
if the message is sent successfully or
false
if the sending thread is interrupted.public boolean send(Message<?> messageArg, long timeout)
send(Message)
).send
in interface MessageChannel
messageArg
- the Message to sendtimeout
- the timeout in millisecondstrue
if the message is sent successfully,
false
if the message cannot be sent within the allotted
time or the sending thread is interrupted.protected abstract boolean doSend(Message<?> message, long timeout)
message
- The message.timeout
- The timeout.public void destroy()
destroy
in interface DisposableBean
destroy
in interface IntegrationManagement