Package org.springframework.integration.support.management

Interface IntegrationManagement

All Superinterfaces:

DisposableBean, NamedComponent

All Known Subinterfaces:

IntegrationInboundManagement

All Known Implementing Classes:

AbstractAmqpChannel, AbstractAmqpOutboundEndpoint, AbstractCorrelatingMessageHandler, AbstractExecutorChannel, AbstractFetchLimitingMessageSource, AbstractHazelcastMessageProducer, AbstractHttpRequestExecutingMessageHandler, AbstractInboundFileSynchronizingMessageSource, AbstractInternetProtocolReceivingChannelAdapter, AbstractInternetProtocolSendingMessageHandler, AbstractJmsChannel, AbstractKafkaChannel, AbstractMappingMessageRouter, AbstractMessageChannel, AbstractMessageHandler, AbstractMessageProducingHandler, AbstractMessageRouter, AbstractMessageSource, AbstractMessageSplitter, AbstractMongoDbMessageSource, AbstractMqttMessageDrivenChannelAdapter, AbstractMqttMessageHandler, AbstractPollableChannel, AbstractReactiveMessageHandler, AbstractRemoteFileOutboundGateway, AbstractRemoteFileStreamingMessageSource, AbstractReplyProducingMessageHandler, AbstractReplyProducingPostProcessingMessageHandler, AbstractSubscribableChannel, AbstractWebServiceInboundGateway, AbstractWebServiceOutboundGateway, AbstractXmppConnectionAwareEndpoint, AbstractXmppConnectionAwareMessageHandler, AggregatingMessageHandler, AmqpInboundChannelAdapter, AmqpInboundGateway, AmqpMessageSource, AmqpOutboundEndpoint, AnnotationGatewayProxyFactoryBean, ApacheCommonsFileTailingMessageProducer, ApplicationEventListeningMessageProducer, ApplicationEventPublishingMessageHandler, AsyncAmqpOutboundGateway, AttributePollingMessageSource, BarrierMessageHandler, BaseHttpInboundEndpoint, BridgeHandler, ByteStreamReadingMessageSource, ByteStreamWritingMessageHandler, CamelMessageHandler, CassandraMessageHandler, CharacterStreamReadingMessageSource, CharacterStreamWritingMessageHandler, ChatMessageListeningEndpoint, ChatMessageSendingMessageHandler, ContentEnricher, CorrelatingMessageBarrier, DefaultMessageSplitter, DelayHandler, DirectChannel, ErrorMessageExceptionTypeRouter, ExecutorChannel, ExpressionEvaluatingMessageHandler, ExpressionEvaluatingMessageSource, ExpressionEvaluatingRouter, ExpressionEvaluatingSplitter, ExpressionMessageProducerSupport, FeedEntryMessageSource, FileReadingMessageSource, FileSplitter, FileTailingMessageProducerSupport, FileTransferringMessageHandler, FileWritingMessageHandler, FluxAggregatorMessageHandler, FluxMessageChannel, FtpInboundFileSynchronizingMessageSource, FtpMessageHandler, FtpOutboundGateway, FtpStreamingMessageSource, GatewayMessageHandler, GatewayProxyFactoryBean, GraphQlMessageHandler, HazelcastCacheWritingMessageHandler, HazelcastClusterMonitorMessageProducer, HazelcastContinuousQueryMessageProducer, HazelcastDistributedSQLMessageSource, HazelcastEventDrivenMessageProducer, HeaderValueRouter, HttpRequestExecutingMessageHandler, HttpRequestHandlingController, HttpRequestHandlingEndpointSupport, HttpRequestHandlingMessagingGateway, ImapIdleChannelAdapter, JdbcMessageHandler, JdbcOutboundGateway, JdbcPollingChannelAdapter, JmsDestinationPollingSource, JmsInboundGateway, JmsMessageDrivenEndpoint, JmsOutboundGateway, JmsSendingMessageHandler, JpaOutboundGateway, JpaPollingChannelAdapter, KafkaInboundGateway, KafkaMessageDrivenChannelAdapter, KafkaMessageSource, KafkaProducerMessageHandler, LoggingHandler, MailReceivingMessageSource, MailSendingMessageHandler, MarshallingWebServiceInboundGateway, MarshallingWebServiceOutboundGateway, MBeanTreePollingMessageSource, MessageFilter, MessageHandlerChain, MessageHandlerSupport, MessageProcessorMessageSource, MessageProducerSupport, MessageTransformingHandler, MessagingGatewaySupport, MethodInvokingMessageHandler, MethodInvokingMessageSource, MethodInvokingRouter, MethodInvokingSplitter, MockMessageHandler, MongoDbChangeStreamMessageProducer, MongoDbMessageSource, MongoDbOutboundGateway, MongoDbStoringMessageHandler, MqttPahoMessageDrivenChannelAdapter, MqttPahoMessageHandler, Mqttv5PahoMessageDrivenChannelAdapter, Mqttv5PahoMessageHandler, MulticastReceivingChannelAdapter, MulticastSendingMessageHandler, NotificationListeningMessageProducer, NotificationPublishingMessageHandler, NullChannel, OperationInvokingMessageHandler, OSDelegatingFileTailingMessageProducer, PartitionedChannel, PayloadTypeRouter, PointToPointSubscribableAmqpChannel, PollableAmqpChannel, PollableJmsChannel, PollableKafkaChannel, PostgresSubscribableChannel, PresenceListeningEndpoint, PresenceSendingMessageHandler, PriorityChannel, PublishSubscribeAmqpChannel, PublishSubscribeChannel, PublishSubscribeKafkaChannel, QueueChannel, R2dbcMessageHandler, R2dbcMessageSource, RabbitStreamMessageHandler, ReactiveMessageSourceProducer, ReactiveMongoDbMessageSource, ReactiveMongoDbStoringMessageHandler, ReactiveRedisStreamMessageHandler, ReactiveRedisStreamMessageProducer, RecipientListRouter, RedisInboundChannelAdapter, RedisOutboundGateway, RedisPublishingMessageHandler, RedisQueueInboundGateway, RedisQueueMessageDrivenEndpoint, RedisQueueOutboundChannelAdapter, RedisQueueOutboundGateway, RedisStoreMessageSource, RedisStoreWritingMessageHandler, RendezvousChannel, ReplyProducingMessageHandlerWrapper, ResequencingMessageHandler, ResourceRetrievingMessageSource, RSocketInboundGateway, RSocketOutboundGateway, ScatterGatherHandler, ScriptExecutingMessageSource, ServiceActivatingHandler, SftpInboundFileSynchronizingMessageSource, SftpMessageHandler, SftpOutboundGateway, SftpStreamingMessageSource, SimpleWebServiceInboundGateway, SimpleWebServiceOutboundGateway, SmbInboundFileSynchronizingMessageSource, SmbMessageHandler, SmbOutboundGateway, SmbStreamingMessageSource, StompInboundChannelAdapter, StompMessageHandler, StoredProcMessageHandler, StoredProcOutboundGateway, StoredProcPollingChannelAdapter, SubscribableJmsChannel, SubscribableKafkaChannel, SubscribableRedisChannel, SyslogReceivingChannelAdapterSupport, TcpInboundGateway, TcpOutboundGateway, TcpReceivingChannelAdapter, TcpSendingMessageHandler, TcpSyslogReceivingChannelAdapter, UdpSyslogReceivingChannelAdapter, UnicastReceivingChannelAdapter, UnicastSendingMessageHandler, UnZipResultSplitter, WebFluxInboundEndpoint, WebFluxRequestExecutingMessageHandler, WebSocketInboundChannelAdapter, WebSocketOutboundMessageHandler, XPathMessageSplitter, XPathRouter, ZeroMqChannel, ZeroMqMessageHandler, ZeroMqMessageProducer

public interface IntegrationManagement
extends NamedComponent, DisposableBean

Base interface for Integration managed components.

Since:

4.2

Author:

Gary Russell, Artem Bilan

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IntegrationManagement.ManagementOverrides	Toggles to inform the management configurer to not set these properties since the user has manually configured them in a bean definition.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METER_PREFIX
static final String	RECEIVE_COUNTER_NAME
static final String	SEND_TIMER_NAME

Method Summary

Modifier and Type	Method	Description
default void	destroy()
default String	getManagedName()
default String	getManagedType()
default IntegrationManagement.ManagementOverrides	getOverrides()	Return the overrides.
default <T> T	getThisAs()	Return this IntegrationManagement as its concrete type.
default boolean	isLoggingEnabled()	Return whether logging is enabled.
default boolean	isObserved()	True if this implementation is going to deal with a registry other than the ObservationRegistry.NOOP instance.
default void	registerMetricsCaptor(MetricsCaptor captor)	Inject a MetricsCaptor.
default void	registerObservationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)	Inject an ObservationRegistry.
default void	setLoggingEnabled(boolean enabled)	Enable logging or not.
default void	setManagedName(String managedName)
default void	setManagedType(String managedType)

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

getBeanName, getComponentName, getComponentType

Field Details

METER_PREFIX

static final String METER_PREFIX

See Also:

• Constant Field Values

SEND_TIMER_NAME

static final String SEND_TIMER_NAME

See Also:

• Constant Field Values

RECEIVE_COUNTER_NAME

static final String RECEIVE_COUNTER_NAME

See Also:

• Constant Field Values

Method Details

setLoggingEnabled

@ManagedAttribute(description="Use to disable debug logging during normal message flow")
default void setLoggingEnabled(boolean enabled)

Enable logging or not.

Parameters:

enabled - false to disable.

isLoggingEnabled

@ManagedAttribute
default boolean isLoggingEnabled()

Return whether logging is enabled.

Returns:

true if enabled.

setManagedName

default void setManagedName(String managedName)

getManagedName

default String getManagedName()

setManagedType

default void setManagedType(String managedType)

getManagedType

default String getManagedType()

getOverrides

@Nullable
default IntegrationManagement.ManagementOverrides getOverrides()

Return the overrides.

Returns:

the overrides.

Since:

5.0

registerMetricsCaptor

default void registerMetricsCaptor(MetricsCaptor captor)

Inject a MetricsCaptor. Ignored if ObservationRegistry is provided.

Parameters:

captor - the captor.

Since:

5.0.4

See Also:

• registerObservationRegistry(ObservationRegistry)

registerObservationRegistry

default void registerObservationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)

Inject an ObservationRegistry. If provided, the MetricsCaptor is ignored. The meters capturing has to be configured as an ObservationHandler on the provided ObservationRegistry.

Parameters:

observationRegistry - the ObservationRegistry to expose observations from the component.

Since:

6.0

See Also:

• registerMetricsCaptor(MetricsCaptor)

isObserved

default boolean isObserved()

True if this implementation is going to deal with a registry other than the ObservationRegistry.NOOP instance.

Returns:

true if this implementation is going to deal with a registry other than the ObservationRegistry.NOOP instance.

Since:

6.0.1

destroy

default void destroy()

Specified by:

destroy in interface DisposableBean

getThisAs

default <T> T getThisAs()

Return this IntegrationManagement as its concrete type.

Type Parameters:

T - the type.

Returns:

this.

Since:

5.4