Interface ConfigurableWebApplicationContext

All Superinterfaces:

ApplicationContext, ApplicationEventPublisher, AutoCloseable, BeanFactory, Closeable, ConfigurableApplicationContext, EnvironmentCapable, HierarchicalBeanFactory, Lifecycle, ListableBeanFactory, MessageSource, ResourceLoader, ResourcePatternResolver, WebApplicationContext

All Known Implementing Classes:

AbstractRefreshableWebApplicationContext, AnnotationConfigWebApplicationContext, GenericWebApplicationContext, GroovyWebApplicationContext, StaticWebApplicationContext, XmlWebApplicationContext

public interface ConfigurableWebApplicationContext
extends WebApplicationContext, ConfigurableApplicationContext

Interface to be implemented by configurable web application contexts. Supported by ContextLoader and FrameworkServlet.

Note: The setters of this interface need to be called before an invocation of the ConfigurableApplicationContext.refresh() method inherited from ConfigurableApplicationContext. They do not cause an initialization of the context on their own.

Since:

05.12.2003

Author:

Juergen Hoeller

See Also:

• ConfigurableApplicationContext.refresh()
• ContextLoader.createWebApplicationContext(ServletContext)
• FrameworkServlet.createWebApplicationContext(ApplicationContext)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPLICATION_CONTEXT_ID_PREFIX	Prefix for ApplicationContext ids that refer to context path and/or servlet name.
static final String	SERVLET_CONFIG_BEAN_NAME	Name of the ServletConfig environment bean in the factory.

Fields inherited from interface BeanFactory

FACTORY_BEAN_PREFIX, FACTORY_BEAN_PREFIX_CHAR

Fields inherited from interface ConfigurableApplicationContext

APPLICATION_STARTUP_BEAN_NAME, BOOTSTRAP_EXECUTOR_BEAN_NAME, CONFIG_LOCATION_DELIMITERS, CONVERSION_SERVICE_BEAN_NAME, ENVIRONMENT_BEAN_NAME, LOAD_TIME_WEAVER_BEAN_NAME, SHUTDOWN_HOOK_THREAD_NAME, SYSTEM_ENVIRONMENT_BEAN_NAME, SYSTEM_PROPERTIES_BEAN_NAME

Fields inherited from interface ResourceLoader

CLASSPATH_URL_PREFIX

Fields inherited from interface ResourcePatternResolver

CLASSPATH_ALL_URL_PREFIX

Fields inherited from interface WebApplicationContext

CONTEXT_ATTRIBUTES_BEAN_NAME, CONTEXT_PARAMETERS_BEAN_NAME, ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, SCOPE_APPLICATION, SCOPE_REQUEST, SCOPE_SESSION, SERVLET_CONTEXT_BEAN_NAME

Method Summary

Modifier and Type	Method	Description
String @Nullable []	getConfigLocations()	Return the config locations for this web application context, or null if none specified.
@Nullable String	getNamespace()	Return the namespace for this web application context, if any.
@Nullable jakarta.servlet.ServletConfig	getServletConfig()	Return the ServletConfig for this web application context, if any.
void	setConfigLocation(String configLocation)	Set the config locations for this web application context in init-param style, i.e.
void	setConfigLocations(String... configLocations)	Set the config locations for this web application context.
void	setNamespace(@Nullable String namespace)	Set the namespace for this web application context, to be used for building a default context config location.
void	setServletConfig(@Nullable jakarta.servlet.ServletConfig servletConfig)	Set the ServletConfig for this web application context.
void	setServletContext(@Nullable jakarta.servlet.ServletContext servletContext)	Set the ServletContext for this web application context.

Methods inherited from interface ApplicationContext

getApplicationName, getAutowireCapableBeanFactory, getDisplayName, getId, getParent, getStartupDate

Methods inherited from interface ApplicationEventPublisher

publishEvent, publishEvent

Methods inherited from interface BeanFactory

containsBean, getAliases, getBean, getBean, getBean, getBean, getBean, getBeanProvider, getBeanProvider, getBeanProvider, getType, getType, isPrototype, isSingleton, isTypeMatch, isTypeMatch

Methods inherited from interface ConfigurableApplicationContext

addApplicationListener, addBeanFactoryPostProcessor, addProtocolResolver, close, getApplicationStartup, getBeanFactory, getEnvironment, isActive, isClosed, pause, refresh, registerShutdownHook, removeApplicationListener, restart, setApplicationStartup, setClassLoader, setEnvironment, setId, setParent

Methods inherited from interface HierarchicalBeanFactory

containsLocalBean, getParentBeanFactory

Methods inherited from interface Lifecycle

isRunning, start, stop

Methods inherited from interface ListableBeanFactory

containsBeanDefinition, findAllAnnotationsOnBean, findAnnotationOnBean, findAnnotationOnBean, getBeanDefinitionCount, getBeanDefinitionNames, getBeanNamesForAnnotation, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanNamesForType, getBeanProvider, getBeanProvider, getBeansOfType, getBeansOfType, getBeansWithAnnotation

Methods inherited from interface MessageSource

getMessage, getMessage, getMessage

Methods inherited from interface ResourceLoader

getClassLoader, getResource

Methods inherited from interface ResourcePatternResolver

getResources

Methods inherited from interface WebApplicationContext

getServletContext

Field Details

APPLICATION_CONTEXT_ID_PREFIX

static final String APPLICATION_CONTEXT_ID_PREFIX

Prefix for ApplicationContext ids that refer to context path and/or servlet name.

SERVLET_CONFIG_BEAN_NAME

static final String SERVLET_CONFIG_BEAN_NAME

Name of the ServletConfig environment bean in the factory.

See Also:

• ServletConfig
• Constant Field Values

Method Details

setServletContext

void setServletContext(@Nullable jakarta.servlet.ServletContext servletContext)

Set the ServletContext for this web application context.

Does not cause an initialization of the context: refresh needs to be called after the setting of all configuration properties.

See Also:

• ConfigurableApplicationContext.refresh()

setServletConfig

void setServletConfig(@Nullable jakarta.servlet.ServletConfig servletConfig)

Set the ServletConfig for this web application context. Only called for a WebApplicationContext that belongs to a specific Servlet.

See Also:

• ConfigurableApplicationContext.refresh()

getServletConfig

@Nullable jakarta.servlet.ServletConfig getServletConfig()

Return the ServletConfig for this web application context, if any.

setNamespace

void setNamespace(@Nullable String namespace)

Set the namespace for this web application context, to be used for building a default context config location. The root web application context does not have a namespace.

getNamespace

@Nullable String getNamespace()

Return the namespace for this web application context, if any.

setConfigLocation

void setConfigLocation(String configLocation)

Set the config locations for this web application context in init-param style, i.e. with distinct locations separated by commas, semicolons or whitespace.

If not set, the implementation is supposed to use a default for the given namespace or the root web application context, as appropriate.

setConfigLocations

void setConfigLocations(String... configLocations)

Set the config locations for this web application context.

If not set, the implementation is supposed to use a default for the given namespace or the root web application context, as appropriate.

getConfigLocations

String @Nullable [] getConfigLocations()

Return the config locations for this web application context, or null if none specified.