Add WebServerApplicationContext abstraction
Add a new `WebServerApplicationContext` interface that provides a common abstraction for all application contexts that create and manage the lifecycle of an embedded `WebServer`. Allows server namespaces to become a first-class concept (rather subverting `ConfigurableWebApplicationContext.getNamespace()`) and allow us to drop `getServerId()` from `WebServerInitializedEvent`. Also helps to improve `ManagementContextAutoConfiguration` and `ManagementContextFactory`. Fixes gh-11881pull/11812/merge
Phillip Webb
7 years ago
parent
c8257b38a2
commit
3ff772957b
@ -0,0 +1,39 @@
|
||||
/*
|
||||
* Copyright 2012-2018 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.boot.web.context;
|
||||
|
||||
import org.springframework.context.ConfigurableApplicationContext;
|
||||
|
||||
/**
|
||||
* SPI interface to be implemented by most if not all {@link WebServerApplicationContext
|
||||
* web server application contexts}. Provides facilities to configure the context, in
|
||||
* addition to the methods in the {WebServerApplicationContext} interface.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public interface ConfigurableWebServerApplicationContext
|
||||
extends ConfigurableApplicationContext, WebServerApplicationContext {
|
||||
|
||||
/**
|
||||
* Set the server namespace of the context.
|
||||
* @param serverNamespace the server namespance
|
||||
* @see #getServerNamespace()
|
||||
*/
|
||||
void setServerNamespace(String serverNamespace);
|
||||
|
||||
}
|
||||
@ -0,0 +1,47 @@
|
||||
/*
|
||||
* Copyright 2012-2018 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.boot.web.context;
|
||||
|
||||
import org.springframework.boot.web.server.WebServer;
|
||||
import org.springframework.context.ApplicationContext;
|
||||
|
||||
/**
|
||||
* Interface to be implemented by {@link ApplicationContext application contexts} that
|
||||
* create and manage the lifecyle of an embedded {@link WebServer}.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public interface WebServerApplicationContext extends ApplicationContext {
|
||||
|
||||
/**
|
||||
* Returns the {@link WebServer} that was created by the context or {@code null} if
|
||||
* the server has not yet been created.
|
||||
* @return the web server
|
||||
*/
|
||||
WebServer getWebServer();
|
||||
|
||||
/**
|
||||
* Returns the namespace of the web server application context or {@code null} if no
|
||||
* namepace 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).
|
||||
* @return the server namespace
|
||||
*/
|
||||
String getServerNamespace();
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue