Module org.refcodes.rest

Package org.refcodes.rest

Class HttpRestServerSugar

java.lang.Object

org.refcodes.rest.HttpRestServerSugar

public class HttpRestServerSugar
extends Object

Declarative syntactic sugar which may be statically imported in order to allow declarative definitions of RESTful server functionality: import static org.refcodes.rest.HttpRestServerSugar.*;

Constructor Summary

Constructors

Constructor	Description
HttpRestServerSugar()

Method Summary

Modifier and Type	Method	Description
static HttpRestServer	close()	See Closable.close()
static HttpRestServer	closeIn(int aCloseMillis)	See Closable.closeIn(int)
static HttpRestServer	closeQuietly()	See Closable.closeQuietly()
static HttpRestServer	getHttpRestServer()	See HttpRestServer
static HttpRestServer	onBasicAuthRequest(org.refcodes.web.BasicAuthObserver aObserver)	See BasicAuthObservable.onBasicAuthRequest(BasicAuthObserver)
static RestEndpointBuilder	onDelete(String aLocatorPathPattern, RestRequestConsumer aRequestConsumer)	See RestServer.onDelete(String, RestRequestConsumer)
static RestEndpointBuilder	onDelete(Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer)	See RestServer.onDelete(String, RestRequestConsumer)
static RestEndpointBuilder	onGet(String aLocatorPathPattern, RestRequestConsumer aRequestConsumer)	See RestServer.onGet(String, RestRequestConsumer)
static RestEndpointBuilder	onGet(Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer)	See RestServer.onGet(String, RestRequestConsumer)
static HttpRestServer	onHttpException(HttpExceptionHandler aHttpExceptionHandler)	See HttpExceptionHandlerAccessor.HttpExceptionHandlerMutator.onHttpException(HttpExceptionHandler)
static RestEndpointBuilder	onPost(String aLocatorPathPattern, RestRequestConsumer aRequestConsumer)	See RestServer.onPost(String, RestRequestConsumer)
static RestEndpointBuilder	onPost(Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer)	See RestServer.onPost(String, RestRequestConsumer)
static RestEndpointBuilder	onPut(String aLocatorPathPattern, RestRequestConsumer aRequestConsumer)	See RestServer.onPut(String, RestRequestConsumer)
static RestEndpointBuilder	onPut(Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer)	See RestServer.onPut(String, RestRequestConsumer)
static RestEndpointBuilder	onRequest(String aLocatorPathPattern, RestRequestConsumer aRequestConsumer)	See RestServer.onRequest(String, RestRequestConsumer)
static RestEndpointBuilder	onRequest(Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer)	See RestServer.onRequest(String, RestRequestConsumer)
static RestEndpointBuilder	onRequest(org.refcodes.web.HttpMethod aHttpMethod, String aLocatorPathPattern, RestRequestConsumer aRequestConsumer)	See RestServer.onRequest(HttpMethod, String, RestRequestConsumer)
static RestEndpointBuilder	onRequest(org.refcodes.web.HttpMethod aHttpMethod, Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer)	See RestServer.onRequest(HttpMethod, String, RestRequestConsumer)
static HttpRestServer	open(int aPort)	See HttpRestServer.open(int)
static HttpRestServer	open(int aPort, int aMaxConnections)	See HttpRestServer.open(int, int)
static HttpRestServer	open(String aSecureSocketProtocol, org.refcodes.security.KeyStoreDescriptor aStoreDescriptor, Integer aPort)	See HttpRestServer.open(String, KeyStoreDescriptor, int)
static HttpRestServer	open(String aSecureSocketProtocol, org.refcodes.security.KeyStoreDescriptor aStoreDescriptor, Integer aPort, int aMaxConnections)	See HttpRestServer.open(String, KeyStoreDescriptor, int, int).
static HttpRestServer	open(org.refcodes.security.KeyStoreDescriptor aStoreDescriptor, Integer aPort)	See HttpRestServer.open(KeyStoreDescriptor, int)
static HttpRestServer	open(org.refcodes.security.KeyStoreDescriptor aStoreDescriptor, Integer aPort, int aMaxConnections)	See HttpRestServer.open(KeyStoreDescriptor, int, int)
static HttpRestServer	open(org.refcodes.web.HttpServerContext aCtx)	See ConnectionOpenable.open(Object)
static boolean	unsubscribeObserver(RestEndpoint aEndpoint)	See Observable.unsubscribeObserver(Object)
static HttpRestServer	withBaseLocator(String aBaseLocator)	See HttpRestServer.withBaseLocator(String).
static HttpRestServer	withRealm(String aRealm)	See HttpRestServer.withRealm(String)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HttpRestServerSugar

public HttpRestServerSugar()

Method Details

getHttpRestServer

public static HttpRestServer getHttpRestServer()

See HttpRestServer

Returns:

The HttpRestServer

close

public static HttpRestServer close()
                            throws IOException

See Closable.close()

Returns:

The HttpRestServer

Throws:

IOException - the close exception

closeIn

public static HttpRestServer closeIn(int aCloseMillis)

See Closable.closeIn(int)

Parameters:

aCloseMillis - The close in millis

Returns:

The HttpRestServer

closeQuietly

public static HttpRestServer closeQuietly()

See Closable.closeQuietly()

Returns:

The HttpRestServer

onHttpException

public static HttpRestServer onHttpException(HttpExceptionHandler aHttpExceptionHandler)

See HttpExceptionHandlerAccessor.HttpExceptionHandlerMutator.onHttpException(HttpExceptionHandler)

Returns:

The HttpRestServer

onBasicAuthRequest

public static HttpRestServer onBasicAuthRequest(org.refcodes.web.BasicAuthObserver aObserver)

See BasicAuthObservable.onBasicAuthRequest(BasicAuthObserver)

Parameters:

aObserver - The observer

Returns:

The HttpRestServer

onDelete

public static RestEndpointBuilder onDelete(String aLocatorPathPattern,
 RestRequestConsumer aRequestConsumer)

See RestServer.onDelete(String, RestRequestConsumer)

Parameters:

aLocatorPathPattern - The locator pattern

aRequestConsumer - The request observer

Returns:

The RestEndpointBuilder

onGet

public static RestEndpointBuilder onGet(String aLocatorPathPattern,
 RestRequestConsumer aRequestConsumer)

See RestServer.onGet(String, RestRequestConsumer)

Parameters:

aLocatorPathPattern - The locator pattern

aRequestConsumer - The request observer

Returns:

The RestEndpointBuilder

onPost

public static RestEndpointBuilder onPost(String aLocatorPathPattern,
 RestRequestConsumer aRequestConsumer)

See RestServer.onPost(String, RestRequestConsumer)

Parameters:

aLocatorPathPattern - The locator pattern

aRequestConsumer - The request observer

Returns:

The RestEndpointBuilder See RestServer.onPost(String, RestRequestConsumer)

onPut

public static RestEndpointBuilder onPut(String aLocatorPathPattern,
 RestRequestConsumer aRequestConsumer)

See RestServer.onPut(String, RestRequestConsumer)

Parameters:

aLocatorPathPattern - The locator pattern

aRequestConsumer - The request observer

Returns:

The RestEndpointBuilder

onRequest

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

See RestServer.onRequest(HttpMethod, String, RestRequestConsumer)

Parameters:

aHttpMethod - The HTTP-Method

aLocatorPathPattern - The locator pattern

aRequestConsumer - The request observer

Returns:

The RestEndpointBuilder

onRequest

public static RestEndpointBuilder onRequest(String aLocatorPathPattern,
 RestRequestConsumer aRequestConsumer)

See RestServer.onRequest(String, RestRequestConsumer)

Parameters:

aLocatorPathPattern - The locator pattern

aRequestConsumer - The request observer

Returns:

The RestEndpointBuilder

onDelete

public static RestEndpointBuilder onDelete(Pattern aLocatorRegExp,
 RestRequestConsumer aRequestConsumer)

See RestServer.onDelete(String, RestRequestConsumer)

Parameters:

aLocatorRegExp - The locator pattern

aRequestConsumer - The request observer

Returns:

The RestEndpointBuilder

onGet

public static RestEndpointBuilder onGet(Pattern aLocatorRegExp,
 RestRequestConsumer aRequestConsumer)

See RestServer.onGet(String, RestRequestConsumer)

Parameters:

aLocatorRegExp - The locator pattern

aRequestConsumer - The request observer

Returns:

The RestEndpointBuilder

onPost

public static RestEndpointBuilder onPost(Pattern aLocatorRegExp,
 RestRequestConsumer aRequestConsumer)

See RestServer.onPost(String, RestRequestConsumer)

Parameters:

aLocatorRegExp - The locator pattern

aRequestConsumer - The request observer

Returns:

The RestEndpointBuilder See RestServer.onPost(String, RestRequestConsumer)

onPut

public static RestEndpointBuilder onPut(Pattern aLocatorRegExp,
 RestRequestConsumer aRequestConsumer)

See RestServer.onPut(String, RestRequestConsumer)

Parameters:

aLocatorRegExp - The locator pattern

aRequestConsumer - The request observer

Returns:

The RestEndpointBuilder

onRequest

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

See RestServer.onRequest(HttpMethod, String, RestRequestConsumer)

Parameters:

aHttpMethod - The HTTP-Method

aLocatorRegExp - The locator pattern

aRequestConsumer - The request observer

Returns:

The RestEndpointBuilder

onRequest

public static RestEndpointBuilder onRequest(Pattern aLocatorRegExp,
 RestRequestConsumer aRequestConsumer)

See RestServer.onRequest(String, RestRequestConsumer)

Parameters:

aLocatorRegExp - The locator pattern

aRequestConsumer - The request observer

Returns:

The RestEndpointBuilder

open

public static HttpRestServer open(org.refcodes.web.HttpServerContext aCtx)
                           throws IOException

See ConnectionOpenable.open(Object)

Parameters:

aCtx - The context describing the parameters required to open the connection.

Returns:

The HttpRestServer

Throws:

IOException - thrown in case the open operation caused problems.

open

public static HttpRestServer open(int aPort)
                           throws IOException

See HttpRestServer.open(int)

Parameters:

aPort - The port

Returns:

The HttpRestServer

Throws:

IOException - thrown in case the open operation caused problems.

open

public static HttpRestServer open(int aPort,
 int aMaxConnections)
                           throws IOException

See HttpRestServer.open(int, int)

Parameters:

aPort - The port

aMaxConnections - The max connections

Returns:

The HttpRestServer

Throws:

IOException - thrown in case the open operation caused problems.

open

public static HttpRestServer open(org.refcodes.security.KeyStoreDescriptor aStoreDescriptor,
 Integer aPort)
                           throws IOException

See HttpRestServer.open(KeyStoreDescriptor, int)

Parameters:

aStoreDescriptor - The store descriptor describing your KeyStore required by HTTP.

aPort - The port

Returns:

The HttpRestServer

Throws:

IOException - thrown in case the open operation caused problems.

open

public static HttpRestServer open(org.refcodes.security.KeyStoreDescriptor aStoreDescriptor,
 Integer aPort,
 int aMaxConnections)
                           throws IOException

See HttpRestServer.open(KeyStoreDescriptor, int, int)

Parameters:

aStoreDescriptor - The store descriptor describing your KeyStore required by HTTP.

aPort - The port

aMaxConnections - The max connections

Returns:

The HttpRestServer

Throws:

IOException - thrown in case the open operation caused problems.

open

public static HttpRestServer open(String aSecureSocketProtocol,
 org.refcodes.security.KeyStoreDescriptor aStoreDescriptor,
 Integer aPort)
                           throws IOException

See HttpRestServer.open(String, KeyStoreDescriptor, int)

Parameters:

aSecureSocketProtocol - The secure socket protocol

aStoreDescriptor - The store descriptor describing your KeyStore required by HTTP.

aPort - The port

Returns:

The HttpRestServer

Throws:

IOException - thrown in case the open operation caused problems.

open

public static HttpRestServer open(String aSecureSocketProtocol,
 org.refcodes.security.KeyStoreDescriptor aStoreDescriptor,
 Integer aPort,
 int aMaxConnections)
                           throws IOException

See HttpRestServer.open(String, KeyStoreDescriptor, int, int).

Parameters:

aSecureSocketProtocol - The secure socket protocol

aStoreDescriptor - The store descriptor describing your KeyStore required by HTTP.

aPort - The port

aMaxConnections - The max connections

Returns:

The HttpRestServer

Throws:

IOException - thrown in case the open operation caused problems.

unsubscribeObserver

public static boolean unsubscribeObserver(RestEndpoint aEndpoint)

See Observable.unsubscribeObserver(Object)

Parameters:

aEndpoint - The endpoint

Returns:

true, if successful

withBaseLocator

public static HttpRestServer withBaseLocator(String aBaseLocator)

See HttpRestServer.withBaseLocator(String).

Parameters:

aBaseLocator - The base locator

Returns:

The HttpRestServer

withRealm

public static HttpRestServer withRealm(String aRealm)

See HttpRestServer.withRealm(String)

Parameters:

aRealm - The realm

Returns:

The HttpRestServer