com.devops4j.embedded.httpserver.HttpsServer Maven / Gradle / Ivy
package com.devops4j.embedded.httpserver;
import com.devops4j.embedded.httpserver.spi.HttpServerProvider;
import java.net.*;
import java.io.*;
/**
* This class is an extension of {@link HttpServer} which provides
* support for HTTPS.
* A HttpsServer must have an associated {@link com.devops4j.embedded.httpserver.HttpsConfigurator} object
* which is used to establish the SSL configuration for the SSL connections.
*
* All other configuration is the same as for HttpServer.
* @since 1.6
*/
public abstract class HttpsServer extends HttpServer {
/**
*/
protected HttpsServer () {
}
/**
* creates a HttpsServer instance which is initially not bound to any local address/port.
* The HttpsServer is acquired from the currently installed {@link com.devops4j.embedded.httpserver.spi.HttpServerProvider}
* The server must be bound using {@link #bind(InetSocketAddress,int)} before it can be used.
* The server must also have a HttpsConfigurator established with {@link #setHttpsConfigurator(com.devops4j.embedded.httpserver.HttpsConfigurator)}
* @throws IOException
*/
public static HttpsServer create () throws IOException {
return create (null, 0);
}
/**
* Create a HttpsServer instance which will bind to the
* specified {@link java.net.InetSocketAddress} (IP address and port number)
*
* A maximum backlog can also be specified. This is the maximum number of
* queued incoming connections to allow on the listening socket.
* Queued TCP connections exceeding this limit may be rejected by the TCP implementation.
* The HttpsServer is acquired from the currently installed {@link com.devops4j.embedded.httpserver.spi.HttpServerProvider}
* The server must have a HttpsConfigurator established with {@link #setHttpsConfigurator(com.devops4j.embedded.httpserver.HttpsConfigurator)}
*
* @param addr the address to listen on, if null then bind() must be called
* to set the address
* @param backlog the socket backlog. If this value is less than or equal to zero,
* then a system default value is used.
* @throws BindException if the server cannot bind to the requested address,
* or if the server is already bound.
* @throws IOException
*/
public static HttpsServer create (
InetSocketAddress addr, int backlog
) throws IOException {
HttpServerProvider provider = HttpServerProvider.provider();
return provider.createHttpsServer (addr, backlog);
}
/**
* Sets this server's {@link com.devops4j.embedded.httpserver.HttpsConfigurator} object.
* @param config the HttpsConfigurator to set
* @throws NullPointerException if config is null.
*/
public abstract void setHttpsConfigurator (HttpsConfigurator config) ;
/**
* Gets this server's {@link com.devops4j.embedded.httpserver.HttpsConfigurator} object, if it has been set.
* @return the HttpsConfigurator for this server, or null if not set.
*/
public abstract HttpsConfigurator getHttpsConfigurator ();
}