- All Superinterfaces:
org.refcodes.web.BaseLocatorAccessor
,org.refcodes.web.BaseLocatorAccessor.BaseLocatorBuilder<RestServer>
,org.refcodes.web.BaseLocatorAccessor.BaseLocatorMutator
,org.refcodes.web.BaseLocatorAccessor.BaseLocatorProperty
,org.refcodes.web.BasicAuthObservable<HttpRestServer>
,org.refcodes.component.Closable
,org.refcodes.component.Closable.CloseBuilder<org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<org.refcodes.web.HttpServerContext,
,HttpRestServer>> org.refcodes.component.ConnectionComponent<org.refcodes.web.HttpServerContext>
,org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<org.refcodes.web.HttpServerContext,
,HttpRestServer> 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, HttpRestServer>> org.refcodes.component.ConnectionStatusAccessor
,HttpExceptionHandlerAccessor
,HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder<RestServer>
,HttpExceptionHandlerAccessor.HttpExceptionHandlerMutator
,HttpExceptionHandlerAccessor.HttpExceptionHandlerProperty
,HttpExceptionHandlingAccessor
,HttpExceptionHandlingAccessor.HttpExceptionHandlingBuilder<RestServer>
,HttpExceptionHandlingAccessor.HttpExceptionHandlingMutator
,HttpExceptionHandlingAccessor.HttpExceptionHandlingProperty
,org.refcodes.web.HttpsConnectionRequestObservable<HttpRestServer>
,org.refcodes.security.KeyStoreDescriptorAccessor
,org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorBuilder<HttpRestServer>
,org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorMutator
,org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorProperty
,org.refcodes.component.LinkComponent
,org.refcodes.io.MaxConnectionsAccessor
,org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsBuilder<HttpRestServer>
,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,
,RestServer> org.refcodes.component.Openable
,org.refcodes.component.OpenedAccessor
,org.refcodes.mixin.PortAccessor
,org.refcodes.mixin.PortAccessor.PortBuilder<HttpRestServer>
,org.refcodes.mixin.PortAccessor.PortMutator
,org.refcodes.mixin.PortAccessor.PortProperty
,org.refcodes.web.RealmAccessor
,org.refcodes.web.RealmAccessor.RealmBuilder<RestServer>
,org.refcodes.web.RealmAccessor.RealmMutator
,org.refcodes.web.RealmAccessor.RealmProperty
,org.refcodes.runtime.RequestCorrelation<RestServer>
,RestServer
,org.refcodes.web.SchemeAccessor
,org.refcodes.web.SchemeAccessor.SchemeBuilder<HttpRestServer>
,org.refcodes.web.SchemeAccessor.SchemeMutator
,org.refcodes.web.SchemeAccessor.SchemeProperty
,org.refcodes.runtime.SessionCorrelation<RestServer>
- All Known Subinterfaces:
HttpRegistryRestServer<DESC,
B>
- All Known Implementing Classes:
AbstractHttpRegistryRestServerDecorator
,AbstractHttpRestServerDecorator
,HttpRestServerImpl
,HttpRestServerSingleton
public interface HttpRestServer
extends RestServer, org.refcodes.component.LinkComponent, org.refcodes.component.ConnectionStatusAccessor, org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<org.refcodes.web.HttpServerContext,HttpRestServer>, org.refcodes.web.BasicAuthObservable<HttpRestServer>, org.refcodes.web.HttpsConnectionRequestObservable<HttpRestServer>, org.refcodes.mixin.PortAccessor.PortProperty, org.refcodes.mixin.PortAccessor.PortBuilder<HttpRestServer>, org.refcodes.web.SchemeAccessor.SchemeProperty, org.refcodes.web.SchemeAccessor.SchemeBuilder<HttpRestServer>, org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorProperty, org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorBuilder<HttpRestServer>, org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsProperty, org.refcodes.io.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 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 extends Object>, org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<CON extends Object,
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 extends Object>, org.refcodes.component.ConnectionOpenable.ConnectionOpenBuilder<CON extends Object,
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 TypeMethodDescriptiondefault void
open()
default void
open
(int aPort) Opens the HTTP sever connection (socket) at the given portdefault 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
Same asopen(String, KeyStoreDescriptor, int)
but: The number of maximum connections at the same time is decided upon by the implementations's default value.default void
Same asopen(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 asopen(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 asopen(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 asopen(String, KeyStoreDescriptor, int)
but: The protocol for the underlyingSSLContext
used is set to "TLS".default void
open
(org.refcodes.security.KeyStoreDescriptor aStoreDescriptor, int aPort) Same asopen(String, KeyStoreDescriptor, int, int)
but: The protocol for the underlyingSSLContext
used is set to "TLS".default void
open
(org.refcodes.security.KeyStoreDescriptor aStoreDescriptor, int aPort, int aMaxConnections) Same asopen(String, KeyStoreDescriptor, int, int)
but: The protocol for the underlyingSSLContext
used is set to "TLS".default void
open
(org.refcodes.web.HttpServerContext aConnection) default HttpRestServer
withBaseLocator
(String aBaseLocator) default HttpRestServer
default HttpRestServer
withCloseIn
(int aCloseMillis) default HttpRestServer
default HttpRestServer
default HttpRestServer
default HttpRestServer
default HttpRestServer
default HttpRestServer
withHttpExceptionHandler
(HttpExceptionHandler aHttpErrorHandler) Sets theHttpExceptionHandler
for theHttpExceptionHandler
property.default HttpRestServer
withHttpExceptionHandling
(HttpExceptionHandling aHttpErrorHandling) Sets theHttpExceptionHandling
for theHttpExceptionHandling
property.default HttpRestServer
withKeyStoreDescriptor
(org.refcodes.security.KeyStoreDescriptor aKeyStoreDescriptor) default HttpRestServer
withMaxConnections
(int aMaxConnections) default HttpRestServer
withOpen
(int aPort) Builder method for opening theHttpRestServer
.default HttpRestServer
withOpen
(org.refcodes.web.HttpServerContext aConnection) default HttpRestServer
withPort
(int aPort) default HttpRestServer
withProtocol
(String aProtocol) default HttpRestServer
default HttpRestServer
withRequestCorrelation
(boolean hasRequestCorrelation) default HttpRestServer
withScheme
(org.refcodes.data.Scheme aScheme) default HttpRestServer
withSessionCorrelation
(boolean hasSessionCorrelation) 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.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
hasObserverSubscription, 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.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.runtime.RequestCorrelation
disableRequestCorrelation, enableRequestCorrelation, hasRequestCorrelation, setRequestCorrelation
Methods inherited from interface org.refcodes.rest.RestServer
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
Methods inherited from interface org.refcodes.runtime.SessionCorrelation
disableSessionCorrelation, enableSessionCorrelation, hasSessionCorrelation, setSessionCorrelation
-
Method Details
-
withHttpExceptionHandler
Sets theHttpExceptionHandler
for theHttpExceptionHandler
property.- Specified by:
withHttpExceptionHandler
in interfaceHttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder<RestServer>
- Parameters:
aHttpErrorHandler
- TheHttpExceptionHandler
to be stored by theHttpExceptionHandler
property.- Returns:
- The builder for applying multiple build operations.
-
withHttpExceptionHandling
Sets theHttpExceptionHandling
for theHttpExceptionHandling
property.- Specified by:
withHttpExceptionHandling
in interfaceHttpExceptionHandlingAccessor.HttpExceptionHandlingBuilder<RestServer>
- Parameters:
aHttpErrorHandling
- TheHttpExceptionHandling
to be stored by theHttpExceptionHandling
property.- Returns:
- The builder for applying multiple build operations.
-
withSessionCorrelation
- Specified by:
withSessionCorrelation
in interfaceRestServer
- Specified by:
withSessionCorrelation
in interfaceorg.refcodes.runtime.SessionCorrelation<RestServer>
-
withEnableSessionCorrelation
- Specified by:
withEnableSessionCorrelation
in interfaceRestServer
- Specified by:
withEnableSessionCorrelation
in interfaceorg.refcodes.runtime.SessionCorrelation<RestServer>
-
withDisableSessionCorrelation
- Specified by:
withDisableSessionCorrelation
in interfaceRestServer
- Specified by:
withDisableSessionCorrelation
in interfaceorg.refcodes.runtime.SessionCorrelation<RestServer>
-
withRequestCorrelation
- Specified by:
withRequestCorrelation
in interfaceorg.refcodes.runtime.RequestCorrelation<RestServer>
- Specified by:
withRequestCorrelation
in interfaceRestServer
-
withEnableRequestCorrelation
- Specified by:
withEnableRequestCorrelation
in interfaceorg.refcodes.runtime.RequestCorrelation<RestServer>
- Specified by:
withEnableRequestCorrelation
in interfaceRestServer
-
withDisableRequestCorrelation
- Specified by:
withDisableRequestCorrelation
in interfaceorg.refcodes.runtime.RequestCorrelation<RestServer>
- Specified by:
withDisableRequestCorrelation
in interfaceRestServer
-
withRealm
- Specified by:
withRealm
in interfaceorg.refcodes.web.RealmAccessor.RealmBuilder<RestServer>
- Specified by:
withRealm
in interfaceRestServer
-
withBaseLocator
- Specified by:
withBaseLocator
in interfaceorg.refcodes.web.BaseLocatorAccessor.BaseLocatorBuilder<RestServer>
- Specified by:
withBaseLocator
in interfaceRestServer
-
withClose
- Specified by:
withClose
in interfaceorg.refcodes.component.Closable.CloseBuilder<org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<org.refcodes.web.HttpServerContext,
HttpRestServer>> - Throws:
IOException
-
withCloseQuietly
- Specified by:
withCloseQuietly
in interfaceorg.refcodes.component.Closable.CloseBuilder<org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<org.refcodes.web.HttpServerContext,
HttpRestServer>>
-
withCloseIn
- Specified by:
withCloseIn
in interfaceorg.refcodes.component.Closable.CloseBuilder<org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<org.refcodes.web.HttpServerContext,
HttpRestServer>>
-
withOpen
- Specified by:
withOpen
in interfaceorg.refcodes.component.ConnectionOpenable.ConnectionOpenBuilder<org.refcodes.web.HttpServerContext,
org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<org.refcodes.web.HttpServerContext, HttpRestServer>> - Throws:
IOException
-
withOpen
Builder method for opening theHttpRestServer
. Delegates toopen(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
- Specified by:
withPort
in interfaceorg.refcodes.mixin.PortAccessor.PortBuilder<HttpRestServer>
-
withScheme
- Specified by:
withScheme
in interfaceorg.refcodes.web.SchemeAccessor.SchemeBuilder<HttpRestServer>
-
withProtocol
- Specified by:
withProtocol
in interfaceorg.refcodes.web.SchemeAccessor.SchemeBuilder<HttpRestServer>
-
withKeyStoreDescriptor
default HttpRestServer withKeyStoreDescriptor(org.refcodes.security.KeyStoreDescriptor aKeyStoreDescriptor) - Specified by:
withKeyStoreDescriptor
in interfaceorg.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorBuilder<HttpRestServer>
-
withMaxConnections
- Specified by:
withMaxConnections
in interfaceorg.refcodes.io.MaxConnectionsAccessor.MaxConnectionsBuilder<HttpRestServer>
-
open
- Specified by:
open
in interfaceorg.refcodes.component.Openable
- Throws:
IOException
-
open
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
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 asopen(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 yourKeyStore
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 asopen(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 yourKeyStore
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 asopen(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 providedKeyStore
password.
- Parameters:
aStoreDescriptor
- The store descriptor describing yourKeyStore
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.
- The protocol for the underlying
-
open
default void open(org.refcodes.security.KeyStoreDescriptor aStoreDescriptor, int aPort) throws IOException Same asopen(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 yourKeyStore
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.
- The protocol for the underlying
-
open
Same asopen(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 yourKeyStore
required for HTTPS.- Throws:
IOException
- thrown in case something went wrong such as the port being already in use.
- The protocol for the underlying
-
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
- TheScheme
to use, e.g.Scheme.HTTPS
defaults to "TLS".aStoreDescriptor
- The store descriptor describing yourKeyStore
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 asopen(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
- TheScheme
to use, e.g.Scheme.HTTPS
defaults to "TLS".aStoreDescriptor
- The store descriptor describing yourKeyStore
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 asopen(String, KeyStoreDescriptor, int)
but:- The number of maximum connections at the same time is decided upon by the implementations's default value.
- Parameters:
aScheme
- TheScheme
to use, e.g.Scheme.HTTPS
defaults to "TLS".aStoreDescriptor
- The store descriptor describing yourKeyStore
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 yourKeyStore
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
- Specified by:
open
in interfaceorg.refcodes.component.ConnectionOpenable<org.refcodes.web.HttpServerContext>
- Throws:
IOException
-