Class AbstractGenericWebContextLoader

Field Detail

• logger

  protected static final Log logger

Constructor Detail

• AbstractGenericWebContextLoader

  public AbstractGenericWebContextLoader()

Method Detail

• loadContext

  public final ConfigurableApplicationContext loadContext​(MergedContextConfiguration mergedConfig)
                                                   throws Exception

  Load a Spring WebApplicationContext from the supplied MergedContextConfiguration.

  Implementation details:

  • Calls validateMergedContextConfiguration(WebMergedContextConfiguration) to allow subclasses to validate the supplied configuration before proceeding.
  • Creates a GenericWebApplicationContext instance.
  • If the supplied MergedContextConfiguration references a parent configuration, the corresponding ApplicationContext will be retrieved and set as the parent for the context created by this method.
  • Delegates to configureWebResources(org.springframework.web.context.support.GenericWebApplicationContext, org.springframework.test.context.web.WebMergedContextConfiguration) to create the MockServletContext and set it in the WebApplicationContext.
  • Calls AbstractContextLoader.prepareContext(org.springframework.context.ConfigurableApplicationContext, org.springframework.test.context.MergedContextConfiguration) to allow for customizing the context before bean definitions are loaded.
  • Calls customizeBeanFactory(org.springframework.beans.factory.support.DefaultListableBeanFactory, org.springframework.test.context.web.WebMergedContextConfiguration) to allow for customizing the context's DefaultListableBeanFactory.
  • Delegates to loadBeanDefinitions(org.springframework.web.context.support.GenericWebApplicationContext, org.springframework.test.context.web.WebMergedContextConfiguration) to populate the context from the locations or classes in the supplied MergedContextConfiguration.
  • Delegates to AnnotationConfigUtils for registering annotation configuration processors.
  • Calls customizeContext(org.springframework.web.context.support.GenericWebApplicationContext, org.springframework.test.context.web.WebMergedContextConfiguration) to allow for customizing the context before it is refreshed.
  • Refreshes the context and registers a JVM shutdown hook for it.

  Parameters:

  mergedConfig - the merged context configuration to use to load the application context

  Returns:

  a new web application context

  Throws:

  Exception - if context loading failed

  See Also:

  SmartContextLoader.loadContext(MergedContextConfiguration), GenericWebApplicationContext

• validateMergedContextConfiguration

  protected void validateMergedContextConfiguration​(WebMergedContextConfiguration mergedConfig)

  Validate the supplied WebMergedContextConfiguration with respect to what this context loader supports.

  The default implementation is a no-op but can be overridden by subclasses as appropriate.

  Parameters:

  mergedConfig - the merged configuration to validate

  Throws:

  IllegalStateException - if the supplied configuration is not valid for this context loader

  Since:

  4.0.4

• configureWebResources

  protected void configureWebResources​(GenericWebApplicationContext context,
                                       WebMergedContextConfiguration webMergedConfig)

  Configures web resources for the supplied web application context (WAC).

  Implementation Details

  If the supplied WAC has no parent or its parent is not a WAC, the supplied WAC will be configured as the Root WAC (see "Root WAC Configuration" below).

  Otherwise the context hierarchy of the supplied WAC will be traversed to find the top-most WAC (i.e., the root); and the ServletContext of the Root WAC will be set as the ServletContext for the supplied WAC.

  Root WAC Configuration

  • The resource base path is retrieved from the supplied WebMergedContextConfiguration.
  • A ResourceLoader is instantiated for the MockServletContext: if the resource base path is prefixed with "classpath:", a DefaultResourceLoader will be used; otherwise, a FileSystemResourceLoader will be used.
  • A MockServletContext will be created using the resource base path and resource loader.
  • The supplied GenericWebApplicationContext is then stored in the MockServletContext under the WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE key.
  • Finally, the MockServletContext is set in the WebApplicationContext.

  Parameters:

  context - the web application context for which to configure the web resources

  webMergedConfig - the merged context configuration to use to load the web application context

• customizeBeanFactory

  protected void customizeBeanFactory​(DefaultListableBeanFactory beanFactory,
                                      WebMergedContextConfiguration webMergedConfig)

  Customize the internal bean factory of the WebApplicationContext created by this context loader.

  The default implementation is empty but can be overridden in subclasses to customize DefaultListableBeanFactory's standard settings.

  Parameters:

  beanFactory - the bean factory created by this context loader

  webMergedConfig - the merged context configuration to use to load the web application context

  See Also:

  loadContext(MergedContextConfiguration), DefaultListableBeanFactory.setAllowBeanDefinitionOverriding(boolean), DefaultListableBeanFactory.setAllowEagerClassLoading(boolean), AbstractAutowireCapableBeanFactory.setAllowCircularReferences(boolean), AbstractAutowireCapableBeanFactory.setAllowRawInjectionDespiteWrapping(boolean)

• loadBeanDefinitions

  protected abstract void loadBeanDefinitions​(GenericWebApplicationContext context,
                                              WebMergedContextConfiguration webMergedConfig)

  Load bean definitions into the supplied context from the locations or classes in the supplied WebMergedContextConfiguration.

  Concrete subclasses must provide an appropriate implementation.

  Parameters:

  context - the context into which the bean definitions should be loaded

  webMergedConfig - the merged context configuration to use to load the web application context

  See Also:

  loadContext(MergedContextConfiguration)

• customizeContext

  protected void customizeContext​(GenericWebApplicationContext context,
                                  WebMergedContextConfiguration webMergedConfig)

  Customize the GenericWebApplicationContext created by this context loader after bean definitions have been loaded into the context but before the context is refreshed.

  The default implementation simply delegates to AbstractContextLoader.customizeContext(ConfigurableApplicationContext, MergedContextConfiguration).

  Parameters:

  context - the newly created web application context

  webMergedConfig - the merged context configuration to use to load the web application context

  See Also:

  loadContext(MergedContextConfiguration), AbstractContextLoader.customizeContext(ConfigurableApplicationContext, MergedContextConfiguration)

• loadContext

  public final ApplicationContext loadContext​(String... locations)
                                       throws Exception

  AbstractGenericWebContextLoader should be used as a SmartContextLoader, not as a legacy ContextLoader. Consequently, this method is not supported.

  Parameters:

  locations - the resource locations to use to load the application context

  Returns:

  a new application context

  Throws:

  UnsupportedOperationException - in this implementation

  Exception - if context loading failed

  See Also:

  ContextLoader.loadContext(java.lang.String[])