Interface ComponentSourceAware

All Superinterfaces:
Aware, BeanNameAware
All Known Implementing Classes:
AbstractAmqpChannel, AbstractAmqpOutboundEndpoint, AbstractClientConnectionFactory, AbstractConnectionFactory, AbstractCorrelatingMessageHandler, AbstractEndpoint, AbstractExecutorChannel, AbstractHandleMessageAdvice, AbstractHazelcastMessageProducer, AbstractHttpRequestExecutingMessageHandler, AbstractInternetProtocolReceivingChannelAdapter, AbstractInternetProtocolReceivingChannelAdapter, AbstractInternetProtocolSendingMessageHandler, AbstractInternetProtocolSendingMessageHandler, AbstractJmsChannel, AbstractJmsChannel, AbstractKafkaChannel, AbstractMailReceiver, AbstractMailReceiver, AbstractMappingMessageRouter, AbstractMessageChannel, AbstractMessageHandler, AbstractMessageProcessingTransformer, AbstractMessageProducingHandler, AbstractMessageRouter, AbstractMessageSplitter, AbstractMqttMessageDrivenChannelAdapter, AbstractMqttMessageHandler, AbstractPayloadTransformer, AbstractPollableChannel, AbstractPollingEndpoint, AbstractReactiveMessageHandler, AbstractRemoteFileOutboundGateway, AbstractReplyProducingMessageHandler, AbstractReplyProducingPostProcessingMessageHandler, AbstractRequestHandlerAdvice, AbstractServerConnectionFactory, AbstractSubscribableChannel, AbstractTransformer, AbstractWebServiceInboundGateway, AbstractWebServiceInboundGateway, AbstractWebServiceOutboundGateway, AbstractWebServiceOutboundGateway, AbstractXmlTransformer, AbstractXmppConnectionAwareEndpoint, AbstractXmppConnectionAwareMessageHandler, AbstractZipTransformer, AggregatingMessageHandler, AmqpClientInboundGateway, AmqpClientMessageHandler, AmqpClientMessageProducer, AmqpInboundChannelAdapter, AmqpInboundGateway, AmqpOutboundEndpoint, AnnotationGatewayProxyFactoryBean, ApacheCommonsFileTailingMessageProducer, ApplicationEventListeningMessageProducer, ApplicationEventPublishingMessageHandler, AsyncAmqpOutboundGateway, BarrierMessageHandler, BaseHttpInboundEndpoint, BridgeHandler, ByteStreamWritingMessageHandler, ByteStreamWritingMessageHandler, CacheRequestHandlerAdvice, CachingClientConnectionFactory, CamelMessageHandler, CassandraMessageHandler, CharacterStreamWritingMessageHandler, CharacterStreamWritingMessageHandler, ChatMessageListeningEndpoint, ChatMessageSendingMessageHandler, ClaimCheckInTransformer, ClaimCheckOutTransformer, CodecMessageConverter, ContentEnricher, ContextHolderRequestHandlerAdvice, CorrelatingMessageBarrier, DebeziumMessageProducer, DecodingTransformer, DefaultHeaderChannelRegistry, DefaultMessageSplitter, DelayHandler, DirectChannel, EncodingPayloadTransformer, ErrorMessageExceptionTypeRouter, EventDrivenConsumer, ExecutorChannel, ExpressionEvaluatingMessageHandler, ExpressionEvaluatingRequestHandlerAdvice, ExpressionEvaluatingRouter, ExpressionEvaluatingSplitter, ExpressionEvaluatingTransactionSynchronizationProcessor, ExpressionEvaluatingTransformer, ExpressionMessageProducerSupport, FailoverClientConnectionFactory, FileSplitter, FileTailingMessageProducerSupport, FileTransferringMessageHandler, FileWritingMessageHandler, FileWritingMessageHandler, FluxAggregatorMessageHandler, FluxMessageChannel, FromProtobufTransformer, FtpMessageHandler, FtpOutboundGateway, FtpOutboundGateway, GatewayMessageHandler, GatewayProxyFactoryBean, GraphQlMessageHandler, HazelcastCacheWritingMessageHandler, HazelcastClusterMonitorMessageProducer, HazelcastContinuousQueryMessageProducer, HazelcastEventDrivenMessageProducer, HeaderEnricher, HeaderFilter, HeaderValueRouter, HttpRequestExecutingMessageHandler, HttpRequestHandlingController, HttpRequestHandlingEndpointSupport, HttpRequestHandlingMessagingGateway, IdempotentReceiverInterceptor, ImapIdleChannelAdapter, ImapIdleChannelAdapter, ImapMailReceiver, ImapMailReceiver, IntegrationFlowAdapter, IntegrationObjectSupport, JdbcMessageHandler, JdbcMessageHandler, JdbcOutboundGateway, JdbcOutboundGateway, JmsInboundGateway, JmsInboundGateway, JmsMessageDrivenEndpoint, JmsMessageDrivenEndpoint, JmsOutboundGateway, JmsOutboundGateway, JmsSendingMessageHandler, JmsSendingMessageHandler, JpaOutboundGateway, JsonToObjectTransformer, KafkaInboundGateway, KafkaMessageDrivenChannelAdapter, KafkaProducerMessageHandler, LockRequestHandlerAdvice, LoggingHandler, MailSendingMessageHandler, MailSendingMessageHandler, MapToObjectTransformer, MarshallingTransformer, MarshallingWebServiceInboundGateway, MarshallingWebServiceInboundGateway, MarshallingWebServiceOutboundGateway, MarshallingWebServiceOutboundGateway, MessageFilter, MessageHandlerChain, MessageHandlerSupport, MessageProducerSupport, MessageTransformingHandler, MessagingGatewaySupport, MethodInvokingMessageHandler, MethodInvokingRouter, MethodInvokingSplitter, MethodInvokingTransformer, MockMessageHandler, MongoDbChangeStreamMessageProducer, MongoDbOutboundGateway, MongoDbStoringMessageHandler, MqttPahoMessageDrivenChannelAdapter, MqttPahoMessageHandler, Mqttv5PahoMessageDrivenChannelAdapter, Mqttv5PahoMessageHandler, MulticastReceivingChannelAdapter, MulticastReceivingChannelAdapter, MulticastSendingMessageHandler, MulticastSendingMessageHandler, NotificationListeningMessageProducer, NotificationListeningMessageProducer, NotificationPublishingMessageHandler, NotificationPublishingMessageHandler, ObjectToJsonTransformer, ObjectToMapTransformer, ObjectToStringTransformer, OperationInvokingMessageHandler, OperationInvokingMessageHandler, OSDelegatingFileTailingMessageProducer, PartitionedChannel, PayloadDeserializingTransformer, PayloadSerializingTransformer, PayloadTypeConvertingTransformer, PayloadTypeRouter, PointToPointSubscribableAmqpChannel, PollableAmqpChannel, PollableJmsChannel, PollableJmsChannel, PollableKafkaChannel, PollingConsumer, Pop3MailReceiver, 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, SftpOutboundGateway, SimpleFromAvroTransformer, SimpleToAvroTransformer, SimpleWebServiceInboundGateway, SimpleWebServiceInboundGateway, SimpleWebServiceOutboundGateway, SimpleWebServiceOutboundGateway, SmbMessageHandler, SmbOutboundGateway, SourceCreatingTransformer, SourcePollingChannelAdapter, StandardIntegrationFlow, StompInboundChannelAdapter, StompMessageHandler, StoredProcMessageHandler, StoredProcMessageHandler, StoredProcOutboundGateway, StoredProcOutboundGateway, StreamTransformer, SubscribableJmsChannel, SubscribableJmsChannel, SubscribableKafkaChannel, SubscribableRedisChannel, SyslogReceivingChannelAdapterSupport, SyslogToMapTransformer, TcpInboundGateway, TcpInboundGateway, TcpNetClientConnectionFactory, TcpNetServerConnectionFactory, TcpNioClientConnectionFactory, TcpNioServerConnectionFactory, TcpOutboundGateway, TcpOutboundGateway, TcpReceivingChannelAdapter, TcpReceivingChannelAdapter, TcpSendingMessageHandler, TcpSendingMessageHandler, TcpSyslogReceivingChannelAdapter, ThreadAffinityClientConnectionFactory, ToProtobufTransformer, UdpSyslogReceivingChannelAdapter, UnicastReceivingChannelAdapter, UnicastReceivingChannelAdapter, UnicastSendingMessageHandler, 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:

  • 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

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