org.refcodes.rest

Class LoopbackRestServerImpl

java.lang.Object

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

org.refcodes.rest.AbstractRestServer

org.refcodes.rest.LoopbackRestServerImpl

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>, org.refcodes.observer.Observers<RestEndpoint,RestServer>, LoopbackRestServer, RestServer, org.refcodes.runtime.RequestCorrelation<RestServer>, org.refcodes.runtime.SessionCorrelation<RestServer>

Direct Known Subclasses:

LoopbackRestServerSingleton

public class LoopbackRestServerImpl
extends AbstractRestServer
implements LoopbackRestServer

Implementation if the LoopbackRestServer for easy testing of your requests being received by a RestServer (HttpRestServer) and the according response lambda expressions.

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 inherited from class org.refcodes.rest.AbstractRestServer

_hasRequestCorrelation, _hasSessionCorrelation

Constructor Summary

Constructors

Constructor and Description
LoopbackRestServerImpl()

Method Summary

Modifier and Type	Method and Description
org.refcodes.net.HttpServerResponse	onHttpRequest(InetSocketAddress aLocalAddress, InetSocketAddress aClientAddress, org.refcodes.net.HttpMethod aHttpMethod, org.refcodes.net.Url aUrl, 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.
org.refcodes.net.HttpServerResponse	onHttpRequest(InetSocketAddress aLocalAddress, InetSocketAddress aClientAddress, org.refcodes.net.HttpMethod aHttpMethod, org.refcodes.net.Url aUrl, org.refcodes.net.RequestHeaderFields aRequestHeaderFields, String aHttpBody) Invoke this method to simulate a REST request to be handled by the according registered RestEndpoint instances:

Methods inherited from class org.refcodes.rest.AbstractRestServer

addMediaTypeFactory, dispose, doRequestCorrelation, doSessionCorrelation, fireEvent, getBaseLocator, getFactoryMediaTypes, getRealm, hasRequestCorrelation, hasSessionCorrelation, initMedaTypeFactories, isObserversActive, observers, setBaseLocator, setObserversActive, setRealm, setRequestCorrelation, setSessionCorrelation, subscribeObserver, toMediaTypeFactory, toNegotiatedContenType, toResponseBody, unsubscribeObserver

Methods inherited from class org.refcodes.observer.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.LoopbackRestServer

withBaseLocator, withRealm

Methods inherited from interface org.refcodes.rest.RestServer

onDelete, onGet, onPost, onPut, onRequest, onRequest, onRequest, withDisableObservers, withDisableRequestCorrelation, withDisableSessionCorrelation, withEnableObservers, withEnableRequestCorrelation, withEnableSessionCorrelation, withObserversActive, withRequestCorrelation, withSessionCorrelation

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.net.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup

addMediaTypeFactory

Methods inherited from interface org.refcodes.net.MediaTypeFactoryLookup

getFactoryMediaTypes, hasMediaTypeFactory, toMediaTypeFactory

Methods inherited from interface org.refcodes.net.RealmAccessor

getRealm

Methods inherited from interface org.refcodes.net.RealmAccessor.RealmMutator

setRealm

Methods inherited from interface org.refcodes.net.BaseLocatorAccessor

getBaseLocator

Methods inherited from interface org.refcodes.net.BaseLocatorAccessor.BaseLocatorMutator

setBaseLocator

Methods inherited from interface org.refcodes.runtime.RequestCorrelation

disableRequestCorrelation, enableRequestCorrelation, hasRequestCorrelation, setRequestCorrelation

Methods inherited from interface org.refcodes.runtime.SessionCorrelation

disableSessionCorrelation, enableSessionCorrelation, hasSessionCorrelation, setSessionCorrelation

Constructor Detail

LoopbackRestServerImpl

public LoopbackRestServerImpl()

Method Detail

onHttpRequest

public org.refcodes.net.HttpServerResponse onHttpRequest(InetSocketAddress aLocalAddress,
                                                         InetSocketAddress aClientAddress,
                                                         org.refcodes.net.HttpMethod aHttpMethod,
                                                         org.refcodes.net.Url aUrl,
                                                         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.

Specified by:

onHttpRequest in interface LoopbackRestServer

Overrides:

onHttpRequest in class AbstractRestServer

Parameters:

aLocalAddress - The host and port of your REST service.

aClientAddress - The host and port for the caller.

aHttpMethod - The HttpMethod of the request.

aUrl - The Url from which to take the URL specific data.

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.

onHttpRequest

public org.refcodes.net.HttpServerResponse onHttpRequest(InetSocketAddress aLocalAddress,
                                                         InetSocketAddress aClientAddress,
                                                         org.refcodes.net.HttpMethod aHttpMethod,
                                                         org.refcodes.net.Url aUrl,
                                                         org.refcodes.net.RequestHeaderFields aRequestHeaderFields,
                                                         String aHttpBody)
                                                  throws org.refcodes.net.HttpStatusException

Invoke this method to simulate a REST request to be handled by the according registered RestEndpoint instances:

Specified by:

onHttpRequest in interface LoopbackRestServer

Parameters:

aLocalAddress - the local address

aClientAddress - the client address

aHttpMethod - The method for the simulated REST request to be used

aUrl - The query string part of the request.

aRequestHeaderFields - The simulated REST request's Header-Fields to be used

aHttpBody - The raw body for the simulated REST request to be used.

Returns:

The HttpServerResponse containing the complete result of processing the request.

Throws:

org.refcodes.net.HttpStatusException - the http status exception