Module simplehttpserver

Package com.kttdevelopment.simplehttpserver

Class SimpleHttpsServer

java.lang.Object

com.kttdevelopment.simplehttpserver.SimpleHttpServer

com.kttdevelopment.simplehttpserver.SimpleHttpsServer

public abstract class SimpleHttpsServer
extends SimpleHttpServer

This class is a simplified implementation of HttpsServer. The server must have a HttpsConfigurator set using setHttpsConfigurator(HttpsConfigurator).
At least one HttpHandler must be created in order to process requests. When handling requests the server will use the most specific context. If no handler can be found it is rejected with a 404 response.
Contexts are case-sensitive.

Since:

02.00.00

Version:

03.04.01

Author:

Ktt Development

See Also:

HttpsServer, HttpHandler, SimpleHttpServer, SimpleHttpHandler

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SimpleHttpsServer()	Creates an empty SimpleHttpsServer.

Method Summary

Modifier and Type	Method	Description
static SimpleHttpsServer	create()	Creates a SimpleHttpsServer.
static SimpleHttpsServer	create(int port)	Creates a SimpleHttpsServer bounded to a port.
static SimpleHttpsServer	create(int port, int backlog)	Creates a SimpleHttpsServer bounded to a port.
abstract HttpsConfigurator	getHttpsConfigurator()	Returns the https configurator of the server
abstract HttpsServer	getHttpServer()	Returns the native https server.
abstract void	setHttpsConfigurator(HttpsConfigurator config)	Sets a https configurator for the server

Methods inherited from class com.kttdevelopment.simplehttpserver.SimpleHttpServer

bind, bind, bind, bind, createContext, createContext, createContext, createContext, getAddress, getContextHandler, getContextHandler, getContexts, getExecutor, getHttpSession, getHttpSession, getHttpSessionHandler, getRandomContext, getRandomContext, removeContext, removeContext, setExecutor, setHttpSessionHandler, start, stop, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleHttpsServer

protected SimpleHttpsServer()

Creates an empty SimpleHttpsServer. Server is created using create(), create(int), or create(int, int).

Since:

02.00.00

See Also:

create(), create(int), create(int, int), SimpleHttpsServerImpl.createSimpleHttpsServer(Integer, Integer)

Method Detail

create

public static SimpleHttpsServer create()
                                throws IOException

Creates a SimpleHttpsServer. The server must have a HttpsConfigurator set using setHttpsConfigurator(HttpsConfigurator).

Returns:

a SimpleHttpsServer

Throws:

IOException - uncaught exception

Since:

03.04.00

create

public static SimpleHttpsServer create(int port)
                                throws IOException

Creates a SimpleHttpsServer bounded to a port. The server must have a HttpsConfigurator set using setHttpsConfigurator(HttpsConfigurator).

Parameters:

port - port to bind to

Returns:

a SimpleHttpsServer

Throws:

BindException - if server can not bind to port

NullPointerException - if address is null

IllegalArgumentException - if port is out of range

IOException - uncaught exception

Since:

03.04.00

create

public static SimpleHttpsServer create(int port,
                                       int backlog)
                                throws IOException

Creates a SimpleHttpsServer bounded to a port. The server must have a HttpsConfigurator set using setHttpsConfigurator(HttpsConfigurator).

Parameters:

port - port to bind to

backlog - maximum amount of inbound connections allowed

Returns:

a SimpleHttpsServer

Throws:

BindException - if server can not bind to port

NullPointerException - if address is null

IllegalArgumentException - if port is out of range

IOException - uncaught exception

Since:

03.04.00

getHttpServer

public abstract HttpsServer getHttpServer()

Returns the native https server.

Specified by:

getHttpServer in class SimpleHttpServer

Returns:

https server

Since:

03.04.00

See Also:

HttpsServer

setHttpsConfigurator

public abstract void setHttpsConfigurator(HttpsConfigurator config)

Sets a https configurator for the server

Parameters:

config - the https configurator

Throws:

NullPointerException - if config is null

Since:

03.04.00

getHttpsConfigurator

public abstract HttpsConfigurator getHttpsConfigurator()

Returns the https configurator of the server

Returns:

the https configurator

Since:

03.04.00