org.refcodes.rest

Interface RestServer

All Superinterfaces:

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.observer.Observable<RestEndpoint>, org.refcodes.net.RealmAccessor, org.refcodes.net.RealmAccessor.RealmBuilder<RestServer>, org.refcodes.net.RealmAccessor.RealmMutator, org.refcodes.net.RealmAccessor.RealmProperty

All Known Subinterfaces:

HttpRestServer, LoopbackRestServer

All Known Implementing Classes:

AbstractRestServer, HttpRestServerImpl, HttpRestServerSingleton, LoopbackRestServerImpl, LoopbackRestServerSingleton

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

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

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

Method Summary

Modifier and Type	Method and Description
default RestEndpointBuilder	onDelete(String aLocatorPattern, RestRequestObserver aRequestObserver) Even more convenient: Everything done here can also be done using onRequest(HttpMethod, String, RestRequestObserver): Registers a RestRequestObserver with the given Locator-Pattern to incoming DELETE methods.
default RestEndpointBuilder	onGet(String aLocatorPattern, RestRequestObserver aRequestObserver) Even more convenient: Everything done here can also be done using onRequest(HttpMethod, String, RestRequestObserver): Registers a RestRequestObserver with the given Locator-Pattern to incoming GET methods.
default RestEndpointBuilder	onPost(String aLocatorPattern, RestRequestObserver aRequestObserver) Even more convenient: Everything done here can also be done using onRequest(HttpMethod, String, RestRequestObserver): Registers a RestRequestObserver with the given Locator-Pattern to incoming POST methods.
default RestEndpointBuilder	onPut(String aLocatorPattern, RestRequestObserver aRequestObserver) Even more convenient: Everything done here can also be done using onRequest(HttpMethod, String, RestRequestObserver): Registers a RestRequestObserver with the given Locator-Pattern to incoming PUT methods.
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.
default boolean	onRequest(RestEndpoint aRestEndpoint) For the sake of unified naming, this method just delegates to #subscribeObserver(RestEndpoint).
default RestEndpointBuilder	onRequest(String aLocatorPattern, RestRequestObserver aRequestObserver) Registers a pre-configured RestEndpoint, triggerd by any HTTP method, and returns its instance.
default RestServer	withBaseLocator(String aBaseLocator)
default RestServer	withRealm(String aRealm)

Methods inherited from interface org.refcodes.observer.Observable

hasObserverSubscription, subscribeObserver, unsubscribeObserver

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

Method Detail

onRequest

default boolean onRequest(RestEndpoint aRestEndpoint)

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

See Also:

#subscribeObserver(RestEndpoint)

withBaseLocator

default RestServer withBaseLocator(String aBaseLocator)

Specified by:

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

withRealm

default RestServer withRealm(String aRealm)

Specified by:

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

onRequest

default RestEndpointBuilder onRequest(String aLocatorPattern,
                                      RestRequestObserver aRequestObserver)

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

Parameters:

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

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).

onRequest

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. To unsubscribe via #unsubscribeObserver(RestEndpoint), use the returned instance. Attention: Invoke Openable.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.

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).

onGet

default RestEndpointBuilder onGet(String aLocatorPattern,
                                  RestRequestObserver aRequestObserver)

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

Parameters:

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

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).

onPut

default RestEndpointBuilder onPut(String aLocatorPattern,
                                  RestRequestObserver aRequestObserver)

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

Parameters:

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

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).

onPost

default RestEndpointBuilder onPost(String aLocatorPattern,
                                   RestRequestObserver aRequestObserver)

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

Parameters:

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

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).

onDelete

default RestEndpointBuilder onDelete(String aLocatorPattern,
                                     RestRequestObserver aRequestObserver)

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

Parameters:

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

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).