spark.embeddedserver.EmbeddedServer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spark-core Show documentation
A micro framework for creating web applications in Kotlin and Java 8 with minimal effort
The newest version!
/*
 * Copyright 2016 - Per Wendel
 *
 *  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 spark.embeddedserver;

import java.util.Map;
import java.util.Optional;

import spark.embeddedserver.jetty.websocket.WebSocketHandlerWrapper;
import spark.ssl.SslStores;

/**
 * Represents an embedded server that can be used in Spark. (this is currently Jetty by default).
 */
public interface EmbeddedServer {

    /**
     * Ignites the embedded server, listening on the specified port, running SSL secured with the specified keystore
     * and truststore.  If truststore is null, keystore is reused.
     *
     * @param host                    The address to listen on
     * @param port                    - the port
     * @param sslStores               - The SSL sslStores.
     * @param maxThreads              - max nbr of threads.
     * @param minThreads              - min nbr of threads.
     * @return The port number the server was launched on.
     */
    int ignite(String host,
                   int port,
                   SslStores sslStores,
                   int maxThreads,
                   int minThreads,
                   int threadIdleTimeoutMillis) throws Exception;


    /**
     * Must be called before ignite()
     *
     * Must be it's own default method to maintain backwards compatibility. Move to ignite method in 3.0.
     */
    default void trustForwardHeaders(boolean trust) {

    }

    /**
     * Configures the web sockets for the embedded server.
     *
     * @param webSocketHandlers          - web socket handlers.
     * @param webSocketIdleTimeoutMillis - Optional WebSocket idle timeout (ms).
     */
    default void configureWebSockets(Map webSocketHandlers,
                                     Optional webSocketIdleTimeoutMillis) {

        NotSupportedException.raise(getClass().getSimpleName(), "Web Sockets");
    }

    /**
     * Joins the embedded server thread(s).
     */
    void join() throws InterruptedException;

    /**
     * Extinguish the embedded server.
     */
    void extinguish();

    /**
     *
     * @return The approximate number of currently active threads
     */
    int activeThreadCount();
}