001/*
002 * Copyright 2012-2017 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.servlet.server;
018
019import org.apache.catalina.core.ApplicationContext;
020
021import org.springframework.boot.web.server.WebServer;
022import org.springframework.boot.web.servlet.ServletContextInitializer;
023
024/**
025 * Factory interface that can be used to create a {@link WebServer}.
026 *
027 * @author Phillip Webb
028 * @see WebServer
029 * @since 2.0.0
030 */
031@FunctionalInterface
032public interface ServletWebServerFactory {
033
034        /**
035         * Gets a new fully configured but paused {@link WebServer} instance. Clients should
036         * not be able to connect to the returned server until {@link WebServer#start()} is
037         * called (which happens when the {@link ApplicationContext} has been fully
038         * refreshed).
039         * @param initializers {@link ServletContextInitializer}s that should be applied as
040         * the server starts
041         * @return a fully configured and started {@link WebServer}
042         * @see WebServer#stop()
043         */
044        WebServer getWebServer(ServletContextInitializer... initializers);
045
046}