Interface WebServerApplicationContext

All Superinterfaces:

ApplicationContext, ApplicationEventPublisher, BeanFactory, EnvironmentCapable, HierarchicalBeanFactory, ListableBeanFactory, MessageSource, ResourceLoader, ResourcePatternResolver

All Known Subinterfaces:

ConfigurableWebServerApplicationContext

All Known Implementing Classes:

AnnotationConfigReactiveWebServerApplicationContext, AnnotationConfigServletWebServerApplicationContext, ReactiveWebServerApplicationContext, ServletWebServerApplicationContext, XmlServletWebServerApplicationContext

public interface WebServerApplicationContext
extends ApplicationContext

Interface to be implemented by application contexts that create and manage the lifecycle of an embedded WebServer.

Since:

4.0.0

Author:

Phillip Webb

Field Summary

Fields

Modifier and Type	Field	Description
static final int	GRACEFUL_SHUTDOWN_PHASE	SmartLifecycle phase in which graceful shutdown of the web server is performed.
static final int	START_STOP_LIFECYCLE_PHASE	SmartLifecycle phase in which starting and stopping of the web server is performed.

Fields inherited from interface BeanFactory

FACTORY_BEAN_PREFIX, FACTORY_BEAN_PREFIX_CHAR

Fields inherited from interface ResourceLoader

CLASSPATH_URL_PREFIX

Fields inherited from interface ResourcePatternResolver

CLASSPATH_ALL_URL_PREFIX

Method Summary

Modifier and Type	Method	Description
@Nullable String	getServerNamespace()	Returns the namespace of the web server application context or null if no namespace has been set.
static @Nullable String	getServerNamespace(@Nullable ApplicationContext context)	Returns the server namespace if the specified context is a WebServerApplicationContext.
@Nullable WebServer	getWebServer()	Returns the WebServer that was created by the context or null if the server has not yet been created.
static boolean	hasServerNamespace(@Nullable ApplicationContext context, String serverNamespace)	Returns true if the specified context is a WebServerApplicationContext with a matching server namespace.

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 EnvironmentCapable

getEnvironment

Methods inherited from interface HierarchicalBeanFactory

containsLocalBean, getParentBeanFactory

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

Field Details

GRACEFUL_SHUTDOWN_PHASE

static final int GRACEFUL_SHUTDOWN_PHASE

SmartLifecycle phase in which graceful shutdown of the web server is performed.

Since:

4.0.0

See Also:

• Constant Field Values

START_STOP_LIFECYCLE_PHASE

static final int START_STOP_LIFECYCLE_PHASE

SmartLifecycle phase in which starting and stopping of the web server is performed.

See Also:

• Constant Field Values

Method Details

getWebServer

@Nullable WebServer getWebServer()

Returns the WebServer that was created by the context or null if the server has not yet been created.

Returns:

the web server

getServerNamespace

@Nullable String getServerNamespace()

Returns the namespace of the web server application context or null if no namespace has been set. Used for disambiguation when multiple web servers are running in the same application (for example a management context running on a different port).

Returns:

the server namespace

hasServerNamespace

static boolean hasServerNamespace(@Nullable ApplicationContext context,
 String serverNamespace)

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

Parameters:

context - the context to check

serverNamespace - the server namespace to match against

Returns:

true if the server namespace of the context matches

getServerNamespace

static @Nullable String getServerNamespace(@Nullable ApplicationContext context)

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

Parameters:

context - the context

Returns:

the server namespace or null if the context is not a WebServerApplicationContext