ej.hoka.rest

Class RestRequestHandler

java.lang.Object

ej.hoka.rest.RestRequestHandler

All Implemented Interfaces:

RequestHandler

public class RestRequestHandler
extends java.lang.Object
implements RequestHandler

A request handler that exposes a REST API. Handles GET, POST, PUT and DELETE operations on endpoints.

The endpoint that handles the request is the endpoint with the most specific URI that matches the request. With two endpoints at /api/* and /api/my/endpoint, the second is used when requesting /api/my/endpoint and the first is used when requesting /api/my/endpoint/and/extension because the second is not a global endpoint.

See Also:

RestEndpoint.RestEndpoint(String), RestEndpoint.isGlobal()

Constructor Summary

Constructors

Constructor and Description
RestRequestHandler() Constructs a REST request handler with no endpoint.

Method Summary

Modifier and Type	Method and Description
void	addEndpoint(RestEndpoint endpoint) Adds an endpoint to this handler.
HTTPResponse	process(HTTPRequest request, java.util.Map<java.lang.String,java.lang.String> attributes) Processes the request and creates the appropriate response, or null if this request handler doesn't match the request.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestRequestHandler

public RestRequestHandler()

Constructs a REST request handler with no endpoint.

See Also:

addEndpoint(RestEndpoint)

Method Detail

addEndpoint

public void addEndpoint(RestEndpoint endpoint)

Adds an endpoint to this handler.

Parameters:

endpoint - the endpoint to add.

process

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

Description copied from interface: RequestHandler

Processes the request and creates the appropriate response, or null if this request handler doesn't match the request.

Specified by:

process in interface RequestHandler

Parameters:

request - the HTTPRequest to process.

attributes - the attributes of the request.

Returns:

the HTTPResponse to send, or null if not handled by this RequestHandler.