Module org.refcodes.rest

Package org.refcodes.rest

Interface RestServer

All Superinterfaces:

org.refcodes.web.BaseLocatorAccessor, org.refcodes.web.BaseLocatorAccessor.BaseLocatorBuilder<RestServer>, org.refcodes.web.BaseLocatorAccessor.BaseLocatorMutator, org.refcodes.web.BaseLocatorAccessor.BaseLocatorProperty, HttpExceptionHandlerAccessor, HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder<RestServer>, HttpExceptionHandlerAccessor.HttpExceptionHandlerMutator, HttpExceptionHandlerAccessor.HttpExceptionHandlerProperty, HttpExceptionHandlingAccessor, HttpExceptionHandlingAccessor.HttpExceptionHandlingBuilder<RestServer>, HttpExceptionHandlingAccessor.HttpExceptionHandlingMutator, HttpExceptionHandlingAccessor.HttpExceptionHandlingProperty, org.refcodes.web.MediaTypeFactoryLookup, org.refcodes.web.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup, org.refcodes.observer.Observable<RestEndpoint>, org.refcodes.observer.Observers<RestEndpoint,RestServer>, org.refcodes.web.RealmAccessor, org.refcodes.web.RealmAccessor.RealmBuilder<RestServer>, org.refcodes.web.RealmAccessor.RealmMutator, org.refcodes.web.RealmAccessor.RealmProperty, org.refcodes.runtime.RequestCorrelation<RestServer>, org.refcodes.runtime.SessionCorrelation<RestServer>

All Known Subinterfaces:

HttpRegistryRestServer<DESC,B>, HttpRestServer, LoopbackRestServer

All Known Implementing Classes:

AbstractHttpRegistryRestServerDecorator, AbstractHttpRestServerDecorator, AbstractRestServer, HttpRestServerImpl, HttpRestServerSingleton, LoopbackRestServerImpl, LoopbackRestServerSingleton

public interface RestServer
extends HttpExceptionHandlerAccessor.HttpExceptionHandlerProperty, HttpExceptionHandlerAccessor.HttpExceptionHandlerBuilder<RestServer>, HttpExceptionHandlingAccessor.HttpExceptionHandlingProperty, HttpExceptionHandlingAccessor.HttpExceptionHandlingBuilder<RestServer>, org.refcodes.observer.Observable<RestEndpoint>, org.refcodes.observer.Observers<RestEndpoint,RestServer>, org.refcodes.web.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup, org.refcodes.web.RealmAccessor.RealmProperty, org.refcodes.web.RealmAccessor.RealmBuilder<RestServer>, org.refcodes.web.BaseLocatorAccessor.BaseLocatorProperty, org.refcodes.web.BaseLocatorAccessor.BaseLocatorBuilder<RestServer>, org.refcodes.runtime.RequestCorrelation<RestServer>, org.refcodes.runtime.SessionCorrelation<RestServer>

The RestServer acts as the target for clients issuing REST requests. RestEndpointBuilder instances, most easily being created with the onRequest(HttpMethod, String, RestRequestConsumer) method (or the like), are registered as listeners to the RestServer ( HttpRestServer). The RestServer (HttpRestServer) fires RestRequestEvent events to the RestRequestConsumers of an RestEndpoint dedicated to an according locator (pattern) for a specific HttpMethod.

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.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.web.MediaTypeFactoryLookup

org.refcodes.web.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup

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

Method Summary

Modifier and Type	Method	Description
default RestEndpointBuilder	onDelete(String aLocatorPathPattern, RestRequestConsumer aRequestConsumer)	Even more convenient: Everything done here can also be done using onRequest(HttpMethod, String, RestRequestConsumer): Registers a RestRequestConsumer with the given Locator-Pattern to incoming DELETE methods.
default RestEndpointBuilder	onDelete(Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer)	Even more convenient: Everything done here can also be done using onRequest(HttpMethod, String, RestRequestConsumer): Registers a RestRequestConsumer with the given Locator-Pattern to incoming DELETE methods.
default RestEndpointBuilder	onGet(String aLocatorPathPattern, RestRequestConsumer aRequestConsumer)	Even more convenient: Everything done here can also be done using onRequest(HttpMethod, String, RestRequestConsumer): Registers a RestRequestConsumer with the given Locator-Pattern to incoming GET methods.
default RestEndpointBuilder	onGet(Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer)	Even more convenient: Everything done here can also be done using onRequest(HttpMethod, String, RestRequestConsumer): Registers a RestRequestConsumer with the given Locator-Pattern to incoming GET methods.
default RestEndpointBuilder	onPost(String aLocatorPathPattern, RestRequestConsumer aRequestConsumer)	Even more convenient: Everything done here can also be done using onRequest(HttpMethod, String, RestRequestConsumer): Registers a RestRequestConsumer with the given Locator-Pattern to incoming POST methods.
default RestEndpointBuilder	onPost(Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer)	Even more convenient: Everything done here can also be done using onRequest(HttpMethod, String, RestRequestConsumer): Registers a RestRequestConsumer with the given Locator-Pattern to incoming POST methods.
default RestEndpointBuilder	onPut(String aLocatorPathPattern, RestRequestConsumer aRequestConsumer)	Even more convenient: Everything done here can also be done using onRequest(HttpMethod, String, RestRequestConsumer): Registers a RestRequestConsumer with the given Locator-Pattern to incoming PUT methods.
default RestEndpointBuilder	onPut(Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer)	Even more convenient: Everything done here can also be done using onRequest(HttpMethod, String, RestRequestConsumer): Registers a RestRequestConsumer with the given Locator-Pattern to incoming PUT methods.
default RestEndpointBuilder	onRequest(String aLocatorPathPattern, RestRequestConsumer aRequestConsumer)	Registers a pre-configured RestEndpoint, triggerd by any HTTP method, and returns its instance.
default RestEndpointBuilder	onRequest(Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer)	Registers a pre-configured RestEndpoint, triggerd by any HTTP method, and returns its instance.
default boolean	onRequest(RestEndpoint aRestEndpoint)	For the sake of unified naming, this method just delegates to Observable.subscribeObserver(Object).
default RestEndpointBuilder	onRequest(org.refcodes.web.HttpMethod aHttpMethod, String aLocatorPathPattern, RestRequestConsumer aRequestConsumer)	Registers a pre-configured RestEndpoint with the least required attributes and returns its instance.
default RestEndpointBuilder	onRequest(org.refcodes.web.HttpMethod aHttpMethod, Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer)	Registers a pre-configured RestEndpoint with the least required attributes and returns its instance.
default RestServer	withBaseLocator(String aBaseLocator)
default RestServer	withDisableObservers()
default RestServer	withDisableRequestCorrelation()
default RestServer	withDisableSessionCorrelation()
default RestServer	withEnableObservers()
default RestServer	withEnableRequestCorrelation()
default RestServer	withEnableSessionCorrelation()
default RestServer	withObserversActive(boolean isActive)
default RestServer	withRealm(String aRealm)
default RestServer	withRequestCorrelation(boolean hasRequestCorrelation)
default RestServer	withSessionCorrelation(boolean hasSessionCorrelation)

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

getHttpExceptionHandler

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

withHttpExceptionHandler, withOnHttpException

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

onHttpException, setHttpExceptionHandler

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

letHttpExceptionHandler

Methods inherited from interface org.refcodes.rest.HttpExceptionHandlingAccessor

getHttpExceptionHandling

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

withHttpExceptionHandling

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

setHttpExceptionHandling

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

letHttpExceptionHandling

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

hasObserverSubscription, subscribeObserver, unsubscribeObserver

Methods inherited from interface org.refcodes.observer.Observers

disableObservers, enableObservers, isObserversActive, observers, setObserversActive

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.runtime.RequestCorrelation

disableRequestCorrelation, enableRequestCorrelation, hasRequestCorrelation, setRequestCorrelation

Methods inherited from interface org.refcodes.runtime.SessionCorrelation

disableSessionCorrelation, enableSessionCorrelation, hasSessionCorrelation, setSessionCorrelation

Method Detail

withObserversActive

default RestServer withObserversActive(boolean isActive)

Specified by:

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

withEnableObservers

default RestServer withEnableObservers()

Specified by:

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

withDisableObservers

default RestServer withDisableObservers()

Specified by:

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

withSessionCorrelation

default RestServer withSessionCorrelation(boolean hasSessionCorrelation)

Specified by:

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

withEnableSessionCorrelation

default RestServer withEnableSessionCorrelation()

Specified by:

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

withDisableSessionCorrelation

default RestServer withDisableSessionCorrelation()

Specified by:

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

withRequestCorrelation

default RestServer withRequestCorrelation(boolean hasRequestCorrelation)

Specified by:

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

withEnableRequestCorrelation

default RestServer withEnableRequestCorrelation()

Specified by:

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

withDisableRequestCorrelation

default RestServer withDisableRequestCorrelation()

Specified by:

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

onRequest

default boolean onRequest(RestEndpoint aRestEndpoint)

For the sake of unified naming, this method just delegates to Observable.subscribeObserver(Object).

Parameters:

aRestEndpoint - the rest endpoint

Returns:

true, if successful

withBaseLocator

default RestServer withBaseLocator(String aBaseLocator)

Specified by:

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

withRealm

default RestServer withRealm(String aRealm)

Specified by:

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

onRequest

default RestEndpointBuilder onRequest(String aLocatorPathPattern,
                                      RestRequestConsumer aRequestConsumer)

Registers a pre-configured RestEndpoint, triggerd by any HTTP method, and returns its instance. To unsubscribe via Observable.unsubscribeObserver(Object), use the returned instance. Attention: Invoke RestEndpointBuilder.open() to activate this endpoint!

Parameters:

aLocatorPathPattern - The local locator (regular expression) pattern to which this RestEndpoint is bound.

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

Returns:

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

onRequest

default RestEndpointBuilder onRequest(Pattern aLocatorRegExp,
                                      RestRequestConsumer aRequestConsumer)

Registers a pre-configured RestEndpoint, triggerd by any HTTP method, and returns its instance. To unsubscribe via Observable.unsubscribeObserver(Object), use the returned instance. Attention: Invoke RestEndpointBuilder.open() to activate this endpoint!

Parameters:

aLocatorRegExp - The local locator (regular expression) pattern to which this RestEndpoint is bound.

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

Returns:

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

onRequest

default RestEndpointBuilder onRequest(org.refcodes.web.HttpMethod aHttpMethod,
                                      String aLocatorPathPattern,
                                      RestRequestConsumer aRequestConsumer)

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

Parameters:

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

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

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

Returns:

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

onRequest

default RestEndpointBuilder onRequest(org.refcodes.web.HttpMethod aHttpMethod,
                                      Pattern aLocatorRegExp,
                                      RestRequestConsumer aRequestConsumer)

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

Parameters:

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

aLocatorRegExp - The local locator (regular expression) pattern to which this RestEndpoint is bound. A value of null means that any locator may trigger this RestEndpoint.

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

Returns:

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

onGet

default RestEndpointBuilder onGet(String aLocatorPathPattern,
                                  RestRequestConsumer aRequestConsumer)

Even more convenient: Everything done here can also be done using onRequest(HttpMethod, String, RestRequestConsumer): Registers a RestRequestConsumer with the given Locator-Pattern to incoming GET methods. Attention: Invoke RestEndpointBuilder.open() to activate this endpoint!

Parameters:

aLocatorPathPattern - The local Locator-Pattern to which this RestEndpoint is bound.

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

Returns:

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

onGet

default RestEndpointBuilder onGet(Pattern aLocatorRegExp,
                                  RestRequestConsumer aRequestConsumer)

Even more convenient: Everything done here can also be done using onRequest(HttpMethod, String, RestRequestConsumer): Registers a RestRequestConsumer with the given Locator-Pattern to incoming GET methods. Attention: Invoke RestEndpointBuilder.open() to activate this endpoint!

Parameters:

aLocatorRegExp - The local locator (regular expression) pattern to which this RestEndpoint is bound.

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

Returns:

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

onPut

default RestEndpointBuilder onPut(String aLocatorPathPattern,
                                  RestRequestConsumer aRequestConsumer)

Even more convenient: Everything done here can also be done using onRequest(HttpMethod, String, RestRequestConsumer): Registers a RestRequestConsumer with the given Locator-Pattern to incoming PUT methods. Attention: Invoke RestEndpointBuilder.open() to activate this endpoint!

Parameters:

aLocatorPathPattern - The local Locator-Pattern to which this RestEndpoint is bound.

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

Returns:

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

onPut

default RestEndpointBuilder onPut(Pattern aLocatorRegExp,
                                  RestRequestConsumer aRequestConsumer)

Even more convenient: Everything done here can also be done using onRequest(HttpMethod, String, RestRequestConsumer): Registers a RestRequestConsumer with the given Locator-Pattern to incoming PUT methods. Attention: Invoke RestEndpointBuilder.open() to activate this endpoint!

Parameters:

aLocatorRegExp - The local locator (regular expression) pattern to which this RestEndpoint is bound.

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

Returns:

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

onPost

default RestEndpointBuilder onPost(String aLocatorPathPattern,
                                   RestRequestConsumer aRequestConsumer)

Even more convenient: Everything done here can also be done using onRequest(HttpMethod, String, RestRequestConsumer): Registers a RestRequestConsumer with the given Locator-Pattern to incoming POST methods. Attention: Invoke RestEndpointBuilder.open() to activate this endpoint!

Parameters:

aLocatorPathPattern - The local Locator-Pattern to which this RestEndpoint is bound.

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

Returns:

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

onPost

default RestEndpointBuilder onPost(Pattern aLocatorRegExp,
                                   RestRequestConsumer aRequestConsumer)

Even more convenient: Everything done here can also be done using onRequest(HttpMethod, String, RestRequestConsumer): Registers a RestRequestConsumer with the given Locator-Pattern to incoming POST methods. Attention: Invoke RestEndpointBuilder.open() to activate this endpoint!

Parameters:

aLocatorRegExp - The local locator (regular expression) pattern to which this RestEndpoint is bound.

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

Returns:

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

onDelete

default RestEndpointBuilder onDelete(String aLocatorPathPattern,
                                     RestRequestConsumer aRequestConsumer)

Even more convenient: Everything done here can also be done using onRequest(HttpMethod, String, RestRequestConsumer): Registers a RestRequestConsumer with the given Locator-Pattern to incoming DELETE methods. Attention: Invoke RestEndpointBuilder.open() to activate this endpoint!

Parameters:

aLocatorPathPattern - The local Locator-Pattern to which this RestEndpoint is bound.

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

Returns:

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

onDelete

default RestEndpointBuilder onDelete(Pattern aLocatorRegExp,
                                     RestRequestConsumer aRequestConsumer)

Even more convenient: Everything done here can also be done using onRequest(HttpMethod, String, RestRequestConsumer): Registers a RestRequestConsumer with the given Locator-Pattern to incoming DELETE methods. Attention: Invoke RestEndpointBuilder.open() to activate this endpoint!

Parameters:

aLocatorRegExp - The local locator (regular expression) pattern to which this RestEndpoint is bound.

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

Returns:

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