org.refcodes.rest

Interface HttpRestServer

All Superinterfaces:

org.refcodes.net.BaseLocatorAccessor, org.refcodes.net.BaseLocatorAccessor.BaseLocatorBuilder<RestServer>, org.refcodes.net.BaseLocatorAccessor.BaseLocatorMutator, org.refcodes.net.BaseLocatorAccessor.BaseLocatorProperty, org.refcodes.net.BasicAuthObservable<HttpRestServer>, org.refcodes.component.Closable, org.refcodes.component.Closable.CloseBuilder<org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<Integer,HttpRestServer>>, org.refcodes.component.ConnectionComponent<Integer>, org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<Integer,HttpRestServer>, org.refcodes.component.ConnectionOpenable<Integer>, org.refcodes.component.ConnectionOpenable.ConnectionOpenBuilder<Integer,org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<Integer,HttpRestServer>>, org.refcodes.net.HttpsConnectionRequestObservable<HttpRestServer>, org.refcodes.net.MediaTypeFactoryLookup, org.refcodes.net.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup, org.refcodes.observer.Observable<RestEndpoint>, org.refcodes.net.RealmAccessor, org.refcodes.net.RealmAccessor.RealmBuilder<RestServer>, org.refcodes.net.RealmAccessor.RealmMutator, org.refcodes.net.RealmAccessor.RealmProperty, org.refcodes.runtime.RequestCorrelation<RestServer>, RestServer, org.refcodes.runtime.SessionCorrelation<RestServer>

All Known Implementing Classes:

HttpRestServerImpl, HttpRestServerSingleton

public interface HttpRestServer
extends RestServer, org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<Integer,HttpRestServer>, org.refcodes.net.BasicAuthObservable<HttpRestServer>, org.refcodes.net.HttpsConnectionRequestObservable<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(Integer, int). To open a HTTPS port, use the methods such as: open(File, String, Integer) or open(File, String, String, Integer) or open(String, File, String, String, String, Integer, int). A HttpRestServer can be shutdown via Closable.close().

Nested Class Summary

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

org.refcodes.net.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup

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

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

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

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

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.Closable

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_KEYSTORE_FORMAT
static String	DEFAULT_SSL_PROTOCOL

Method Summary

Modifier and Type	Method and Description
default void	open(File aKeyStoreFile, String aPassword, Integer aPort) Same as open(String, File, String, String, String, Integer, int) but: The protocol fore the underlying SSLContext used is set to "TLS".
default void	open(File aKeyStoreFile, String aKeyStorePassword, Integer aPort, int aMaxConnections) Same as open(String, File, String, String, String, Integer, int) but: The protocol fore the underlying SSLContext used is set to "TLS".
default void	open(File aKeyStoreFile, String aKeyStorePassword, String aKeyPassword, Integer aPort) Same as open(String, File, String, String, String, Integer, int) but: The protocol fore the underlying SSLContext used is set to "TLS".
default void	open(File aKeyStoreFile, String aKeyStorePassword, String aKeyPassword, Integer aPort, int aMaxConnections) Same as open(String, File, String, String, String, Integer, int) but: The protocol fore the underlying SSLContext used is set to "TLS".
void	open(Integer 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 aSecureSocketProtocol, File aKeyStoreFile, String aKeyStorePassword, Integer aPort) Same as open(String, File, String, String, String, Integer, int) but: The type of KeyStore is set to "JKS".
default void	open(String aSecureSocketProtocol, File aKeyStoreFile, String aKeyStorePassword, Integer aPort, int aMaxConnections) Same as open(String, File, String, String, String, Integer, int) but: The type of KeyStore is set to "JKS".
default void	open(String aSecureSocketProtocol, File aKeyStoreFile, String aKeyStoreType, String aKeyStorePassword, String aKeyPassword, Integer aPort) Same as open(String, File, String, String, String, Integer, int) but: The number of maximum connections at the same time is decided upon by the implementations's default value.
void	open(String aSecureSocketProtocol, File aKeyStoreFile, String aKeyStoreType, String aKeyStorePassword, String aKeyPassword, Integer 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 HttpRestServer	withBaseLocator(String aBaseLocator)
default HttpRestServer	withClose()
default HttpRestServer	withCloseIn(int aCloseInMillis)
default HttpRestServer	withCloseQuietly()
default HttpRestServer	withDisableRequestCorrelation()
default HttpRestServer	withDisableSessionCorrelation()
default HttpRestServer	withEnableRequestCorrelation()
default HttpRestServer	withEnableSessionCorrelation()
default HttpRestServer	withOpen(Integer aConnection)
default HttpRestServer	withRealm(String aRealm)
default HttpRestServer	withRequestCorrelation(boolean hasRequestCorrelation)
default HttpRestServer	withSessionCorrelation(boolean hasSessionCorrelation)

Methods inherited from interface org.refcodes.rest.RestServer

onDelete, onGet, onPost, onPut, onRequest, onRequest, onRequest

Methods inherited from interface org.refcodes.observer.Observable

hasObserverSubscription, subscribeObserver, unsubscribeObserver

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

addMediaTypeFactory

Methods inherited from interface org.refcodes.net.MediaTypeFactoryLookup

getFactoryMediaTypes, hasMediaTypeFactory, toMediaTypeFactory

Methods inherited from interface org.refcodes.net.RealmAccessor

getRealm

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

setRealm

Methods inherited from interface org.refcodes.net.BaseLocatorAccessor

getBaseLocator

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

setBaseLocator

Methods inherited from interface org.refcodes.runtime.RequestCorrelation

disableRequestCorrelation, enableRequestCorrelation, hasRequestCorrelation, setRequestCorrelation

Methods inherited from interface org.refcodes.runtime.SessionCorrelation

disableSessionCorrelation, enableSessionCorrelation, hasSessionCorrelation, setSessionCorrelation

Methods inherited from interface org.refcodes.component.ConnectionOpenable

open, openUnchecked

Methods inherited from interface org.refcodes.component.Closable

close, closeIn, closeQuietly, closeUnchecked

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

withOpenUnchecked

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

withCloseUnchecked

Methods inherited from interface org.refcodes.net.BasicAuthObservable

onBasicAuthRequest

Methods inherited from interface org.refcodes.net.HttpsConnectionRequestObservable

onConnectionRequest

Field Detail

DEFAULT_SSL_PROTOCOL

static final String DEFAULT_SSL_PROTOCOL

See Also:

Constant Field Values

DEFAULT_KEYSTORE_FORMAT

static final String DEFAULT_KEYSTORE_FORMAT

See Also:

Constant Field Values

Method Detail

withSessionCorrelation

default HttpRestServer withSessionCorrelation(boolean hasSessionCorrelation)

Specified by:

withSessionCorrelation in interface RestServer

Specified by:

withSessionCorrelation in interface org.refcodes.runtime.SessionCorrelation<RestServer>

withEnableSessionCorrelation

default HttpRestServer withEnableSessionCorrelation()

Specified by:

withEnableSessionCorrelation in interface RestServer

Specified by:

withEnableSessionCorrelation in interface org.refcodes.runtime.SessionCorrelation<RestServer>

withDisableSessionCorrelation

default HttpRestServer withDisableSessionCorrelation()

Specified by:

withDisableSessionCorrelation in interface RestServer

Specified by:

withDisableSessionCorrelation in interface org.refcodes.runtime.SessionCorrelation<RestServer>

withRequestCorrelation

default HttpRestServer withRequestCorrelation(boolean hasRequestCorrelation)

Specified by:

withRequestCorrelation in interface org.refcodes.runtime.RequestCorrelation<RestServer>

Specified by:

withRequestCorrelation in interface RestServer

withEnableRequestCorrelation

default HttpRestServer withEnableRequestCorrelation()

Specified by:

withEnableRequestCorrelation in interface org.refcodes.runtime.RequestCorrelation<RestServer>

Specified by:

withEnableRequestCorrelation in interface RestServer

withDisableRequestCorrelation

default HttpRestServer withDisableRequestCorrelation()

Specified by:

withDisableRequestCorrelation in interface org.refcodes.runtime.RequestCorrelation<RestServer>

Specified by:

withDisableRequestCorrelation in interface RestServer

open

void open(Integer aPort,
          int aMaxConnections)
   throws org.refcodes.component.OpenException

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:

org.refcodes.component.OpenException - thrown in case something went wrong such as the port being already in use.

open

void open(String aSecureSocketProtocol,
          File aKeyStoreFile,
          String aKeyStoreType,
          String aKeyStorePassword,
          String aKeyPassword,
          Integer aPort,
          int aMaxConnections)
   throws org.refcodes.component.OpenException

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:

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

aKeyStoreFile - The file pointing to your KeyStore.

aKeyStoreType - The type of KeyStore, e.g. "JKS" format.

aKeyStorePassword - The password for the KeyStore.

aKeyPassword - The password for the KeyStore's key.

aPort - The port on which to listen for requests.

aMaxConnections - The number of maximum connections at the same time

Throws:

org.refcodes.component.OpenException - thrown in case something went wrong such as the port being already in use.

open

default void open(String aSecureSocketProtocol,
                  File aKeyStoreFile,
                  String aKeyStoreType,
                  String aKeyStorePassword,
                  String aKeyPassword,
                  Integer aPort)
           throws org.refcodes.component.OpenException

Same as open(String, File, String, String, String, Integer, int) but:

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

Parameters:

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

aKeyStoreFile - The file pointing to your KeyStore.

aKeyStoreType - The type of KeyStore, e.g. "JKS" format.

aKeyStorePassword - The password for the KeyStore.

aKeyPassword - The password for the KeyStore's key.

aPort - The port on which to listen for requests.

Throws:

org.refcodes.component.OpenException - thrown in case something went wrong such as the port being already in use.

open

default void open(String aSecureSocketProtocol,
                  File aKeyStoreFile,
                  String aKeyStorePassword,
                  Integer aPort,
                  int aMaxConnections)
           throws org.refcodes.component.OpenException

Same as open(String, File, String, String, String, Integer, int) but:

• 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:

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

aKeyStoreFile - The file pointing to your KeyStore.

aKeyStorePassword - The password for the KeyStore.

aPort - The port on which to listen for requests.

aMaxConnections - The number of maximum connections at the same time

Throws:

org.refcodes.component.OpenException - thrown in case something went wrong such as the port being already in use.

open

default void open(String aSecureSocketProtocol,
                  File aKeyStoreFile,
                  String aKeyStorePassword,
                  Integer aPort)
           throws org.refcodes.component.OpenException

Same as open(String, File, String, String, String, Integer, int) but:

• 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.
• The number of maximum connections at the same time is decided upon by the implementations's default value.

Parameters:

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

aKeyStoreFile - The file pointing to your KeyStore.

aKeyStorePassword - The password for the KeyStore.

aPort - The port on which to listen for requests.

Throws:

org.refcodes.component.OpenException - thrown in case something went wrong such as the port being already in use.

open

default void open(File aKeyStoreFile,
                  String aKeyStorePassword,
                  Integer aPort,
                  int aMaxConnections)
           throws org.refcodes.component.OpenException

Same as open(String, File, String, String, String, Integer, int) but:

• The protocol fore 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:

aKeyStoreFile - The file pointing to your KeyStore.

aKeyStorePassword - The password for the KeyStore.

aPort - The port on which to listen for requests.

aMaxConnections - The number of maximum connections at the same time

Throws:

org.refcodes.component.OpenException - thrown in case something went wrong such as the port being already in use.

open

default void open(File aKeyStoreFile,
                  String aKeyStorePassword,
                  String aKeyPassword,
                  Integer aPort)
           throws org.refcodes.component.OpenException

Same as open(String, File, String, String, String, Integer, int) but:

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

Parameters:

aKeyStoreFile - The file pointing to your KeyStore.

aKeyStorePassword - The password for the KeyStore.

aKeyPassword - The password for the KeyStore's key.

aPort - The port on which to listen for requests.

Throws:

org.refcodes.component.OpenException - thrown in case something went wrong such as the port being already in use.

open

default void open(File aKeyStoreFile,
                  String aKeyStorePassword,
                  String aKeyPassword,
                  Integer aPort,
                  int aMaxConnections)
           throws org.refcodes.component.OpenException

Same as open(String, File, String, String, String, Integer, int) but:

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

Parameters:

aKeyStoreFile - The file pointing to your KeyStore.

aKeyStorePassword - The password for the KeyStore.

aKeyPassword - The password for the KeyStore's key.

aPort - The port on which to listen for requests.

aMaxConnections - The number of maximum connections at the same time

Throws:

org.refcodes.component.OpenException - thrown in case something went wrong such as the port being already in use.

open

default void open(File aKeyStoreFile,
                  String aPassword,
                  Integer aPort)
           throws org.refcodes.component.OpenException

Same as open(String, File, String, String, String, Integer, int) but:

• The protocol fore 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.
• The number of maximum connections at the same time is decided upon by the implementations's default value.

Parameters:

aKeyStoreFile - The file pointing to your KeyStore.

aPassword - The password for the KeyStore.

aPort - The port on which to listen for requests.

Throws:

org.refcodes.component.OpenException - thrown in case something went wrong such as the port being already in use.

withRealm

default HttpRestServer withRealm(String aRealm)

Specified by:

withRealm in interface org.refcodes.net.RealmAccessor.RealmBuilder<RestServer>

Specified by:

withRealm in interface RestServer

withBaseLocator

default HttpRestServer withBaseLocator(String aBaseLocator)

Specified by:

withBaseLocator in interface org.refcodes.net.BaseLocatorAccessor.BaseLocatorBuilder<RestServer>

Specified by:

withBaseLocator in interface RestServer

withClose

default HttpRestServer withClose()
                          throws org.refcodes.component.CloseException

Specified by:

withClose in interface org.refcodes.component.Closable.CloseBuilder<org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<Integer,HttpRestServer>>

Throws:

org.refcodes.component.CloseException

withCloseQuietly

default HttpRestServer withCloseQuietly()

Specified by:

withCloseQuietly in interface org.refcodes.component.Closable.CloseBuilder<org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<Integer,HttpRestServer>>

withCloseIn

default HttpRestServer withCloseIn(int aCloseInMillis)

Specified by:

withCloseIn in interface org.refcodes.component.Closable.CloseBuilder<org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<Integer,HttpRestServer>>

withOpen

default HttpRestServer withOpen(Integer aConnection)
                         throws org.refcodes.component.OpenException

Specified by:

withOpen in interface org.refcodes.component.ConnectionOpenable.ConnectionOpenBuilder<Integer,org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<Integer,HttpRestServer>>

Throws:

org.refcodes.component.OpenException