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/server/ApiRequestHandler.html | |
| parent | 0645ec66e1618ce4b52e56212c79196dd7c5c608 (diff) | |
Documentation refresh; ResourceBundle in ShowUtils; probably some format pokery.
Diffstat (limited to 'doc/uk/org/ury/server/ApiRequestHandler.html')
| -rw-r--r-- | doc/uk/org/ury/server/ApiRequestHandler.html | 238 |
1 files changed, 238 insertions, 0 deletions
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 @@ +<!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 17:00:02 GMT 2011 --> +<TITLE> +ApiRequestHandler +</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="ApiRequestHandler"; + } +} +</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/ApiRequestHandler.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/server/AbstractRequestHandler.html" title="class in uk.org.ury.server"><B>PREV CLASS</B></A> + <A HREF="../../../../uk/org/ury/server/HttpHandler.html" title="class in uk.org.ury.server"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?uk/org/ury/server/ApiRequestHandler.html" target="_top"><B>FRAMES</B></A> + <A HREF="ApiRequestHandler.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <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.server</FONT> +<BR> +Interface ApiRequestHandler</H2> +<DL> +<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../uk/org/ury/server/ServerRequestHandler.html" title="class in uk.org.ury.server">ServerRequestHandler</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public interface <B>ApiRequestHandler</B></DL> +</PRE> + +<P> +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. +<P> + +<P> +<DL> +<DT><B>Author:</B></DT> + <DD>Matt Windsor</DD> +</DL> +<HR> + +<P> + +<!-- ========== 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> java.util.Map<java.lang.String,java.lang.Object></CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../uk/org/ury/server/ApiRequestHandler.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> + +<BR> + Handle a server GET request (that is, a request for data + output).</TD> +</TR> +</TABLE> + +<P> + +<!-- ============ 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="handleGetRequest(java.util.Map, uk.org.ury.server.Server)"><!-- --></A><H3> +handleGetRequest</H3> +<PRE> +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> +<DL> +<DD>Handle a server GET request (that is, a request for data + output). +<P> +<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 series of key-value pairs to pass back to + the client. +<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> +</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/ApiRequestHandler.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/server/AbstractRequestHandler.html" title="class in uk.org.ury.server"><B>PREV CLASS</B></A> + <A HREF="../../../../uk/org/ury/server/HttpHandler.html" title="class in uk.org.ury.server"><B>NEXT CLASS</B></A></FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../index.html?uk/org/ury/server/ApiRequestHandler.html" target="_top"><B>FRAMES</B></A> + <A HREF="ApiRequestHandler.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> + +</BODY> +</HTML> |