org.refcodes.rest.impls

Class AbstractRestService

java.lang.Object

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

org.refcodes.rest.impls.AbstractRestService

All Implemented Interfaces:

org.refcodes.mixin.Disposable, org.refcodes.net.MediaTypeFactoryLookup, org.refcodes.observer.Observable<Endpoint>, RestService

Direct Known Subclasses:

HttpRestServerImpl, LoopbackRestService

public abstract class AbstractRestService
extends org.refcodes.observer.impls.AbstractObservable<Endpoint,org.refcodes.net.HttpRequest>
implements RestService

Implementation of the RestService interface using the HttpServer defined in com.sun.net.httpserver package.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.Disposable

org.refcodes.mixin.Disposable.Disposedable

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	addMediaTypeFactory(org.refcodes.net.MediaTypeFactory aMediaTypeFactory) Registers a MediaTypeFactory for marshaling and unmarshaling a HTTP request's body of the according MediaType.
void	dispose()
protected boolean	fireEvent(org.refcodes.net.HttpRequest aEvent, Endpoint aObserver, org.refcodes.controlflow.ExecutionStrategy aExecutionStrategy)
protected void	initMedaTypeFactories() Adds the default MediaTypeFactory instances.
protected org.refcodes.net.HttpServerResponse	onHttpRequest(org.refcodes.net.HttpMethod aHttpMethod, String aLocator, String aQueryString, org.refcodes.net.RequestHeaderFields aRequestHeaderFields, String aRequestBody) Extensions of this class disect an incoming request and pass it to this method for doing the actual invocation of the registered Endpoint instances.
boolean	subscribeObserver(Endpoint aObserver)
EndpointBuilder	subscribeObserver(org.refcodes.net.HttpMethod aHttpMethod, String aLocatorPattern, RequestObserver aRequestObserver) Registers a pre-configured EndpointBuilder with the least required attributes. and returns its instance.
org.refcodes.net.MediaTypeFactory	toMediaTypeFactory(org.refcodes.net.MediaType aMediaType)
boolean	unsubscribeObserver(Endpoint 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.RestService

onDelete, onGet, onPost, onPut

Methods inherited from interface org.refcodes.observer.Observable

hasObserverSubscription

Constructor Detail

AbstractRestService

public AbstractRestService()

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

AbstractRestService

public AbstractRestService(ExecutorService aExecutorService)

CConstructs a AbstractRestService 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.

subscribeObserver

public boolean subscribeObserver(Endpoint aObserver)

Specified by:

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

Overrides:

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

subscribeObserver

public EndpointBuilder subscribeObserver(org.refcodes.net.HttpMethod aHttpMethod,
                                         String aLocatorPattern,
                                         RequestObserver aRequestObserver)

Description copied from interface: RestService

Registers a pre-configured EndpointBuilder with the least required attributes. and returns its instance. To unsubscribe via #unsubscribeObserver(EndpointBuilder), use the returned instance.

Specified by:

subscribeObserver in interface RestService

Parameters:

aHttpMethod - The HTTP method to which this EndpointBuilder is bound.

aLocatorPattern - The local locator pattern to which this EndpointBuilder is bound.

aRequestObserver - The Command processing a request targeted at this EndpointBuilder.

Returns:

The pre-configured EndpointBuilder which acts as handle to unsubscribe the EndpointBuilder.

unsubscribeObserver

public boolean unsubscribeObserver(Endpoint aObserver)

Specified by:

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

Overrides:

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

addMediaTypeFactory

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

Description copied from interface: RestService

Registers a MediaTypeFactory for marshaling and unmarshaling a HTTP request's body of the according MediaType. A MediaTypeFactory is responsible for exactly one MediaType , declared via the MediaTypeAccessor.getMediaType() method. .

Specified by:

addMediaTypeFactory in interface RestService

Parameters:

aMediaTypeFactory - The MediaTypeFactory to be registered.

Returns:

True in case the MediaTypeFactory has successfully been registered, false in case there has already a MediaTypeFactory been registered which is responsible for the provided MediaTypeFactory's MediaType.

toMediaTypeFactory

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

Specified by:

toMediaTypeFactory 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<Endpoint,org.refcodes.net.HttpRequest>

onHttpRequest

protected org.refcodes.net.HttpServerResponse onHttpRequest(org.refcodes.net.HttpMethod aHttpMethod,
                                                            String aLocator,
                                                            String aQueryString,
                                                            org.refcodes.net.RequestHeaderFields aRequestHeaderFields,
                                                            String aRequestBody)
                                                     throws org.refcodes.net.HttpException

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

Parameters:

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.

aRequestBody - 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.HttpException - thrown in case of an Endpoint responsible for the given request encountered a problem or none Endpoint felt responsible to produce a HttpServerResponse.

fireEvent

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

Specified by:

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

Throws:

org.refcodes.exception.VetoException