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/server/AbstractRequestHandler.html | 290 ++++++++++++++++++ doc/uk/org/ury/server/ApiRequestHandler.html | 238 +++++++++++++++ doc/uk/org/ury/server/HttpHandler.html | 309 ++++++++++++++++++++ doc/uk/org/ury/server/HttpListenerThread.html | 322 ++++++++++++++++++++ doc/uk/org/ury/server/HttpWorkerThread.html | 324 +++++++++++++++++++++ doc/uk/org/ury/server/Server.html | 221 ++++++-------- doc/uk/org/ury/server/ServerRequestHandler.html | 14 +- .../server/class-use/AbstractRequestHandler.html | 209 +++++++++++++ .../ury/server/class-use/ApiRequestHandler.html | 180 ++++++++++++ doc/uk/org/ury/server/class-use/HttpHandler.html | 144 +++++++++ .../ury/server/class-use/HttpListenerThread.html | 144 +++++++++ .../org/ury/server/class-use/HttpWorkerThread.html | 144 +++++++++ doc/uk/org/ury/server/class-use/Server.html | 50 +++- .../ury/server/class-use/ServerRequestHandler.html | 4 +- .../ury/server/exceptions/BadRequestException.html | 4 +- .../server/exceptions/HandleFailureException.html | 4 +- .../exceptions/HandlerNotFoundException.html | 4 +- .../exceptions/HandlerSetupFailureException.html | 4 +- .../ury/server/exceptions/HandlingException.html | 6 +- .../server/exceptions/NotAHandlerException.html | 8 +- .../exceptions/UnknownFunctionException.html | 252 ++++++++++++++++ .../exceptions/class-use/BadRequestException.html | 43 ++- .../class-use/HandleFailureException.html | 26 +- .../class-use/HandlerNotFoundException.html | 43 ++- .../class-use/HandlerSetupFailureException.html | 43 ++- .../exceptions/class-use/HandlingException.html | 13 +- .../exceptions/class-use/NotAHandlerException.html | 43 ++- .../class-use/UnknownFunctionException.html | 182 ++++++++++++ .../org/ury/server/exceptions/package-frame.html | 8 +- .../org/ury/server/exceptions/package-summary.html | 9 +- doc/uk/org/ury/server/exceptions/package-tree.html | 6 +- doc/uk/org/ury/server/exceptions/package-use.html | 41 ++- doc/uk/org/ury/server/package-frame.html | 16 +- doc/uk/org/ury/server/package-summary.html | 54 +++- doc/uk/org/ury/server/package-tree.html | 15 +- doc/uk/org/ury/server/package-use.html | 21 +- 36 files changed, 3203 insertions(+), 235 deletions(-) create mode 100644 doc/uk/org/ury/server/AbstractRequestHandler.html create mode 100644 doc/uk/org/ury/server/ApiRequestHandler.html create mode 100644 doc/uk/org/ury/server/HttpHandler.html create mode 100644 doc/uk/org/ury/server/HttpListenerThread.html create mode 100644 doc/uk/org/ury/server/HttpWorkerThread.html create mode 100644 doc/uk/org/ury/server/class-use/AbstractRequestHandler.html create mode 100644 doc/uk/org/ury/server/class-use/ApiRequestHandler.html create mode 100644 doc/uk/org/ury/server/class-use/HttpHandler.html create mode 100644 doc/uk/org/ury/server/class-use/HttpListenerThread.html create mode 100644 doc/uk/org/ury/server/class-use/HttpWorkerThread.html create mode 100644 doc/uk/org/ury/server/exceptions/UnknownFunctionException.html create mode 100644 doc/uk/org/ury/server/exceptions/class-use/UnknownFunctionException.html (limited to 'doc/uk/org/ury/server') diff --git a/doc/uk/org/ury/server/AbstractRequestHandler.html b/doc/uk/org/ury/server/AbstractRequestHandler.html new file mode 100644 index 0000000..af3eb03 --- /dev/null +++ b/doc/uk/org/ury/server/AbstractRequestHandler.html @@ -0,0 +1,290 @@ + + + + + + +AbstractRequestHandler + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.server +
+Class AbstractRequestHandler

+
+java.lang.Object
+  extended by uk.org.ury.server.AbstractRequestHandler
+
+
+
All Implemented Interfaces:
org.apache.http.protocol.HttpRequestHandler
+
+
+
Direct Known Subclasses:
HttpHandler, LibraryRequestHandler
+
+
+
+
public abstract class AbstractRequestHandler
extends java.lang.Object
implements org.apache.http.protocol.HttpRequestHandler
+ + +

+An abstract request handler for HttpCore, providing basic functionality such + as uniform error response. +

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
AbstractRequestHandler(Server server, + java.lang.String mount) + +
+          Constructs a new AbstractRequestHandler.
+  + + + + + + + + + + + +
+Method Summary
+ voidhandle(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + +
+          Begins handling of a HTTP request.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AbstractRequestHandler

+
+public AbstractRequestHandler(Server server,
+                              java.lang.String mount)
+
+
Constructs a new AbstractRequestHandler. + + Obviously, this class cannot be instantiated directly. +

+

+
Parameters:
server - The instance of the URY server responsible for the request.
mount - The directory to which this handler is to be mounted.
+
+ + + + + + + + +
+Method Detail
+ +

+handle

+
+public void handle(org.apache.http.HttpRequest request,
+                   org.apache.http.HttpResponse response,
+                   org.apache.http.protocol.HttpContext context)
+            throws org.apache.http.HttpException,
+                   java.io.IOException
+
+
Begins handling of a HTTP request. +

+

+
Specified by:
handle in interface org.apache.http.protocol.HttpRequestHandler
+
+
+
Parameters:
request - The HTTP request.
response - The response that the handler will populate during the + handling of the request.
context - The HTTP context. +
Throws: +
org.apache.http.HttpException +
java.io.IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + 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 @@ + + + + + + +ApiRequestHandler + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.server +
+Interface ApiRequestHandler

+
+
All Known Implementing Classes:
ServerRequestHandler
+
+
+
+
public interface ApiRequestHandler
+ + +

+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. +

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

+ + + + + + + + + + + + +
+Method Summary
+ java.util.Map<java.lang.String,java.lang.Object>handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, + Server server) + +
+          Handle a server GET request (that is, a request for data + output).
+  +

+ + + + + + + + +
+Method Detail
+ +

+handleGetRequest

+
+java.util.Map<java.lang.String,java.lang.Object> handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters,
+                                                                  Server server)
+                                                                  throws HandleFailureException
+
+
Handle a server GET request (that is, a request for data + output). +

+

+
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 series of key-value pairs to pass back to + the client. +
Throws: +
HandleFailureException - if the handler cannot + handle the request.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/server/HttpHandler.html b/doc/uk/org/ury/server/HttpHandler.html new file mode 100644 index 0000000..22afeac --- /dev/null +++ b/doc/uk/org/ury/server/HttpHandler.html @@ -0,0 +1,309 @@ + + + + + + +HttpHandler + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.server +
+Class HttpHandler

+
+java.lang.Object
+  extended by uk.org.ury.server.AbstractRequestHandler
+      extended by uk.org.ury.server.HttpHandler
+
+
+
All Implemented Interfaces:
org.apache.http.protocol.HttpRequestHandler
+
+
+
+
public class HttpHandler
extends AbstractRequestHandler
implements org.apache.http.protocol.HttpRequestHandler
+ + +

+

+
Author:
+
Matt Windsor, Apache Software Foundation
+
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
HttpHandler(Server server, + java.lang.String mount) + +
+          Construct a new HttpHandler.
+  + + + + + + + + + + + +
+Method Summary
+ voidhandleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + +
+          Handle a HTTP GET request.
+  + + + + + + + +
Methods inherited from class uk.org.ury.server.AbstractRequestHandler
handle
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface org.apache.http.protocol.HttpRequestHandler
handle
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+HttpHandler

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

+

+
Parameters:
server - The instance of the URY server responsible for the request.
mount - The directory to which this handler is to be mounted.
+
+ + + + + + + + +
+Method Detail
+ +

+handleGet

+
+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
+
+
Handle a HTTP GET request. +

+

+
+
+
+
Parameters:
request - The HTTP request.
response - The response that the handler will populate during the + handling of the request.
context - The HTTP context. +
Throws: +
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.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/server/HttpListenerThread.html b/doc/uk/org/ury/server/HttpListenerThread.html new file mode 100644 index 0000000..a68c618 --- /dev/null +++ b/doc/uk/org/ury/server/HttpListenerThread.html @@ -0,0 +1,322 @@ + + + + + + +HttpListenerThread + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.server +
+Class HttpListenerThread

+
+java.lang.Object
+  extended by java.lang.Thread
+      extended by uk.org.ury.server.HttpListenerThread
+
+
+
All Implemented Interfaces:
java.lang.Runnable
+
+
+
+
public class HttpListenerThread
extends java.lang.Thread
+ + +

+Listener thread for the URY server HTTP interface. +

+ +

+

+
Author:
+
Matt Windsor, Apache Software Foundation
+
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class java.lang.Thread
java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class java.lang.Thread
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
+  + + + + + + + + + + +
+Constructor Summary
HttpListenerThread(int port, + Server server) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ voidrun() + +
+          Thread execution body.
+  + + + + + + + +
Methods inherited from class java.lang.Thread
activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+HttpListenerThread

+
+public HttpListenerThread(int port,
+                          Server server)
+                   throws java.io.IOException
+
+
+ +
Throws: +
java.io.IOException
+
+ + + + + + + + +
+Method Detail
+ +

+run

+
+public void run()
+
+
Thread execution body. +

+

+
Specified by:
run in interface java.lang.Runnable
Overrides:
run in class java.lang.Thread
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/server/HttpWorkerThread.html b/doc/uk/org/ury/server/HttpWorkerThread.html new file mode 100644 index 0000000..14b58e8 --- /dev/null +++ b/doc/uk/org/ury/server/HttpWorkerThread.html @@ -0,0 +1,324 @@ + + + + + + +HttpWorkerThread + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.server +
+Class HttpWorkerThread

+
+java.lang.Object
+  extended by java.lang.Thread
+      extended by uk.org.ury.server.HttpWorkerThread
+
+
+
All Implemented Interfaces:
java.lang.Runnable
+
+
+
+
public class HttpWorkerThread
extends java.lang.Thread
+ + +

+A worker thread in the server HTTP interface. + + This thread handles requests from the connected client, passing them to the + request handler(s). +

+ +

+

+
Author:
+
Matt Windsor, Apache Software Foundation
+
+
+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from class java.lang.Thread
java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler
+  + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class java.lang.Thread
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
+  + + + + + + + + + + +
+Constructor Summary
HttpWorkerThread(org.apache.http.protocol.HttpService service, + org.apache.http.HttpServerConnection conn) + +
+          Construct a new HttpWorkerThread.
+  + + + + + + + + + + + +
+Method Summary
+ voidrun() + +
+          Thread execution body.
+  + + + + + + + +
Methods inherited from class java.lang.Thread
activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+HttpWorkerThread

+
+public HttpWorkerThread(org.apache.http.protocol.HttpService service,
+                        org.apache.http.HttpServerConnection conn)
+
+
Construct a new HttpWorkerThread. +

+

+
Parameters:
service - The HTTP service the thread is working for.
conn - The connection the thread is listening on.
+
+ + + + + + + + +
+Method Detail
+ +

+run

+
+public void run()
+
+
Thread execution body. +

+

+
Specified by:
run in interface java.lang.Runnable
Overrides:
run in class java.lang.Thread
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + 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 @@ - + Server - + @@ -55,8 +55,8 @@ function windowTitle() - PREV CLASS  - NEXT CLASS + PREV CLASS  + NEXT CLASS FRAMES    NO FRAMES   @@ -76,9 +76,9 @@ function windowTitle() - SUMMARY: NESTED | FIELD | CONSTR | METHOD + SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD @@ -106,13 +106,48 @@ The unified URY server, accepting requests over HTTP.

+
Version:
+
2011.0320
Author:
Matt Windsor

+ + + + + + + + + + + + + + + + + + +
+Field Summary
+static java.lang.StringDOCTYPE + +
+           
+static java.lang.StringINDEX_HTML + +
+           
+static java.lang.StringSERVER_VERSION + +
+           
+  @@ -139,19 +174,11 @@ The unified URY server, accepting requests over HTTP. - void -doConnection(java.net.Socket clientSocket) - -
-            - - -  DatabaseDriver getDatabaseConnection(UserClass userClass)
-          Get a database connection using the given user class. +          Gets a database connection using the given user class. @@ -163,38 +190,12 @@ The unified URY server, accepting requests over HTTP. - org.apache.http.HttpResponse -handleGet(java.util.List<java.lang.String> buffer) - -
-          Handle a HTTP GET request. - - - static void main(java.lang.String[] args)
          The main method, which serves to create a server. - - - java.util.Map<java.lang.String,java.lang.String> -parseQueryString(java.lang.String query) - -
-          Parse a query string, populating a key-value map of the - URL-unescaped results. - - - - void -processBuffer(java.util.List<java.lang.String> buffer, - java.io.PrintWriter out) - -
-            -   @@ -208,6 +209,45 @@ The unified URY server, accepting requests over HTTP.  

+ + + +

+ + + +
+Field Detail
+ +

+SERVER_VERSION

+
+public static final java.lang.String SERVER_VERSION
+
+
+
See Also:
Constant Field Values
+
+
+ +

+DOCTYPE

+
+public static final java.lang.String DOCTYPE
+
+
+
See Also:
Constant Field Values
+
+
+ +

+INDEX_HTML

+
+public static final java.lang.String INDEX_HTML
+
+
+
See Also:
Constant Field Values
+
+ @@ -248,85 +288,6 @@ public static void main(java.lang.String[] args)
-

-doConnection

-
-public void doConnection(java.net.Socket clientSocket)
-                  throws java.io.IOException
-
-
- -
Throws: -
java.io.IOException
-
-
-
- -

-processBuffer

-
-public void processBuffer(java.util.List<java.lang.String> buffer,
-                          java.io.PrintWriter out)
-
-
-
-
-
-
- -

-handleGet

-
-public org.apache.http.HttpResponse handleGet(java.util.List<java.lang.String> buffer)
-                                       throws HandlerNotFoundException,
-                                              HandlerSetupFailureException,
-                                              HandleFailureException,
-                                              BadRequestException,
-                                              NotAHandlerException
-
-
Handle a HTTP GET request. -

-

-
Parameters:
buffer - The HTTP request as a list of strings. -
Returns:
The HTTP response. -
Throws: -
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.
-
-
-
- -

-parseQueryString

-
-public java.util.Map<java.lang.String,java.lang.String> parseQueryString(java.lang.String query)
-                                                                  throws java.io.UnsupportedEncodingException
-
-
Parse a query string, populating a key-value map of the - URL-unescaped results. -

-

-
Parameters:
query - The query string to parse. -
Returns:
A map associating parameter keys and values. -
Throws: -
java.io.UnsupportedEncodingException - if the URL decoder - fails.
-
-
-
-

getDatabaseConnection

@@ -334,17 +295,15 @@ public MissingCredentialsException,
                                             ConnectionFailureException
-
Get a database connection using the given user class. +
Gets a database connection using the given user class.

Parameters:
userClass - The user class to get a connection for. -
Returns:
a database connection, which may or may not - have been created on this call. +
Returns:
a database connection, which may or may not have been created on + this call.
Throws: -
MissingCredentialsException - if the credentials - for the given userclass are missing. -
ConnectionFailureException - if the connection - failed.
+
MissingCredentialsException - if the credentials for the given userclass are missing. +
ConnectionFailureException - if the connection failed.
@@ -390,8 +349,8 @@ public java.lang.String getVersion() - PREV CLASS  - NEXT CLASS + PREV CLASS  + NEXT CLASS FRAMES    NO FRAMES   @@ -411,9 +370,9 @@ public java.lang.String getVersion() - SUMMARY: NESTED | FIELD | CONSTR | METHOD + SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD diff --git a/doc/uk/org/ury/server/ServerRequestHandler.html b/doc/uk/org/ury/server/ServerRequestHandler.html index c2d61bc..428fde3 100644 --- a/doc/uk/org/ury/server/ServerRequestHandler.html +++ b/doc/uk/org/ury/server/ServerRequestHandler.html @@ -2,12 +2,12 @@ - + ServerRequestHandler - + @@ -55,7 +55,7 @@ function windowTitle() - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   @@ -96,11 +96,11 @@ java.lang.Object extended by uk.org.ury.server.ServerRequestHandler
-
All Implemented Interfaces:
RequestHandler
+
All Implemented Interfaces:
ApiRequestHandler
-
public class ServerRequestHandler
extends java.lang.Object
implements RequestHandler
+
public class ServerRequestHandler
extends java.lang.Object
implements ApiRequestHandler

@@ -201,7 +201,7 @@ public java.util.Map<java.lang.String,java.lang.Object> handleGetReques output).

-
Specified by:
handleGetRequest in interface RequestHandler
+
Specified by:
handleGetRequest in interface ApiRequestHandler
Parameters:
parameters - A key-value map of parameters supplied with @@ -248,7 +248,7 @@ public java.util.Map<java.lang.String,java.lang.Object> handleGetReques - PREV CLASS  + PREV CLASS   NEXT CLASS FRAMES   diff --git a/doc/uk/org/ury/server/class-use/AbstractRequestHandler.html b/doc/uk/org/ury/server/class-use/AbstractRequestHandler.html new file mode 100644 index 0000000..95c2388 --- /dev/null +++ b/doc/uk/org/ury/server/class-use/AbstractRequestHandler.html @@ -0,0 +1,209 @@ + + + + + + +Uses of Class uk.org.ury.server.AbstractRequestHandler + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.server.AbstractRequestHandler

+
+ + + + + + + + + + + + + +
+Packages that use AbstractRequestHandler
uk.org.ury.library  
uk.org.ury.serverThe URY Server kernel. 
+  +

+ + + + + +
+Uses of AbstractRequestHandler in uk.org.ury.library
+  +

+ + + + + + + + + +
Subclasses of AbstractRequestHandler in uk.org.ury.library
+ classLibraryRequestHandler + +
+          A request handler for library queries.
+  +

+ + + + + +
+Uses of AbstractRequestHandler in uk.org.ury.server
+  +

+ + + + + + + + + +
Subclasses of AbstractRequestHandler in uk.org.ury.server
+ classHttpHandler + +
+           
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/server/class-use/ApiRequestHandler.html b/doc/uk/org/ury/server/class-use/ApiRequestHandler.html new file mode 100644 index 0000000..e7b7e16 --- /dev/null +++ b/doc/uk/org/ury/server/class-use/ApiRequestHandler.html @@ -0,0 +1,180 @@ + + + + + + +Uses of Interface uk.org.ury.server.ApiRequestHandler + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
uk.org.ury.server.ApiRequestHandler

+
+ + + + + + + + + +
+Packages that use ApiRequestHandler
uk.org.ury.serverThe URY Server kernel. 
+  +

+ + + + + +
+Uses of ApiRequestHandler in uk.org.ury.server
+  +

+ + + + + + + + + +
Classes in uk.org.ury.server that implement ApiRequestHandler
+ classServerRequestHandler + +
+          A request handler for server queries.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/server/class-use/HttpHandler.html b/doc/uk/org/ury/server/class-use/HttpHandler.html new file mode 100644 index 0000000..c28d00e --- /dev/null +++ b/doc/uk/org/ury/server/class-use/HttpHandler.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.server.HttpHandler + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.server.HttpHandler

+
+No usage of uk.org.ury.server.HttpHandler +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/server/class-use/HttpListenerThread.html b/doc/uk/org/ury/server/class-use/HttpListenerThread.html new file mode 100644 index 0000000..c4d2a84 --- /dev/null +++ b/doc/uk/org/ury/server/class-use/HttpListenerThread.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.server.HttpListenerThread + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.server.HttpListenerThread

+
+No usage of uk.org.ury.server.HttpListenerThread +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/server/class-use/HttpWorkerThread.html b/doc/uk/org/ury/server/class-use/HttpWorkerThread.html new file mode 100644 index 0000000..71a4ba5 --- /dev/null +++ b/doc/uk/org/ury/server/class-use/HttpWorkerThread.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.server.HttpWorkerThread + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.server.HttpWorkerThread

+
+No usage of uk.org.ury.server.HttpWorkerThread +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/server/class-use/Server.html b/doc/uk/org/ury/server/class-use/Server.html index 3fa9f67..1cddf89 100644 --- a/doc/uk/org/ury/server/class-use/Server.html +++ b/doc/uk/org/ury/server/class-use/Server.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.server.Server - + @@ -95,7 +95,7 @@ Packages that use uk.org.ury.server -   +The URY Server kernel.    @@ -112,17 +112,14 @@ Uses of -Methods in uk.org.ury.library with parameters of type Server +Constructors in uk.org.ury.library with parameters of type Server - - java.util.Map<java.lang.String,java.lang.Object> -LibraryRequestHandler.handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, - Server server) +LibraryRequestHandler(Server server, + java.lang.String mount)
-          Handle a server GET request (that is, a request for data - output). +          Construct a new LibraryRequestHandler.   @@ -144,7 +141,7 @@ Uses of  java.util.Map<java.lang.String,java.lang.Object> -ServerRequestHandler.handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, +ApiRequestHandler.handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, Server server)
@@ -154,7 +151,7 @@ Uses of  java.util.Map<java.lang.String,java.lang.Object> -RequestHandler.handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, +ServerRequestHandler.handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, Server server)
@@ -164,6 +161,35 @@ Uses of + +Constructors in uk.org.ury.server with parameters of type Server + + +AbstractRequestHandler(Server server, + java.lang.String mount) + +
+          Constructs a new AbstractRequestHandler. + + +HttpHandler(Server server, + java.lang.String mount) + +
+          Construct a new HttpHandler. + + +HttpListenerThread(int port, + Server server) + +
+            + + +  +

diff --git a/doc/uk/org/ury/server/class-use/ServerRequestHandler.html b/doc/uk/org/ury/server/class-use/ServerRequestHandler.html index 8269410..5b77285 100644 --- a/doc/uk/org/ury/server/class-use/ServerRequestHandler.html +++ b/doc/uk/org/ury/server/class-use/ServerRequestHandler.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.server.ServerRequestHandler - + diff --git a/doc/uk/org/ury/server/exceptions/BadRequestException.html b/doc/uk/org/ury/server/exceptions/BadRequestException.html index 2c17ab1..c8e95a2 100644 --- a/doc/uk/org/ury/server/exceptions/BadRequestException.html +++ b/doc/uk/org/ury/server/exceptions/BadRequestException.html @@ -2,12 +2,12 @@ - + BadRequestException - + diff --git a/doc/uk/org/ury/server/exceptions/HandleFailureException.html b/doc/uk/org/ury/server/exceptions/HandleFailureException.html index 2daa29c..85b2ea6 100644 --- a/doc/uk/org/ury/server/exceptions/HandleFailureException.html +++ b/doc/uk/org/ury/server/exceptions/HandleFailureException.html @@ -2,12 +2,12 @@ - + HandleFailureException - + diff --git a/doc/uk/org/ury/server/exceptions/HandlerNotFoundException.html b/doc/uk/org/ury/server/exceptions/HandlerNotFoundException.html index 01b72bf..a752990 100644 --- a/doc/uk/org/ury/server/exceptions/HandlerNotFoundException.html +++ b/doc/uk/org/ury/server/exceptions/HandlerNotFoundException.html @@ -2,12 +2,12 @@ - + HandlerNotFoundException - + diff --git a/doc/uk/org/ury/server/exceptions/HandlerSetupFailureException.html b/doc/uk/org/ury/server/exceptions/HandlerSetupFailureException.html index 8b863f9..8ee330d 100644 --- a/doc/uk/org/ury/server/exceptions/HandlerSetupFailureException.html +++ b/doc/uk/org/ury/server/exceptions/HandlerSetupFailureException.html @@ -2,12 +2,12 @@ - + HandlerSetupFailureException - + diff --git a/doc/uk/org/ury/server/exceptions/HandlingException.html b/doc/uk/org/ury/server/exceptions/HandlingException.html index 3cc3042..fdc97b1 100644 --- a/doc/uk/org/ury/server/exceptions/HandlingException.html +++ b/doc/uk/org/ury/server/exceptions/HandlingException.html @@ -2,12 +2,12 @@ - + HandlingException - + @@ -101,7 +101,7 @@ java.lang.Object
All Implemented Interfaces:
java.io.Serializable
-
Direct Known Subclasses:
BadRequestException, HandleFailureException, HandlerNotFoundException, HandlerSetupFailureException, NotAHandlerException
+
Direct Known Subclasses:
BadRequestException, HandleFailureException, HandlerNotFoundException, HandlerSetupFailureException, NotAHandlerException, UnknownFunctionException
diff --git a/doc/uk/org/ury/server/exceptions/NotAHandlerException.html b/doc/uk/org/ury/server/exceptions/NotAHandlerException.html index bab0a9d..0bb2b0b 100644 --- a/doc/uk/org/ury/server/exceptions/NotAHandlerException.html +++ b/doc/uk/org/ury/server/exceptions/NotAHandlerException.html @@ -2,12 +2,12 @@ - + NotAHandlerException - + @@ -56,7 +56,7 @@ function windowTitle()  PREV CLASS  - NEXT CLASS + NEXT CLASS FRAMES    NO FRAMES   @@ -220,7 +220,7 @@ public NotAHandlerException(java.lang.String className)  PREV CLASS  - NEXT CLASS + NEXT CLASS FRAMES    NO FRAMES   diff --git a/doc/uk/org/ury/server/exceptions/UnknownFunctionException.html b/doc/uk/org/ury/server/exceptions/UnknownFunctionException.html new file mode 100644 index 0000000..86da911 --- /dev/null +++ b/doc/uk/org/ury/server/exceptions/UnknownFunctionException.html @@ -0,0 +1,252 @@ + + + + + + +UnknownFunctionException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.server.exceptions +
+Class UnknownFunctionException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by uk.org.ury.server.exceptions.HandlingException
+              extended by uk.org.ury.server.exceptions.UnknownFunctionException
+
+
+
All Implemented Interfaces:
java.io.Serializable
+
+
+
+
public class UnknownFunctionException
extends HandlingException
+ + +

+Exception thrown when a handler receives a request for a path that does not + correspond to one of its functions. +

+ +

+

+
Author:
+
Matt Windsor
+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
UnknownFunctionException(java.lang.String path) + +
+          Construct a new UnknownFunctionException.
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+UnknownFunctionException

+
+public UnknownFunctionException(java.lang.String path)
+
+
Construct a new UnknownFunctionException. +

+

+
Parameters:
path - The path that was requested.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/server/exceptions/class-use/BadRequestException.html b/doc/uk/org/ury/server/exceptions/class-use/BadRequestException.html index 5b6157e..2d57f73 100644 --- a/doc/uk/org/ury/server/exceptions/class-use/BadRequestException.html +++ b/doc/uk/org/ury/server/exceptions/class-use/BadRequestException.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.server.exceptions.BadRequestException - + @@ -90,9 +90,40 @@ function windowTitle() Packages that use BadRequestException -uk.org.ury.server +uk.org.ury.library    + +uk.org.ury.server +The URY Server kernel.  + + +  +

+ + + + + +
+Uses of BadRequestException in uk.org.ury.library
+  +

+ + + + + + + + +
Methods in uk.org.ury.library that throw BadRequestException
+ voidLibraryRequestHandler.handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + +
+          Handle a HTTP GET request.
 

@@ -112,8 +143,10 @@ Uses of - org.apache.http.HttpResponse -Server.handleGet(java.util.List<java.lang.String> buffer) + void +HttpHandler.handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context)
          Handle a HTTP GET request. diff --git a/doc/uk/org/ury/server/exceptions/class-use/HandleFailureException.html b/doc/uk/org/ury/server/exceptions/class-use/HandleFailureException.html index f55933d..9364cdf 100644 --- a/doc/uk/org/ury/server/exceptions/class-use/HandleFailureException.html +++ b/doc/uk/org/ury/server/exceptions/class-use/HandleFailureException.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.server.exceptions.HandleFailureException - + @@ -95,7 +95,7 @@ Packages that use uk.org.ury.server -   +The URY Server kernel.    @@ -116,13 +116,13 @@ Uses of - java.util.Map<java.lang.String,java.lang.Object> -LibraryRequestHandler.handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, - Server server) + void +LibraryRequestHandler.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.   @@ -143,8 +143,10 @@ Uses of - org.apache.http.HttpResponse -Server.handleGet(java.util.List<java.lang.String> buffer) + void +HttpHandler.handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context)
          Handle a HTTP GET request. @@ -152,7 +154,7 @@ Uses of  java.util.Map<java.lang.String,java.lang.Object> -ServerRequestHandler.handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, +ApiRequestHandler.handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, Server server)
@@ -162,7 +164,7 @@ Uses of  java.util.Map<java.lang.String,java.lang.Object> -RequestHandler.handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, +ServerRequestHandler.handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, Server server)
diff --git a/doc/uk/org/ury/server/exceptions/class-use/HandlerNotFoundException.html b/doc/uk/org/ury/server/exceptions/class-use/HandlerNotFoundException.html index 1b11504..02106c5 100644 --- a/doc/uk/org/ury/server/exceptions/class-use/HandlerNotFoundException.html +++ b/doc/uk/org/ury/server/exceptions/class-use/HandlerNotFoundException.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.server.exceptions.HandlerNotFoundException - + @@ -90,9 +90,40 @@ function windowTitle() Packages that use HandlerNotFoundException -uk.org.ury.server +uk.org.ury.library    + +uk.org.ury.server +The URY Server kernel.  + + +  +

+ + + + + +
+Uses of HandlerNotFoundException in uk.org.ury.library
+  +

+ + + + + + + + +
Methods in uk.org.ury.library that throw HandlerNotFoundException
+ voidLibraryRequestHandler.handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + +
+          Handle a HTTP GET request.
 

@@ -112,8 +143,10 @@ Uses of - org.apache.http.HttpResponse -Server.handleGet(java.util.List<java.lang.String> buffer) + void +HttpHandler.handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context)
          Handle a HTTP GET request. diff --git a/doc/uk/org/ury/server/exceptions/class-use/HandlerSetupFailureException.html b/doc/uk/org/ury/server/exceptions/class-use/HandlerSetupFailureException.html index 0fe52ae..3424716 100644 --- a/doc/uk/org/ury/server/exceptions/class-use/HandlerSetupFailureException.html +++ b/doc/uk/org/ury/server/exceptions/class-use/HandlerSetupFailureException.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.server.exceptions.HandlerSetupFailureException - + @@ -90,9 +90,40 @@ function windowTitle() Packages that use HandlerSetupFailureException -uk.org.ury.server +uk.org.ury.library    + +uk.org.ury.server +The URY Server kernel.  + + +  +

+ + + + + +
+Uses of HandlerSetupFailureException in uk.org.ury.library
+  +

+ + + + + + + + +
Methods in uk.org.ury.library that throw HandlerSetupFailureException
+ voidLibraryRequestHandler.handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + +
+          Handle a HTTP GET request.
 

@@ -112,8 +143,10 @@ Uses of - org.apache.http.HttpResponse -Server.handleGet(java.util.List<java.lang.String> buffer) + void +HttpHandler.handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context)
          Handle a HTTP GET request. diff --git a/doc/uk/org/ury/server/exceptions/class-use/HandlingException.html b/doc/uk/org/ury/server/exceptions/class-use/HandlingException.html index cbf12c8..d9922f4 100644 --- a/doc/uk/org/ury/server/exceptions/class-use/HandlingException.html +++ b/doc/uk/org/ury/server/exceptions/class-use/HandlingException.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.server.exceptions.HandlingException - + @@ -155,6 +155,15 @@ Uses of + + class +UnknownFunctionException + +
+          Exception thrown when a handler receives a request for a path that does not + correspond to one of its functions. +  

diff --git a/doc/uk/org/ury/server/exceptions/class-use/NotAHandlerException.html b/doc/uk/org/ury/server/exceptions/class-use/NotAHandlerException.html index 76923dc..6014f7d 100644 --- a/doc/uk/org/ury/server/exceptions/class-use/NotAHandlerException.html +++ b/doc/uk/org/ury/server/exceptions/class-use/NotAHandlerException.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.server.exceptions.NotAHandlerException - + @@ -90,9 +90,40 @@ function windowTitle() Packages that use NotAHandlerException -uk.org.ury.server +uk.org.ury.library    + +uk.org.ury.server +The URY Server kernel.  + + +  +

+ + + + + +
+Uses of NotAHandlerException in uk.org.ury.library
+  +

+ + + + + + + + +
Methods in uk.org.ury.library that throw NotAHandlerException
+ voidLibraryRequestHandler.handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + +
+          Handle a HTTP GET request.
 

@@ -112,8 +143,10 @@ Uses of - org.apache.http.HttpResponse -Server.handleGet(java.util.List<java.lang.String> buffer) + void +HttpHandler.handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context)
          Handle a HTTP GET request. diff --git a/doc/uk/org/ury/server/exceptions/class-use/UnknownFunctionException.html b/doc/uk/org/ury/server/exceptions/class-use/UnknownFunctionException.html new file mode 100644 index 0000000..25b291a --- /dev/null +++ b/doc/uk/org/ury/server/exceptions/class-use/UnknownFunctionException.html @@ -0,0 +1,182 @@ + + + + + + +Uses of Class uk.org.ury.server.exceptions.UnknownFunctionException + + + + + + + + + + + + +

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.server.exceptions.UnknownFunctionException

+
+ + + + + + + + + +
+Packages that use UnknownFunctionException
uk.org.ury.library  
+  +

+ + + + + +
+Uses of UnknownFunctionException in uk.org.ury.library
+  +

+ + + + + + + + + +
Methods in uk.org.ury.library that throw UnknownFunctionException
+ voidLibraryRequestHandler.handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + +
+          Handle a HTTP GET request.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/server/exceptions/package-frame.html b/doc/uk/org/ury/server/exceptions/package-frame.html index 4a740da..787aadf 100644 --- a/doc/uk/org/ury/server/exceptions/package-frame.html +++ b/doc/uk/org/ury/server/exceptions/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.server.exceptions - + @@ -33,7 +33,9 @@ Exceptions 
HandlingException
-NotAHandlerException +NotAHandlerException +
+UnknownFunctionException diff --git a/doc/uk/org/ury/server/exceptions/package-summary.html b/doc/uk/org/ury/server/exceptions/package-summary.html index 6687b8c..f09d12b 100644 --- a/doc/uk/org/ury/server/exceptions/package-summary.html +++ b/doc/uk/org/ury/server/exceptions/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.server.exceptions - + @@ -117,6 +117,11 @@ Package uk.org.ury.server.exceptions Exception thrown if the class requested as a handler by the client is, in fact, not a handler (it does not implement RequestHandler). + +UnknownFunctionException +Exception thrown when a handler receives a request for a path that does not + correspond to one of its functions. +   diff --git a/doc/uk/org/ury/server/exceptions/package-tree.html b/doc/uk/org/ury/server/exceptions/package-tree.html index 25cf80a..4379b03 100644 --- a/doc/uk/org/ury/server/exceptions/package-tree.html +++ b/doc/uk/org/ury/server/exceptions/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.server.exceptions Class Hierarchy - + @@ -96,7 +96,7 @@ Class Hierarchy diff --git a/doc/uk/org/ury/server/exceptions/package-use.html b/doc/uk/org/ury/server/exceptions/package-use.html index 44ad46a..e3b1724 100644 --- a/doc/uk/org/ury/server/exceptions/package-use.html +++ b/doc/uk/org/ury/server/exceptions/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.server.exceptions - + @@ -95,7 +95,7 @@ Packages that use uk.org.ury.server -   +The URY Server kernel.  uk.org.ury.server.exceptions @@ -111,12 +111,47 @@ Packages that use uk.org.ury.server.exceptions used by uk.org.ury.library +BadRequestException + +
+          Exception thrown when the server meets a malformed request, or + part of one. + + HandleFailureException
          Generic exception thrown when a server request handler fails to handle a request. + +HandlerNotFoundException + +
+          Exception thrown when the server request handler requested + by the client is not * found in the class space. + + +HandlerSetupFailureException + +
+          Exception thrown when the server request handler requested + by the client cannot be set up to process the request. + + +NotAHandlerException + +
+          Exception thrown if the class requested as a handler by the client + is, in fact, not a handler (it does not implement RequestHandler). + + +UnknownFunctionException + +
+          Exception thrown when a handler receives a request for a path that does not + correspond to one of its functions. +  

diff --git a/doc/uk/org/ury/server/package-frame.html b/doc/uk/org/ury/server/package-frame.html index 4385631..b46ac47 100644 --- a/doc/uk/org/ury/server/package-frame.html +++ b/doc/uk/org/ury/server/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.server - + @@ -23,7 +23,7 @@ uk.org.ury.server Interfaces 
-RequestHandler +ApiRequestHandler @@ -34,9 +34,15 @@ Interfaces  Classes 
-Server +AbstractRequestHandler +
+HttpHandler +
+HttpListenerThread
-ServerProtocol +HttpWorkerThread +
+Server
ServerRequestHandler diff --git a/doc/uk/org/ury/server/package-summary.html b/doc/uk/org/ury/server/package-summary.html index 9c9a7e4..483dc4f 100644 --- a/doc/uk/org/ury/server/package-summary.html +++ b/doc/uk/org/ury/server/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.server - + @@ -82,6 +82,12 @@ function windowTitle()

Package uk.org.ury.server

+The URY Server kernel. +

+See: +
+          Description +

@@ -89,7 +95,7 @@ Package uk.org.ury.server Interface Summary - + @@ -104,12 +110,25 @@ Package uk.org.ury.server Class Summary - - + + + + + + + + + + + + + + - - + + @@ -118,6 +137,27 @@ Package uk.org.ury.server
RequestHandlerApiRequestHandler Interface for classes that can handle requests addressed to their class name from the main server.
ServerThe unified URY server, accepting requests over HTTP.AbstractRequestHandlerAn abstract request handler for HttpCore, providing basic functionality such + as uniform error response.
HttpHandler 
HttpListenerThreadListener thread for the URY server HTTP interface.
HttpWorkerThreadA worker thread in the server HTTP interface.
ServerProtocolThe BAPS server protocol (a minimal implementation of HTTP 1.1) handler.ServerThe unified URY server, accepting requests over HTTP.
ServerRequestHandler
  +

+

+Package uk.org.ury.server Description +

+ +

+

The URY Server kernel.

+

The URY Server provides high-level access to the assets + (database, files and sound playback) available on the computer + systems of a radio station, exposing an intuitive application + programming interface using standard formats.

+

The server kernel consists of an Apache HttpCore-based HTTP + server implementation, which serves the high-level interface + to the server, code for managing the external modules that make + up the URY backend, and a common provider of objects useful to + server-level modules.

+

Though designed and built to replace the systems in place + at University Radio York, it is hoped that the URY Server will + be of use +

+

diff --git a/doc/uk/org/ury/server/package-tree.html b/doc/uk/org/ury/server/package-tree.html index d056887..f23608b 100644 --- a/doc/uk/org/ury/server/package-tree.html +++ b/doc/uk/org/ury/server/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.server Class Hierarchy - + @@ -92,14 +92,21 @@ Class Hierarchy

Interface Hierarchy

+
  • uk.org.ury.server.ApiRequestHandler
    diff --git a/doc/uk/org/ury/server/package-use.html b/doc/uk/org/ury/server/package-use.html index 51349ea..de1ef5a 100644 --- a/doc/uk/org/ury/server/package-use.html +++ b/doc/uk/org/ury/server/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.server - + @@ -95,7 +95,7 @@ Packages that use u uk.org.ury.server -   +The URY Server kernel.    @@ -107,11 +107,11 @@ Packages that use u Classes in uk.org.ury.server used by uk.org.ury.library -RequestHandler +AbstractRequestHandler
    -          Interface for classes that can handle requests addressed to their - class name from the main server. +          An abstract request handler for HttpCore, providing basic functionality such + as uniform error response. Server @@ -129,7 +129,14 @@ Classes in uk.org.u Classes in uk.org.ury.server used by uk.org.ury.server -RequestHandler +AbstractRequestHandler + +
    +          An abstract request handler for HttpCore, providing basic functionality such + as uniform error response. + + +ApiRequestHandler
              Interface for classes that can handle requests addressed to their -- cgit v1.2.3