Interface ApplicationContextAware

All Superinterfaces:
Aware
All Known Implementing Classes:
AbstractAtomFeedView, AbstractCachingViewResolver, AbstractController, AbstractDetectingUrlHandlerMapping, AbstractFeedView, AbstractHandlerMapping, AbstractHandlerMapping, AbstractHandlerMethodAdapter, AbstractHandlerMethodMapping, AbstractHandlerMethodMapping, AbstractJackson2View, AbstractJUnit4SpringContextTests, AbstractMessageBrokerConfiguration, AbstractMethodMessageHandler, AbstractMethodMessageHandler, AbstractPdfStamperView, AbstractPdfView, AbstractRssFeedView, AbstractTemplateView, AbstractTemplateViewResolver, AbstractTestNGSpringContextTests, AbstractTransactionalJUnit4SpringContextTests, AbstractTransactionalTestNGSpringContextTests, AbstractUrlBasedView, AbstractUrlBasedView, AbstractUrlHandlerMapping, AbstractUrlHandlerMapping, AbstractUrlViewController, AbstractView, AbstractView, AbstractXlsView, AbstractXlsxStreamingView, AbstractXlsxView, ApplicationObjectSupport, BeanNameUrlHandlerMapping, BeanNameViewResolver, ContentNegotiatingViewResolver, DelegatingWebFluxConfiguration, DelegatingWebMvcConfiguration, DelegatingWebSocketMessageBrokerConfiguration, DispatcherHandler, DispatcherServlet, EventListenerMethodProcessor, ExceptionHandlerExceptionResolver, FrameworkServlet, FreeMarkerView, FreeMarkerView, FreeMarkerViewResolver, FreeMarkerViewResolver, GroovyMarkupConfigurer, GroovyMarkupView, GroovyMarkupViewResolver, HandlerMappingIntrospector, InternalResourceView, InternalResourceViewResolver, Jackson2ObjectMapperFactoryBean, JmsListenerEndpointRegistry, JobDetailFactoryBean, JstlView, LocalValidatorFactoryBean, MappingJackson2JsonView, MappingJackson2XmlView, MarshallingView, MessageMappingMessageHandler, OptionalValidatorFactoryBean, ParameterizableViewController, RedirectView, RedirectView, RequestMappingHandlerAdapter, RequestMappingHandlerAdapter, RequestMappingHandlerMapping, RequestMappingHandlerMapping, RequestMappingInfoHandlerMapping, RequestMappingInfoHandlerMapping, ResourceBundleViewResolver, ResourceHttpRequestHandler, ResourceUrlProvider, ResourceUrlProvider, RouterFunctionMapping, RouterFunctionMapping, RSocketMessageHandler, ScheduledAnnotationBeanPostProcessor, SchedulerFactoryBean, ScriptTemplateView, ScriptTemplateView, ScriptTemplateViewResolver, ScriptTemplateViewResolver, ServerEndpointExporter, ServletForwardingController, ServletWrappingController, SimpAnnotationMethodMessageHandler, SimpleUrlHandlerMapping, SimpleUrlHandlerMapping, SpringBeanJobFactory, UrlBasedViewResolver, UrlBasedViewResolver, UrlFilenameViewController, ViewResolverComposite, WebApplicationObjectSupport, WebContentGenerator, WebContentInterceptor, WebFluxConfigurationSupport, WebMvcConfigurationSupport, WebSocketAnnotationMethodMessageHandler, WebSocketHandlerMapping, WebSocketMessageBrokerConfigurationSupport, XmlViewResolver, XsltView, XsltViewResolver

public interface ApplicationContextAware extends Aware
Interface to be implemented by any object that wishes to be notified of the ApplicationContext that it runs in.

Implementing this interface makes sense for example when an object requires access to a set of collaborating beans. Note that configuration via bean references is preferable to implementing this interface just for bean lookup purposes.

This interface can also be implemented if an object needs access to file resources, i.e. wants to call getResource, wants to publish an application event, or requires access to the MessageSource. However, it is preferable to implement the more specific ResourceLoaderAware, ApplicationEventPublisherAware or MessageSourceAware interface in such a specific scenario.

Note that file resource dependencies can also be exposed as bean properties of type Resource, populated via Strings with automatic type conversion by the bean factory. This removes the need for implementing any callback interface just for the purpose of accessing a specific file resource.

ApplicationObjectSupport is a convenience base class for application objects, implementing this interface.

For a list of all bean lifecycle methods, see the BeanFactory javadocs.

Author:
Rod Johnson, Juergen Hoeller, Chris Beams
See Also:
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Set the ApplicationContext that this object runs in.