Interface HttpRestServer

All Superinterfaces:

BaseLocatorAccessor, BaseLocatorAccessor.BaseLocatorBuilder<RestServer>, BaseLocatorAccessor.BaseLocatorMutator, BaseLocatorAccessor.BaseLocatorProperty, BasicAuthObservable<HttpRestServer>, Closable, Closable.CloseBuilder<ConnectionComponent.ConnectionComponentBuilder<HttpServerContext, HttpRestServer>>, ConnectionComponent<HttpServerContext>, ConnectionComponent.ConnectionComponentBuilder<HttpServerContext, HttpRestServer>, ConnectionOpenable<HttpServerContext>, ConnectionOpenable.ConnectionOpenBuilder<HttpServerContext, ConnectionComponent.ConnectionComponentBuilder<HttpServerContext, HttpRestServer>>, ConnectionStatusAccessor, HttpExceptionHandlerAccessor, HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder<HttpRestServer>, HttpExceptionHandlerAccessor.HttpExceptionHandlerMutator, HttpExceptionHandlerAccessor.HttpExceptionHandlerProperty, HttpExceptionHandlingAccessor, HttpExceptionHandlingAccessor.HttpExceptionHandlingBuilder<HttpRestServer>, HttpExceptionHandlingAccessor.HttpExceptionHandlingMutator, HttpExceptionHandlingAccessor.HttpExceptionHandlingProperty, HttpsConnectionRequestObservable<HttpRestServer>, HttpServerInterceptable, KeyStoreDescriptorAccessor, KeyStoreDescriptorAccessor.KeyStoreDescriptorBuilder<HttpRestServer>, KeyStoreDescriptorAccessor.KeyStoreDescriptorMutator, KeyStoreDescriptorAccessor.KeyStoreDescriptorProperty, LinkComponent, MaxConnectionsAccessor, MaxConnectionsAccessor.MaxConnectionsBuilder<HttpRestServer>, MaxConnectionsAccessor.MaxConnectionsMutator, MaxConnectionsAccessor.MaxConnectionsProperty, MediaTypeFactoryLookup, MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup, Observable<RestEndpoint>, Observers<RestEndpoint, RestServer>, Openable, OpenedAccessor, PortAccessor, PortAccessor.PortBuilder<HttpRestServer>, PortAccessor.PortMutator, PortAccessor.PortProperty, PostHttpInterceptable<PostHttpServerInterceptor>, PostHttpServerInterceptable, PreHttpInterceptable<PreHttpServerInterceptor>, PreHttpServerInterceptable, RealmAccessor, RealmAccessor.RealmBuilder<RestServer>, RealmAccessor.RealmMutator, RealmAccessor.RealmProperty, RestServer, SchemeAccessor, SchemeAccessor.SchemeBuilder<HttpRestServer>, SchemeAccessor.SchemeMutator, SchemeAccessor.SchemeProperty

All Known Subinterfaces:

HttpRestRegistryServer<DESC,B>

All Known Implementing Classes:

AbstractHttpRestRegistryServerDecorator, AbstractHttpRestServerDecorator, JdkHttpRestServer, JdkHttpRestServerSingleton

public interface HttpRestServer
extends RestServer, HttpServerInterceptable, HttpExceptionHandlerAccessor.HttpExceptionHandlerProperty, HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder<HttpRestServer>, HttpExceptionHandlingAccessor.HttpExceptionHandlingProperty, HttpExceptionHandlingAccessor.HttpExceptionHandlingBuilder<HttpRestServer>, LinkComponent, ConnectionStatusAccessor, ConnectionComponent.ConnectionComponentBuilder<HttpServerContext, HttpRestServer>, BasicAuthObservable<HttpRestServer>, HttpsConnectionRequestObservable<HttpRestServer>, PortAccessor.PortProperty, PortAccessor.PortBuilder<HttpRestServer>, SchemeAccessor.SchemeProperty, SchemeAccessor.SchemeBuilder<HttpRestServer>, KeyStoreDescriptorAccessor.KeyStoreDescriptorProperty, KeyStoreDescriptorAccessor.KeyStoreDescriptorBuilder<HttpRestServer>, MaxConnectionsAccessor.MaxConnectionsProperty, MaxConnectionsAccessor.MaxConnectionsBuilder<HttpRestServer>

Extends a RestServer to be capable of opening a server socket on the local host with the provided port number via ConnectionOpenable.open(Object) or with an additional maximum number of connections via open(int, int). To open a HTTPS port, use the methods such as: open(KeyStoreDescriptor, int) or open(KeyStoreDescriptor, int, int) or open(String, KeyStoreDescriptor, int) or open(String, KeyStoreDescriptor, int, int). A HttpRestServer can be shutdown via Closable.close().

Nested Class Summary

Nested classes/interfaces inherited from interface BaseLocatorAccessor

BaseLocatorAccessor.BaseLocatorBuilder<B>, BaseLocatorAccessor.BaseLocatorMutator, BaseLocatorAccessor.BaseLocatorProperty

Nested classes/interfaces inherited from interface Closable

Closable.CloseAutomaton, Closable.CloseBuilder<B>

Nested classes/interfaces inherited from interface ConnectionComponent

ConnectionComponent.ConnectionAutomaton<CON>, ConnectionComponent.ConnectionComponentBuilder<CON,B>

Nested classes/interfaces inherited from interface ConnectionOpenable

ConnectionOpenable.ConnectionOpenAutomaton<CON>, ConnectionOpenable.ConnectionOpenBuilder<CON,B>

Nested classes/interfaces inherited from interface ConnectionStatusAccessor

ConnectionStatusAccessor.ConnectionStatusMutator, ConnectionStatusAccessor.ConnectionStatusProperty

Nested classes/interfaces inherited from interface HttpExceptionHandlerAccessor

HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder<B>, HttpExceptionHandlerAccessor.HttpExceptionHandlerMutator, HttpExceptionHandlerAccessor.HttpExceptionHandlerProperty

Nested classes/interfaces inherited from interface HttpExceptionHandlingAccessor

HttpExceptionHandlingAccessor.HttpExceptionHandlingBuilder<B>, HttpExceptionHandlingAccessor.HttpExceptionHandlingMutator, HttpExceptionHandlingAccessor.HttpExceptionHandlingProperty

Nested classes/interfaces inherited from interface KeyStoreDescriptorAccessor

KeyStoreDescriptorAccessor.KeyStoreDescriptorBuilder<B>, KeyStoreDescriptorAccessor.KeyStoreDescriptorMutator, KeyStoreDescriptorAccessor.KeyStoreDescriptorProperty

Nested classes/interfaces inherited from interface LinkComponent

LinkComponent.LinkAutomaton, LinkComponent.LinkComponentBuilder<B>

Nested classes/interfaces inherited from interface MaxConnectionsAccessor

MaxConnectionsAccessor.MaxConnectionsBuilder<B>, MaxConnectionsAccessor.MaxConnectionsMutator, MaxConnectionsAccessor.MaxConnectionsProperty

Nested classes/interfaces inherited from interface MediaTypeFactoryLookup

MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup

Nested classes/interfaces inherited from interface Openable

Openable.OpenAutomaton, Openable.OpenBuilder<B>

Nested classes/interfaces inherited from interface OpenedAccessor

OpenedAccessor.OpenedMutator, OpenedAccessor.OpenedProperty

Nested classes/interfaces inherited from interface PortAccessor

PortAccessor.PortBuilder<B>, PortAccessor.PortMutator, PortAccessor.PortProperty

Nested classes/interfaces inherited from interface RealmAccessor

RealmAccessor.RealmBuilder<B>, RealmAccessor.RealmMutator, RealmAccessor.RealmProperty

Nested classes/interfaces inherited from interface SchemeAccessor

SchemeAccessor.SchemeBuilder<B>, SchemeAccessor.SchemeMutator, SchemeAccessor.SchemeProperty

Method Summary

Modifier and Type	Method	Description
default void	open()
default void	open(int aPort)	Opens the HTTP sever connection (socket) at the given port.
default void	open(int aPort, int aMaxConnections)	Opens the HTTP sever connection (socket) at the given port allowing the given number of maximum connections at the same time.
default void	open(String aProtocol, KeyStoreDescriptor aStoreDescriptor)	Same as open(String, KeyStoreDescriptor, int) but: The number of maximum connections at the same time is decided upon by the implementations's default value.
default void	open(String aProtocol, KeyStoreDescriptor aStoreDescriptor, int aPort)	Same as open(String, KeyStoreDescriptor, int, int) but: The number of maximum connections at the same time is decided upon by the implementations's default value.
void	open(String aProtocol, KeyStoreDescriptor aStoreDescriptor, int aPort, int aMaxConnections)	Opens the HTTPS sever connection (socket) at the given port allowing the given number of maximum connections at the same time using the provided HTTPS configuration parameters.
default void	open(Scheme aScheme, KeyStoreDescriptor aStoreDescriptor)	Same as open(String, KeyStoreDescriptor, int) but: The number of maximum connections at the same time is decided upon by the implementations's default value.
default void	open(Scheme aScheme, KeyStoreDescriptor aStoreDescriptor, int aPort)	Same as open(String, KeyStoreDescriptor, int, int) but: The number of maximum connections at the same time is decided upon by the implementations's default value.
default void	open(Scheme aScheme, KeyStoreDescriptor aStoreDescriptor, int aPort, int aMaxConnections)	Opens the HTTPS sever connection (socket) at the given port allowing the given number of maximum connections at the same time using the provided HTTPS configuration parameters.
default void	open(KeyStoreDescriptor aStoreDescriptor)	Same as open(String, KeyStoreDescriptor, int) but: The protocol for the underlying SSLContext used is set to "TLS".
default void	open(KeyStoreDescriptor aStoreDescriptor, int aPort)	Same as open(String, KeyStoreDescriptor, int, int) but: The protocol for the underlying SSLContext used is set to "TLS".
default void	open(KeyStoreDescriptor aStoreDescriptor, int aPort, int aMaxConnections)	Same as open(String, KeyStoreDescriptor, int, int) but: The protocol for the underlying SSLContext used is set to "TLS".
default void	open(HttpServerContext aConnection)
default HttpRestServer	withBaseLocator(String aBaseLocator)
default HttpRestServer	withClose()
default HttpRestServer	withCloseIn(int aCloseMillis)
default HttpRestServer	withCloseQuietly()
default HttpRestServer	withHttpExceptionHandler(HttpExceptionHandler aHttpErrorHandler)	Sets the HttpExceptionHandler for the HttpExceptionHandler property.
default HttpRestServer	withHttpExceptionHandling(HttpExceptionHandling aHttpErrorHandling)	Sets the HttpExceptionHandling for the HttpExceptionHandling property.
default HttpRestServer	withKeyStoreDescriptor(KeyStoreDescriptor aKeyStoreDescriptor)
default HttpRestServer	withMaxConnections(int aMaxConnections)
default HttpRestServer	withOpen(int aPort)	Builder method for opening the HttpRestServer.
default HttpRestServer	withOpen(HttpServerContext aConnection)
default HttpRestServer	withPort(int aPort)
default HttpRestServer	withProtocol(String aProtocol)
default HttpRestServer	withRealm(String aRealm)
default HttpRestServer	withScheme(Scheme aScheme)

Methods inherited from interface BaseLocatorAccessor

getBaseLocator

Methods inherited from interface BaseLocatorAccessor.BaseLocatorMutator

setBaseLocator

Methods inherited from interface BaseLocatorAccessor.BaseLocatorProperty

letBaseLocator

Methods inherited from interface BasicAuthObservable

onBasicAuthRequest

Methods inherited from interface Closable

close, closeIn, closeQuietly, closeUnchecked

Methods inherited from interface Closable.CloseBuilder

withCloseUnchecked

Methods inherited from interface ConnectionOpenable

openUnchecked

Methods inherited from interface ConnectionOpenable.ConnectionOpenBuilder

withOpenUnchecked

Methods inherited from interface ConnectionStatusAccessor

getConnectionStatus, isOpened

Methods inherited from interface HttpExceptionHandlerAccessor

getHttpExceptionHandler

Methods inherited from interface HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder

withOnHttpException

Methods inherited from interface HttpExceptionHandlerAccessor.HttpExceptionHandlerMutator

onHttpException, setHttpExceptionHandler

Methods inherited from interface HttpExceptionHandlerAccessor.HttpExceptionHandlerProperty

letHttpExceptionHandler

Methods inherited from interface HttpExceptionHandlingAccessor

getHttpExceptionHandling

Methods inherited from interface HttpExceptionHandlingAccessor.HttpExceptionHandlingMutator

setHttpExceptionHandling

Methods inherited from interface HttpExceptionHandlingAccessor.HttpExceptionHandlingProperty

letHttpExceptionHandling

Methods inherited from interface HttpsConnectionRequestObservable

onConnectionRequest

Methods inherited from interface HttpServerInterceptable

addHttpInterceptor, hasHttpInterceptor, removeHttpInterceptor

Methods inherited from interface KeyStoreDescriptorAccessor

getKeyStoreDescriptor

Methods inherited from interface KeyStoreDescriptorAccessor.KeyStoreDescriptorMutator

setKeyStoreDescriptor

Methods inherited from interface KeyStoreDescriptorAccessor.KeyStoreDescriptorProperty

letKeyStoreDescriptor

Methods inherited from interface MaxConnectionsAccessor

getMaxConnections

Methods inherited from interface MaxConnectionsAccessor.MaxConnectionsMutator

setMaxConnections

Methods inherited from interface MaxConnectionsAccessor.MaxConnectionsProperty

letMaxConnections

Methods inherited from interface MediaTypeFactoryLookup

getFactoryMediaTypes, hasMediaTypeFactory, toMediaTypeFactory

Methods inherited from interface MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup

addMediaTypeFactory

Methods inherited from interface Observable

hasObserver, subscribeObserver, unsubscribeObserver

Methods inherited from interface Observers

disableObservers, enableObservers, isObserversActive, observers, setObserversActive

Methods inherited from interface Openable

openUnchecked

Methods inherited from interface PortAccessor

getPort

Methods inherited from interface PortAccessor.PortMutator

setPort

Methods inherited from interface PortAccessor.PortProperty

letPort

Methods inherited from interface PostHttpInterceptable

addPostHttpInterceptor, hasPostHttpInterceptor, removePostHttpInterceptor

Methods inherited from interface PreHttpInterceptable

addPreHttpInterceptor, hasPreHttpInterceptor, removePreHttpInterceptor

Methods inherited from interface RealmAccessor

getRealm

Methods inherited from interface RealmAccessor.RealmMutator

setRealm

Methods inherited from interface RealmAccessor.RealmProperty

letRealm

Methods inherited from interface RestServer

onDelete, onDelete, onGet, onGet, onPost, onPost, onPut, onPut, onRequest, onRequest, onRequest, onRequest, onRequest, withDisableObservers, withEnableObservers, withObserversActive

Methods inherited from interface SchemeAccessor

getScheme, toProtocol

Methods inherited from interface SchemeAccessor.SchemeMutator

setProtocol, setScheme

Methods inherited from interface SchemeAccessor.SchemeProperty

letProtocol, letScheme

Method Details

withHttpExceptionHandler

default HttpRestServer withHttpExceptionHandler(HttpExceptionHandler aHttpErrorHandler)

Sets the HttpExceptionHandler for the HttpExceptionHandler property.

Specified by:

withHttpExceptionHandler in interface HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder<HttpRestServer>

Parameters:

aHttpErrorHandler - The HttpExceptionHandler to be stored by the HttpExceptionHandler property.

Returns:

The builder for applying multiple build operations.

withHttpExceptionHandling

default HttpRestServer withHttpExceptionHandling(HttpExceptionHandling aHttpErrorHandling)

Sets the HttpExceptionHandling for the HttpExceptionHandling property.

Specified by:

withHttpExceptionHandling in interface HttpExceptionHandlingAccessor.HttpExceptionHandlingBuilder<HttpRestServer>

Parameters:

aHttpErrorHandling - The HttpExceptionHandling to be stored by the HttpExceptionHandling property.

Returns:

The builder for applying multiple build operations.

withRealm

default HttpRestServer withRealm(String aRealm)

Specified by:

withRealm in interface RealmAccessor.RealmBuilder<RestServer>

Specified by:

withRealm in interface RestServer

withBaseLocator

default HttpRestServer withBaseLocator(String aBaseLocator)

Specified by:

withBaseLocator in interface BaseLocatorAccessor.BaseLocatorBuilder<RestServer>

Specified by:

withBaseLocator in interface RestServer

withClose

default HttpRestServer withClose()
                          throws IOException

Specified by:

withClose in interface Closable.CloseBuilder<ConnectionComponent.ConnectionComponentBuilder<HttpServerContext, HttpRestServer>>

Throws:

IOException

withCloseQuietly

default HttpRestServer withCloseQuietly()

Specified by:

withCloseQuietly in interface Closable.CloseBuilder<ConnectionComponent.ConnectionComponentBuilder<HttpServerContext, HttpRestServer>>

withCloseIn

default HttpRestServer withCloseIn(int aCloseMillis)

Specified by:

withCloseIn in interface Closable.CloseBuilder<ConnectionComponent.ConnectionComponentBuilder<HttpServerContext, HttpRestServer>>

withOpen

default HttpRestServer withOpen(HttpServerContext aConnection)
                         throws IOException

Specified by:

withOpen in interface ConnectionOpenable.ConnectionOpenBuilder<HttpServerContext, ConnectionComponent.ConnectionComponentBuilder<HttpServerContext, HttpRestServer>>

Throws:

IOException

withOpen

default HttpRestServer withOpen(int aPort)
                         throws IOException

Builder method for opening the HttpRestServer. Delegates to open(int) and returns this method.

Parameters:

aPort - The port on which to listen for requests.

Returns:

This instance for applying method chaining.

Throws:

IOException - thrown in case something went wrong such as the port being already in use.

withPort

default HttpRestServer withPort(int aPort)

Specified by:

withPort in interface PortAccessor.PortBuilder<HttpRestServer>

withScheme

default HttpRestServer withScheme(Scheme aScheme)

Specified by:

withScheme in interface SchemeAccessor.SchemeBuilder<HttpRestServer>

withProtocol

default HttpRestServer withProtocol(String aProtocol)

Specified by:

withProtocol in interface SchemeAccessor.SchemeBuilder<HttpRestServer>

withKeyStoreDescriptor

default HttpRestServer withKeyStoreDescriptor(KeyStoreDescriptor aKeyStoreDescriptor)

Specified by:

withKeyStoreDescriptor in interface KeyStoreDescriptorAccessor.KeyStoreDescriptorBuilder<HttpRestServer>

withMaxConnections

default HttpRestServer withMaxConnections(int aMaxConnections)

Specified by:

withMaxConnections in interface MaxConnectionsAccessor.MaxConnectionsBuilder<HttpRestServer>

open

default void open()
           throws IOException

Specified by:

open in interface Openable

Throws:

IOException

open

default void open(int aPort)
           throws IOException

Opens the HTTP sever connection (socket) at the given port.

Parameters:

aPort - The port on which to listen for requests.

Throws:

IOException - thrown in case something went wrong such as the port being already in use.

open

default void open(int aPort,
 int aMaxConnections)
           throws IOException

Opens the HTTP sever connection (socket) at the given port allowing the given number of maximum connections at the same time.

Parameters:

aPort - The port on which to listen for requests.

aMaxConnections - The number of maximum connections at the same time.

Throws:

IOException - thrown in case something went wrong such as the port being already in use.

open

default void open(String aProtocol,
 KeyStoreDescriptor aStoreDescriptor,
 int aPort)
           throws IOException

Same as open(String, KeyStoreDescriptor, int, int) but:

• The number of maximum connections at the same time is decided upon by the implementations's default value.

Parameters:

aProtocol - The protocol to use, e.g. "TLS".

aStoreDescriptor - The store descriptor describing your KeyStore required for HTTPS.

aPort - The port on which to listen for requests.

Throws:

IOException - thrown in case something went wrong such as the port being already in use.

open

default void open(String aProtocol,
 KeyStoreDescriptor aStoreDescriptor)
           throws IOException

Same as open(String, KeyStoreDescriptor, int) but:

• The number of maximum connections at the same time is decided upon by the implementations's default value.

Parameters:

aProtocol - The protocol to use, e.g. "TLS".

aStoreDescriptor - The store descriptor describing your KeyStore required for HTTPS.

Throws:

IOException - thrown in case something went wrong such as the port being already in use.

open

default void open(KeyStoreDescriptor aStoreDescriptor,
 int aPort,
 int aMaxConnections)
           throws IOException

Same as open(String, KeyStoreDescriptor, int, int) but:

• The protocol for the underlying SSLContext used is set to "TLS".
• The type of KeyStore is set to "JKS".
• The password for the KeyStore's key is assumed to be the same as the provided KeyStore password.

Parameters:

aStoreDescriptor - The store descriptor describing your KeyStore required for HTTPS.

aPort - The port on which to listen for requests.

aMaxConnections - The number of maximum connections at the same time.

Throws:

IOException - thrown in case something went wrong such as the port being already in use.

open

default void open(KeyStoreDescriptor aStoreDescriptor,
 int aPort)
           throws IOException

Same as open(String, KeyStoreDescriptor, int, int) but:

• The protocol for the underlying SSLContext used is set to "TLS".
• The type of KeyStore is set to "JKS".

Parameters:

aStoreDescriptor - The store descriptor describing your KeyStore required for HTTPS.

aPort - The port on which to listen for requests.

Throws:

IOException - thrown in case something went wrong such as the port being already in use.

open

default void open(KeyStoreDescriptor aStoreDescriptor)
           throws IOException

Same as open(String, KeyStoreDescriptor, int) but:

• The protocol for the underlying SSLContext used is set to "TLS".
• The type of KeyStore is set to "JKS".

Parameters:

aStoreDescriptor - The store descriptor describing your KeyStore required for HTTPS.

Throws:

IOException - thrown in case something went wrong such as the port being already in use.

open

default void open(Scheme aScheme,
 KeyStoreDescriptor aStoreDescriptor,
 int aPort,
 int aMaxConnections)
           throws IOException

Opens the HTTPS sever connection (socket) at the given port allowing the given number of maximum connections at the same time using the provided HTTPS configuration parameters.

Parameters:

aScheme - The Scheme to use, e.g. Scheme.HTTPS defaults to "TLS".

aStoreDescriptor - The store descriptor describing your KeyStore required for HTTPS.

aPort - The port on which to listen for requests.

aMaxConnections - The number of maximum connections at the same time.

Throws:

IOException - thrown in case something went wrong such as the port being already in use.

open

default void open(Scheme aScheme,
 KeyStoreDescriptor aStoreDescriptor,
 int aPort)
           throws IOException

Same as open(String, KeyStoreDescriptor, int, int) but:

• The number of maximum connections at the same time is decided upon by the implementations's default value.

Parameters:

aScheme - The Scheme to use, e.g. Scheme.HTTPS defaults to "TLS".

aStoreDescriptor - The store descriptor describing your KeyStore required for HTTPS.

aPort - The port on which to listen for requests.

Throws:

IOException - thrown in case something went wrong such as the port being already in use.

open

default void open(Scheme aScheme,
 KeyStoreDescriptor aStoreDescriptor)
           throws IOException

Same as open(String, KeyStoreDescriptor, int) but:

• The number of maximum connections at the same time is decided upon by the implementations's default value.

Parameters:

aScheme - The Scheme to use, e.g. Scheme.HTTPS defaults to "TLS".

aStoreDescriptor - The store descriptor describing your KeyStore required for HTTPS.

Throws:

IOException - thrown in case something went wrong such as the port being already in use.

open

void open(String aProtocol,
 KeyStoreDescriptor aStoreDescriptor,
 int aPort,
 int aMaxConnections)
   throws IOException

Opens the HTTPS sever connection (socket) at the given port allowing the given number of maximum connections at the same time using the provided HTTPS configuration parameters.

Parameters:

aProtocol - The protocol to use, e.g. "TLS".

aStoreDescriptor - The store descriptor describing your KeyStore required for HTTPS.

aPort - The port on which to listen for requests.

aMaxConnections - The number of maximum connections at the same time.

Throws:

IOException - thrown in case something went wrong such as the port being already in use.

open

default void open(HttpServerContext aConnection)
           throws IOException

Specified by:

open in interface ConnectionOpenable<HttpServerContext>

Throws:

IOException