Module org.refcodes.rest

Package org.refcodes.rest

Interface RestfulServer

All Superinterfaces:

org.refcodes.web.BaseLocatorAccessor, org.refcodes.web.BaseLocatorAccessor.BaseLocatorBuilder<RestfulServer>, org.refcodes.web.BaseLocatorAccessor.BaseLocatorMutator, org.refcodes.web.BaseLocatorAccessor.BaseLocatorProperty, org.refcodes.web.MediaTypeFactoryLookup, org.refcodes.web.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup, org.refcodes.observer.Observable<RestEndpoint>, org.refcodes.observer.Observers<RestEndpoint,RestfulServer>, org.refcodes.web.RealmAccessor, org.refcodes.web.RealmAccessor.RealmBuilder<RestfulServer>, org.refcodes.web.RealmAccessor.RealmMutator, org.refcodes.web.RealmAccessor.RealmProperty

All Known Subinterfaces:

RestfulHttpRegistryServer<DESC,B>, RestfulHttpServer

All Known Implementing Classes:

AbstractRestfulHttpRegistryServerDecorator, AbstractRestfulHttpServerDecorator, AbstractRestfulServer, HttpRestServer, HttpRestServerSingleton, LoopbackRestServer, LoopbackRestServerSingleton

public interface RestfulServer
extends org.refcodes.observer.Observable<RestEndpoint>, org.refcodes.observer.Observers<RestEndpoint,RestfulServer>, org.refcodes.web.MediaTypeFactoryLookup.MutableMediaTypeFactoryLookup, org.refcodes.web.RealmAccessor.RealmProperty, org.refcodes.web.RealmAccessor.RealmBuilder<RestfulServer>, org.refcodes.web.BaseLocatorAccessor.BaseLocatorProperty, org.refcodes.web.BaseLocatorAccessor.BaseLocatorBuilder<RestfulServer>

The RestfulServer 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 RestfulServer ( RestfulHttpServer). The RestfulServer (RestfulHttpServer) 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.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 preconfigured RestEndpoint, triggerd by any HTTP method, and returns its instance.
default RestEndpointBuilder	onRequest(Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer)	Registers a preconfigured 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 preconfigured RestEndpoint with the least required attributes and returns its instance.
default RestEndpointBuilder	onRequest(org.refcodes.web.HttpMethod aHttpMethod, Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer)	Registers a preconfigured RestEndpoint with the least required attributes and returns its instance.
default RestfulServer	withBaseLocator(String aBaseLocator)
default RestfulServer	withDisableObservers()
default RestfulServer	withEnableObservers()
default RestfulServer	withObserversActive(boolean isActive)
default RestfulServer	withRealm(String aRealm)

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

getRealm

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

setRealm

Methods inherited from interface org.refcodes.web.RealmAccessor.RealmProperty

letRealm

Method Details

withObserversActive

default RestfulServer withObserversActive(boolean isActive)

Specified by:

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

withEnableObservers

default RestfulServer withEnableObservers()

Specified by:

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

withDisableObservers

default RestfulServer withDisableObservers()

Specified by:

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

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 RestfulServer withBaseLocator(String aBaseLocator)

Specified by:

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

withRealm

default RestfulServer withRealm(String aRealm)

Specified by:

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

onRequest

default RestEndpointBuilder onRequest(String aLocatorPathPattern,
 RestRequestConsumer aRequestConsumer)

Registers a preconfigured 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 preconfigured RestEndpoint which acts as handle to unsubscribe the RestEndpoint via Observable.unsubscribeObserver(Object).

onRequest

default RestEndpointBuilder onRequest(Pattern aLocatorRegExp,
 RestRequestConsumer aRequestConsumer)

Registers a preconfigured 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 preconfigured 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 preconfigured 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 preconfigured 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 preconfigured 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 preconfigured 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 preconfigured 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 preconfigured 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 preconfigured 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 preconfigured 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 preconfigured 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 preconfigured 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 preconfigured 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 preconfigured RestEndpoint which acts as handle to unsubscribe the RestEndpoint via Observable.unsubscribeObserver(Object).