Module org.refcodes.rest

Package org.refcodes.rest

Class HttpRestServer

java.lang.Object

org.refcodes.observer.AbstractObservable<RestEndpoint,org.refcodes.web.HttpRequest>

org.refcodes.rest.AbstractRestfulServer

org.refcodes.rest.HttpRestServer

All Implemented Interfaces:

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, org.refcodes.component.LinkComponent, org.refcodes.component.Openable, org.refcodes.component.OpenedAccessor, org.refcodes.io.MaxConnectionsAccessor, org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsBuilder<RestfulHttpServer>, org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsMutator, org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsProperty, org.refcodes.mixin.Disposable, org.refcodes.mixin.PortAccessor, org.refcodes.mixin.PortAccessor.PortBuilder<RestfulHttpServer>, org.refcodes.mixin.PortAccessor.PortMutator, org.refcodes.mixin.PortAccessor.PortProperty, org.refcodes.observer.Observable<RestEndpoint>, org.refcodes.observer.Observers<RestEndpoint,RestfulServer>, HttpExceptionHandlerAccessor, HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder<RestfulHttpServer>, HttpExceptionHandlerAccessor.HttpExceptionHandlerMutator, HttpExceptionHandlerAccessor.HttpExceptionHandlerProperty, HttpExceptionHandlingAccessor, HttpExceptionHandlingAccessor.HttpExceptionHandlingBuilder<RestfulHttpServer>, HttpExceptionHandlingAccessor.HttpExceptionHandlingMutator, HttpExceptionHandlingAccessor.HttpExceptionHandlingProperty, RestfulHttpServer, RestfulServer, org.refcodes.security.KeyStoreDescriptorAccessor, org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorBuilder<RestfulHttpServer>, org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorMutator, org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorProperty, 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.web.HttpsConnectionRequestObservable<RestfulHttpServer>, org.refcodes.web.HttpServerInterceptable, org.refcodes.web.MediaTypeFactoryLookup, org.refcodes.web.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup, 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, org.refcodes.web.SchemeAccessor, org.refcodes.web.SchemeAccessor.SchemeBuilder<RestfulHttpServer>, org.refcodes.web.SchemeAccessor.SchemeMutator, org.refcodes.web.SchemeAccessor.SchemeProperty

Direct Known Subclasses:

HttpRestServerSingleton

public class HttpRestServer
extends AbstractRestfulServer
implements RestfulHttpServer

Implementation of the RestfulHttpServer interface using the RestfulHttpServer defined in the com.sun.net.httpserver package. The HttpRestServer is being initialized with some common MediaTypeFactory instances (as implemented by the AbstractRestfulServer). At the time of writing this document the MediaTypeFactory instances being preconfigured are:

• JsonMediaTypeFactory
• XmlMediaTypeFactory
• TextMediaTypeFactory
• FormMediaTypeFactory

The HttpRestServer supports HTTP as well as HTTPS protocols as being based on the RestfulHttpServer as well as on the HttpsServer. For opening up an HTTPS connection, refer to the methods such as RestfulHttpServer.open(String, KeyStoreDescriptor, int) or RestfulHttpServer.open(KeyStoreDescriptor, int) and the like. Set the system property SystemProperty.LOG_DEBUG to true (set when invoking the JRA by passing the argument -Dlog.debug=true to the java executable) to log additional erroneous situations e.g. related to content types and accept types alongside marshaling and unmarshaling.

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

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CONTEXT_PATH

Fields inherited from class org.refcodes.rest.AbstractRestfulServer

_isVerbose

Constructor Summary

Constructors

Constructor	Description
HttpRestServer()	Constructs a HttpRestServer.
HttpRestServer(boolean isVerbose)	Constructs a HttpRestServer.
HttpRestServer(ExecutorService aExecutorService)	Constructs a HttpRestServer.
HttpRestServer(ExecutorService aExecutorService, boolean isVerbose)	Constructs a HttpRestServer.
HttpRestServer(org.refcodes.controlflow.ThreadingModel aThreadingModel)	Constructs a HttpRestServer.
HttpRestServer(org.refcodes.controlflow.ThreadingModel aThreadingModel, boolean isVerbose)	Constructs a HttpRestServer.

Method Summary

Modifier and Type	Method	Description
boolean	addPostHttpInterceptor(org.refcodes.web.PostHttpServerInterceptor aPostInterceptor)
boolean	addPreHttpInterceptor(org.refcodes.web.PreHttpServerInterceptor aPreInterceptor)
void	close()
org.refcodes.component.ConnectionStatus	getConnectionStatus()
HttpExceptionHandler	getHttpExceptionHandler()	Retrieves the HttpExceptionHandler from the HttpExceptionHandler property.
HttpExceptionHandling	getHttpExceptionHandling()	Retrieves the HttpExceptionHandling from the HttpExceptionHandling property.
protected HttpServer	getHttpServer()	Gets the HTTP server.
org.refcodes.security.KeyStoreDescriptor	getKeyStoreDescriptor()
int	getMaxConnections()
int	getPort()
org.refcodes.data.Scheme	getScheme()
boolean	hasPostHttpInterceptor(org.refcodes.web.PostHttpServerInterceptor aPostInterceptor)
boolean	hasPreHttpInterceptor(org.refcodes.web.PreHttpServerInterceptor aPreInterceptor)
RestfulHttpServer	onBasicAuthRequest(org.refcodes.web.BasicAuthObserver aBasicAuthObserver)
RestfulHttpServer	onConnectionRequest(org.refcodes.web.HttpsConnectionRequestObserver aObserver)
protected void	open(HttpServer aHttpServer)	A hook to be used when using custom RestfulHttpServer ( HttpsServer) by custom open(...) methods of sub-classes of this HttpRestServer.
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.
protected void	postIntercept(org.refcodes.web.HttpServerRequest aRequest, org.refcodes.web.HttpServerResponse aResponse)	Invoked to post-process a HttpServerRequest alongside a HttpServerResponse.
protected void	preIntercept(org.refcodes.web.HttpServerRequest aRequest, org.refcodes.web.HttpServerResponse aResponse)	Invoked to pre-process a HttpServerRequest alongside a HttpServerResponse.
boolean	removePostHttpInterceptor(org.refcodes.web.PostHttpServerInterceptor aPostInterceptor)
boolean	removePreHttpInterceptor(org.refcodes.web.PreHttpServerInterceptor aPreInterceptor)
void	setHttpExceptionHandler(HttpExceptionHandler aHttpErrorHandler)	Sets the HttpExceptionHandler for the HttpExceptionHandler property.
void	setHttpExceptionHandling(HttpExceptionHandling aHttpErrorHandling)	Sets the HttpExceptionHandling for the HttpExceptionHandling property.
void	setKeyStoreDescriptor(org.refcodes.security.KeyStoreDescriptor aKeyStoreDescriptor)
void	setMaxConnections(int aMaxConnections)
void	setPort(int aPort)
void	setProtocol(String aProtocol)
void	setScheme(org.refcodes.data.Scheme aScheme)
String	toProtocol()
HttpRestServer	withBaseLocator(String aBaseLocator)
HttpRestServer	withClose()
HttpRestServer	withCloseIn(int aCloseMillis)
HttpRestServer	withCloseQuietly()
HttpRestServer	withCloseUnchecked()
HttpRestServer	withDisableObservers()
HttpRestServer	withEnableObservers()
HttpRestServer	withHttpExceptionHandler(HttpExceptionHandler aHttpErrorHandler)	Sets the HttpExceptionHandler for the HttpExceptionHandler property.
HttpRestServer	withHttpExceptionHandling(HttpExceptionHandling aHttpErrorHandling)	Sets the HttpExceptionHandling for the HttpExceptionHandling property.
HttpRestServer	withKeyStoreDescriptor(org.refcodes.security.KeyStoreDescriptor aKeyStoreDescriptor)
HttpRestServer	withMaxConnections(int aMaxConnections)
HttpRestServer	withObserversActive(boolean isActive)
HttpRestServer	withOnHttpException(HttpExceptionHandler aHttpExceptionHandler)	Sets the HttpExceptionHandler for the HttpExceptionHandler property.
HttpRestServer	withOpen(int aPort)	Builder method for opening the RestfulHttpServer.
HttpRestServer	withOpen(org.refcodes.web.HttpServerContext aConnection)
HttpRestServer	withOpenUnchecked(org.refcodes.web.HttpServerContext aConnection)
HttpRestServer	withPort(int aPort)
HttpRestServer	withProtocol(String aProtocol)
HttpRestServer	withRealm(String aRealm)
HttpRestServer	withScheme(org.refcodes.data.Scheme aScheme)

Methods inherited from class org.refcodes.rest.AbstractRestfulServer

addMediaTypeFactory, dispose, fireEvent, getBaseLocator, getFactoryMediaTypes, getRealm, initMedaTypeFactories, isObserversActive, observers, onHttpRequest, setBaseLocator, setObserversActive, setRealm, subscribeObserver, toMediaTypeFactory, toNegotiatedContenType, toResponseBody, unsubscribeObserver

Methods inherited from class org.refcodes.observer.AbstractObservable

clear, doHandleEventListenerException, fireEvent, getThreadPriority, hasObserver, isEmpty, setThreadPriority, size

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

closeIn, closeQuietly, closeUnchecked

Methods inherited from interface org.refcodes.component.ConnectionOpenable

openUnchecked

Methods inherited from interface org.refcodes.component.ConnectionStatusAccessor

isOpened

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

onHttpException

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

letHttpExceptionHandler

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

letHttpExceptionHandling

Methods inherited from interface org.refcodes.web.HttpServerInterceptable

addHttpInterceptor, hasHttpInterceptor, removeHttpInterceptor

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

letKeyStoreDescriptor

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.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.rest.RestfulHttpServer

open, open, open, open, open, open, open, open, open, open, open, open

Methods inherited from interface org.refcodes.rest.RestfulServer

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

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

letProtocol, letScheme

Field Details

CONTEXT_PATH

protected static final String CONTEXT_PATH

Constructor Details

HttpRestServer

public HttpRestServer(org.refcodes.controlflow.ThreadingModel aThreadingModel)

Constructs a HttpRestServer. Use RestfulHttpServer.open(int) or similar to make it listen on your port. The provided ThreadingModel defines whether to use a single-threaded or a multi-threaded threading model. Threads are created as daemon threads. For more control on thread generation use the constructor HttpRestServer(ExecutorService).

Parameters:

aThreadingModel - Specifies to either use a single-threaded threading model (no ExecutorService) or a multi-threaded threading model with a default ExecutorService as of ControlFlowUtility.createCachedExecutorService(boolean).

HttpRestServer

public HttpRestServer(org.refcodes.controlflow.ThreadingModel aThreadingModel,
 boolean isVerbose)

Constructs a HttpRestServer. Use RestfulHttpServer.open(int) or similar to make it listen on your port. The provided ThreadingModel defines whether to use a single-threaded or a multi-threaded threading model. Threads are created as daemon threads. For more control on thread generation use the constructor HttpRestServer(ExecutorService).

Parameters:

aThreadingModel - Specifies to either use a single-threaded threading model (no ExecutorService) or a multi-threaded threading model with a default ExecutorService as of ControlFlowUtility.createCachedExecutorService(boolean).

isVerbose - When true, any unknown content- and accept-types are logged.

HttpRestServer

public HttpRestServer()

Constructs a HttpRestServer. Use RestfulHttpServer.open(int) or similar to make it listen on your port. Uses a multi threaded threading model with a default ExecutorService as of ControlFlowUtility.createCachedExecutorService(boolean). Threads are created as daemon threads. For more control on thread generation use the constructor HttpRestServer(ExecutorService).

HttpRestServer

public HttpRestServer(boolean isVerbose)

Constructs a HttpRestServer. Use RestfulHttpServer.open(int) or similar to make it listen on your port. Uses a multi threaded threading model with a default ExecutorService as of ControlFlowUtility.createCachedExecutorService(boolean). Threads are created as daemon threads. For more control on thread generation use the constructor HttpRestServer(ExecutorService).

Parameters:

isVerbose - When true, any unknown content- and accept-types are logged.

HttpRestServer

public HttpRestServer(ExecutorService aExecutorService)

Constructs a HttpRestServer. Use RestfulHttpServer.open(int) or similar to make it listen on your port. Uses a multi threaded threading model.

Parameters:

aExecutorService - An executor service to be used when creating Threads.

HttpRestServer

public HttpRestServer(ExecutorService aExecutorService,
 boolean isVerbose)

Constructs a HttpRestServer. Use RestfulHttpServer.open(int) or similar to make it listen on your port. Uses a multi threaded threading model.

Parameters:

aExecutorService - An executor service to be used when creating Threads.

isVerbose - When true, any unknown content- and accept-types are logged.

Method Details

close

public void close()
           throws IOException

Specified by:

close in interface org.refcodes.component.Closable

Throws:

IOException

open

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

Specified by:

open in interface RestfulHttpServer

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.

getConnectionStatus

public org.refcodes.component.ConnectionStatus getConnectionStatus()

Specified by:

getConnectionStatus in interface org.refcodes.component.ConnectionStatusAccessor

getHttpExceptionHandler

public HttpExceptionHandler getHttpExceptionHandler()

Retrieves the HttpExceptionHandler from the HttpExceptionHandler property.

Specified by:

getHttpExceptionHandler in interface HttpExceptionHandlerAccessor

Returns:

The HttpExceptionHandler stored by the HttpExceptionHandler property.

setHttpExceptionHandler

public void setHttpExceptionHandler(HttpExceptionHandler aHttpErrorHandler)

Sets the HttpExceptionHandler for the HttpExceptionHandler property.

Specified by:

setHttpExceptionHandler in interface HttpExceptionHandlerAccessor.HttpExceptionHandlerMutator

Parameters:

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

getHttpExceptionHandling

public HttpExceptionHandling getHttpExceptionHandling()

Retrieves the HttpExceptionHandling from the HttpExceptionHandling property.

Specified by:

getHttpExceptionHandling in interface HttpExceptionHandlingAccessor

Returns:

The HttpExceptionHandling stored by the HttpExceptionHandling property.

setHttpExceptionHandling

public void setHttpExceptionHandling(HttpExceptionHandling aHttpErrorHandling)

Sets the HttpExceptionHandling for the HttpExceptionHandling property.

Specified by:

setHttpExceptionHandling in interface HttpExceptionHandlingAccessor.HttpExceptionHandlingMutator

Parameters:

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

onConnectionRequest

public RestfulHttpServer onConnectionRequest(org.refcodes.web.HttpsConnectionRequestObserver aObserver)

Specified by:

onConnectionRequest in interface org.refcodes.web.HttpsConnectionRequestObservable<RestfulHttpServer>

onBasicAuthRequest

public RestfulHttpServer onBasicAuthRequest(org.refcodes.web.BasicAuthObserver aBasicAuthObserver)

Specified by:

onBasicAuthRequest in interface org.refcodes.web.BasicAuthObservable<RestfulHttpServer>

setPort

public void setPort(int aPort)

Specified by:

setPort in interface org.refcodes.mixin.PortAccessor.PortMutator

getPort

public int getPort()

Specified by:

getPort in interface org.refcodes.mixin.PortAccessor

setScheme

public void setScheme(org.refcodes.data.Scheme aScheme)

Specified by:

setScheme in interface org.refcodes.web.SchemeAccessor.SchemeMutator

getScheme

public org.refcodes.data.Scheme getScheme()

Specified by:

getScheme in interface org.refcodes.web.SchemeAccessor

toProtocol

public String toProtocol()

Specified by:

toProtocol in interface org.refcodes.web.SchemeAccessor

setProtocol

public void setProtocol(String aProtocol)

Specified by:

setProtocol in interface org.refcodes.web.SchemeAccessor.SchemeMutator

getKeyStoreDescriptor

public org.refcodes.security.KeyStoreDescriptor getKeyStoreDescriptor()

Specified by:

getKeyStoreDescriptor in interface org.refcodes.security.KeyStoreDescriptorAccessor

setKeyStoreDescriptor

public void setKeyStoreDescriptor(org.refcodes.security.KeyStoreDescriptor aKeyStoreDescriptor)

Specified by:

setKeyStoreDescriptor in interface org.refcodes.security.KeyStoreDescriptorAccessor.KeyStoreDescriptorMutator

getMaxConnections

public int getMaxConnections()

Specified by:

getMaxConnections in interface org.refcodes.io.MaxConnectionsAccessor

setMaxConnections

public void setMaxConnections(int aMaxConnections)

Specified by:

setMaxConnections in interface org.refcodes.io.MaxConnectionsAccessor.MaxConnectionsMutator

hasPreHttpInterceptor

public boolean hasPreHttpInterceptor(org.refcodes.web.PreHttpServerInterceptor aPreInterceptor)

Specified by:

hasPreHttpInterceptor in interface org.refcodes.web.PreHttpInterceptable<org.refcodes.web.PreHttpServerInterceptor>

addPreHttpInterceptor

public boolean addPreHttpInterceptor(org.refcodes.web.PreHttpServerInterceptor aPreInterceptor)

Specified by:

addPreHttpInterceptor in interface org.refcodes.web.PreHttpInterceptable<org.refcodes.web.PreHttpServerInterceptor>

removePreHttpInterceptor

public boolean removePreHttpInterceptor(org.refcodes.web.PreHttpServerInterceptor aPreInterceptor)

Specified by:

removePreHttpInterceptor in interface org.refcodes.web.PreHttpInterceptable<org.refcodes.web.PreHttpServerInterceptor>

hasPostHttpInterceptor

public boolean hasPostHttpInterceptor(org.refcodes.web.PostHttpServerInterceptor aPostInterceptor)

Specified by:

hasPostHttpInterceptor in interface org.refcodes.web.PostHttpInterceptable<org.refcodes.web.PostHttpServerInterceptor>

addPostHttpInterceptor

public boolean addPostHttpInterceptor(org.refcodes.web.PostHttpServerInterceptor aPostInterceptor)

Specified by:

addPostHttpInterceptor in interface org.refcodes.web.PostHttpInterceptable<org.refcodes.web.PostHttpServerInterceptor>

removePostHttpInterceptor

public boolean removePostHttpInterceptor(org.refcodes.web.PostHttpServerInterceptor aPostInterceptor)

Specified by:

removePostHttpInterceptor in interface org.refcodes.web.PostHttpInterceptable<org.refcodes.web.PostHttpServerInterceptor>

withRealm

public HttpRestServer withRealm(String aRealm)

Specified by:

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

Specified by:

withRealm in interface RestfulHttpServer

Specified by:

withRealm in interface RestfulServer

withCloseUnchecked

public HttpRestServer withCloseUnchecked()

Specified by:

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

withObserversActive

public HttpRestServer withObserversActive(boolean isActive)

Specified by:

withObserversActive in interface org.refcodes.observer.Observers<RestEndpoint,RestfulServer>

Specified by:

withObserversActive in interface RestfulServer

withEnableObservers

public HttpRestServer withEnableObservers()

Specified by:

withEnableObservers in interface org.refcodes.observer.Observers<RestEndpoint,RestfulServer>

Specified by:

withEnableObservers in interface RestfulServer

withDisableObservers

public HttpRestServer withDisableObservers()

Specified by:

withDisableObservers in interface org.refcodes.observer.Observers<RestEndpoint,RestfulServer>

Specified by:

withDisableObservers in interface RestfulServer

withOnHttpException

public HttpRestServer withOnHttpException(HttpExceptionHandler aHttpExceptionHandler)

Sets the HttpExceptionHandler for the HttpExceptionHandler property.

Specified by:

withOnHttpException in interface HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder<RestfulHttpServer>

Parameters:

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

Returns:

The builder for applying multiple build operations.

withOpenUnchecked

public HttpRestServer withOpenUnchecked(org.refcodes.web.HttpServerContext aConnection)

Specified by:

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

withHttpExceptionHandler

public HttpRestServer withHttpExceptionHandler(HttpExceptionHandler aHttpErrorHandler)

Sets the HttpExceptionHandler for the HttpExceptionHandler property.

Specified by:

withHttpExceptionHandler in interface HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder<RestfulHttpServer>

Specified by:

withHttpExceptionHandler in interface RestfulHttpServer

Parameters:

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

Returns:

The builder for applying multiple build operations.

withHttpExceptionHandling

public HttpRestServer withHttpExceptionHandling(HttpExceptionHandling aHttpErrorHandling)

Sets the HttpExceptionHandling for the HttpExceptionHandling property.

Specified by:

withHttpExceptionHandling in interface HttpExceptionHandlingAccessor.HttpExceptionHandlingBuilder<RestfulHttpServer>

Specified by:

withHttpExceptionHandling in interface RestfulHttpServer

Parameters:

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

Returns:

The builder for applying multiple build operations.

withBaseLocator

public HttpRestServer withBaseLocator(String aBaseLocator)

Specified by:

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

Specified by:

withBaseLocator in interface RestfulHttpServer

Specified by:

withBaseLocator in interface RestfulServer

withClose

public HttpRestServer withClose()
                         throws IOException

Specified by:

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

Specified by:

withClose in interface RestfulHttpServer

Throws:

IOException

withCloseQuietly

public HttpRestServer withCloseQuietly()

Specified by:

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

Specified by:

withCloseQuietly in interface RestfulHttpServer

withCloseIn

public HttpRestServer withCloseIn(int aCloseMillis)

Specified by:

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

Specified by:

withCloseIn in interface RestfulHttpServer

withOpen

public HttpRestServer 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>>

Specified by:

withOpen in interface RestfulHttpServer

Throws:

IOException

withOpen

public HttpRestServer withOpen(int aPort)
                        throws IOException

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

Specified by:

withOpen in interface RestfulHttpServer

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

public HttpRestServer withPort(int aPort)

Specified by:

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

Specified by:

withPort in interface RestfulHttpServer

withScheme

public HttpRestServer withScheme(org.refcodes.data.Scheme aScheme)

Specified by:

withScheme in interface RestfulHttpServer

Specified by:

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

withProtocol

public HttpRestServer withProtocol(String aProtocol)

Specified by:

withProtocol in interface RestfulHttpServer

Specified by:

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

withKeyStoreDescriptor

public HttpRestServer withKeyStoreDescriptor(org.refcodes.security.KeyStoreDescriptor aKeyStoreDescriptor)

Specified by:

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

Specified by:

withKeyStoreDescriptor in interface RestfulHttpServer

withMaxConnections

public HttpRestServer withMaxConnections(int aMaxConnections)

Specified by:

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

Specified by:

withMaxConnections in interface RestfulHttpServer

preIntercept

protected void preIntercept(org.refcodes.web.HttpServerRequest aRequest,
 org.refcodes.web.HttpServerResponse aResponse)

Invoked to pre-process a HttpServerRequest alongside a HttpServerResponse.

Overrides:

preIntercept in class AbstractRestfulServer

Parameters:

aRequest - The HttpServerRequest to pre-process.

aResponse - The HttpServerResponse to post-process.

postIntercept

protected void postIntercept(org.refcodes.web.HttpServerRequest aRequest,
 org.refcodes.web.HttpServerResponse aResponse)

Invoked to post-process a HttpServerRequest alongside a HttpServerResponse.

Overrides:

postIntercept in class AbstractRestfulServer

Parameters:

aRequest - The HttpServerRequest to post-process.

aResponse - The HttpServerResponse to post-process.

getHttpServer

protected HttpServer getHttpServer()

Gets the HTTP server.

Returns:

the HTTP server

open

protected void open(HttpServer aHttpServer)
             throws IOException

A hook to be used when using custom RestfulHttpServer ( HttpsServer) by custom open(...) methods of sub-classes of this HttpRestServer. E.g HttpRestServer uses this hook to pre-configure a HttpsServer for HTTPS. The passed RestfulHttpServer ( HttpsServer) must already be bound to a port and enabled with the number of concurrent connections as of HttpServer.bind(InetSocketAddress, int).

Parameters:

aHttpServer - The RestfulHttpServer to be used. E.g. an HttpsServer might be used to enable HTTPS.

Throws:

IOException - in case opening with the provided RestfulHttpServer fails.