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.reactive.server;
018
019import org.springframework.boot.web.server.WebServer;
020import org.springframework.http.server.reactive.HttpHandler;
021
022/**
023 * Factory interface that can be used to create a reactive {@link WebServer}.
024 *
025 * @author Brian Clozel
026 * @since 2.0.0
027 * @see WebServer
028 */
029@FunctionalInterface
030public interface ReactiveWebServerFactory {
031
032        /**
033         * Gets a new fully configured but paused {@link WebServer} instance. Clients should
034         * not be able to connect to the returned server until {@link WebServer#start()} is
035         * called (which happens when the {@code ApplicationContext} has been fully
036         * refreshed).
037         * @param httpHandler the HTTP handler in charge of processing requests
038         * @return a fully configured and started {@link WebServer}
039         * @see WebServer#stop()
040         */
041        WebServer getWebServer(HttpHandler httpHandler);
042
043}