spring-boot/org.springframework.boot.web.servlet.context/XmlServletWebServerApplicationContext

XmlServletWebServerApplicationContext

open class XmlServletWebServerApplicationContext : ServletWebServerApplicationContext

ServletWebServerApplicationContext which takes its configuration from XML documents, understood by an org.springframework.beans.factory.xml.XmlBeanDefinitionReader.

Note: In case of multiple config locations, later bean definitions will override ones defined in earlier loaded files. This can be leveraged to deliberately override certain bean definitions through an extra XML file.

Author

Phillip Webb

Since

1.0.0

See also

setConfigLocations

ServletWebServerApplicationContext

XmlWebApplicationContext

Constructors

XmlServletWebServerApplicationContext

constructor()

Create a new XmlServletWebServerApplicationContext that needs to be loaded and then manually refreshed.

constructor(resources: Array<Resource>)

Create a new XmlServletWebServerApplicationContext, loading bean definitions from the given resources and automatically refreshing the context.

constructor(resourceLocations: Array<String>)

Create a new XmlServletWebServerApplicationContext, loading bean definitions from the given resource locations and automatically refreshing the context.

constructor(relativeClass: Class<out Any>, resourceNames: Array<String>)

Create a new XmlServletWebServerApplicationContext, loading bean definitions from the given resource locations and automatically refreshing the context.

Properties

APPLICATION_CONTEXT_ID_PREFIX

val APPLICATION_CONTEXT_ID_PREFIX: String

APPLICATION_EVENT_MULTICASTER_BEAN_NAME

val APPLICATION_EVENT_MULTICASTER_BEAN_NAME: String = "applicationEventMulticaster"

APPLICATION_STARTUP_BEAN_NAME

val APPLICATION_STARTUP_BEAN_NAME: String = "applicationStartup"

applicationStartup

open var applicationStartup: ApplicationStartup

beanFactoryPostProcessors

val beanFactoryPostProcessors: List<BeanFactoryPostProcessor>

open var classLoader: ClassLoader

CLASSPATH_ALL_URL_PREFIX

val CLASSPATH_ALL_URL_PREFIX: String = "classpath*:"

CLASSPATH_URL_PREFIX

val CLASSPATH_URL_PREFIX: String = "classpath:"

CONFIG_LOCATION_DELIMITERS

val CONFIG_LOCATION_DELIMITERS: String = ",; "

CONTEXT_ATTRIBUTES_BEAN_NAME

val CONTEXT_ATTRIBUTES_BEAN_NAME: String = "contextAttributes"

CONTEXT_PARAMETERS_BEAN_NAME

val CONTEXT_PARAMETERS_BEAN_NAME: String = "contextParameters"

CONVERSION_SERVICE_BEAN_NAME

val CONVERSION_SERVICE_BEAN_NAME: String = "conversionService"

DISPATCHER_SERVLET_NAME

val DISPATCHER_SERVLET_NAME: String = "dispatcherServlet"

Constant value for the DispatcherServlet bean name.

open var displayName: String

open var environment: ConfigurableEnvironment

ENVIRONMENT_BEAN_NAME

val ENVIRONMENT_BEAN_NAME: String = "environment"

FACTORY_BEAN_PREFIX

val FACTORY_BEAN_PREFIX: String = "&"

open var id: String

LIFECYCLE_PROCESSOR_BEAN_NAME

val LIFECYCLE_PROCESSOR_BEAN_NAME: String = "lifecycleProcessor"

LOAD_TIME_WEAVER_BEAN_NAME

val LOAD_TIME_WEAVER_BEAN_NAME: String = "loadTimeWeaver"

MESSAGE_SOURCE_BEAN_NAME

val MESSAGE_SOURCE_BEAN_NAME: String = "messageSource"

open var parent: ApplicationContext

ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE

val ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE: String

SCOPE_APPLICATION

val SCOPE_APPLICATION: String = "application"

val SCOPE_REQUEST: String = "request"

val SCOPE_SESSION: String = "session"

serverNamespace

open var serverNamespace: String

SERVLET_CONFIG_BEAN_NAME

val SERVLET_CONFIG_BEAN_NAME: String = "servletConfig"

SERVLET_CONTEXT_BEAN_NAME

val SERVLET_CONTEXT_BEAN_NAME: String = "servletContext"

open var servletConfig: ServletConfig

open var servletContext: ServletContext

SHUTDOWN_HOOK_THREAD_NAME

val SHUTDOWN_HOOK_THREAD_NAME: String = "SpringContextShutdownHook"

open val startupDate: Long

SYSTEM_ENVIRONMENT_BEAN_NAME

val SYSTEM_ENVIRONMENT_BEAN_NAME: String = "systemEnvironment"

SYSTEM_PROPERTIES_BEAN_NAME

val SYSTEM_PROPERTIES_BEAN_NAME: String = "systemProperties"

open val webServer: WebServer

Functions

addApplicationListener

open fun addApplicationListener(listener: ApplicationListener<out Any>)

addBeanFactoryPostProcessor

open fun addBeanFactoryPostProcessor(postProcessor: BeanFactoryPostProcessor)

addProtocolResolver

open fun addProtocolResolver(resolver: ProtocolResolver)

clearResourceCaches

open fun clearResourceCaches()

open fun close()

open fun containsBean(name: String): Boolean

containsBeanDefinition

open fun containsBeanDefinition(beanName: String): Boolean

containsLocalBean

open fun containsLocalBean(name: String): Boolean

findAllAnnotationsOnBean

open fun <A : Annotation?> findAllAnnotationsOnBean(beanName: String, annotationType: Class<A>, allowFactoryBeanInit: Boolean): Set<A>

findAnnotationOnBean

open fun <A : Annotation?> findAnnotationOnBean(beanName: String, annotationType: Class<A>): A

open fun getAliases(name: String): Array<String>

getApplicationListeners

open fun getApplicationListeners(): Collection<ApplicationListener<out Any>>

getApplicationName

open fun getApplicationName(): String

getAutowireCapableBeanFactory

open fun getAutowireCapableBeanFactory(): AutowireCapableBeanFactory

open fun getBean(name: String): Any

open fun <T> getBean(name: String, requiredType: Class<T>): T

getBeanDefinition

open fun getBeanDefinition(beanName: String): BeanDefinition

getBeanDefinitionCount

open fun getBeanDefinitionCount(): Int

getBeanDefinitionNames

open fun getBeanDefinitionNames(): Array<String>

fun getBeanFactory(): ConfigurableListableBeanFactory

getBeanNamesForAnnotation

open fun getBeanNamesForAnnotation(annotationType: Class<out Annotation>): Array<String>

getBeanNamesForType

open fun getBeanNamesForType(type: ResolvableType): Array<String>

getBeanProvider

open fun <T> getBeanProvider(requiredType: Class<T>): ObjectProvider<T>

open fun <T> getBeansOfType(type: Class<T>): Map<String, T>

getBeansWithAnnotation

open fun getBeansWithAnnotation(annotationType: Class<out Annotation>): Map<String, Any>

getConfigLocations

open fun getConfigLocations(): Array<String>

getDefaultListableBeanFactory

fun getDefaultListableBeanFactory(): DefaultListableBeanFactory

abstract fun getEnvironment(): Environment

open fun getMessage(code: String, args: Array<Any>, defaultMessage: String, locale: Locale): String

open fun getNamespace(): String

getParentBeanFactory

open fun getParentBeanFactory(): BeanFactory

getProtocolResolvers

open fun getProtocolResolvers(): Collection<ProtocolResolver>

open fun getResource(location: String): Resource

getResourceCache

open fun <T> getResourceCache(valueType: Class<T>): Map<Resource, T>

open fun getResources(locationPattern: String): Array<Resource>

getServerNamespace

open fun getServerNamespace(context: ApplicationContext): String

Returns the server namespace if the specified context is a WebServerApplicationContext.

open fun getTheme(themeName: String): Theme

open fun getType(name: String): Class<out Any>

hasServerNamespace

open fun hasServerNamespace(context: ApplicationContext, serverNamespace: String): Boolean

Returns true if the specified context is a WebServerApplicationContext with a matching server namespace.

open fun isActive(): Boolean

open fun isAlias(beanName: String): Boolean

isBeanDefinitionOverridable

open fun isBeanDefinitionOverridable(beanName: String): Boolean

isBeanNameInUse

open fun isBeanNameInUse(beanName: String): Boolean

open fun isPrototype(name: String): Boolean

open fun isRunning(): Boolean

open fun isSingleton(name: String): Boolean

open fun isTypeMatch(name: String, typeToMatch: ResolvableType): Boolean

fun load(resourceLocations: Array<String>)

fun load(resources: Array<Resource>)

fun load(relativeClass: Class<out Any>, resourceNames: Array<String>)

Load bean definitions from the given XML resources.

open fun publishEvent(event: ApplicationEvent)

open fun refresh()

refreshForAotProcessing

open fun refreshForAotProcessing(runtimeHints: RuntimeHints)

open fun registerAlias(beanName: String, alias: String)

open fun <T> registerBean(beanClass: Class<T>, constructorArgs: Array<Any>)

registerBeanDefinition

open fun registerBeanDefinition(beanName: String, beanDefinition: BeanDefinition)

registerShutdownHook

open fun registerShutdownHook()

open fun removeAlias(alias: String)

removeApplicationListener

open fun removeApplicationListener(listener: ApplicationListener<out Any>)

removeBeanDefinition

open fun removeBeanDefinition(beanName: String)

setAllowBeanDefinitionOverriding

open fun setAllowBeanDefinitionOverriding(allowBeanDefinitionOverriding: Boolean)

setAllowCircularReferences

open fun setAllowCircularReferences(allowCircularReferences: Boolean)

setConfigLocation

open fun setConfigLocation(configLocation: String)

setConfigLocations

open fun setConfigLocations(configLocations: Array<String>)

open fun setEnvironment(environment: ConfigurableEnvironment)

Delegates the given environment to underlying XmlBeanDefinitionReader.

open fun setNamespace(namespace: String)

setResourceLoader

open fun setResourceLoader(resourceLoader: ResourceLoader)

open fun setValidating(validating: Boolean)

Set whether to use XML validation.

open fun start()

open fun stop()

open fun toString(): String