+ApiRequestHandler +

From 2d073129857a42ab4195cd433c8be152e357033f Mon Sep 17 00:00:00 2001 From: Matt Windsor Date: Mon, 21 Mar 2011 20:40:57 +0000 Subject: Documentation refresh; ResourceBundle in ShowUtils; probably some format pokery. --- doc/uk/org/ury/server/ApiRequestHandler.html | 238 +++++++++++++++++++++++++++ 1 file changed, 238 insertions(+) create mode 100644 doc/uk/org/ury/server/ApiRequestHandler.html (limited to 'doc/uk/org/ury/server/ApiRequestHandler.html') diff --git a/doc/uk/org/ury/server/ApiRequestHandler.html b/doc/uk/org/ury/server/ApiRequestHandler.html new file mode 100644 index 0000000..8b2571c --- /dev/null +++ b/doc/uk/org/ury/server/ApiRequestHandler.html @@ -0,0 +1,238 @@ + + + + + + +ApiRequestHandler + + + + + + + + + + + + +

+ + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + + +

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

+ +

+ PREV CLASS + NEXT CLASS

+ FRAMES + NO FRAMES + + + + +

+ SUMMARY: NESTED | FIELD | CONSTR | METHOD

+DETAIL: FIELD | CONSTR | METHOD

+ + + +

+ +

+ +uk.org.ury.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 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.

+ +