Package org.springframework.integration.context

Interface ComponentSourceAware

All Superinterfaces:

Aware, BeanNameAware

All Known Implementing Classes:

AbstractAmqpChannel, AbstractAmqpOutboundEndpoint, AbstractClientConnectionFactory, AbstractConnectionFactory, AbstractCorrelatingMessageHandler, AbstractEndpoint, AbstractExecutorChannel, AbstractHandleMessageAdvice, AbstractHazelcastMessageProducer, AbstractHttpRequestExecutingMessageHandler, AbstractInternetProtocolReceivingChannelAdapter, AbstractInternetProtocolSendingMessageHandler, AbstractJmsChannel, AbstractKafkaChannel, AbstractMailReceiver, AbstractMappingMessageRouter, AbstractMessageChannel, AbstractMessageHandler, AbstractMessageProducingHandler, AbstractMessageRouter, AbstractMessageSplitter, AbstractMqttMessageDrivenChannelAdapter, AbstractMqttMessageHandler, AbstractPayloadTransformer, AbstractPollableChannel, AbstractPollingEndpoint, AbstractReactiveMessageHandler, AbstractRemoteFileOutboundGateway, AbstractReplyProducingMessageHandler, AbstractReplyProducingPostProcessingMessageHandler, AbstractRequestHandlerAdvice, AbstractServerConnectionFactory, AbstractSubscribableChannel, AbstractTransformer, AbstractWebServiceInboundGateway, AbstractWebServiceOutboundGateway, AbstractXmlTransformer, AbstractXmppConnectionAwareEndpoint, AbstractXmppConnectionAwareMessageHandler, AbstractZipTransformer, AggregatingMessageHandler, AmqpInboundChannelAdapter, AmqpInboundGateway, AmqpOutboundEndpoint, AnnotationGatewayProxyFactoryBean, ApacheCommonsFileTailingMessageProducer, ApplicationEventListeningMessageProducer, ApplicationEventPublishingMessageHandler, AsyncAmqpOutboundGateway, BarrierMessageHandler, BaseHttpInboundEndpoint, BridgeHandler, ByteStreamWritingMessageHandler, CacheRequestHandlerAdvice, CachingClientConnectionFactory, CamelMessageHandler, CassandraMessageHandler, CharacterStreamWritingMessageHandler, ChatMessageListeningEndpoint, ChatMessageSendingMessageHandler, ClaimCheckInTransformer, ClaimCheckOutTransformer, CodecMessageConverter, ContentEnricher, ContextHolderRequestHandlerAdvice, CorrelatingMessageBarrier, DebeziumMessageProducer, DecodingTransformer, DefaultHeaderChannelRegistry, DefaultMessageSplitter, DelayHandler, DirectChannel, EncodingPayloadTransformer, ErrorMessageExceptionTypeRouter, EventDrivenConsumer, ExecutorChannel, ExpressionEvaluatingMessageHandler, ExpressionEvaluatingRequestHandlerAdvice, ExpressionEvaluatingRouter, ExpressionEvaluatingSplitter, ExpressionEvaluatingTransactionSynchronizationProcessor, ExpressionMessageProducerSupport, FailoverClientConnectionFactory, FileSplitter, FileTailingMessageProducerSupport, FileTransferringMessageHandler, FileWritingMessageHandler, FluxAggregatorMessageHandler, FluxMessageChannel, FromProtobufTransformer, FtpMessageHandler, FtpOutboundGateway, GatewayMessageHandler, GatewayProxyFactoryBean, GraphQlMessageHandler, HazelcastCacheWritingMessageHandler, HazelcastClusterMonitorMessageProducer, HazelcastContinuousQueryMessageProducer, HazelcastEventDrivenMessageProducer, HeaderEnricher, HeaderFilter, HeaderValueRouter, HttpRequestExecutingMessageHandler, HttpRequestHandlingController, HttpRequestHandlingEndpointSupport, HttpRequestHandlingMessagingGateway, IdempotentReceiverInterceptor, ImapIdleChannelAdapter, ImapMailReceiver, IntegrationFlowAdapter, IntegrationObjectSupport, JdbcMessageHandler, JdbcOutboundGateway, JmsInboundGateway, JmsMessageDrivenEndpoint, JmsOutboundGateway, JmsSendingMessageHandler, JpaOutboundGateway, JsonToObjectTransformer, KafkaInboundGateway, KafkaMessageDrivenChannelAdapter, KafkaProducerMessageHandler, LoggingHandler, MailSendingMessageHandler, MapToObjectTransformer, MarshallingTransformer, MarshallingWebServiceInboundGateway, MarshallingWebServiceOutboundGateway, MessageFilter, MessageHandlerChain, MessageHandlerSupport, MessageProducerSupport, MessageTransformingHandler, MessagingGatewaySupport, MethodInvokingMessageHandler, MethodInvokingRouter, MethodInvokingSplitter, MockMessageHandler, MongoDbChangeStreamMessageProducer, MongoDbOutboundGateway, MongoDbStoringMessageHandler, MqttPahoMessageDrivenChannelAdapter, MqttPahoMessageHandler, Mqttv5PahoMessageDrivenChannelAdapter, Mqttv5PahoMessageHandler, MulticastReceivingChannelAdapter, MulticastSendingMessageHandler, NotificationListeningMessageProducer, NotificationPublishingMessageHandler, ObjectToJsonTransformer, ObjectToMapTransformer, ObjectToStringTransformer, OperationInvokingMessageHandler, OSDelegatingFileTailingMessageProducer, PartitionedChannel, PayloadDeserializingTransformer, PayloadSerializingTransformer, PayloadTypeConvertingTransformer, PayloadTypeRouter, PointToPointSubscribableAmqpChannel, PollableAmqpChannel, PollableJmsChannel, PollableKafkaChannel, PollingConsumer, Pop3MailReceiver, PostgresSubscribableChannel, PresenceListeningEndpoint, PresenceSendingMessageHandler, PriorityChannel, PublishSubscribeAmqpChannel, PublishSubscribeChannel, PublishSubscribeKafkaChannel, QueueChannel, R2dbcMessageHandler, RabbitStreamMessageHandler, RateLimiterRequestHandlerAdvice, ReactiveMessageSourceProducer, ReactiveMongoDbStoringMessageHandler, ReactiveRedisStreamMessageHandler, ReactiveRedisStreamMessageProducer, ReactiveStreamsConsumer, RecipientListRouter, RedisInboundChannelAdapter, RedisOutboundGateway, RedisPublishingMessageHandler, RedisQueueInboundGateway, RedisQueueMessageDrivenEndpoint, RedisQueueOutboundChannelAdapter, RedisQueueOutboundGateway, RedisStoreWritingMessageHandler, RendezvousChannel, ReplyProducingMessageHandlerWrapper, RequestHandlerCircuitBreakerAdvice, RequestHandlerRetryAdvice, ResequencingMessageHandler, RSocketInboundGateway, RSocketOutboundGateway, ScatterGatherHandler, ServiceActivatingHandler, SftpMessageHandler, SftpOutboundGateway, SimpleFromAvroTransformer, SimpleToAvroTransformer, SimpleWebServiceInboundGateway, SimpleWebServiceOutboundGateway, SmbMessageHandler, SmbOutboundGateway, SourceCreatingTransformer, SourcePollingChannelAdapter, StandardIntegrationFlow, StompInboundChannelAdapter, StompMessageHandler, StoredProcMessageHandler, StoredProcOutboundGateway, StreamTransformer, SubscribableJmsChannel, SubscribableKafkaChannel, SubscribableRedisChannel, SyslogReceivingChannelAdapterSupport, SyslogToMapTransformer, TcpInboundGateway, TcpNetClientConnectionFactory, TcpNetServerConnectionFactory, TcpNioClientConnectionFactory, TcpNioServerConnectionFactory, TcpOutboundGateway, TcpReceivingChannelAdapter, TcpSendingMessageHandler, TcpSyslogReceivingChannelAdapter, ThreadAffinityClientConnectionFactory, ToProtobufTransformer, UdpSyslogReceivingChannelAdapter, UnicastReceivingChannelAdapter, UnicastSendingMessageHandler, UnmarshallingTransformer, UnZipResultSplitter, UnZipTransformer, WebFluxInboundEndpoint, WebFluxRequestExecutingMessageHandler, WebSocketInboundChannelAdapter, WebSocketOutboundMessageHandler, XPathHeaderEnricher, XPathMessageSplitter, XPathRouter, XPathTransformer, XsltPayloadTransformer, ZeroMqChannel, ZeroMqMessageHandler, ZeroMqMessageProducer, ZipTransformer

public interface ComponentSourceAware
extends BeanNameAware

The contract to supply and provide useful information about a bean definition (or singleton) source - the place where this bean is declared. Usually populated from a respective BeanDefinition or via Spring Integration infrastructure.

The information from this contract is typically used from exceptions to easy determine the place in the application resources where this bean is declared.

Since:

6.4

Author:

Artem Bilan

See Also:

• BeanDefinition

Method Summary

Modifier and Type	Method	Description
String	getBeanName()	Return the bean name populated by the BeanNameAware.setBeanName(String).
String	getComponentDescription()	Return a human-readable description of this bean.
Object	getComponentSource()	Return the configuration source Object for this bean (maybe null).
void	setComponentDescription(String description)	Set a human-readable description of this bean.
void	setComponentSource(Object source)	Set a configuration source Object for this bean definition.

Methods inherited from interface org.springframework.beans.factory.BeanNameAware

setBeanName

Method Details

setComponentSource

void setComponentSource(Object source)

Set a configuration source Object for this bean definition. For normal BeanDefinition this is supplied by application context automatically. Could be useful when bean is registered at runtime via SingletonBeanRegistry.registerSingleton(String, Object)

Parameters:

source - the configuration source

getComponentSource

@Nullable
Object getComponentSource()

Return the configuration source Object for this bean (maybe null). Usually (if not set explicitly) a BeanMetadataElement.getSource().

Returns:

the configuration source for the bean (if any).

setComponentDescription

void setComponentDescription(String description)

Set a human-readable description of this bean. For normal bean definition a BeanDefinition.getDescription() is used.

Parameters:

description - the bean description

getComponentDescription

@Nullable
String getComponentDescription()

Return a human-readable description of this bean. Usually (if not set explicitly) a BeanDefinition.getDescription().

Returns:

the bean description (if any).

getBeanName

@Nullable
String getBeanName()

Return the bean name populated by the BeanNameAware.setBeanName(String).

Returns:

the bean name.