uk.org.ury.backend.server
Interface ApiRequestHandler

All Known Implementing Classes:

ServerRequestHandler

public interface ApiRequestHandler

Interface for classes that can handle requests addressed to their class name from the main server. For an example of how to implement a RequestHandler, see ServerRequestHandler.

Author:

Matt Windsor

Method Summary

java.util.Map<java.lang.String,java.lang.Object>

handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, Server server) Handle a server GET request (that is, a request for data output).

Method Detail

handleGetRequest

java.util.Map<java.lang.String,java.lang.Object> handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters,
                                                                  Server server)
                                                                  throws HandleFailureException

Handle a server GET request (that is, a request for data output).

Parameters:

parameters - A key-value map of parameters supplied with the server request. Typically, the "function" parameter will detail the function that the request handler is expected to perform.

server - The server from which the request originated. This will be able to provide the handler with pooled resources, for example the database.

Returns:

A series of key-value pairs to pass back to the client.

Throws:

HandleFailureException - if the handler cannot handle the request.