Module org.refcodes.rest

Package org.refcodes.rest

Interface RestfulHttpServer

All Superinterfaces:

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

All Known Subinterfaces:

RestfulHttpRegistryServer<DESC,B>

All Known Implementing Classes:

AbstractRestfulHttpRegistryServerDecorator, AbstractRestfulHttpServerDecorator, HttpRestServer, HttpRestServerSingleton

public interface RestfulHttpServer
extends RestfulServer, org.refcodes.web.HttpServerInterceptable, HttpExceptionHandlerAccessor.HttpExceptionHandlerProperty, HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder<RestfulHttpServer>, HttpExceptionHandlingAccessor.HttpExceptionHandlingProperty, HttpExceptionHandlingAccessor.HttpExceptionHandlingBuilder<RestfulHttpServer>, org.refcodes.component.LinkComponent, org.refcodes.component.ConnectionStatusAccessor, org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<org.refcodes.web.HttpServerContext,RestfulHttpServer>, org.refcodes.web.BasicAuthObservable<RestfulHttpServer>, org.refcodes.web.HttpsConnectionRequestObservable<RestfulHttpServer>, org.refcodes.mixin.PortAccessor.PortProperty, org.refcodes.mixin.PortAccessor.PortBuilder<RestfulHttpServer>, org.refcodes.web.SchemeAccessor.SchemeProperty, org.refcodes.web.SchemeAccessor.SchemeBuilder<RestfulHttpServer>, org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorProperty, org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorBuilder<RestfulHttpServer>, org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsProperty, org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsBuilder<RestfulHttpServer>

Extends a RestfulServer 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 RestfulHttpServer can be shutdown via Closable.close().

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.web.BaseLocatorAccessor

org.refcodes.web.BaseLocatorAccessor.BaseLocatorBuilder<B extends org.refcodes.web.BaseLocatorAccessor.BaseLocatorBuilder<B>>, org.refcodes.web.BaseLocatorAccessor.BaseLocatorMutator, org.refcodes.web.BaseLocatorAccessor.BaseLocatorProperty

Nested classes/interfaces inherited from interface org.refcodes.component.Closable

org.refcodes.component.Closable.CloseAutomaton, org.refcodes.component.Closable.CloseBuilder<B extends org.refcodes.component.Closable.CloseBuilder<B>>

Nested classes/interfaces inherited from interface org.refcodes.component.ConnectionComponent

org.refcodes.component.ConnectionComponent.ConnectionAutomaton<CON>, org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<CON,B extends org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<CON,B>>

Nested classes/interfaces inherited from interface org.refcodes.component.ConnectionOpenable

org.refcodes.component.ConnectionOpenable.ConnectionOpenAutomaton<CON>, org.refcodes.component.ConnectionOpenable.ConnectionOpenBuilder<CON,B extends org.refcodes.component.ConnectionOpenable.ConnectionOpenBuilder<CON,B>>

Nested classes/interfaces inherited from interface org.refcodes.component.ConnectionStatusAccessor

org.refcodes.component.ConnectionStatusAccessor.ConnectionStatusMutator, org.refcodes.component.ConnectionStatusAccessor.ConnectionStatusProperty

Nested classes/interfaces inherited from interface org.refcodes.rest.HttpExceptionHandlerAccessor

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

Nested classes/interfaces inherited from interface org.refcodes.rest.HttpExceptionHandlingAccessor

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

Nested classes/interfaces inherited from interface org.refcodes.security.KeyStoreDescriptorAccessor

org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorBuilder<B extends org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorBuilder<B>>, org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorMutator, org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorProperty

Nested classes/interfaces inherited from interface org.refcodes.component.LinkComponent

org.refcodes.component.LinkComponent.LinkAutomaton, org.refcodes.component.LinkComponent.LinkComponentBuilder<B extends org.refcodes.component.LinkComponent.LinkComponentBuilder<B>>

Nested classes/interfaces inherited from interface org.refcodes.io.MaxConnectionsAccessor

org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsBuilder<B extends org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsBuilder<B>>, org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsMutator, org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsProperty

Nested classes/interfaces inherited from interface org.refcodes.web.MediaTypeFactoryLookup

org.refcodes.web.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup

Nested classes/interfaces inherited from interface org.refcodes.component.Openable

org.refcodes.component.Openable.OpenAutomaton, org.refcodes.component.Openable.OpenBuilder<B extends org.refcodes.component.Openable.OpenBuilder<B>>

Nested classes/interfaces inherited from interface org.refcodes.component.OpenedAccessor

org.refcodes.component.OpenedAccessor.OpenedMutator, org.refcodes.component.OpenedAccessor.OpenedProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.PortAccessor

org.refcodes.mixin.PortAccessor.PortBuilder<B extends org.refcodes.mixin.PortAccessor.PortBuilder<B>>, org.refcodes.mixin.PortAccessor.PortMutator, org.refcodes.mixin.PortAccessor.PortProperty

Nested classes/interfaces inherited from interface org.refcodes.web.RealmAccessor

org.refcodes.web.RealmAccessor.RealmBuilder<B extends org.refcodes.web.RealmAccessor.RealmBuilder<B>>, org.refcodes.web.RealmAccessor.RealmMutator, org.refcodes.web.RealmAccessor.RealmProperty

Nested classes/interfaces inherited from interface org.refcodes.web.SchemeAccessor

org.refcodes.web.SchemeAccessor.SchemeBuilder<B extends org.refcodes.web.SchemeAccessor.SchemeBuilder<B>>, org.refcodes.web.SchemeAccessor.SchemeMutator, org.refcodes.web.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, org.refcodes.security.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, org.refcodes.security.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, org.refcodes.security.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(org.refcodes.data.Scheme aScheme, org.refcodes.security.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(org.refcodes.data.Scheme aScheme, org.refcodes.security.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(org.refcodes.data.Scheme aScheme, org.refcodes.security.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(org.refcodes.security.KeyStoreDescriptor aStoreDescriptor)	Same as open(String, KeyStoreDescriptor, int) but: The protocol for the underlying SSLContext used is set to "TLS".
default void	open(org.refcodes.security.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(org.refcodes.security.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(org.refcodes.web.HttpServerContext aConnection)
default RestfulHttpServer	withBaseLocator(String aBaseLocator)
default RestfulHttpServer	withClose()
default RestfulHttpServer	withCloseIn(int aCloseMillis)
default RestfulHttpServer	withCloseQuietly()
default RestfulHttpServer	withHttpExceptionHandler(HttpExceptionHandler aHttpErrorHandler)	Sets the HttpExceptionHandler for the HttpExceptionHandler property.
default RestfulHttpServer	withHttpExceptionHandling(HttpExceptionHandling aHttpErrorHandling)	Sets the HttpExceptionHandling for the HttpExceptionHandling property.
default RestfulHttpServer	withKeyStoreDescriptor(org.refcodes.security.KeyStoreDescriptor aKeyStoreDescriptor)
default RestfulHttpServer	withMaxConnections(int aMaxConnections)
default RestfulHttpServer	withOpen(int aPort)	Builder method for opening the RestfulHttpServer.
default RestfulHttpServer	withOpen(org.refcodes.web.HttpServerContext aConnection)
default RestfulHttpServer	withPort(int aPort)
default RestfulHttpServer	withProtocol(String aProtocol)
default RestfulHttpServer	withRealm(String aRealm)
default RestfulHttpServer	withScheme(org.refcodes.data.Scheme aScheme)

Methods inherited from interface org.refcodes.web.BaseLocatorAccessor

getBaseLocator

Methods inherited from interface org.refcodes.web.BaseLocatorAccessor.BaseLocatorMutator

setBaseLocator

Methods inherited from interface org.refcodes.web.BaseLocatorAccessor.BaseLocatorProperty

letBaseLocator

Methods inherited from interface org.refcodes.web.BasicAuthObservable

onBasicAuthRequest

Methods inherited from interface org.refcodes.component.Closable

close, closeIn, closeQuietly, closeUnchecked

Methods inherited from interface org.refcodes.component.Closable.CloseBuilder

withCloseUnchecked

Methods inherited from interface org.refcodes.component.ConnectionOpenable

openUnchecked

Methods inherited from interface org.refcodes.component.ConnectionOpenable.ConnectionOpenBuilder

withOpenUnchecked

Methods inherited from interface org.refcodes.component.ConnectionStatusAccessor

getConnectionStatus, isOpened

Methods inherited from interface org.refcodes.rest.HttpExceptionHandlerAccessor

getHttpExceptionHandler

Methods inherited from interface org.refcodes.rest.HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder

withOnHttpException

Methods inherited from interface org.refcodes.rest.HttpExceptionHandlerAccessor.HttpExceptionHandlerMutator

onHttpException, setHttpExceptionHandler

Methods inherited from interface org.refcodes.rest.HttpExceptionHandlerAccessor.HttpExceptionHandlerProperty

letHttpExceptionHandler

Methods inherited from interface org.refcodes.rest.HttpExceptionHandlingAccessor

getHttpExceptionHandling

Methods inherited from interface org.refcodes.rest.HttpExceptionHandlingAccessor.HttpExceptionHandlingMutator

setHttpExceptionHandling

Methods inherited from interface org.refcodes.rest.HttpExceptionHandlingAccessor.HttpExceptionHandlingProperty

letHttpExceptionHandling

Methods inherited from interface org.refcodes.web.HttpsConnectionRequestObservable

onConnectionRequest

Methods inherited from interface org.refcodes.web.HttpServerInterceptable

addHttpInterceptor, hasHttpInterceptor, removeHttpInterceptor

Methods inherited from interface org.refcodes.security.KeyStoreDescriptorAccessor

getKeyStoreDescriptor

Methods inherited from interface org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorMutator

setKeyStoreDescriptor

Methods inherited from interface org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorProperty

letKeyStoreDescriptor

Methods inherited from interface org.refcodes.io.MaxConnectionsAccessor

getMaxConnections

Methods inherited from interface org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsMutator

setMaxConnections

Methods inherited from interface org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsProperty

letMaxConnections

Methods inherited from interface org.refcodes.web.MediaTypeFactoryLookup

getFactoryMediaTypes, hasMediaTypeFactory, toMediaTypeFactory

Methods inherited from interface org.refcodes.web.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup

addMediaTypeFactory

Methods inherited from interface org.refcodes.observer.Observable

hasObserver, subscribeObserver, unsubscribeObserver

Methods inherited from interface org.refcodes.observer.Observers

disableObservers, enableObservers, isObserversActive, observers, setObserversActive

Methods inherited from interface org.refcodes.component.Openable

openUnchecked

Methods inherited from interface org.refcodes.mixin.PortAccessor

getPort

Methods inherited from interface org.refcodes.mixin.PortAccessor.PortMutator

setPort

Methods inherited from interface org.refcodes.mixin.PortAccessor.PortProperty

letPort

Methods inherited from interface org.refcodes.web.PostHttpInterceptable

addPostHttpInterceptor, hasPostHttpInterceptor, removePostHttpInterceptor

Methods inherited from interface org.refcodes.web.PreHttpInterceptable

addPreHttpInterceptor, hasPreHttpInterceptor, removePreHttpInterceptor

Methods inherited from interface org.refcodes.web.RealmAccessor

getRealm

Methods inherited from interface org.refcodes.web.RealmAccessor.RealmMutator

setRealm

Methods inherited from interface org.refcodes.web.RealmAccessor.RealmProperty

letRealm

Methods inherited from interface org.refcodes.rest.RestfulServer

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

Methods inherited from interface org.refcodes.web.SchemeAccessor

getScheme, toProtocol

Methods inherited from interface org.refcodes.web.SchemeAccessor.SchemeMutator

setProtocol, setScheme

Methods inherited from interface org.refcodes.web.SchemeAccessor.SchemeProperty

letProtocol, letScheme

Method Details

withHttpExceptionHandler

default RestfulHttpServer withHttpExceptionHandler(HttpExceptionHandler aHttpErrorHandler)

Sets the HttpExceptionHandler for the HttpExceptionHandler property.

Specified by:

withHttpExceptionHandler in interface HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder<RestfulHttpServer>

Parameters:

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

Returns:

The builder for applying multiple build operations.

withHttpExceptionHandling

default RestfulHttpServer withHttpExceptionHandling(HttpExceptionHandling aHttpErrorHandling)

Sets the HttpExceptionHandling for the HttpExceptionHandling property.

Specified by:

withHttpExceptionHandling in interface HttpExceptionHandlingAccessor.HttpExceptionHandlingBuilder<RestfulHttpServer>

Parameters:

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

Returns:

The builder for applying multiple build operations.

withRealm

default RestfulHttpServer withRealm(String aRealm)

Specified by:

withRealm in interface org.refcodes.web.RealmAccessor.RealmBuilder<RestfulServer>

Specified by:

withRealm in interface RestfulServer

withBaseLocator

default RestfulHttpServer withBaseLocator(String aBaseLocator)

Specified by:

withBaseLocator in interface org.refcodes.web.BaseLocatorAccessor.BaseLocatorBuilder<RestfulServer>

Specified by:

withBaseLocator in interface RestfulServer

withClose

default RestfulHttpServer withClose()
                             throws IOException

Specified by:

withClose in interface org.refcodes.component.Closable.CloseBuilder<org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<org.refcodes.web.HttpServerContext,RestfulHttpServer>>

Throws:

IOException

withCloseQuietly

default RestfulHttpServer withCloseQuietly()

Specified by:

withCloseQuietly in interface org.refcodes.component.Closable.CloseBuilder<org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<org.refcodes.web.HttpServerContext,RestfulHttpServer>>

withCloseIn

default RestfulHttpServer withCloseIn(int aCloseMillis)

Specified by:

withCloseIn in interface org.refcodes.component.Closable.CloseBuilder<org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<org.refcodes.web.HttpServerContext,RestfulHttpServer>>

withOpen

default RestfulHttpServer withOpen(org.refcodes.web.HttpServerContext aConnection)
                            throws IOException

Specified by:

withOpen in interface org.refcodes.component.ConnectionOpenable.ConnectionOpenBuilder<org.refcodes.web.HttpServerContext,org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<org.refcodes.web.HttpServerContext,RestfulHttpServer>>

Throws:

IOException

withOpen

default RestfulHttpServer withOpen(int aPort)
                            throws IOException

Builder method for opening the RestfulHttpServer. 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 RestfulHttpServer withPort(int aPort)

Specified by:

withPort in interface org.refcodes.mixin.PortAccessor.PortBuilder<RestfulHttpServer>

withScheme

default RestfulHttpServer withScheme(org.refcodes.data.Scheme aScheme)

Specified by:

withScheme in interface org.refcodes.web.SchemeAccessor.SchemeBuilder<RestfulHttpServer>

withProtocol

default RestfulHttpServer withProtocol(String aProtocol)

Specified by:

withProtocol in interface org.refcodes.web.SchemeAccessor.SchemeBuilder<RestfulHttpServer>

withKeyStoreDescriptor

default RestfulHttpServer withKeyStoreDescriptor(org.refcodes.security.KeyStoreDescriptor aKeyStoreDescriptor)

Specified by:

withKeyStoreDescriptor in interface org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorBuilder<RestfulHttpServer>

withMaxConnections

default RestfulHttpServer withMaxConnections(int aMaxConnections)

Specified by:

withMaxConnections in interface org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsBuilder<RestfulHttpServer>

open

default void open()
           throws IOException

Specified by:

open in interface org.refcodes.component.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,
 org.refcodes.security.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,
 org.refcodes.security.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(org.refcodes.security.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(org.refcodes.security.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(org.refcodes.security.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(org.refcodes.data.Scheme aScheme,
 org.refcodes.security.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(org.refcodes.data.Scheme aScheme,
 org.refcodes.security.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(org.refcodes.data.Scheme aScheme,
 org.refcodes.security.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,
 org.refcodes.security.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(org.refcodes.web.HttpServerContext aConnection)
           throws IOException

Specified by:

open in interface org.refcodes.component.ConnectionOpenable<org.refcodes.web.HttpServerContext>

Throws:

IOException