001/*
002 * Copyright 2012-2018 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.boot.web.context;
018
019import org.springframework.boot.web.server.WebServer;
020import org.springframework.context.ApplicationContext;
021
022/**
023 * Interface to be implemented by {@link ApplicationContext application contexts} that
024 * create and manage the lifecycle of an embedded {@link WebServer}.
025 *
026 * @author Phillip Webb
027 * @since 2.0.0
028 */
029public interface WebServerApplicationContext extends ApplicationContext {
030
031        /**
032         * Returns the {@link WebServer} that was created by the context or {@code null} if
033         * the server has not yet been created.
034         * @return the web server
035         */
036        WebServer getWebServer();
037
038        /**
039         * Returns the namespace of the web server application context or {@code null} if no
040         * namespace has been set. Used for disambiguation when multiple web servers are
041         * running in the same application (for example a management context running on a
042         * different port).
043         * @return the server namespace
044         */
045        String getServerNamespace();
046
047}