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/library/LibraryRequestHandler.html | 88 ++++++++++++++--------- 1 file changed, 56 insertions(+), 32 deletions(-) (limited to 'doc/uk/org/ury/library/LibraryRequestHandler.html') diff --git a/doc/uk/org/ury/library/LibraryRequestHandler.html b/doc/uk/org/ury/library/LibraryRequestHandler.html index cf88582..6779f19 100644 --- a/doc/uk/org/ury/library/LibraryRequestHandler.html +++ b/doc/uk/org/ury/library/LibraryRequestHandler.html @@ -2,12 +2,12 @@ - + LibraryRequestHandler - + @@ -93,14 +93,15 @@ uk.org.ury.library Class LibraryRequestHandler 
 java.lang.Object
-  extended by uk.org.ury.library.LibraryRequestHandler
+  extended by uk.org.ury.server.AbstractRequestHandler
+      extended by uk.org.ury.library.LibraryRequestHandler
-
All Implemented Interfaces:
RequestHandler
+
All Implemented Interfaces:
org.apache.http.protocol.HttpRequestHandler
-
public class LibraryRequestHandler
extends java.lang.Object
implements RequestHandler
+
public class LibraryRequestHandler
extends AbstractRequestHandler

@@ -125,10 +126,11 @@ A request handler for library queries. Constructor Summary -LibraryRequestHandler() +LibraryRequestHandler(Server server, + java.lang.String mount)
-            +          Construct a new LibraryRequestHandler.   @@ -142,13 +144,22 @@ A request handler for library queries. - java.util.Map<java.lang.String,java.lang.Object> -handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, - Server server) + void +handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context)
-          Handle a server GET request (that is, a request for data - output). +          Handle a HTTP GET request. + + +  + + + + + +
Methods inherited from class uk.org.ury.server.AbstractRequestHandler
handle
  @@ -173,11 +184,16 @@ A request handler for library queries. -

+

LibraryRequestHandler

-public LibraryRequestHandler()
+public LibraryRequestHandler(Server server, + java.lang.String mount) +
+
Construct a new LibraryRequestHandler. +

+
Parameters:
server - The instance of the URY server responsible for the request.
mount - The directory to which this handler is to be mounted.
@@ -190,31 +206,39 @@ public LibraryRequestHandler() -

-handleGetRequest

+

+handleGet

-public java.util.Map<java.lang.String,java.lang.Object> handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters,
-                                                                         Server server)
-                                                                  throws HandleFailureException
+public void handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + throws HandlerNotFoundException, + HandlerSetupFailureException, + HandleFailureException, + BadRequestException, + NotAHandlerException, + UnknownFunctionException
-
Handle a server GET request (that is, a request for data - output). +
Handle a HTTP GET request.

-
Specified by:
handleGetRequest in interface RequestHandler
+
-
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 list of lines to return in the body of the - server's response to the client. +
Parameters:
request - The HTTP request.
response - The response that the handler will populate during the + handling of the request.
context - The HTTP context.
Throws: -
HandleFailureException - if the handler cannot - handle the request.
+
HandlerNotFoundException - if the client requested a request handler that could not be + found on the class path. +
HandlerSetupFailureException - if the handler was found but could not be set up (eg does not + implement appropriate interface or cannot be instantiated). +
HandleFailureException - if an appropriate handler was contacted, but it failed to + process the request. +
BadRequestException - if the request was malformed or invalid. +
NotAHandlerException - if the class requested to handle the request is not a + handler. +
UnknownFunctionException - if the request is for a path that does not correspond to one + of this handler's functions.
-- cgit v1.2.3