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/Server.html | |
| parent | 0645ec66e1618ce4b52e56212c79196dd7c5c608 (diff) | |
Documentation refresh; ResourceBundle in ShowUtils; probably some format pokery.
Diffstat (limited to 'doc/uk/org/ury/server/Server.html')
| -rw-r--r-- | doc/uk/org/ury/server/Server.html | 221 |
1 files changed, 90 insertions, 131 deletions
diff --git a/doc/uk/org/ury/server/Server.html b/doc/uk/org/ury/server/Server.html index abb6497..32baceb 100644 --- a/doc/uk/org/ury/server/Server.html +++ b/doc/uk/org/ury/server/Server.html @@ -2,12 +2,12 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_20) on Sun Mar 20 03:05:36 GMT 2011 --> +<!-- Generated by javadoc (build 1.6.0_20) on Mon Mar 21 17:00:02 GMT 2011 --> <TITLE> Server </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"> @@ -55,8 +55,8 @@ function windowTitle() <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../uk/org/ury/server/RequestHandler.html" title="interface in uk.org.ury.server"><B>PREV CLASS</B></A> - <A HREF="../../../../uk/org/ury/server/ServerProtocol.html" title="class in uk.org.ury.server"><B>NEXT CLASS</B></A></FONT></TD> + <A HREF="../../../../uk/org/ury/server/HttpWorkerThread.html" title="class in uk.org.ury.server"><B>PREV CLASS</B></A> + <A HREF="../../../../uk/org/ury/server/ServerRequestHandler.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/Server.html" target="_top"><B>FRAMES</B></A> <A HREF="Server.html" target="_top"><B>NO FRAMES</B></A> @@ -76,9 +76,9 @@ function windowTitle() </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> + SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <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> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_top"></A> @@ -106,13 +106,48 @@ The unified URY server, accepting requests over HTTP. <P> <DL> +<DT><B>Version:</B></DT> + <DD>2011.0320</DD> <DT><B>Author:</B></DT> <DD>Matt Windsor</DD> </DL> <HR> <P> +<!-- =========== FIELD SUMMARY =========== --> +<A NAME="field_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>Field Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../uk/org/ury/server/Server.html#DOCTYPE">DOCTYPE</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../uk/org/ury/server/Server.html#INDEX_HTML">INDEX_HTML</A></B></CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../uk/org/ury/server/Server.html#SERVER_VERSION">SERVER_VERSION</A></B></CODE> + +<BR> + </TD> +</TR> +</TABLE> + <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_summary"><!-- --></A> @@ -139,19 +174,11 @@ The unified URY server, accepting requests over HTTP. </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/server/Server.html#doConnection(java.net.Socket)">doConnection</A></B>(java.net.Socket clientSocket)</CODE> - -<BR> - </TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../uk/org/ury/database/DatabaseDriver.html" title="class in uk.org.ury.database">DatabaseDriver</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../uk/org/ury/server/Server.html#getDatabaseConnection(uk.org.ury.database.UserClass)">getDatabaseConnection</A></B>(<A HREF="../../../../uk/org/ury/database/UserClass.html" title="enum in uk.org.ury.database">UserClass</A> userClass)</CODE> <BR> - Get a database connection using the given user class.</TD> + Gets a database connection using the given user class.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> @@ -163,38 +190,12 @@ The unified URY server, accepting requests over HTTP. </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> org.apache.http.HttpResponse</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../uk/org/ury/server/Server.html#handleGet(java.util.List)">handleGet</A></B>(java.util.List<java.lang.String> buffer)</CODE> - -<BR> - Handle a HTTP GET request.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE>static void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../uk/org/ury/server/Server.html#main(java.lang.String[])">main</A></B>(java.lang.String[] args)</CODE> <BR> The main method, which serves to create a server.</TD> </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.String></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../../uk/org/ury/server/Server.html#parseQueryString(java.lang.String)">parseQueryString</A></B>(java.lang.String query)</CODE> - -<BR> - Parse a query string, populating a key-value map of the - URL-unescaped results.</TD> -</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/server/Server.html#processBuffer(java.util.List, java.io.PrintWriter)">processBuffer</A></B>(java.util.List<java.lang.String> buffer, - java.io.PrintWriter out)</CODE> - -<BR> - </TD> -</TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> @@ -208,6 +209,45 @@ The unified URY server, accepting requests over HTTP. <P> +<!-- ============ FIELD DETAIL =========== --> + +<A NAME="field_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>Field Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="SERVER_VERSION"><!-- --></A><H3> +SERVER_VERSION</H3> +<PRE> +public static final java.lang.String <B>SERVER_VERSION</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#uk.org.ury.server.Server.SERVER_VERSION">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="DOCTYPE"><!-- --></A><H3> +DOCTYPE</H3> +<PRE> +public static final java.lang.String <B>DOCTYPE</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#uk.org.ury.server.Server.DOCTYPE">Constant Field Values</A></DL> +</DL> +<HR> + +<A NAME="INDEX_HTML"><!-- --></A><H3> +INDEX_HTML</H3> +<PRE> +public static final java.lang.String <B>INDEX_HTML</B></PRE> +<DL> +<DL> +<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#uk.org.ury.server.Server.INDEX_HTML">Constant Field Values</A></DL> +</DL> + <!-- ========= CONSTRUCTOR DETAIL ======== --> <A NAME="constructor_detail"><!-- --></A> @@ -248,85 +288,6 @@ public static void <B>main</B>(java.lang.String[] args)</PRE> </DL> <HR> -<A NAME="doConnection(java.net.Socket)"><!-- --></A><H3> -doConnection</H3> -<PRE> -public void <B>doConnection</B>(java.net.Socket clientSocket) - throws java.io.IOException</PRE> -<DL> -<DD><DL> - -<DT><B>Throws:</B> -<DD><CODE>java.io.IOException</CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="processBuffer(java.util.List, java.io.PrintWriter)"><!-- --></A><H3> -processBuffer</H3> -<PRE> -public void <B>processBuffer</B>(java.util.List<java.lang.String> buffer, - java.io.PrintWriter out)</PRE> -<DL> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="handleGet(java.util.List)"><!-- --></A><H3> -handleGet</H3> -<PRE> -public org.apache.http.HttpResponse <B>handleGet</B>(java.util.List<java.lang.String> buffer) - 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></PRE> -<DL> -<DD>Handle a HTTP GET request. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>buffer</CODE> - The HTTP request as a list of strings. -<DT><B>Returns:</B><DD>The HTTP response. -<DT><B>Throws:</B> -<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.</DL> -</DD> -</DL> -<HR> - -<A NAME="parseQueryString(java.lang.String)"><!-- --></A><H3> -parseQueryString</H3> -<PRE> -public java.util.Map<java.lang.String,java.lang.String> <B>parseQueryString</B>(java.lang.String query) - throws java.io.UnsupportedEncodingException</PRE> -<DL> -<DD>Parse a query string, populating a key-value map of the - URL-unescaped results. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>query</CODE> - The query string to parse. -<DT><B>Returns:</B><DD>A map associating parameter keys and values. -<DT><B>Throws:</B> -<DD><CODE>java.io.UnsupportedEncodingException</CODE> - if the URL decoder - fails.</DL> -</DD> -</DL> -<HR> - <A NAME="getDatabaseConnection(uk.org.ury.database.UserClass)"><!-- --></A><H3> getDatabaseConnection</H3> <PRE> @@ -334,17 +295,15 @@ public <A HREF="../../../../uk/org/ury/database/DatabaseDriver.html" title="clas throws <A HREF="../../../../uk/org/ury/database/exceptions/MissingCredentialsException.html" title="class in uk.org.ury.database.exceptions">MissingCredentialsException</A>, <A HREF="../../../../uk/org/ury/database/exceptions/ConnectionFailureException.html" title="class in uk.org.ury.database.exceptions">ConnectionFailureException</A></PRE> <DL> -<DD>Get a database connection using the given user class. +<DD>Gets a database connection using the given user class. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>userClass</CODE> - The user class to get a connection for. -<DT><B>Returns:</B><DD>a database connection, which may or may not - have been created on this call. +<DT><B>Returns:</B><DD>a database connection, which may or may not have been created on + this call. <DT><B>Throws:</B> -<DD><CODE><A HREF="../../../../uk/org/ury/database/exceptions/MissingCredentialsException.html" title="class in uk.org.ury.database.exceptions">MissingCredentialsException</A></CODE> - if the credentials - for the given userclass are missing. -<DD><CODE><A HREF="../../../../uk/org/ury/database/exceptions/ConnectionFailureException.html" title="class in uk.org.ury.database.exceptions">ConnectionFailureException</A></CODE> - if the connection - failed.</DL> +<DD><CODE><A HREF="../../../../uk/org/ury/database/exceptions/MissingCredentialsException.html" title="class in uk.org.ury.database.exceptions">MissingCredentialsException</A></CODE> - if the credentials for the given userclass are missing. +<DD><CODE><A HREF="../../../../uk/org/ury/database/exceptions/ConnectionFailureException.html" title="class in uk.org.ury.database.exceptions">ConnectionFailureException</A></CODE> - if the connection failed.</DL> </DD> </DL> <HR> @@ -390,8 +349,8 @@ public java.lang.String <B>getVersion</B>()</PRE> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../../uk/org/ury/server/RequestHandler.html" title="interface in uk.org.ury.server"><B>PREV CLASS</B></A> - <A HREF="../../../../uk/org/ury/server/ServerProtocol.html" title="class in uk.org.ury.server"><B>NEXT CLASS</B></A></FONT></TD> + <A HREF="../../../../uk/org/ury/server/HttpWorkerThread.html" title="class in uk.org.ury.server"><B>PREV CLASS</B></A> + <A HREF="../../../../uk/org/ury/server/ServerRequestHandler.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/Server.html" target="_top"><B>FRAMES</B></A> <A HREF="Server.html" target="_top"><B>NO FRAMES</B></A> @@ -411,9 +370,9 @@ public java.lang.String <B>getVersion</B>()</PRE> </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> + SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <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> +DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> |