Class JdkHttpRestServerSugar
java.lang.Object
org.refcodes.rest.JdkHttpRestServerSugar
Declarative syntactic sugar which may be statically imported in order to
allow declarative definitions of RESTful server functionality:
import static org.refcodes.rest.JdkHttpRestServerSugar.*;-
Method Summary
Modifier and TypeMethodDescriptionstatic HttpRestServerclose()SeeClosable.close().static HttpRestServercloseIn(int aCloseMillis) static HttpRestServerstatic HttpRestServerSeeHttpRestServer.static HttpRestServeronBasicAuthRequest(BasicAuthObserver aObserver) static RestEndpointBuilderonDelete(String aLocatorPathPattern, RestRequestConsumer aRequestConsumer) static RestEndpointBuilderonDelete(Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer) static RestEndpointBuilderonGet(String aLocatorPathPattern, RestRequestConsumer aRequestConsumer) static RestEndpointBuilderonGet(Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer) static HttpRestServeronHttpException(HttpExceptionHandler aHttpExceptionHandler) static RestEndpointBuilderonPost(String aLocatorPathPattern, RestRequestConsumer aRequestConsumer) static RestEndpointBuilderonPost(Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer) static RestEndpointBuilderonPut(String aLocatorPathPattern, RestRequestConsumer aRequestConsumer) static RestEndpointBuilderonPut(Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer) static RestEndpointBuilderonRequest(String aLocatorPathPattern, RestRequestConsumer aRequestConsumer) static RestEndpointBuilderonRequest(Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer) static RestEndpointBuilderonRequest(HttpMethod aHttpMethod, String aLocatorPathPattern, RestRequestConsumer aRequestConsumer) static RestEndpointBuilderonRequest(HttpMethod aHttpMethod, Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer) static HttpRestServeropen(int aPort) static HttpRestServeropen(int aPort, int aMaxConnections) static HttpRestServeropen(String aSecureSocketProtocol, KeyStoreDescriptor aStoreDescriptor, Integer aPort) static HttpRestServeropen(String aSecureSocketProtocol, KeyStoreDescriptor aStoreDescriptor, Integer aPort, int aMaxConnections) static HttpRestServeropen(KeyStoreDescriptor aStoreDescriptor, Integer aPort) static HttpRestServeropen(KeyStoreDescriptor aStoreDescriptor, Integer aPort, int aMaxConnections) static HttpRestServeropen(HttpServerContext aCtx) static booleanunsubscribeObserver(RestEndpoint aEndpoint) static HttpRestServerwithBaseLocator(String aBaseLocator) static HttpRestServer
-
Method Details
-
getHttpRestServer
-
close
SeeClosable.close().- Returns:
- The
HttpRestServer - Throws:
IOException- the close exception
-
closeIn
- Parameters:
aCloseMillis- The close in millis- Returns:
- The
HttpRestServer
-
closeQuietly
- Returns:
- The
HttpRestServer
-
onHttpException
- Parameters:
aHttpExceptionHandler- the http exception handler- Returns:
- The
HttpRestServer
-
onBasicAuthRequest
- Parameters:
aObserver- The observer- Returns:
- The
HttpRestServer
-
onDelete
public static RestEndpointBuilder onDelete(String aLocatorPathPattern, RestRequestConsumer aRequestConsumer) - Parameters:
aLocatorPathPattern- The locator patternaRequestConsumer- The request observer- Returns:
- The
RestEndpointBuilder
-
onGet
public static RestEndpointBuilder onGet(String aLocatorPathPattern, RestRequestConsumer aRequestConsumer) - Parameters:
aLocatorPathPattern- The locator patternaRequestConsumer- The request observer- Returns:
- The
RestEndpointBuilder
-
onPost
public static RestEndpointBuilder onPost(String aLocatorPathPattern, RestRequestConsumer aRequestConsumer) - Parameters:
aLocatorPathPattern- The locator patternaRequestConsumer- The request observer- Returns:
- The
RestEndpointBuilderSeeRestServer.onPost(String, RestRequestConsumer)
-
onPut
public static RestEndpointBuilder onPut(String aLocatorPathPattern, RestRequestConsumer aRequestConsumer) - Parameters:
aLocatorPathPattern- The locator patternaRequestConsumer- The request observer- Returns:
- The
RestEndpointBuilder
-
onRequest
public static RestEndpointBuilder onRequest(HttpMethod aHttpMethod, String aLocatorPathPattern, RestRequestConsumer aRequestConsumer) - Parameters:
aHttpMethod- The HTTP-MethodaLocatorPathPattern- The locator patternaRequestConsumer- The request observer- Returns:
- The
RestEndpointBuilder
-
onRequest
public static RestEndpointBuilder onRequest(String aLocatorPathPattern, RestRequestConsumer aRequestConsumer) - Parameters:
aLocatorPathPattern- The locator patternaRequestConsumer- The request observer- Returns:
- The
RestEndpointBuilder
-
onDelete
public static RestEndpointBuilder onDelete(Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer) - Parameters:
aLocatorRegExp- The locator patternaRequestConsumer- The request observer- Returns:
- The
RestEndpointBuilder
-
onGet
public static RestEndpointBuilder onGet(Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer) - Parameters:
aLocatorRegExp- The locator patternaRequestConsumer- The request observer- Returns:
- The
RestEndpointBuilder
-
onPost
public static RestEndpointBuilder onPost(Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer) - Parameters:
aLocatorRegExp- The locator patternaRequestConsumer- The request observer- Returns:
- The
RestEndpointBuilderSeeRestServer.onPost(String, RestRequestConsumer)
-
onPut
public static RestEndpointBuilder onPut(Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer) - Parameters:
aLocatorRegExp- The locator patternaRequestConsumer- The request observer- Returns:
- The
RestEndpointBuilder
-
onRequest
public static RestEndpointBuilder onRequest(HttpMethod aHttpMethod, Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer) - Parameters:
aHttpMethod- The HTTP-MethodaLocatorRegExp- The locator patternaRequestConsumer- The request observer- Returns:
- The
RestEndpointBuilder
-
onRequest
public static RestEndpointBuilder onRequest(Pattern aLocatorRegExp, RestRequestConsumer aRequestConsumer) - Parameters:
aLocatorRegExp- The locator patternaRequestConsumer- The request observer- Returns:
- The
RestEndpointBuilder
-
open
- 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
- Parameters:
aPort- The port- Returns:
- The
HttpRestServer - Throws:
IOException- thrown in case the open operation caused problems.
-
open
- Parameters:
aPort- The portaMaxConnections- The max connections- Returns:
- The
HttpRestServer - Throws:
IOException- thrown in case the open operation caused problems.
-
open
public static HttpRestServer open(KeyStoreDescriptor aStoreDescriptor, Integer aPort) throws IOException - Parameters:
aStoreDescriptor- The store descriptor describing yourKeyStorerequired by HTTP.aPort- The port- Returns:
- The
HttpRestServer - Throws:
IOException- thrown in case the open operation caused problems.
-
open
public static HttpRestServer open(KeyStoreDescriptor aStoreDescriptor, Integer aPort, int aMaxConnections) throws IOException - Parameters:
aStoreDescriptor- The store descriptor describing yourKeyStorerequired by HTTP.aPort- The portaMaxConnections- The max connections- Returns:
- The
HttpRestServer - Throws:
IOException- thrown in case the open operation caused problems.
-
open
public static HttpRestServer open(String aSecureSocketProtocol, KeyStoreDescriptor aStoreDescriptor, Integer aPort) throws IOException - Parameters:
aSecureSocketProtocol- The secure socket protocolaStoreDescriptor- The store descriptor describing yourKeyStorerequired 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, KeyStoreDescriptor aStoreDescriptor, Integer aPort, int aMaxConnections) throws IOException - Parameters:
aSecureSocketProtocol- The secure socket protocolaStoreDescriptor- The store descriptor describing yourKeyStorerequired by HTTP.aPort- The portaMaxConnections- The max connections- Returns:
- The
HttpRestServer - Throws:
IOException- thrown in case the open operation caused problems.
-
unsubscribeObserver
- Parameters:
aEndpoint- The endpoint- Returns:
- true, if successful
-
withBaseLocator
- Parameters:
aBaseLocator- The base locator- Returns:
- The
HttpRestServer
-
withRealm
- Parameters:
aRealm- The realm- Returns:
- The
HttpRestServer
-