org.refcodes.rest.impls

Class AbstractRestServer

java.lang.Object

org.refcodes.observer.impls.AbstractObservable<RestEndpoint,org.refcodes.net.HttpRequest>

org.refcodes.rest.impls.AbstractRestServer

All Implemented Interfaces:

org.refcodes.mixin.Disposable, org.refcodes.net.BaseLocatorAccessor, org.refcodes.net.BaseLocatorAccessor.BaseLocatorBuilder<RestServer>, org.refcodes.net.BaseLocatorAccessor.BaseLocatorMutator, org.refcodes.net.BaseLocatorAccessor.BaseLocatorProperty, org.refcodes.net.MediaTypeFactoryLookup, org.refcodes.net.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup, org.refcodes.net.RealmAccessor, org.refcodes.net.RealmAccessor.RealmBuilder<RestServer>, org.refcodes.net.RealmAccessor.RealmMutator, org.refcodes.net.RealmAccessor.RealmProperty, org.refcodes.observer.Observable<RestEndpoint>, RestServer, org.refcodes.runtime.RequestCorrelation<RestServer>, org.refcodes.runtime.SessionCorrelation<RestServer>

Direct Known Subclasses:

HttpRestServerImpl, LoopbackRestServerImpl

public abstract class AbstractRestServer
extends org.refcodes.observer.impls.AbstractObservable<RestEndpoint,org.refcodes.net.HttpRequest>
implements RestServer

Implementation of the base functionality of the RestServer interface omitting the HTTP handling part being the foundation for various RestServer implementations such as HttpRestServerImpl or LoopbackRestServerImpl. The AbstractRestServer is pre-configured with the following MediaTypeFactory instances:

• ApplicationJsonFactory
• ApplicationXmlFactory
• TextPlainFactory
• ApplicationFormFactory
  In your sub-classes, overwrite the method initMedaTypeFactories(), therein calling addMediaTypeFactory(MediaTypeFactory) to add (by also invoking super's initMedaTypeFactories()) or to set your own (without invoking super's initMedaTypeFactories()) MediaTypeFactory instances.

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.mixin.Disposable

org.refcodes.mixin.Disposable.Disposedable

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	_hasRequestCorrelation
protected boolean	_hasSessionCorrelation

Constructor Summary

Constructors

Constructor and Description
AbstractRestServer() Constructs a AbstractRestServer pre-configured with MediaTypeFactory instances for JSON and REST.
AbstractRestServer(ExecutorService aExecutorService) CConstructs a AbstractRestServer pre-configured with MediaTypeFactory instances for JSON and REST.

Method Summary

Modifier and Type	Method and Description
boolean	addMediaTypeFactory(org.refcodes.net.MediaTypeFactory aMediaTypeFactory)
void	dispose()
protected void	doRequestCorrelation(org.refcodes.net.RequestHeaderFields aRequestHeaderFields, org.refcodes.net.HttpServerResponse aServerResponse)
protected void	doSessionCorrelation(org.refcodes.net.RequestHeaderFields aRequestHeaderFields, org.refcodes.net.HttpServerResponse aServerResponse)
protected boolean	fireEvent(org.refcodes.net.HttpRequest aEvent, RestEndpoint aObserver, org.refcodes.controlflow.ExecutionStrategy aExecutionStrategy)
String	getBaseLocator()
org.refcodes.net.MediaType[]	getFactoryMediaTypes()
String	getRealm()
boolean	hasRequestCorrelation()
boolean	hasSessionCorrelation()
protected void	initMedaTypeFactories() Adds the default MediaTypeFactory instances.
protected org.refcodes.net.HttpServerResponse	onHttpRequest(InetSocketAddress aLocalAddress, InetSocketAddress aRemoteAddress, org.refcodes.net.HttpMethod aHttpMethod, String aLocator, String aQueryString, org.refcodes.net.RequestHeaderFields aRequestHeaderFields, InputStream aHttpInputStream) Extensions of this class disect an incoming request and pass it to this method for doing the actual invocation of the registered RestEndpoint instances.
RestEndpointBuilder	onRequest(org.refcodes.net.HttpMethod aHttpMethod, String aLocatorPattern, RestRequestObserver aRequestObserver) Registers a pre-configured RestEndpoint with the least required attributes and returns its instance.
void	setBaseLocator(String aBaseLocator)
void	setRealm(String aRealm)
void	setRequestCorrelation(boolean hasRequestCorrelation)
void	setSessionCorrelation(boolean hasSessionCorrelation)
boolean	subscribeObserver(RestEndpoint aObserver)
org.refcodes.net.MediaTypeFactory	toMediaTypeFactory(org.refcodes.net.MediaType aMediaType)
protected org.refcodes.net.ContentType	toNegotiatedContenType(org.refcodes.net.RequestHeaderFields aRequestHeaderFields) Determines the best fitting respone's ContentType.
protected byte[]	toResponseBody(Object aResponse, org.refcodes.net.RequestHeaderFields aRequestHeaderFields, org.refcodes.net.ResponseHeaderFields aResponseHeaderFields) Creates a String MediaType encoded as of the HeaderField.CONTENT_TYPE from the response header or if not set as of the HeaderField.ACCEPT from the request header or if not set as of the HeaderField.CONTENT_TYPE from the request header.
boolean	unsubscribeObserver(RestEndpoint aObserver)

Methods inherited from class org.refcodes.observer.impls.AbstractObservable

clear, doHandleEventListenerException, fireEvent, getThreadPriority, hasObserverSubscription, 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.rest.RestServer

onDelete, onGet, onPost, onPut, onRequest, onRequest, withBaseLocator, withDisableRequestCorrelation, withDisableSessionCorrelation, withEnableRequestCorrelation, withEnableSessionCorrelation, withRealm, withRequestCorrelation, withSessionCorrelation

Methods inherited from interface org.refcodes.observer.Observable

hasObserverSubscription

Methods inherited from interface org.refcodes.net.MediaTypeFactoryLookup

hasMediaTypeFactory

Methods inherited from interface org.refcodes.runtime.RequestCorrelation

disableRequestCorrelation, enableRequestCorrelation

Methods inherited from interface org.refcodes.runtime.SessionCorrelation

disableSessionCorrelation, enableSessionCorrelation

Field Detail

_hasRequestCorrelation

protected boolean _hasRequestCorrelation

_hasSessionCorrelation

protected boolean _hasSessionCorrelation

Constructor Detail

AbstractRestServer

public AbstractRestServer()

Constructs a AbstractRestServer pre-configured with MediaTypeFactory instances for JSON and REST.

AbstractRestServer

public AbstractRestServer(ExecutorService aExecutorService)

CConstructs a AbstractRestServer pre-configured with MediaTypeFactory instances for JSON and REST.

Parameters:

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

Method Detail

initMedaTypeFactories

protected void initMedaTypeFactories()

Adds the default MediaTypeFactory instances. Can be overridden.

setRequestCorrelation

public void setRequestCorrelation(boolean hasRequestCorrelation)

Specified by:

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

hasRequestCorrelation

public boolean hasRequestCorrelation()

Specified by:

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

setSessionCorrelation

public void setSessionCorrelation(boolean hasSessionCorrelation)

Specified by:

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

hasSessionCorrelation

public boolean hasSessionCorrelation()

Specified by:

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

getRealm

public String getRealm()

Specified by:

getRealm in interface org.refcodes.net.RealmAccessor

setRealm

public void setRealm(String aRealm)

Specified by:

setRealm in interface org.refcodes.net.RealmAccessor.RealmMutator

getBaseLocator

public String getBaseLocator()

Specified by:

getBaseLocator in interface org.refcodes.net.BaseLocatorAccessor

setBaseLocator

public void setBaseLocator(String aBaseLocator)

Specified by:

setBaseLocator in interface org.refcodes.net.BaseLocatorAccessor.BaseLocatorMutator

subscribeObserver

public boolean subscribeObserver(RestEndpoint aObserver)

Specified by:

subscribeObserver in interface org.refcodes.observer.Observable<RestEndpoint>

Overrides:

subscribeObserver in class org.refcodes.observer.impls.AbstractObservable<RestEndpoint,org.refcodes.net.HttpRequest>

onRequest

public RestEndpointBuilder onRequest(org.refcodes.net.HttpMethod aHttpMethod,
                                     String aLocatorPattern,
                                     RestRequestObserver aRequestObserver)

Description copied from interface: RestServer

Registers a pre-configured RestEndpoint with the least required attributes and returns its instance. To unsubscribe via #unsubscribeObserver(RestEndpoint), use the returned instance. Attention: Invoke Openable.open() to activate this endpoint!

Specified by:

onRequest in interface RestServer

Parameters:

aHttpMethod - The HTTP-Method to which this RestEndpoint is bound. A value of null means that any HTTP-Method may trigger this RestEndpoint.

aLocatorPattern - The local Locator-Pattern to which this RestEndpoint is bound. A value of null means that any locator may trigger this RestEndpoint.

aRequestObserver - The listener processing a request targeted at this RestEndpoint.

Returns:

The pre-configured RestEndpoint which acts as handle to unsubscribe the RestEndpoint via #unsubscribeObserver(RestEndpoint).

unsubscribeObserver

public boolean unsubscribeObserver(RestEndpoint aObserver)

Specified by:

unsubscribeObserver in interface org.refcodes.observer.Observable<RestEndpoint>

Overrides:

unsubscribeObserver in class org.refcodes.observer.impls.AbstractObservable<RestEndpoint,org.refcodes.net.HttpRequest>

addMediaTypeFactory

public boolean addMediaTypeFactory(org.refcodes.net.MediaTypeFactory aMediaTypeFactory)

Specified by:

addMediaTypeFactory in interface org.refcodes.net.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup

toMediaTypeFactory

public org.refcodes.net.MediaTypeFactory toMediaTypeFactory(org.refcodes.net.MediaType aMediaType)

Specified by:

toMediaTypeFactory in interface org.refcodes.net.MediaTypeFactoryLookup

getFactoryMediaTypes

public org.refcodes.net.MediaType[] getFactoryMediaTypes()

Specified by:

getFactoryMediaTypes in interface org.refcodes.net.MediaTypeFactoryLookup

dispose

public void dispose()

Specified by:

dispose in interface org.refcodes.mixin.Disposable

Overrides:

dispose in class org.refcodes.observer.impls.AbstractObservable<RestEndpoint,org.refcodes.net.HttpRequest>

onHttpRequest

protected org.refcodes.net.HttpServerResponse onHttpRequest(InetSocketAddress aLocalAddress,
                                                            InetSocketAddress aRemoteAddress,
                                                            org.refcodes.net.HttpMethod aHttpMethod,
                                                            String aLocator,
                                                            String aQueryString,
                                                            org.refcodes.net.RequestHeaderFields aRequestHeaderFields,
                                                            InputStream aHttpInputStream)
                                                     throws org.refcodes.net.HttpStatusException

Extensions of this class disect an incoming request and pass it to this method for doing the actual invocation of the registered RestEndpoint instances. An extension might call this method from inside an event (request) handler.

Parameters:

aLocalAddress - The host and port of your REST service.

aRemoteAddress - The host and port for the caller.

aHttpMethod - The HttpMethod of the request.

aLocator - The locator (URL) targeted by the request (without the query string).

aQueryString - The query string part of the request.

aRequestHeaderFields - The header fields (HeaderFields) belonging to the request.

aHttpInputStream - The body passed by the request.

Returns:

A HttpServerResponse instance to by used by the extension to produce an according HTTP-Response.

Throws:

org.refcodes.net.HttpStatusException - thrown in case of an RestEndpoint responsible for the given request encountered a problem or none RestEndpoint felt responsible to produce a HttpServerResponse.

toNegotiatedContenType

protected org.refcodes.net.ContentType toNegotiatedContenType(org.refcodes.net.RequestHeaderFields aRequestHeaderFields)

Determines the best fitting respone's ContentType. The default Content-Type-Negotiation implementation of this method makes use of the RequestHeaderFields and matches them against the supported MediaType types ( retrieved via getFactoryMediaTypes()). May be overwritten to enforce another Content-Type-Negotiation strategy.

Parameters:

aRequestHeaderFields - The request's HeaderField instance to use when determining the best fitting respone's ContentType.

Returns:

The best fitting (as of the implemented Content-Type-Negotiation strategy) Content-Type to be used for the response.

toResponseBody

protected byte[] toResponseBody(Object aResponse,
                                org.refcodes.net.RequestHeaderFields aRequestHeaderFields,
                                org.refcodes.net.ResponseHeaderFields aResponseHeaderFields)
                         throws org.refcodes.exception.MarshalException,
                                org.refcodes.net.UnsupportedMediaTypeException

Creates a String MediaType encoded as of the HeaderField.CONTENT_TYPE from the response header or if not set as of the HeaderField.ACCEPT from the request header or if not set as of the HeaderField.CONTENT_TYPE from the request header.

Parameters:

aResponse - The response which to encode as of the detected MediaTypes.

aRequestHeaderFields - The header fields from the request.

aResponseHeaderFields - The header fields from the response.

Returns:

An accordingly encoded response as byte array.

Throws:

org.refcodes.exception.MarshalException - thrown when marshaling / serializing an object failed.

org.refcodes.net.UnsupportedMediaTypeException - thrown in case none of the identified media types is supported, e.g. no required MediaTypeFactory has been registered as of addMediaTypeFactory(MediaTypeFactory).

fireEvent

protected boolean fireEvent(org.refcodes.net.HttpRequest aEvent,
                            RestEndpoint aObserver,
                            org.refcodes.controlflow.ExecutionStrategy aExecutionStrategy)
                     throws org.refcodes.exception.VetoException

Specified by:

fireEvent in class org.refcodes.observer.impls.AbstractObservable<RestEndpoint,org.refcodes.net.HttpRequest>

Throws:

org.refcodes.exception.VetoException

doRequestCorrelation

protected void doRequestCorrelation(org.refcodes.net.RequestHeaderFields aRequestHeaderFields,
                                    org.refcodes.net.HttpServerResponse aServerResponse)

doSessionCorrelation

protected void doSessionCorrelation(org.refcodes.net.RequestHeaderFields aRequestHeaderFields,
                                    org.refcodes.net.HttpServerResponse aServerResponse)