diff options
| author | Matt Windsor <mattwindsor@btinternet.com> | 2011-03-21 21:54:31 +0000 |
|---|---|---|
| committer | Matt Windsor <mattwindsor@btinternet.com> | 2011-03-21 21:54:31 +0000 |
| commit | df7d7981b56a4560c95ea7e9b194080e93398ecf (patch) | |
| tree | b3ae4f02d23ae1f7f4951c776ee8d91b0047dd6f /doc/uk/org/ury/backend/server/HttpHandler.html | |
| parent | 2d073129857a42ab4195cd433c8be152e357033f (diff) | |
GREAT PACKAGE RESHUFFLE: Everything is now organised into frontend, backend and common (to frontend and backend) packages. Things may have been broken. Doc refresh.
Diffstat (limited to 'doc/uk/org/ury/backend/server/HttpHandler.html')
| -rw-r--r-- | doc/uk/org/ury/backend/server/HttpHandler.html | 309 |
1 files changed, 309 insertions, 0 deletions
diff --git a/doc/uk/org/ury/backend/server/HttpHandler.html b/doc/uk/org/ury/backend/server/HttpHandler.html new file mode 100644 index 0000000..3417051 --- /dev/null +++ b/doc/uk/org/ury/backend/server/HttpHandler.html @@ -0,0 +1,309 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.6.0_20) on Mon Mar 21 21:53:07 GMT 2011 --> +<TITLE> +HttpHandler +</TITLE> + +<META NAME="date" CONTENT="2011-03-21"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="HttpHandler"; + } +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> +<HR> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/HttpHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../uk/org/ury/backend/server/ApiRequestHandler.html" title="interface in uk.org.ury.backend.server"><B>PREV CLASS</B></A> + <A HREF="../../../../../uk/org/ury/backend/server/HttpListenerThread.html" title="class in uk.org.ury.backend.server"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?uk/org/ury/backend/server/HttpHandler.html" target="_top"><B>FRAMES</B></A> + <A HREF="HttpHandler.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +uk.org.ury.backend.server</FONT> +<BR> +Class HttpHandler</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../uk/org/ury/backend/server/AbstractRequestHandler.html" title="class in uk.org.ury.backend.server">uk.org.ury.backend.server.AbstractRequestHandler</A> + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>uk.org.ury.backend.server.HttpHandler</B> +</PRE> +<DL> +<DT><B>All Implemented Interfaces:</B> <DD>org.apache.http.protocol.HttpRequestHandler</DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <B>HttpHandler</B><DT>extends <A HREF="../../../../../uk/org/ury/backend/server/AbstractRequestHandler.html" title="class in uk.org.ury.backend.server">AbstractRequestHandler</A><DT>implements org.apache.http.protocol.HttpRequestHandler</DL> +</PRE> + +<P> +<DL> +<DT><B>Author:</B></DT> + <DD>Matt Windsor, Apache Software Foundation</DD> +</DL> +<HR> + +<P> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><B><A HREF="../../../../../uk/org/ury/backend/server/HttpHandler.html#HttpHandler(uk.org.ury.backend.server.Server, java.lang.String)">HttpHandler</A></B>(<A HREF="../../../../../uk/org/ury/backend/server/Server.html" title="class in uk.org.ury.backend.server">Server</A> server, + java.lang.String mount)</CODE> + +<BR> + Construct a new HttpHandler.</TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../uk/org/ury/backend/server/HttpHandler.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 HTTP GET request.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_uk.org.ury.backend.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.backend.server.<A HREF="../../../../../uk/org/ury/backend/server/AbstractRequestHandler.html" title="class in uk.org.ury.backend.server">AbstractRequestHandler</A></B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE><A HREF="../../../../../uk/org/ury/backend/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> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_org.apache.http.protocol.HttpRequestHandler"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from interface org.apache.http.protocol.HttpRequestHandler</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>handle</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="HttpHandler(uk.org.ury.backend.server.Server, java.lang.String)"><!-- --></A><H3> +HttpHandler</H3> +<PRE> +public <B>HttpHandler</B>(<A HREF="../../../../../uk/org/ury/backend/server/Server.html" title="class in uk.org.ury.backend.server">Server</A> server, + java.lang.String mount)</PRE> +<DL> +<DD>Construct a new HttpHandler. +<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 ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="handleGet(org.apache.http.HttpRequest, org.apache.http.HttpResponse, org.apache.http.protocol.HttpContext)"><!-- --></A><H3> +handleGet</H3> +<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/backend/server/exceptions/HandlerNotFoundException.html" title="class in uk.org.ury.backend.server.exceptions">HandlerNotFoundException</A>, + <A HREF="../../../../../uk/org/ury/backend/server/exceptions/HandlerSetupFailureException.html" title="class in uk.org.ury.backend.server.exceptions">HandlerSetupFailureException</A>, + <A HREF="../../../../../uk/org/ury/backend/server/exceptions/HandleFailureException.html" title="class in uk.org.ury.backend.server.exceptions">HandleFailureException</A>, + <A HREF="../../../../../uk/org/ury/backend/server/exceptions/BadRequestException.html" title="class in uk.org.ury.backend.server.exceptions">BadRequestException</A>, + <A HREF="../../../../../uk/org/ury/backend/server/exceptions/NotAHandlerException.html" title="class in uk.org.ury.backend.server.exceptions">NotAHandlerException</A></PRE> +<DL> +<DD>Handle a HTTP GET request. +<P> +<DD><DL> +</DL> +</DD> +<DD><DL> +<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/backend/server/exceptions/HandlerNotFoundException.html" title="class in uk.org.ury.backend.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/backend/server/exceptions/HandlerSetupFailureException.html" title="class in uk.org.ury.backend.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/backend/server/exceptions/HandleFailureException.html" title="class in uk.org.ury.backend.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/backend/server/exceptions/BadRequestException.html" title="class in uk.org.ury.backend.server.exceptions">BadRequestException</A></CODE> - if the request was malformed or invalid. +<DD><CODE><A HREF="../../../../../uk/org/ury/backend/server/exceptions/NotAHandlerException.html" title="class in uk.org.ury.backend.server.exceptions">NotAHandlerException</A></CODE> - if the class requested to handle the request is not a + handler.</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/HttpHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../uk/org/ury/backend/server/ApiRequestHandler.html" title="interface in uk.org.ury.backend.server"><B>PREV CLASS</B></A> + <A HREF="../../../../../uk/org/ury/backend/server/HttpListenerThread.html" title="class in uk.org.ury.backend.server"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?uk/org/ury/backend/server/HttpHandler.html" target="_top"><B>FRAMES</B></A> + <A HREF="HttpHandler.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + +</BODY> +</HTML> |