ej.hoka.rest

Class RestEndpoint

java.lang.Object

ej.hoka.rest.RestEndpoint

Direct Known Subclasses:

AliasEndpoint, LoginEndpoint, LogoutEndpoint, ResourceRestEndpoint

public class RestEndpoint
extends java.lang.Object

A REST endpoint exposes resources.

Allow HTTP verbs are GET, POST, PUT and DELETE.

See Also:

RestRequestHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	uri The URI this endpoint answers.

Constructor Summary

Constructors

Constructor and Description
RestEndpoint(java.lang.String uri) Creates a new endpoint at given URI.

Method Summary

Modifier and Type	Method and Description
HTTPResponse	delete(HTTPRequest request, java.util.Map<java.lang.String,java.lang.String> attributes) Handles DELETE request on this endpoint.
HTTPResponse	get(HTTPRequest request, java.util.Map<java.lang.String,java.lang.String> attributes) Handles GET request on this endpoint.
java.lang.String	getURI() Gets this endpoint URI.
boolean	isGlobal() Returns whether or not this endpoint is global, which means it can process sub-endpoints.
HTTPResponse	post(HTTPRequest request, java.util.Map<java.lang.String,java.lang.String> attributes) Handles POST request on this endpoint.
HTTPResponse	put(HTTPRequest request, java.util.Map<java.lang.String,java.lang.String> attributes) Handles PUT request on this endpoint.

Methods inherited from class java.lang.Object

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

Field Detail

uri

protected java.lang.String uri

The URI this endpoint answers.

Constructor Detail

RestEndpoint

public RestEndpoint(java.lang.String uri)

Creates a new endpoint at given URI.

For example, assuming a server running at 127.0.0.1:80 with a REST request handler, following code creates an endpoint at http://127.0.0.1:80/my/custom/endpoint

 restRequestHandler.addEndpoint(new RestEndpoint("/my/custom/endpoint"));
 

If URI does not start with a / character, it is automatically added.

If URI ends with /*, the RestEndpoint created is a global endpoint and is able to process requests to sub-endpoints.

For example, an endpoint created with the "/my/custom/*" URI is able to process, among others, the requests to "/my/custom" and "/my/custom/endpoint".

Parameters:

uri - the URI of this endpoint.

Throws:

java.lang.IllegalArgumentException - if URI is empty

Method Detail

getURI

public java.lang.String getURI()

Gets this endpoint URI.

If this endpoint is global, the returned URI doesn't contain the trailing /* of the URI given to the constructor.

Returns:

this endpoint URI, cannot be null.

isGlobal

public boolean isGlobal()

Returns whether or not this endpoint is global, which means it can process sub-endpoints.

For example, a global /my/custom/* endpoint can process request to /my/custom/endpoint.

Returns:

true if this endpoint is global, false otherwise.

See Also:

RestEndpoint(String)

get

public HTTPResponse get(HTTPRequest request,
                        java.util.Map<java.lang.String,java.lang.String> attributes)

Handles GET request on this endpoint.

Default implementation return a status code 501

Parameters:

request - the request to handle.

attributes - the attributes populated by the request processing.

Returns:

an HTTP response.

post

public HTTPResponse post(HTTPRequest request,
                         java.util.Map<java.lang.String,java.lang.String> attributes)

Handles POST request on this endpoint.

Default implementation return a status code 501

Parameters:

request - the request to handle.

attributes - the attributes populated by the request processing.

Returns:

an HTTP response.

put

public HTTPResponse put(HTTPRequest request,
                        java.util.Map<java.lang.String,java.lang.String> attributes)

Handles PUT request on this endpoint.

Default implementation return a status code 501

Parameters:

request - the request to handle.

attributes - the attributes populated by the request processing.

Returns:

an HTTP response.

delete

public HTTPResponse delete(HTTPRequest request,
                           java.util.Map<java.lang.String,java.lang.String> attributes)

Handles DELETE request on this endpoint.

Default implementation return a status code 501

Parameters:

request - the request to handle.

attributes - the attributes populated by the request processing.

Returns:

an HTTP response.