diff options
| author | Matt Windsor <mattwindsor@btinternet.com> | 2011-03-21 20:40:57 +0000 |
|---|---|---|
| committer | Matt Windsor <mattwindsor@btinternet.com> | 2011-03-21 20:40:57 +0000 |
| commit | 2d073129857a42ab4195cd433c8be152e357033f (patch) | |
| tree | 967a4bbd1989df9847539a4c4c28e0ca6a79a453 /doc/uk/org/ury/library/LibraryRequestHandler.html | |
| parent | 0645ec66e1618ce4b52e56212c79196dd7c5c608 (diff) | |
Documentation refresh; ResourceBundle in ShowUtils; probably some format pokery.
Diffstat (limited to 'doc/uk/org/ury/library/LibraryRequestHandler.html')
| -rw-r--r-- | doc/uk/org/ury/library/LibraryRequestHandler.html | 88 |
1 files changed, 56 insertions, 32 deletions
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 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_20) on Sun Mar 20 03:05:33 GMT 2011 --> +<!-- Generated by javadoc (build 1.6.0_20) on Mon Mar 21 16:59:59 GMT 2011 --> <TITLE> LibraryRequestHandler </TITLE> -<META NAME="date" CONTENT="2011-03-20"> +<META NAME="date" CONTENT="2011-03-21"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> @@ -93,14 +93,15 @@ uk.org.ury.library</FONT> Class LibraryRequestHandler</H2> <PRE> java.lang.Object - <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>uk.org.ury.library.LibraryRequestHandler</B> + <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../uk/org/ury/server/AbstractRequestHandler.html" title="class in uk.org.ury.server">uk.org.ury.server.AbstractRequestHandler</A> + <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>uk.org.ury.library.LibraryRequestHandler</B> </PRE> <DL> -<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../uk/org/ury/server/RequestHandler.html" title="interface in uk.org.ury.server">RequestHandler</A></DD> +<DT><B>All Implemented Interfaces:</B> <DD>org.apache.http.protocol.HttpRequestHandler</DD> </DL> <HR> <DL> -<DT><PRE>public class <B>LibraryRequestHandler</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../uk/org/ury/server/RequestHandler.html" title="interface in uk.org.ury.server">RequestHandler</A></DL> +<DT><PRE>public class <B>LibraryRequestHandler</B><DT>extends <A HREF="../../../../uk/org/ury/server/AbstractRequestHandler.html" title="class in uk.org.ury.server">AbstractRequestHandler</A></DL> </PRE> <P> @@ -125,10 +126,11 @@ A request handler for library queries. <B>Constructor Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><B><A HREF="../../../../uk/org/ury/library/LibraryRequestHandler.html#LibraryRequestHandler()">LibraryRequestHandler</A></B>()</CODE> +<TD><CODE><B><A HREF="../../../../uk/org/ury/library/LibraryRequestHandler.html#LibraryRequestHandler(uk.org.ury.server.Server, java.lang.String)">LibraryRequestHandler</A></B>(<A HREF="../../../../uk/org/ury/server/Server.html" title="class in uk.org.ury.server">Server</A> server, + java.lang.String mount)</CODE> <BR> - </TD> + Construct a new LibraryRequestHandler.</TD> </TR> </TABLE> @@ -142,13 +144,22 @@ A request handler for library queries. </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> java.util.Map<java.lang.String,java.lang.Object></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../uk/org/ury/library/LibraryRequestHandler.html#handleGetRequest(java.util.Map, uk.org.ury.server.Server)">handleGetRequest</A></B>(java.util.Map<java.lang.String,java.lang.String> parameters, - <A HREF="../../../../uk/org/ury/server/Server.html" title="class in uk.org.ury.server">Server</A> server)</CODE> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../uk/org/ury/library/LibraryRequestHandler.html#handleGet(org.apache.http.HttpRequest, org.apache.http.HttpResponse, org.apache.http.protocol.HttpContext)">handleGet</A></B>(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context)</CODE> <BR> - Handle a server GET request (that is, a request for data - output).</TD> + Handle a HTTP GET request.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_uk.org.ury.server.AbstractRequestHandler"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class uk.org.ury.server.<A HREF="../../../../uk/org/ury/server/AbstractRequestHandler.html" title="class in uk.org.ury.server">AbstractRequestHandler</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="../../../../uk/org/ury/server/AbstractRequestHandler.html#handle(org.apache.http.HttpRequest, org.apache.http.HttpResponse, org.apache.http.protocol.HttpContext)">handle</A></CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> @@ -173,11 +184,16 @@ A request handler for library queries. </TR> </TABLE> -<A NAME="LibraryRequestHandler()"><!-- --></A><H3> +<A NAME="LibraryRequestHandler(uk.org.ury.server.Server, java.lang.String)"><!-- --></A><H3> LibraryRequestHandler</H3> <PRE> -public <B>LibraryRequestHandler</B>()</PRE> +public <B>LibraryRequestHandler</B>(<A HREF="../../../../uk/org/ury/server/Server.html" title="class in uk.org.ury.server">Server</A> server, + java.lang.String mount)</PRE> +<DL> +<DD>Construct a new LibraryRequestHandler. +<P> <DL> +<DT><B>Parameters:</B><DD><CODE>server</CODE> - The instance of the URY server responsible for the request.<DD><CODE>mount</CODE> - The directory to which this handler is to be mounted.</DL> </DL> <!-- ============ METHOD DETAIL ========== --> @@ -190,31 +206,39 @@ public <B>LibraryRequestHandler</B>()</PRE> </TR> </TABLE> -<A NAME="handleGetRequest(java.util.Map, uk.org.ury.server.Server)"><!-- --></A><H3> -handleGetRequest</H3> +<A NAME="handleGet(org.apache.http.HttpRequest, org.apache.http.HttpResponse, org.apache.http.protocol.HttpContext)"><!-- --></A><H3> +handleGet</H3> <PRE> -public java.util.Map<java.lang.String,java.lang.Object> <B>handleGetRequest</B>(java.util.Map<java.lang.String,java.lang.String> parameters, - <A HREF="../../../../uk/org/ury/server/Server.html" title="class in uk.org.ury.server">Server</A> server) - throws <A HREF="../../../../uk/org/ury/server/exceptions/HandleFailureException.html" title="class in uk.org.ury.server.exceptions">HandleFailureException</A></PRE> +public void <B>handleGet</B>(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + throws <A HREF="../../../../uk/org/ury/server/exceptions/HandlerNotFoundException.html" title="class in uk.org.ury.server.exceptions">HandlerNotFoundException</A>, + <A HREF="../../../../uk/org/ury/server/exceptions/HandlerSetupFailureException.html" title="class in uk.org.ury.server.exceptions">HandlerSetupFailureException</A>, + <A HREF="../../../../uk/org/ury/server/exceptions/HandleFailureException.html" title="class in uk.org.ury.server.exceptions">HandleFailureException</A>, + <A HREF="../../../../uk/org/ury/server/exceptions/BadRequestException.html" title="class in uk.org.ury.server.exceptions">BadRequestException</A>, + <A HREF="../../../../uk/org/ury/server/exceptions/NotAHandlerException.html" title="class in uk.org.ury.server.exceptions">NotAHandlerException</A>, + <A HREF="../../../../uk/org/ury/server/exceptions/UnknownFunctionException.html" title="class in uk.org.ury.server.exceptions">UnknownFunctionException</A></PRE> <DL> -<DD>Handle a server GET request (that is, a request for data - output). +<DD>Handle a HTTP GET request. <P> <DD><DL> -<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../uk/org/ury/server/RequestHandler.html#handleGetRequest(java.util.Map, uk.org.ury.server.Server)">handleGetRequest</A></CODE> in interface <CODE><A HREF="../../../../uk/org/ury/server/RequestHandler.html" title="interface in uk.org.ury.server">RequestHandler</A></CODE></DL> +</DL> </DD> <DD><DL> -<DT><B>Parameters:</B><DD><CODE>parameters</CODE> - 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.<DD><CODE>server</CODE> - The server from which the request originated. - This will be able to provide the handler with - pooled resources, for example the database. -<DT><B>Returns:</B><DD>A list of lines to return in the body of the - server's response to the client. +<DT><B>Parameters:</B><DD><CODE>request</CODE> - The HTTP request.<DD><CODE>response</CODE> - The response that the handler will populate during the + handling of the request.<DD><CODE>context</CODE> - The HTTP context. <DT><B>Throws:</B> -<DD><CODE><A HREF="../../../../uk/org/ury/server/exceptions/HandleFailureException.html" title="class in uk.org.ury.server.exceptions">HandleFailureException</A></CODE> - if the handler cannot - handle the request.</DL> +<DD><CODE><A HREF="../../../../uk/org/ury/server/exceptions/HandlerNotFoundException.html" title="class in uk.org.ury.server.exceptions">HandlerNotFoundException</A></CODE> - if the client requested a request handler that could not be + found on the class path. +<DD><CODE><A HREF="../../../../uk/org/ury/server/exceptions/HandlerSetupFailureException.html" title="class in uk.org.ury.server.exceptions">HandlerSetupFailureException</A></CODE> - if the handler was found but could not be set up (eg does not + implement appropriate interface or cannot be instantiated). +<DD><CODE><A HREF="../../../../uk/org/ury/server/exceptions/HandleFailureException.html" title="class in uk.org.ury.server.exceptions">HandleFailureException</A></CODE> - if an appropriate handler was contacted, but it failed to + process the request. +<DD><CODE><A HREF="../../../../uk/org/ury/server/exceptions/BadRequestException.html" title="class in uk.org.ury.server.exceptions">BadRequestException</A></CODE> - if the request was malformed or invalid. +<DD><CODE><A HREF="../../../../uk/org/ury/server/exceptions/NotAHandlerException.html" title="class in uk.org.ury.server.exceptions">NotAHandlerException</A></CODE> - if the class requested to handle the request is not a + handler. +<DD><CODE><A HREF="../../../../uk/org/ury/server/exceptions/UnknownFunctionException.html" title="class in uk.org.ury.server.exceptions">UnknownFunctionException</A></CODE> - if the request is for a path that does not correspond to one + of this handler's functions.</DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> |