com.devops4j.embedded.httpserver

Class HttpsServer

java.lang.Object

com.devops4j.embedded.httpserver.HttpServer

com.devops4j.embedded.httpserver.HttpsServer

Direct Known Subclasses:

HttpsServerImpl

public abstract class HttpsServer
extends HttpServer

This class is an extension of HttpServer which provides support for HTTPS.

A HttpsServer must have an associated 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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpsServer()

Method Summary

Methods

Modifier and Type	Method and Description
static HttpsServer	create() creates a HttpsServer instance which is initially not bound to any local address/port.
static HttpsServer	create(InetSocketAddress addr, int backlog) Create a HttpsServer instance which will bind to the specified InetSocketAddress (IP address and port number) A maximum backlog can also be specified.
abstract HttpsConfigurator	getHttpsConfigurator() Gets this server's HttpsConfigurator object, if it has been set.
abstract void	setHttpsConfigurator(HttpsConfigurator config) Sets this server's HttpsConfigurator object.

Methods inherited from class com.devops4j.embedded.httpserver.HttpServer

bind, createContext, createContext, getAddress, getExecutor, removeContext, removeContext, setExecutor, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpsServer

protected HttpsServer()

Method Detail

create

public static HttpsServer create()
                          throws IOException

creates a HttpsServer instance which is initially not bound to any local address/port. The HttpsServer is acquired from the currently installed HttpServerProvider The server must be bound using HttpServer.bind(InetSocketAddress,int) before it can be used. The server must also have a HttpsConfigurator established with setHttpsConfigurator(com.devops4j.embedded.httpserver.HttpsConfigurator)

Throws:

IOException

create

public static HttpsServer create(InetSocketAddress addr,
                 int backlog)
                          throws IOException

Create a HttpsServer instance which will bind to the specified 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 HttpServerProvider The server must have a HttpsConfigurator established with setHttpsConfigurator(com.devops4j.embedded.httpserver.HttpsConfigurator)

Parameters:

addr - the address to listen on, if null then bind() must be called to set the address

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.

IOException

setHttpsConfigurator

public abstract void setHttpsConfigurator(HttpsConfigurator config)

Sets this server's HttpsConfigurator object.

Parameters:

config - the HttpsConfigurator to set

Throws:

NullPointerException - if config is null.

getHttpsConfigurator

public abstract HttpsConfigurator getHttpsConfigurator()

Gets this server's HttpsConfigurator object, if it has been set.

Returns:

the HttpsConfigurator for this server, or null if not set.