From df7d7981b56a4560c95ea7e9b194080e93398ecf Mon Sep 17 00:00:00 2001 From: Matt Windsor Date: Mon, 21 Mar 2011 21:54:31 +0000 Subject: GREAT PACKAGE RESHUFFLE: Everything is now organised into frontend, backend and common (to frontend and backend) packages. Things may have been broken. Doc refresh. --- .../ury/backend/server/AbstractRequestHandler.html | 290 ++++++++++++++++ .../org/ury/backend/server/ApiRequestHandler.html | 238 +++++++++++++ doc/uk/org/ury/backend/server/HttpHandler.html | 309 +++++++++++++++++ .../org/ury/backend/server/HttpListenerThread.html | 322 +++++++++++++++++ .../org/ury/backend/server/HttpWorkerThread.html | 324 +++++++++++++++++ doc/uk/org/ury/backend/server/Server.html | 384 +++++++++++++++++++++ .../ury/backend/server/ServerRequestHandler.html | 283 +++++++++++++++ .../server/class-use/AbstractRequestHandler.html | 209 +++++++++++ .../server/class-use/ApiRequestHandler.html | 180 ++++++++++ .../ury/backend/server/class-use/HttpHandler.html | 144 ++++++++ .../server/class-use/HttpListenerThread.html | 144 ++++++++ .../backend/server/class-use/HttpWorkerThread.html | 144 ++++++++ .../org/ury/backend/server/class-use/Server.html | 249 +++++++++++++ .../server/class-use/ServerRequestHandler.html | 144 ++++++++ .../server/exceptions/BadRequestException.html | 271 +++++++++++++++ .../server/exceptions/HandleFailureException.html | 270 +++++++++++++++ .../exceptions/HandlerNotFoundException.html | 275 +++++++++++++++ .../exceptions/HandlerSetupFailureException.html | 278 +++++++++++++++ .../server/exceptions/HandlingException.html | 275 +++++++++++++++ .../server/exceptions/NotAHandlerException.html | 254 ++++++++++++++ .../exceptions/UnknownFunctionException.html | 252 ++++++++++++++ .../exceptions/class-use/BadRequestException.html | 213 ++++++++++++ .../class-use/HandleFailureException.html | 233 +++++++++++++ .../class-use/HandlerNotFoundException.html | 213 ++++++++++++ .../class-use/HandlerSetupFailureException.html | 213 ++++++++++++ .../exceptions/class-use/HandlingException.html | 226 ++++++++++++ .../exceptions/class-use/NotAHandlerException.html | 213 ++++++++++++ .../class-use/UnknownFunctionException.html | 182 ++++++++++ .../backend/server/exceptions/package-frame.html | 44 +++ .../backend/server/exceptions/package-summary.html | 187 ++++++++++ .../backend/server/exceptions/package-tree.html | 160 +++++++++ .../ury/backend/server/exceptions/package-use.html | 273 +++++++++++++++ doc/uk/org/ury/backend/server/package-frame.html | 53 +++ doc/uk/org/ury/backend/server/package-summary.html | 220 ++++++++++++ doc/uk/org/ury/backend/server/package-tree.html | 166 +++++++++ doc/uk/org/ury/backend/server/package-use.html | 210 +++++++++++ 36 files changed, 8045 insertions(+) create mode 100644 doc/uk/org/ury/backend/server/AbstractRequestHandler.html create mode 100644 doc/uk/org/ury/backend/server/ApiRequestHandler.html create mode 100644 doc/uk/org/ury/backend/server/HttpHandler.html create mode 100644 doc/uk/org/ury/backend/server/HttpListenerThread.html create mode 100644 doc/uk/org/ury/backend/server/HttpWorkerThread.html create mode 100644 doc/uk/org/ury/backend/server/Server.html create mode 100644 doc/uk/org/ury/backend/server/ServerRequestHandler.html create mode 100644 doc/uk/org/ury/backend/server/class-use/AbstractRequestHandler.html create mode 100644 doc/uk/org/ury/backend/server/class-use/ApiRequestHandler.html create mode 100644 doc/uk/org/ury/backend/server/class-use/HttpHandler.html create mode 100644 doc/uk/org/ury/backend/server/class-use/HttpListenerThread.html create mode 100644 doc/uk/org/ury/backend/server/class-use/HttpWorkerThread.html create mode 100644 doc/uk/org/ury/backend/server/class-use/Server.html create mode 100644 doc/uk/org/ury/backend/server/class-use/ServerRequestHandler.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/BadRequestException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/HandleFailureException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/HandlerNotFoundException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/HandlerSetupFailureException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/HandlingException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/NotAHandlerException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/UnknownFunctionException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/class-use/BadRequestException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/class-use/HandleFailureException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/class-use/HandlerNotFoundException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/class-use/HandlerSetupFailureException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/class-use/HandlingException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/class-use/NotAHandlerException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/class-use/UnknownFunctionException.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/package-frame.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/package-summary.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/package-tree.html create mode 100644 doc/uk/org/ury/backend/server/exceptions/package-use.html create mode 100644 doc/uk/org/ury/backend/server/package-frame.html create mode 100644 doc/uk/org/ury/backend/server/package-summary.html create mode 100644 doc/uk/org/ury/backend/server/package-tree.html create mode 100644 doc/uk/org/ury/backend/server/package-use.html (limited to 'doc/uk/org/ury/backend/server') diff --git a/doc/uk/org/ury/backend/server/AbstractRequestHandler.html b/doc/uk/org/ury/backend/server/AbstractRequestHandler.html new file mode 100644 index 0000000..6d70dc7 --- /dev/null +++ b/doc/uk/org/ury/backend/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.backend.server +
+Class AbstractRequestHandler

+
+java.lang.Object
+  extended by uk.org.ury.backend.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/backend/server/ApiRequestHandler.html b/doc/uk/org/ury/backend/server/ApiRequestHandler.html new file mode 100644 index 0000000..7f3b44c --- /dev/null +++ b/doc/uk/org/ury/backend/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.backend.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/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 @@ + + + + + + +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.backend.server +
+Class HttpHandler

+
+java.lang.Object
+  extended by uk.org.ury.backend.server.AbstractRequestHandler
+      extended by uk.org.ury.backend.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.backend.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/backend/server/HttpListenerThread.html b/doc/uk/org/ury/backend/server/HttpListenerThread.html new file mode 100644 index 0000000..18c5b3f --- /dev/null +++ b/doc/uk/org/ury/backend/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.backend.server +
+Class HttpListenerThread

+
+java.lang.Object
+  extended by java.lang.Thread
+      extended by uk.org.ury.backend.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/backend/server/HttpWorkerThread.html b/doc/uk/org/ury/backend/server/HttpWorkerThread.html new file mode 100644 index 0000000..8d8db00 --- /dev/null +++ b/doc/uk/org/ury/backend/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.backend.server +
+Class HttpWorkerThread

+
+java.lang.Object
+  extended by java.lang.Thread
+      extended by uk.org.ury.backend.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/backend/server/Server.html b/doc/uk/org/ury/backend/server/Server.html new file mode 100644 index 0000000..afdc004 --- /dev/null +++ b/doc/uk/org/ury/backend/server/Server.html @@ -0,0 +1,384 @@ + + + + + + +Server + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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.backend.server +
+Class Server

+
+java.lang.Object
+  extended by uk.org.ury.backend.server.Server
+
+
+
+
public class Server
extends java.lang.Object
+ + +

+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 + +
+           
+  + + + + + + + + + + +
+Constructor Summary
Server() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ DatabaseDrivergetDatabaseConnection(UserClass userClass) + +
+          Gets a database connection using the given user class.
+ java.lang.StringgetVersion() + +
+           
+static voidmain(java.lang.String[] args) + +
+          The main method, which serves to create a server.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+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
+
+ + + + + + + + +
+Constructor Detail
+ +

+Server

+
+public Server()
+
+
+ + + + + + + + +
+Method Detail
+ +

+main

+
+public static void main(java.lang.String[] args)
+
+
The main method, which serves to create a server. +

+

+
Parameters:
args - The argument vector.
+
+
+
+ +

+getDatabaseConnection

+
+public DatabaseDriver getDatabaseConnection(UserClass userClass)
+                                     throws MissingCredentialsException,
+                                            ConnectionFailureException
+
+
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. +
Throws: +
MissingCredentialsException - if the credentials for the given userclass are missing. +
ConnectionFailureException - if the connection failed.
+
+
+
+ +

+getVersion

+
+public java.lang.String getVersion()
+
+
+ +
Returns:
the version string of the server.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/backend/server/ServerRequestHandler.html b/doc/uk/org/ury/backend/server/ServerRequestHandler.html new file mode 100644 index 0000000..217821e --- /dev/null +++ b/doc/uk/org/ury/backend/server/ServerRequestHandler.html @@ -0,0 +1,283 @@ + + + + + + +ServerRequestHandler + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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.backend.server +
+Class ServerRequestHandler

+
+java.lang.Object
+  extended by uk.org.ury.backend.server.ServerRequestHandler
+
+
+
All Implemented Interfaces:
ApiRequestHandler
+
+
+
+
public class ServerRequestHandler
extends java.lang.Object
implements ApiRequestHandler
+ + +

+A request handler for server queries. +

+ +

+

+
Author:
+
Matt Windsor
+
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
ServerRequestHandler() + +
+           
+  + + + + + + + + + + + +
+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).
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

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

+ServerRequestHandler

+
+public ServerRequestHandler()
+
+
+ + + + + + + + +
+Method Detail
+ +

+handleGetRequest

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

+

+
Specified by:
handleGetRequest in interface ApiRequestHandler
+
+
+
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 list of lines to return in the body of the + server's response 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/backend/server/class-use/AbstractRequestHandler.html b/doc/uk/org/ury/backend/server/class-use/AbstractRequestHandler.html new file mode 100644 index 0000000..bcd6183 --- /dev/null +++ b/doc/uk/org/ury/backend/server/class-use/AbstractRequestHandler.html @@ -0,0 +1,209 @@ + + + + + + +Uses of Class uk.org.ury.backend.server.AbstractRequestHandler + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

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

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

+ + + + + +
+Uses of AbstractRequestHandler in uk.org.ury.backend.handlers
+  +

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

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

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

+

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

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

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

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

+ + + + + + + + + +
Classes in uk.org.ury.backend.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/backend/server/class-use/HttpHandler.html b/doc/uk/org/ury/backend/server/class-use/HttpHandler.html new file mode 100644 index 0000000..a64ac0d --- /dev/null +++ b/doc/uk/org/ury/backend/server/class-use/HttpHandler.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Class uk.org.ury.backend.server.HttpHandler + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

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

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

+

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

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

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

+

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

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

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

+

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

+Uses of Class
uk.org.ury.backend.server.Server

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

+ + + + + +
+Uses of Server in uk.org.ury.backend.handlers
+  +

+ + + + + + + + +
Constructors in uk.org.ury.backend.handlers with parameters of type Server
LibraryRequestHandler(Server server, + java.lang.String mount) + +
+          Construct a new LibraryRequestHandler.
+  +

+ + + + + +
+Uses of Server in uk.org.ury.backend.server
+  +

+ + + + + + + + + + + + + +
Methods in uk.org.ury.backend.server with parameters of type Server
+ java.util.Map<java.lang.String,java.lang.Object>ApiRequestHandler.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).
+ java.util.Map<java.lang.String,java.lang.Object>ServerRequestHandler.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).
+  +

+ + + + + + + + + + + + + + +
Constructors in uk.org.ury.backend.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) + +
+           
+  +

+

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

+Uses of Class
uk.org.ury.backend.server.ServerRequestHandler

+
+No usage of uk.org.ury.backend.server.ServerRequestHandler +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/server/exceptions/BadRequestException.html b/doc/uk/org/ury/backend/server/exceptions/BadRequestException.html new file mode 100644 index 0000000..a1c1218 --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/BadRequestException.html @@ -0,0 +1,271 @@ + + + + + + +BadRequestException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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.backend.server.exceptions +
+Class BadRequestException

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

+Exception thrown when the server meets a malformed request, or + part of one. +

+ +

+

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

+ + + + + + + + + + + + + + +
+Constructor Summary
BadRequestException() + +
+          Construct a new BadRequestException with a default reason.
BadRequestException(java.lang.Throwable cause) + +
+          Construct a new HandlerNotFoundException with a chained + exception.
+  + + + + + + + +
+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
+ +

+BadRequestException

+
+public BadRequestException()
+
+
Construct a new BadRequestException with a default reason. +

+

+
+ +

+BadRequestException

+
+public BadRequestException(java.lang.Throwable cause)
+
+
Construct a new HandlerNotFoundException with a chained + exception. +

+

+
Parameters:
cause - The exception that this new exception is to + wrap.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/backend/server/exceptions/HandleFailureException.html b/doc/uk/org/ury/backend/server/exceptions/HandleFailureException.html new file mode 100644 index 0000000..1c5629f --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/HandleFailureException.html @@ -0,0 +1,270 @@ + + + + + + +HandleFailureException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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.backend.server.exceptions +
+Class HandleFailureException

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

+Generic exception thrown when a server request handler fails to + handle a request. +

+ +

+

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

+ + + + + + + + + + + + + + +
+Constructor Summary
HandleFailureException() + +
+          Construct a new HandleFailureException with a + default reason.
HandleFailureException(java.lang.String reason) + +
+          Construct a new HandleFailureException.
+  + + + + + + + +
+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
+ +

+HandleFailureException

+
+public HandleFailureException()
+
+
Construct a new HandleFailureException with a + default reason. +

+

+
+ +

+HandleFailureException

+
+public HandleFailureException(java.lang.String reason)
+
+
Construct a new HandleFailureException. +

+

+
Parameters:
reason - The explanation for the exception.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/backend/server/exceptions/HandlerNotFoundException.html b/doc/uk/org/ury/backend/server/exceptions/HandlerNotFoundException.html new file mode 100644 index 0000000..78aef35 --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/HandlerNotFoundException.html @@ -0,0 +1,275 @@ + + + + + + +HandlerNotFoundException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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.backend.server.exceptions +
+Class HandlerNotFoundException

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

+Exception thrown when the server request handler requested + by the client is not * found in the class space. +

+ +

+

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

+ + + + + + + + + + + + + + +
+Constructor Summary
HandlerNotFoundException() + +
+          Construct a new HandlerNotFoundException with a + default reason.
HandlerNotFoundException(java.lang.String className, + java.lang.Throwable cause) + +
+          Construct a new HandlerNotFoundException with a class name and + chained exception.
+  + + + + + + + +
+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
+ +

+HandlerNotFoundException

+
+public HandlerNotFoundException()
+
+
Construct a new HandlerNotFoundException with a + default reason. +

+

+
+ +

+HandlerNotFoundException

+
+public HandlerNotFoundException(java.lang.String className,
+                                java.lang.Throwable cause)
+
+
Construct a new HandlerNotFoundException with a class name and + chained exception. +

+

+
Parameters:
className - The name of the missing handler class.
cause - The exception that this new exception is to + wrap.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/backend/server/exceptions/HandlerSetupFailureException.html b/doc/uk/org/ury/backend/server/exceptions/HandlerSetupFailureException.html new file mode 100644 index 0000000..6820215 --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/HandlerSetupFailureException.html @@ -0,0 +1,278 @@ + + + + + + +HandlerSetupFailureException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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.backend.server.exceptions +
+Class HandlerSetupFailureException

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

+Exception thrown when the server request handler requested + by the client cannot be set up to process the request. +

+ +

+

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

+ + + + + + + + + + + + + + +
+Constructor Summary
HandlerSetupFailureException() + +
+          Construct a new HandlerNotFoundException with a + default reason.
HandlerSetupFailureException(java.lang.String className, + java.lang.Throwable cause) + +
+          Construct a new HandlerSetupFailureException with a class name + and chained exception.
+  + + + + + + + +
+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
+ +

+HandlerSetupFailureException

+
+public HandlerSetupFailureException()
+
+
Construct a new HandlerNotFoundException with a + default reason. +

+

+
+ +

+HandlerSetupFailureException

+
+public HandlerSetupFailureException(java.lang.String className,
+                                    java.lang.Throwable cause)
+
+
Construct a new HandlerSetupFailureException with a class name + and chained exception. + + Use this to hide exception specifics from higher abstraction + layers. +

+

+
Parameters:
className - The name of the failed handler class.
cause - The exception that this new exception is to + wrap.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/backend/server/exceptions/HandlingException.html b/doc/uk/org/ury/backend/server/exceptions/HandlingException.html new file mode 100644 index 0000000..04ea1db --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/HandlingException.html @@ -0,0 +1,275 @@ + + + + + + +HandlingException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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.backend.server.exceptions +
+Class HandlingException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by uk.org.ury.backend.server.exceptions.HandlingException
+
+
+
All Implemented Interfaces:
java.io.Serializable
+
+
+
Direct Known Subclasses:
BadRequestException, HandleFailureException, HandlerNotFoundException, HandlerSetupFailureException, NotAHandlerException, UnknownFunctionException
+
+
+
+
public class HandlingException
extends java.lang.Exception
+ + +

+Generic exception thrown when the server cannot handle a request. +

+ +

+

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

+ + + + + + + + + + + + + + +
+Constructor Summary
HandlingException(java.lang.String string) + +
+          Construct a HandlingException with a reason.
HandlingException(java.lang.String string, + java.lang.Throwable cause) + +
+          Construct a HandlingException with a reason and a cause to + chain.
+  + + + + + + + +
+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
+ +

+HandlingException

+
+public HandlingException(java.lang.String string)
+
+
Construct a HandlingException with a reason. +

+

+
Parameters:
string - The reason to present.
+
+
+ +

+HandlingException

+
+public HandlingException(java.lang.String string,
+                         java.lang.Throwable cause)
+
+
Construct a HandlingException with a reason and a cause to + chain. +

+

+
Parameters:
string - The reason to present.
cause - The thrown cause that this exception should wrap.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/backend/server/exceptions/NotAHandlerException.html b/doc/uk/org/ury/backend/server/exceptions/NotAHandlerException.html new file mode 100644 index 0000000..bec4181 --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/NotAHandlerException.html @@ -0,0 +1,254 @@ + + + + + + +NotAHandlerException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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.backend.server.exceptions +
+Class NotAHandlerException

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

+Exception thrown if the class requested as a handler by the client + is, in fact, not a handler (it does not implement RequestHandler). +

+ +

+

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

+ + + + + + + + + + + +
+Constructor Summary
NotAHandlerException(java.lang.String className) + +
+          Construct a NotAHandlerException with the name of the class that + is not a handler.
+  + + + + + + + +
+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
+ +

+NotAHandlerException

+
+public NotAHandlerException(java.lang.String className)
+
+
Construct a NotAHandlerException with the name of the class that + is not a handler. +

+

+
Parameters:
className - The name of the offending class.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/backend/server/exceptions/UnknownFunctionException.html b/doc/uk/org/ury/backend/server/exceptions/UnknownFunctionException.html new file mode 100644 index 0000000..29c6529 --- /dev/null +++ b/doc/uk/org/ury/backend/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.backend.server.exceptions +
+Class UnknownFunctionException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by uk.org.ury.backend.server.exceptions.HandlingException
+              extended by uk.org.ury.backend.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/backend/server/exceptions/class-use/BadRequestException.html b/doc/uk/org/ury/backend/server/exceptions/class-use/BadRequestException.html new file mode 100644 index 0000000..0a06f90 --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/class-use/BadRequestException.html @@ -0,0 +1,213 @@ + + + + + + +Uses of Class uk.org.ury.backend.server.exceptions.BadRequestException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.backend.server.exceptions.BadRequestException

+
+ + + + + + + + + + + + + +
+Packages that use BadRequestException
uk.org.ury.backend.handlers  
uk.org.ury.backend.serverThe URY Server kernel. 
+  +

+ + + + + +
+Uses of BadRequestException in uk.org.ury.backend.handlers
+  +

+ + + + + + + + + +
Methods in uk.org.ury.backend.handlers 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.
+  +

+ + + + + +
+Uses of BadRequestException in uk.org.ury.backend.server
+  +

+ + + + + + + + + +
Methods in uk.org.ury.backend.server that throw BadRequestException
+ voidHttpHandler.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/backend/server/exceptions/class-use/HandleFailureException.html b/doc/uk/org/ury/backend/server/exceptions/class-use/HandleFailureException.html new file mode 100644 index 0000000..2429bc2 --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/class-use/HandleFailureException.html @@ -0,0 +1,233 @@ + + + + + + +Uses of Class uk.org.ury.backend.server.exceptions.HandleFailureException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.backend.server.exceptions.HandleFailureException

+
+ + + + + + + + + + + + + +
+Packages that use HandleFailureException
uk.org.ury.backend.handlers  
uk.org.ury.backend.serverThe URY Server kernel. 
+  +

+ + + + + +
+Uses of HandleFailureException in uk.org.ury.backend.handlers
+  +

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

+ + + + + +
+Uses of HandleFailureException in uk.org.ury.backend.server
+  +

+ + + + + + + + + + + + + + + + + +
Methods in uk.org.ury.backend.server that throw HandleFailureException
+ voidHttpHandler.handleGet(org.apache.http.HttpRequest request, + org.apache.http.HttpResponse response, + org.apache.http.protocol.HttpContext context) + +
+          Handle a HTTP GET request.
+ java.util.Map<java.lang.String,java.lang.Object>ApiRequestHandler.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).
+ java.util.Map<java.lang.String,java.lang.Object>ServerRequestHandler.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).
+  +

+

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

+Uses of Class
uk.org.ury.backend.server.exceptions.HandlerNotFoundException

+
+ + + + + + + + + + + + + +
+Packages that use HandlerNotFoundException
uk.org.ury.backend.handlers  
uk.org.ury.backend.serverThe URY Server kernel. 
+  +

+ + + + + +
+Uses of HandlerNotFoundException in uk.org.ury.backend.handlers
+  +

+ + + + + + + + + +
Methods in uk.org.ury.backend.handlers 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.
+  +

+ + + + + +
+Uses of HandlerNotFoundException in uk.org.ury.backend.server
+  +

+ + + + + + + + + +
Methods in uk.org.ury.backend.server that throw HandlerNotFoundException
+ voidHttpHandler.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/backend/server/exceptions/class-use/HandlerSetupFailureException.html b/doc/uk/org/ury/backend/server/exceptions/class-use/HandlerSetupFailureException.html new file mode 100644 index 0000000..74df677 --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/class-use/HandlerSetupFailureException.html @@ -0,0 +1,213 @@ + + + + + + +Uses of Class uk.org.ury.backend.server.exceptions.HandlerSetupFailureException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.backend.server.exceptions.HandlerSetupFailureException

+
+ + + + + + + + + + + + + +
+Packages that use HandlerSetupFailureException
uk.org.ury.backend.handlers  
uk.org.ury.backend.serverThe URY Server kernel. 
+  +

+ + + + + +
+Uses of HandlerSetupFailureException in uk.org.ury.backend.handlers
+  +

+ + + + + + + + + +
Methods in uk.org.ury.backend.handlers 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.
+  +

+ + + + + +
+Uses of HandlerSetupFailureException in uk.org.ury.backend.server
+  +

+ + + + + + + + + +
Methods in uk.org.ury.backend.server that throw HandlerSetupFailureException
+ voidHttpHandler.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/backend/server/exceptions/class-use/HandlingException.html b/doc/uk/org/ury/backend/server/exceptions/class-use/HandlingException.html new file mode 100644 index 0000000..de0bffa --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/class-use/HandlingException.html @@ -0,0 +1,226 @@ + + + + + + +Uses of Class uk.org.ury.backend.server.exceptions.HandlingException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.backend.server.exceptions.HandlingException

+
+ + + + + + + + + +
+Packages that use HandlingException
uk.org.ury.backend.server.exceptions  
+  +

+ + + + + +
+Uses of HandlingException in uk.org.ury.backend.server.exceptions
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Subclasses of HandlingException in uk.org.ury.backend.server.exceptions
+ classBadRequestException + +
+          Exception thrown when the server meets a malformed request, or + part of one.
+ classHandleFailureException + +
+          Generic exception thrown when a server request handler fails to + handle a request.
+ classHandlerNotFoundException + +
+          Exception thrown when the server request handler requested + by the client is not * found in the class space.
+ classHandlerSetupFailureException + +
+          Exception thrown when the server request handler requested + by the client cannot be set up to process the request.
+ classNotAHandlerException + +
+          Exception thrown if the class requested as a handler by the client + is, in fact, not a handler (it does not implement RequestHandler).
+ classUnknownFunctionException + +
+          Exception thrown when a handler receives a request for a path that does not + correspond to one of its functions.
+  +

+

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

+Uses of Class
uk.org.ury.backend.server.exceptions.NotAHandlerException

+
+ + + + + + + + + + + + + +
+Packages that use NotAHandlerException
uk.org.ury.backend.handlers  
uk.org.ury.backend.serverThe URY Server kernel. 
+  +

+ + + + + +
+Uses of NotAHandlerException in uk.org.ury.backend.handlers
+  +

+ + + + + + + + + +
Methods in uk.org.ury.backend.handlers 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.
+  +

+ + + + + +
+Uses of NotAHandlerException in uk.org.ury.backend.server
+  +

+ + + + + + + + + +
Methods in uk.org.ury.backend.server that throw NotAHandlerException
+ voidHttpHandler.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/backend/server/exceptions/class-use/UnknownFunctionException.html b/doc/uk/org/ury/backend/server/exceptions/class-use/UnknownFunctionException.html new file mode 100644 index 0000000..2de3a73 --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/class-use/UnknownFunctionException.html @@ -0,0 +1,182 @@ + + + + + + +Uses of Class uk.org.ury.backend.server.exceptions.UnknownFunctionException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

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

+
+ + + + + + + + + +
+Packages that use UnknownFunctionException
uk.org.ury.backend.handlers  
+  +

+ + + + + +
+Uses of UnknownFunctionException in uk.org.ury.backend.handlers
+  +

+ + + + + + + + + +
Methods in uk.org.ury.backend.handlers 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/backend/server/exceptions/package-frame.html b/doc/uk/org/ury/backend/server/exceptions/package-frame.html new file mode 100644 index 0000000..b480516 --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/package-frame.html @@ -0,0 +1,44 @@ + + + + + + +uk.org.ury.backend.server.exceptions + + + + + + + + + + + +uk.org.ury.backend.server.exceptions + + + + +
+Exceptions  + +
+BadRequestException +
+HandleFailureException +
+HandlerNotFoundException +
+HandlerSetupFailureException +
+HandlingException +
+NotAHandlerException +
+UnknownFunctionException
+ + + + diff --git a/doc/uk/org/ury/backend/server/exceptions/package-summary.html b/doc/uk/org/ury/backend/server/exceptions/package-summary.html new file mode 100644 index 0000000..eef32f9 --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/package-summary.html @@ -0,0 +1,187 @@ + + + + + + +uk.org.ury.backend.server.exceptions + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package uk.org.ury.backend.server.exceptions +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Exception Summary
BadRequestExceptionException thrown when the server meets a malformed request, or + part of one.
HandleFailureExceptionGeneric exception thrown when a server request handler fails to + handle a request.
HandlerNotFoundExceptionException thrown when the server request handler requested + by the client is not * found in the class space.
HandlerSetupFailureExceptionException thrown when the server request handler requested + by the client cannot be set up to process the request.
HandlingExceptionGeneric exception thrown when the server cannot handle a request.
NotAHandlerExceptionException thrown if the class requested as a handler by the client + is, in fact, not a handler (it does not implement RequestHandler).
UnknownFunctionExceptionException thrown when a handler receives a request for a path that does not + correspond to one of its functions.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/server/exceptions/package-tree.html b/doc/uk/org/ury/backend/server/exceptions/package-tree.html new file mode 100644 index 0000000..98e97bd --- /dev/null +++ b/doc/uk/org/ury/backend/server/exceptions/package-tree.html @@ -0,0 +1,160 @@ + + + + + + +uk.org.ury.backend.server.exceptions Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package uk.org.ury.backend.server.exceptions +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

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

+Uses of Package
uk.org.ury.backend.server.exceptions

+
+ + + + + + + + + + + + + + + + + +
+Packages that use uk.org.ury.backend.server.exceptions
uk.org.ury.backend.handlers  
uk.org.ury.backend.serverThe URY Server kernel. 
uk.org.ury.backend.server.exceptions  
+  +

+ + + + + + + + + + + + + + + + + + + + + + + +
+Classes in uk.org.ury.backend.server.exceptions used by uk.org.ury.backend.handlers
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.
+  +

+ + + + + + + + + + + + + + + + + + + + +
+Classes in uk.org.ury.backend.server.exceptions used by uk.org.ury.backend.server
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).
+  +

+ + + + + + + + +
+Classes in uk.org.ury.backend.server.exceptions used by uk.org.ury.backend.server.exceptions
HandlingException + +
+          Generic exception thrown when the server cannot handle a request.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/server/package-frame.html b/doc/uk/org/ury/backend/server/package-frame.html new file mode 100644 index 0000000..2bb20e0 --- /dev/null +++ b/doc/uk/org/ury/backend/server/package-frame.html @@ -0,0 +1,53 @@ + + + + + + +uk.org.ury.backend.server + + + + + + + + + + + +uk.org.ury.backend.server + + + + +
+Interfaces  + +
+ApiRequestHandler
+ + + + + + +
+Classes  + +
+AbstractRequestHandler +
+HttpHandler +
+HttpListenerThread +
+HttpWorkerThread +
+Server +
+ServerRequestHandler
+ + + + diff --git a/doc/uk/org/ury/backend/server/package-summary.html b/doc/uk/org/ury/backend/server/package-summary.html new file mode 100644 index 0000000..71b017e --- /dev/null +++ b/doc/uk/org/ury/backend/server/package-summary.html @@ -0,0 +1,220 @@ + + + + + + +uk.org.ury.backend.server + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package uk.org.ury.backend.server +

+The URY Server kernel. +

+See: +
+          Description +

+ + + + + + + + + +
+Interface Summary
ApiRequestHandlerInterface for classes that can handle requests addressed to their + class name from the main server.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
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.
ServerThe unified URY server, accepting requests over HTTP.
ServerRequestHandlerA request handler for server queries.
+  + +

+

+Package uk.org.ury.backend.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 +

+ +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/server/package-tree.html b/doc/uk/org/ury/backend/server/package-tree.html new file mode 100644 index 0000000..d044a8c --- /dev/null +++ b/doc/uk/org/ury/backend/server/package-tree.html @@ -0,0 +1,166 @@ + + + + + + +uk.org.ury.backend.server Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package uk.org.ury.backend.server +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

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

+Uses of Package
uk.org.ury.backend.server

+
+ + + + + + + + + + + + + +
+Packages that use uk.org.ury.backend.server
uk.org.ury.backend.handlers  
uk.org.ury.backend.serverThe URY Server kernel. 
+  +

+ + + + + + + + + + + +
+Classes in uk.org.ury.backend.server used by uk.org.ury.backend.handlers
AbstractRequestHandler + +
+          An abstract request handler for HttpCore, providing basic functionality such + as uniform error response.
Server + +
+          The unified URY server, accepting requests over HTTP.
+  +

+ + + + + + + + + + + + + + +
+Classes in uk.org.ury.backend.server used by uk.org.ury.backend.server
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 + class name from the main server.
Server + +
+          The unified URY server, accepting requests over HTTP.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + -- cgit v1.2.3