Interface ApplicationContextAware
- All Superinterfaces:
Aware
- All Known Implementing Classes:
AbstractAtomFeedView,AbstractCachingViewResolver,AbstractController,AbstractController,AbstractControllerUrlHandlerMapping,AbstractDetectingUrlHandlerMapping,AbstractExcelView,AbstractFeedView,AbstractHandlerMapping,AbstractHandlerMapping,AbstractHandlerMethodAdapter,AbstractHandlerMethodMapping,AbstractJackson2View,AbstractJasperReportsSingleFormatView,AbstractJasperReportsView,AbstractJExcelView,AbstractJUnit4SpringContextTests,AbstractMapBasedHandlerMapping,AbstractMessageBrokerConfiguration,AbstractMethodMessageHandler,AbstractPdfStamperView,AbstractPdfView,AbstractRssFeedView,AbstractTemplateView,AbstractTemplateViewResolver,AbstractTestNGSpringContextTests,AbstractTransactionalJUnit4SpringContextTests,AbstractTransactionalTestNGSpringContextTests,AbstractUrlBasedView,AbstractUrlHandlerMapping,AbstractUrlViewController,AbstractView,AbstractXlsView,AbstractXlsxStreamingView,AbstractXlsxView,AnnotationMethodHandlerAdapter,AnnotationMethodHandlerAdapter,ApplicationObjectSupport,BeanNameUrlHandlerMapping,BeanNameViewResolver,ConfigurableJasperReportsView,ContentNegotiatingViewResolver,ControllerBeanNameHandlerMapping,ControllerClassNameHandlerMapping,DefaultAnnotationHandlerMapping,DefaultAnnotationHandlerMapping,DelegatingWebMvcConfiguration,DelegatingWebSocketMessageBrokerConfiguration,DispatcherServlet,EventListenerMethodProcessor,ExceptionHandlerExceptionResolver,FrameworkServlet,FreeMarkerView,FreeMarkerViewResolver,GroovyMarkupConfigurer,GroovyMarkupView,GroovyMarkupViewResolver,HandlerMappingIntrospector,InternalResourceView,InternalResourceViewResolver,Jackson2ObjectMapperFactoryBean,JasperReportsCsvView,JasperReportsHtmlView,JasperReportsMultiFormatView,JasperReportsPdfView,JasperReportsViewResolver,JasperReportsXlsView,JasperReportsXlsxView,JmsListenerEndpointRegistry,JobDetailFactoryBean,JstlView,LiveBeansView,LocalValidatorFactoryBean,MappingJackson2JsonView,MappingJackson2XmlView,MarshallingView,MultiActionController,OptionalValidatorFactoryBean,ParameterHandlerMapping,ParameterizableViewController,ParameterizableViewController,PortletApplicationObjectSupport,PortletContentGenerator,PortletModeHandlerMapping,PortletModeParameterHandlerMapping,PortletWrappingController,RedirectView,RequestMappingHandlerAdapter,RequestMappingHandlerMapping,RequestMappingInfoHandlerMapping,ResourceBundleViewResolver,ResourceHttpRequestHandler,ScheduledAnnotationBeanPostProcessor,SchedulerFactoryBean,ScriptTemplateView,ScriptTemplateViewResolver,ServerEndpointExporter,ServletContextLiveBeansView,ServletForwardingController,ServletWrappingController,SimpAnnotationMethodMessageHandler,SimpleUrlHandlerMapping,TilesView,TilesView,TilesViewResolver,TilesViewResolver,UrlBasedViewResolver,UrlFilenameViewController,VelocityLayoutView,VelocityLayoutViewResolver,VelocityToolboxView,VelocityView,VelocityViewResolver,ViewResolverComposite,WebApplicationObjectSupport,WebContentGenerator,WebContentInterceptor,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 theApplicationContextthat 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 specificResourceLoaderAware,ApplicationEventPublisherAwareorMessageSourceAwareinterface 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.ApplicationObjectSupportis 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:
ResourceLoaderAware,ApplicationEventPublisherAware,MessageSourceAware,ApplicationObjectSupport,BeanFactoryAware
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidsetApplicationContext(ApplicationContext applicationContext)Set the ApplicationContext that this object runs in.
Method Detail
setApplicationContext
void setApplicationContext(ApplicationContext applicationContext) throws BeansException
Set the ApplicationContext that this object runs in. Normally this call will be used to initialize the object.Invoked after population of normal bean properties but before an init callback such as
InitializingBean.afterPropertiesSet()or a custom init-method. Invoked afterResourceLoaderAware.setResourceLoader(org.springframework.core.io.ResourceLoader),ApplicationEventPublisherAware.setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher)andMessageSourceAware, if applicable.- Parameters:
applicationContext- the ApplicationContext object to be used by this object- Throws:
ApplicationContextException- in case of context initialization errorsBeansException- if thrown by application context methods- See Also:
BeanInitializationException