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.*;

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Details

getHttpRestServer

public static RestfulHttpServer getHttpRestServer()

See RestfulHttpServer.

Returns:

The RestfulHttpServer

close

public static RestfulHttpServer close()
                               throws IOException

See Closable.close().

Returns:

The RestfulHttpServer

Throws:

IOException - the close exception

closeIn

public static RestfulHttpServer closeIn(int aCloseMillis)

See Closable.closeIn(int).

Parameters:

aCloseMillis - The close in millis

Returns:

The RestfulHttpServer

closeQuietly

public static RestfulHttpServer closeQuietly()

See Closable.closeQuietly().

Returns:

The RestfulHttpServer

onHttpException

public static RestfulHttpServer onHttpException(HttpExceptionHandler aHttpExceptionHandler)

See HttpExceptionHandlerAccessor.HttpExceptionHandlerMutator.onHttpException(HttpExceptionHandler).

Parameters:

aHttpExceptionHandler - the http exception handler

Returns:

The RestfulHttpServer

onBasicAuthRequest

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

See BasicAuthObservable.onBasicAuthRequest(BasicAuthObserver).

Parameters:

aObserver - The observer

Returns:

The RestfulHttpServer

onDelete

public static RestEndpointBuilder onDelete(String aLocatorPathPattern,
 RestRequestConsumer aRequestConsumer)

See RestfulServer.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 RestfulServer.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 RestfulServer.onPost(String, RestRequestConsumer).

Parameters:

aLocatorPathPattern - The locator pattern

aRequestConsumer - The request observer

Returns:

The RestEndpointBuilder See RestfulServer.onPost(String, RestRequestConsumer)

onPut

public static RestEndpointBuilder onPut(String aLocatorPathPattern,
 RestRequestConsumer aRequestConsumer)

See RestfulServer.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 RestfulServer.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 RestfulServer.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 RestfulServer.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 RestfulServer.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 RestfulServer.onPost(String, RestRequestConsumer).

Parameters:

aLocatorRegExp - The locator pattern

aRequestConsumer - The request observer

Returns:

The RestEndpointBuilder See RestfulServer.onPost(String, RestRequestConsumer)

onPut

public static RestEndpointBuilder onPut(Pattern aLocatorRegExp,
 RestRequestConsumer aRequestConsumer)

See RestfulServer.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 RestfulServer.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 RestfulServer.onRequest(String, RestRequestConsumer).

Parameters:

aLocatorRegExp - The locator pattern

aRequestConsumer - The request observer

Returns:

The RestEndpointBuilder

open

public static RestfulHttpServer 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 RestfulHttpServer

Throws:

IOException - thrown in case the open operation caused problems.

open

public static RestfulHttpServer open(int aPort)
                              throws IOException

See RestfulHttpServer.open(int).

Parameters:

aPort - The port

Returns:

The RestfulHttpServer

Throws:

IOException - thrown in case the open operation caused problems.

open

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

See RestfulHttpServer.open(int, int).

Parameters:

aPort - The port

aMaxConnections - The max connections

Returns:

The RestfulHttpServer

Throws:

IOException - thrown in case the open operation caused problems.

open

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

See RestfulHttpServer.open(KeyStoreDescriptor, int).

Parameters:

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

aPort - The port

Returns:

The RestfulHttpServer

Throws:

IOException - thrown in case the open operation caused problems.

open

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

See RestfulHttpServer.open(KeyStoreDescriptor, int, int).

Parameters:

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

aPort - The port

aMaxConnections - The max connections

Returns:

The RestfulHttpServer

Throws:

IOException - thrown in case the open operation caused problems.

open

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

See RestfulHttpServer.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 RestfulHttpServer

Throws:

IOException - thrown in case the open operation caused problems.

open

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

See RestfulHttpServer.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 RestfulHttpServer

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

See RestfulHttpServer.withBaseLocator(String).

Parameters:

aBaseLocator - The base locator

Returns:

The RestfulHttpServer

withRealm

public static RestfulHttpServer withRealm(String aRealm)

See RestfulHttpServer.withRealm(String).

Parameters:

aRealm - The realm

Returns:

The RestfulHttpServer