Interface HttpRestServer

All Superinterfaces:

BaseLocatorAccessor, BasicAuthObservable<HttpRestServer>, Closable, Closable.CloseBuilder<LinkComponent.LinkComponentBuilder<HttpRestServer>>, ConnectionStatusAccessor, HttpExceptionHandlerAccessor, HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder<HttpRestServer>, HttpExceptionHandlerAccessor.HttpExceptionHandlerMutator, HttpExceptionHandlerAccessor.HttpExceptionHandlerProperty, HttpExceptionHandlingAccessor, HttpExceptionHandlingAccessor.HttpExceptionHandlingBuilder<HttpRestServer>, HttpExceptionHandlingAccessor.HttpExceptionHandlingMutator, HttpExceptionHandlingAccessor.HttpExceptionHandlingProperty, HttpsConnectionRequestObservable<HttpRestServer>, HttpServerInterceptable, KeyStoreDescriptorAccessor, LinkComponent, LinkComponent.LinkComponentBuilder<HttpRestServer>, MaxConnectionsAccessor, MediaTypeFactoryLookup, MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup, Observable<RestEndpoint>, Observers<RestEndpoint, RestServer>, Openable, Openable.OpenBuilder<LinkComponent.LinkComponentBuilder<HttpRestServer>>, OpenedAccessor, PortAccessor, PostHttpInterceptable<PostHttpServerInterceptor>, PostHttpServerInterceptable, PreHttpInterceptable<PreHttpServerInterceptor>, PreHttpServerInterceptable, RealmAccessor, RestServer, SchemeAccessor

All Known Subinterfaces:

HttpRestRegistryServer<DESC,B>

All Known Implementing Classes:

AbstractHttpRestRegistryServerDecorator, AbstractHttpRestServerDecorator, JdkHttpRestServer

public interface HttpRestServer
extends RestServer, HttpServerInterceptable, HttpExceptionHandlerAccessor.HttpExceptionHandlerProperty, HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder<HttpRestServer>, HttpExceptionHandlingAccessor.HttpExceptionHandlingProperty, HttpExceptionHandlingAccessor.HttpExceptionHandlingBuilder<HttpRestServer>, ConnectionStatusAccessor, LinkComponent.LinkComponentBuilder<HttpRestServer>, BasicAuthObservable<HttpRestServer>, HttpsConnectionRequestObservable<HttpRestServer>, PortAccessor, SchemeAccessor, KeyStoreDescriptorAccessor, MaxConnectionsAccessor

Extends a RestServer to be capable of opening a server socket on the local host . 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 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
void	open()
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.

Methods inherited from interface BaseLocatorAccessor

getBaseLocator

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 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 MaxConnectionsAccessor

getMaxConnections

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

withOpen

Methods inherited from interface PortAccessor

getPort

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 RestServer

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

Methods inherited from interface SchemeAccessor

getScheme, toProtocol

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.

withClose

default HttpRestServer withClose()
                          throws IOException

Specified by:

withClose in interface Closable.CloseBuilder<LinkComponent.LinkComponentBuilder<HttpRestServer>>

Throws:

IOException

withCloseQuietly

default HttpRestServer withCloseQuietly()

Specified by:

withCloseQuietly in interface Closable.CloseBuilder<LinkComponent.LinkComponentBuilder<HttpRestServer>>

withCloseIn

default HttpRestServer withCloseIn(int aCloseMillis)

Specified by:

withCloseIn in interface Closable.CloseBuilder<LinkComponent.LinkComponentBuilder<HttpRestServer>>

open

void open()
   throws IOException

Specified by:

open in interface Openable

Throws:

IOException