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 and Description
HttpRestServerSugar()

Method Summary

Modifier and Type	Method and Description
static HttpRestServer	close()
static HttpRestServer	closeIn(int aCloseInMillis)
static HttpRestServer	closeQuietly()
static HttpRestServer	onBasicAuthRequest(org.refcodes.net.BasicAuthObserver aObserver)
static RestEndpointBuilder	onDelete(String aLocatorPattern, RestRequestObserver aRequestObserver)
static RestEndpointBuilder	onGet(String aLocatorPattern, RestRequestObserver aRequestObserver)
static RestEndpointBuilder	onPost(String aLocatorPattern, RestRequestObserver aRequestObserver)
static RestEndpointBuilder	onPut(String aLocatorPattern, RestRequestObserver aRequestObserver)
static HttpRestServer	open(File aKeyStoreFile, String aKeyStorePassword, Integer aPort)
static HttpRestServer	open(File aKeyStoreFile, String aKeyStorePassword, Integer aPort, int aMaxConnections)
static HttpRestServer	open(File aKeyStoreFile, String aKeyStorePassword, String aKeyPassword, Integer aPort)
static HttpRestServer	open(File aKeyStoreFile, String aKeyStorePassword, String aKeyPassword, Integer aPort, int aMaxConnections)
static HttpRestServer	open(int aPort)
static HttpRestServer	open(int aPort, int aMaxConnections)
static HttpRestServer	open(String aSecureSocketProtocol, File aKeyStoreFile, String aKeyStorePassword, Integer aPort)
static HttpRestServer	open(String aSecureSocketProtocol, File aKeyStoreFile, String aKeyStorePassword, Integer aPort, int aMaxConnections)
static HttpRestServer	open(String aSecureSocketProtocol, File aKeyStoreFile, String aKeyStoreType, String aKeyStorePassword, String aKeyPassword, Integer aPort)
static HttpRestServer	open(String aSecureSocketProtocol, File aKeyStoreFile, String aKeyStoreType, String aKeyStorePassword, String aKeyPassword, Integer aPort, int aMaxConnections)
static HttpRestServer	withBaseLocator(String aBaseLocator)
static HttpRestServer	withRealm(String aRealm)

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpRestServerSugar

public HttpRestServerSugar()

Method Detail

withBaseLocator

public static HttpRestServer withBaseLocator(String aBaseLocator)

See Also:

HttpRestServer.withBaseLocator(String)

withRealm

public static HttpRestServer withRealm(String aRealm)

See Also:

HttpRestServer.withRealm(String)

open

public static HttpRestServer open(int aPort)
                           throws org.refcodes.component.OpenException

Throws:

org.refcodes.component.OpenException

See Also:

HttpRestServer#open(Integer)

open

public static HttpRestServer open(int aPort,
                                  int aMaxConnections)
                           throws org.refcodes.component.OpenException

Throws:

org.refcodes.component.OpenException

See Also:

HttpRestServer.open(Integer, int)

open

public static HttpRestServer open(String aSecureSocketProtocol,
                                  File aKeyStoreFile,
                                  String aKeyStoreType,
                                  String aKeyStorePassword,
                                  String aKeyPassword,
                                  Integer aPort,
                                  int aMaxConnections)
                           throws org.refcodes.component.OpenException

Throws:

org.refcodes.component.OpenException

See Also:

HttpRestServer.open(String, File, String, String, String, Integer, int)

open

public static HttpRestServer open(String aSecureSocketProtocol,
                                  File aKeyStoreFile,
                                  String aKeyStoreType,
                                  String aKeyStorePassword,
                                  String aKeyPassword,
                                  Integer aPort)
                           throws org.refcodes.component.OpenException

Throws:

org.refcodes.component.OpenException

See Also:

HttpRestServer.open(String, File, String, String, String, Integer)

open

public static HttpRestServer open(String aSecureSocketProtocol,
                                  File aKeyStoreFile,
                                  String aKeyStorePassword,
                                  Integer aPort,
                                  int aMaxConnections)
                           throws org.refcodes.component.OpenException

Throws:

org.refcodes.component.OpenException

See Also:

HttpRestServer.open(String, File, String, Integer, int )

open

public static HttpRestServer open(String aSecureSocketProtocol,
                                  File aKeyStoreFile,
                                  String aKeyStorePassword,
                                  Integer aPort)
                           throws org.refcodes.component.OpenException

Throws:

org.refcodes.component.OpenException

See Also:

HttpRestServer.open(String, File, String, Integer )

open

public static HttpRestServer open(File aKeyStoreFile,
                                  String aKeyStorePassword,
                                  Integer aPort,
                                  int aMaxConnections)
                           throws org.refcodes.component.OpenException

Throws:

org.refcodes.component.OpenException

See Also:

HttpRestServer.open(File, String, Integer, int )

open

public static HttpRestServer open(File aKeyStoreFile,
                                  String aKeyStorePassword,
                                  Integer aPort)
                           throws org.refcodes.component.OpenException

Throws:

org.refcodes.component.OpenException

See Also:

HttpRestServer.open(File, String, Integer )

open

public static HttpRestServer open(File aKeyStoreFile,
                                  String aKeyStorePassword,
                                  String aKeyPassword,
                                  Integer aPort,
                                  int aMaxConnections)
                           throws org.refcodes.component.OpenException

Throws:

org.refcodes.component.OpenException

See Also:

HttpRestServer.open(File, String, String, Integer, int)

open

public static HttpRestServer open(File aKeyStoreFile,
                                  String aKeyStorePassword,
                                  String aKeyPassword,
                                  Integer aPort)
                           throws org.refcodes.component.OpenException

Throws:

org.refcodes.component.OpenException

See Also:

HttpRestServer.open(File, String, String, Integer, int)

close

public static HttpRestServer close()
                            throws org.refcodes.component.CloseException

Throws:

org.refcodes.component.CloseException

See Also:

Closable.close()

closeIn

public static HttpRestServer closeIn(int aCloseInMillis)

See Also:

Closable.closeIn(int)

closeQuietly

public static HttpRestServer closeQuietly()

See Also:

Closable.closeQuietly()

onGet

public static RestEndpointBuilder onGet(String aLocatorPattern,
                                        RestRequestObserver aRequestObserver)

See Also:

RestServer.onGet(String, RestRequestObserver)

onPut

public static RestEndpointBuilder onPut(String aLocatorPattern,
                                        RestRequestObserver aRequestObserver)

See Also:

RestServer.onPut(String, RestRequestObserver)

onPost

public static RestEndpointBuilder onPost(String aLocatorPattern,
                                         RestRequestObserver aRequestObserver)

See Also:

RestServer.onPost(String, RestRequestObserver)

onDelete

public static RestEndpointBuilder onDelete(String aLocatorPattern,
                                           RestRequestObserver aRequestObserver)

See Also:

RestServer.onDelete(String, RestRequestObserver)

onBasicAuthRequest

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

See Also:

BasicAuthObservable.onBasicAuthRequest(BasicAuthObserver)