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/allclasses-frame.html | 20 +- doc/allclasses-noframe.html | 20 +- doc/constant-values.html | 24 +- doc/deprecated-list.html | 4 +- doc/help-doc.html | 4 +- doc/index-files/index-1.html | 15 +- doc/index-files/index-10.html | 10 +- doc/index-files/index-11.html | 4 +- doc/index-files/index-12.html | 4 +- doc/index-files/index-13.html | 14 +- doc/index-files/index-14.html | 4 +- doc/index-files/index-15.html | 15 +- doc/index-files/index-16.html | 14 +- doc/index-files/index-17.html | 6 +- doc/index-files/index-18.html | 10 +- doc/index-files/index-19.html | 4 +- doc/index-files/index-2.html | 7 +- doc/index-files/index-3.html | 8 +- doc/index-files/index-4.html | 20 +- doc/index-files/index-5.html | 4 +- doc/index-files/index-6.html | 4 +- doc/index-files/index-7.html | 15 +- doc/index-files/index-8.html | 31 +- doc/index-files/index-9.html | 7 +- doc/index.html | 2 +- doc/overview-frame.html | 4 +- doc/overview-summary.html | 42 ++- doc/overview-tree.html | 20 +- doc/serialized-form.html | 18 +- doc/uk/org/ury/client/Client.html | 8 +- doc/uk/org/ury/client/class-use/Client.html | 4 +- doc/uk/org/ury/client/package-frame.html | 4 +- doc/uk/org/ury/client/package-summary.html | 4 +- doc/uk/org/ury/client/package-tree.html | 4 +- doc/uk/org/ury/client/package-use.html | 4 +- doc/uk/org/ury/client/test/ClientTest.html | 8 +- .../org/ury/client/test/class-use/ClientTest.html | 4 +- doc/uk/org/ury/client/test/package-frame.html | 4 +- doc/uk/org/ury/client/test/package-summary.html | 4 +- doc/uk/org/ury/client/test/package-tree.html | 4 +- doc/uk/org/ury/client/test/package-use.html | 4 +- doc/uk/org/ury/config/Auth.html | 4 +- doc/uk/org/ury/config/ConfigReader.html | 4 +- doc/uk/org/ury/config/Database.html | 4 +- doc/uk/org/ury/config/class-use/Auth.html | 4 +- doc/uk/org/ury/config/class-use/ConfigReader.html | 6 +- doc/uk/org/ury/config/class-use/Database.html | 4 +- doc/uk/org/ury/config/package-frame.html | 4 +- doc/uk/org/ury/config/package-summary.html | 4 +- doc/uk/org/ury/config/package-tree.html | 4 +- doc/uk/org/ury/config/package-use.html | 6 +- doc/uk/org/ury/database/DatabaseDriver.html | 31 +- doc/uk/org/ury/database/DatabaseItem.html | 15 +- doc/uk/org/ury/database/UserClass.html | 20 +- .../org/ury/database/class-use/DatabaseDriver.html | 12 +- .../org/ury/database/class-use/DatabaseItem.html | 6 +- doc/uk/org/ury/database/class-use/UserClass.html | 10 +- .../exceptions/ConnectionFailureException.html | 4 +- .../exceptions/MissingCredentialsException.html | 4 +- .../exceptions/MissingPropertyException.html | 4 +- .../database/exceptions/QueryFailureException.html | 4 +- .../class-use/ConnectionFailureException.html | 10 +- .../class-use/MissingCredentialsException.html | 10 +- .../class-use/MissingPropertyException.html | 6 +- .../class-use/QueryFailureException.html | 8 +- .../org/ury/database/exceptions/package-frame.html | 4 +- .../ury/database/exceptions/package-summary.html | 19 +- .../org/ury/database/exceptions/package-tree.html | 4 +- .../org/ury/database/exceptions/package-use.html | 8 +- doc/uk/org/ury/database/package-frame.html | 4 +- doc/uk/org/ury/database/package-summary.html | 33 ++- doc/uk/org/ury/database/package-tree.html | 4 +- doc/uk/org/ury/database/package-use.html | 35 +-- .../org/ury/frontend/AbstractFrontendModule.html | 4 +- doc/uk/org/ury/frontend/FrontendApplet.html | 4 +- doc/uk/org/ury/frontend/FrontendBanner.html | 4 +- doc/uk/org/ury/frontend/FrontendControlPanel.html | 4 +- doc/uk/org/ury/frontend/FrontendError.html | 4 +- doc/uk/org/ury/frontend/FrontendFrame.html | 4 +- doc/uk/org/ury/frontend/FrontendMaster.html | 4 +- doc/uk/org/ury/frontend/FrontendModule.html | 4 +- doc/uk/org/ury/frontend/FrontendModulePanel.html | 4 +- doc/uk/org/ury/frontend/FrontendPanel.html | 4 +- doc/uk/org/ury/frontend/FrontendSubBanner.html | 4 +- doc/uk/org/ury/frontend/HintField.html | 4 +- .../frontend/class-use/AbstractFrontendModule.html | 4 +- .../org/ury/frontend/class-use/FrontendApplet.html | 4 +- .../org/ury/frontend/class-use/FrontendBanner.html | 4 +- .../frontend/class-use/FrontendControlPanel.html | 4 +- .../org/ury/frontend/class-use/FrontendError.html | 4 +- .../org/ury/frontend/class-use/FrontendFrame.html | 4 +- .../org/ury/frontend/class-use/FrontendMaster.html | 6 +- .../org/ury/frontend/class-use/FrontendModule.html | 4 +- .../frontend/class-use/FrontendModulePanel.html | 6 +- .../org/ury/frontend/class-use/FrontendPanel.html | 4 +- .../ury/frontend/class-use/FrontendSubBanner.html | 4 +- doc/uk/org/ury/frontend/class-use/HintField.html | 4 +- .../frontend/exceptions/LoadFailureException.html | 4 +- .../exceptions/UICreationFailureException.html | 4 +- .../exceptions/class-use/LoadFailureException.html | 4 +- .../class-use/UICreationFailureException.html | 4 +- .../org/ury/frontend/exceptions/package-frame.html | 4 +- .../ury/frontend/exceptions/package-summary.html | 4 +- .../org/ury/frontend/exceptions/package-tree.html | 4 +- .../org/ury/frontend/exceptions/package-use.html | 4 +- doc/uk/org/ury/frontend/package-frame.html | 4 +- doc/uk/org/ury/frontend/package-summary.html | 4 +- doc/uk/org/ury/frontend/package-tree.html | 4 +- doc/uk/org/ury/frontend/package-use.html | 4 +- doc/uk/org/ury/library/LibraryRequestHandler.html | 88 ++++-- doc/uk/org/ury/library/LibraryUtils.html | 4 +- .../library/class-use/LibraryRequestHandler.html | 4 +- doc/uk/org/ury/library/class-use/LibraryUtils.html | 4 +- .../library/exceptions/EmptySearchException.html | 4 +- .../exceptions/class-use/EmptySearchException.html | 6 +- .../org/ury/library/exceptions/package-frame.html | 4 +- .../ury/library/exceptions/package-summary.html | 4 +- .../org/ury/library/exceptions/package-tree.html | 4 +- doc/uk/org/ury/library/exceptions/package-use.html | 4 +- doc/uk/org/ury/library/item/LibraryItem.html | 4 +- .../org/ury/library/item/LibraryItemProperty.html | 4 +- .../ury/library/item/class-use/LibraryItem.html | 4 +- .../item/class-use/LibraryItemProperty.html | 4 +- doc/uk/org/ury/library/item/package-frame.html | 4 +- doc/uk/org/ury/library/item/package-summary.html | 4 +- doc/uk/org/ury/library/item/package-tree.html | 4 +- doc/uk/org/ury/library/item/package-use.html | 4 +- doc/uk/org/ury/library/package-frame.html | 4 +- doc/uk/org/ury/library/package-summary.html | 4 +- doc/uk/org/ury/library/package-tree.html | 8 +- doc/uk/org/ury/library/package-use.html | 4 +- .../org/ury/library/viewer/LibraryTableModel.html | 4 +- doc/uk/org/ury/library/viewer/LibraryViewer.html | 24 +- .../org/ury/library/viewer/LibraryViewerPanel.html | 4 +- .../viewer/class-use/LibraryTableModel.html | 4 +- .../library/viewer/class-use/LibraryViewer.html | 4 +- .../viewer/class-use/LibraryViewerPanel.html | 4 +- doc/uk/org/ury/library/viewer/package-frame.html | 4 +- doc/uk/org/ury/library/viewer/package-summary.html | 4 +- doc/uk/org/ury/library/viewer/package-tree.html | 4 +- doc/uk/org/ury/library/viewer/package-use.html | 4 +- doc/uk/org/ury/protocol/Directive.html | 4 +- doc/uk/org/ury/protocol/ProtocolUtils.html | 4 +- doc/uk/org/ury/protocol/Status.html | 4 +- doc/uk/org/ury/protocol/class-use/Directive.html | 4 +- .../org/ury/protocol/class-use/ProtocolUtils.html | 4 +- doc/uk/org/ury/protocol/class-use/Status.html | 4 +- .../exceptions/DecodeFailureException.html | 4 +- .../exceptions/InvalidMessageException.html | 4 +- .../class-use/DecodeFailureException.html | 4 +- .../class-use/InvalidMessageException.html | 6 +- .../org/ury/protocol/exceptions/package-frame.html | 4 +- .../ury/protocol/exceptions/package-summary.html | 4 +- .../org/ury/protocol/exceptions/package-tree.html | 4 +- .../org/ury/protocol/exceptions/package-use.html | 4 +- doc/uk/org/ury/protocol/package-frame.html | 4 +- doc/uk/org/ury/protocol/package-summary.html | 4 +- doc/uk/org/ury/protocol/package-tree.html | 4 +- doc/uk/org/ury/protocol/package-use.html | 4 +- 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 +- doc/uk/org/ury/show/ShowChannel.html | 28 +- doc/uk/org/ury/show/ShowUtils.html | 43 ++- doc/uk/org/ury/show/class-use/ShowChannel.html | 4 +- doc/uk/org/ury/show/class-use/ShowUtils.html | 4 +- doc/uk/org/ury/show/item/ShowItem.html | 4 +- doc/uk/org/ury/show/item/ShowItemProperty.html | 4 +- doc/uk/org/ury/show/item/class-use/ShowItem.html | 14 +- .../ury/show/item/class-use/ShowItemProperty.html | 6 +- doc/uk/org/ury/show/item/package-frame.html | 4 +- doc/uk/org/ury/show/item/package-summary.html | 22 +- doc/uk/org/ury/show/item/package-tree.html | 4 +- doc/uk/org/ury/show/item/package-use.html | 6 +- doc/uk/org/ury/show/package-frame.html | 4 +- doc/uk/org/ury/show/package-summary.html | 8 +- doc/uk/org/ury/show/package-tree.html | 4 +- doc/uk/org/ury/show/package-use.html | 4 +- doc/uk/org/ury/show/viewer/ChannelPanel.html | 4 +- .../org/ury/show/viewer/LibraryControlPanel.html | 4 +- doc/uk/org/ury/show/viewer/ShowViewer.html | 4 +- doc/uk/org/ury/show/viewer/ShowViewerPanel.html | 4 +- doc/uk/org/ury/show/viewer/TrackBin.html | 4 +- .../ury/show/viewer/class-use/ChannelPanel.html | 4 +- .../show/viewer/class-use/LibraryControlPanel.html | 4 +- .../org/ury/show/viewer/class-use/ShowViewer.html | 4 +- .../ury/show/viewer/class-use/ShowViewerPanel.html | 4 +- doc/uk/org/ury/show/viewer/class-use/TrackBin.html | 4 +- doc/uk/org/ury/show/viewer/package-frame.html | 4 +- doc/uk/org/ury/show/viewer/package-summary.html | 4 +- doc/uk/org/ury/show/viewer/package-tree.html | 4 +- doc/uk/org/ury/show/viewer/package-use.html | 4 +- doc/uk/org/ury/testrig/ApplicationLauncher.html | 4 +- doc/uk/org/ury/testrig/DemoControlPanel.html | 4 +- doc/uk/org/ury/testrig/DemoMenu.html | 4 +- doc/uk/org/ury/testrig/DemoMenuPanel.html | 4 +- doc/uk/org/ury/testrig/Launcher.html | 4 +- .../ury/testrig/class-use/ApplicationLauncher.html | 4 +- .../ury/testrig/class-use/DemoControlPanel.html | 4 +- doc/uk/org/ury/testrig/class-use/DemoMenu.html | 4 +- .../org/ury/testrig/class-use/DemoMenuPanel.html | 4 +- doc/uk/org/ury/testrig/class-use/Launcher.html | 4 +- doc/uk/org/ury/testrig/package-frame.html | 4 +- doc/uk/org/ury/testrig/package-summary.html | 4 +- doc/uk/org/ury/testrig/package-tree.html | 4 +- doc/uk/org/ury/testrig/package-use.html | 4 +- 239 files changed, 4000 insertions(+), 882 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') diff --git a/doc/allclasses-frame.html b/doc/allclasses-frame.html index 73bb778..e5749f5 100644 --- a/doc/allclasses-frame.html +++ b/doc/allclasses-frame.html @@ -2,12 +2,12 @@ - + All Classes - + @@ -23,6 +23,10 @@ All Classes AbstractFrontendModule
+AbstractRequestHandler +
+ApiRequestHandler +
ApplicationLauncher
Auth @@ -87,6 +91,12 @@ All Classes
HintField
+HttpHandler +
+HttpListenerThread +
+HttpWorkerThread +
InvalidMessageException
Launcher @@ -119,12 +129,8 @@ All Classes
QueryFailureException
-RequestHandler -
Server
-ServerProtocol -
ServerRequestHandler
ShowChannel @@ -145,6 +151,8 @@ All Classes
UICreationFailureException
+UnknownFunctionException +
UserClass
diff --git a/doc/allclasses-noframe.html b/doc/allclasses-noframe.html index b8dfe7d..1115f5e 100644 --- a/doc/allclasses-noframe.html +++ b/doc/allclasses-noframe.html @@ -2,12 +2,12 @@ - + All Classes - + @@ -23,6 +23,10 @@ All Classes AbstractFrontendModule
+AbstractRequestHandler +
+ApiRequestHandler +
ApplicationLauncher
Auth @@ -87,6 +91,12 @@ All Classes
HintField
+HttpHandler +
+HttpListenerThread +
+HttpWorkerThread +
InvalidMessageException
Launcher @@ -119,12 +129,8 @@ All Classes
QueryFailureException
-RequestHandler -
Server
-ServerProtocol -
ServerRequestHandler
ShowChannel @@ -145,6 +151,8 @@ All Classes
UICreationFailureException
+UnknownFunctionException +
UserClass
diff --git a/doc/constant-values.html b/doc/constant-values.html index e09905e..94d50b9 100644 --- a/doc/constant-values.html +++ b/doc/constant-values.html @@ -2,12 +2,12 @@ - + Constant Field Values - + @@ -100,13 +100,25 @@ uk.org.* - + - - - + + + + + + + + + + + + diff --git a/doc/deprecated-list.html b/doc/deprecated-list.html index 480c71f..b585e26 100644 --- a/doc/deprecated-list.html +++ b/doc/deprecated-list.html @@ -2,12 +2,12 @@ - + Deprecated List - + diff --git a/doc/help-doc.html b/doc/help-doc.html index dbfa0f8..5f7caeb 100644 --- a/doc/help-doc.html +++ b/doc/help-doc.html @@ -2,12 +2,12 @@ - + API Help - + diff --git a/doc/index-files/index-1.html b/doc/index-files/index-1.html index 888aa74..eb48bf3 100644 --- a/doc/index-files/index-1.html +++ b/doc/index-files/index-1.html @@ -2,12 +2,12 @@ - + A-Index - + @@ -85,13 +85,18 @@ function windowTitle()
AbstractFrontendModule - Class in uk.org.ury.frontend
An abstract implementation of the FrontendModule interface.
AbstractFrontendModule() - Constructor for class uk.org.ury.frontend.AbstractFrontendModule
  +
AbstractRequestHandler - Class in uk.org.ury.server
An abstract request handler for HttpCore, providing basic functionality such + as uniform error response.
AbstractRequestHandler(Server, String) - +Constructor for class uk.org.ury.server.AbstractRequestHandler +
Constructs a new AbstractRequestHandler.
add(int, ShowItem) - Method in class uk.org.ury.show.ShowChannel -
Add a new item to the channel. +
Adds a new item to the channel.
add(ShowItem) - Method in class uk.org.ury.show.ShowChannel -
Add a new item to the end of the channel. -
ApplicationLauncher - Class in uk.org.ury.testrig
An application-based entry point into the frontend.
ApplicationLauncher() - +
Adds a new item to the end of the channel. +
ApiRequestHandler - Interface in uk.org.ury.server
Interface for classes that can handle requests addressed to their + class name from the main server.
ApplicationLauncher - Class in uk.org.ury.testrig
An application-based entry point into the frontend.
ApplicationLauncher() - Constructor for class uk.org.ury.testrig.ApplicationLauncher
 
asResponse() - diff --git a/doc/index-files/index-10.html b/doc/index-files/index-10.html index a8824ad..d093928 100644 --- a/doc/index-files/index-10.html +++ b/doc/index-files/index-10.html @@ -2,12 +2,12 @@ - + L-Index - + @@ -88,9 +88,9 @@ Constructor for class uk.org.ury.show.viewer.LibraryItem - Class in uk.org.ury.library.item
An item in the URY library.
LibraryItem(Map<LibraryItemProperty, String>) - Constructor for class uk.org.ury.library.item.LibraryItem
  -
LibraryItemProperty - Enum in uk.org.ury.library.item
The parameters that are stored in the LibraryItem.
LibraryRequestHandler - Class in uk.org.ury.library
A request handler for library queries.
LibraryRequestHandler() - +
LibraryItemProperty - Enum in uk.org.ury.library.item
The parameters that are stored in the LibraryItem.
LibraryRequestHandler - Class in uk.org.ury.library
A request handler for library queries.
LibraryRequestHandler(Server, String) - Constructor for class uk.org.ury.library.LibraryRequestHandler -
  +
Construct a new LibraryRequestHandler.
LibraryTableModel - Class in uk.org.ury.library.viewer
A table model for the library viewer.
LibraryTableModel(List<LibraryItem>) - Constructor for class uk.org.ury.library.viewer.LibraryTableModel
Construct a new table model. @@ -100,7 +100,7 @@ Constructor for class uk.org.ury.library.LibraryViewer - Class in uk.org.ury.library.viewer
Module for investigating the track library.
LibraryViewer() - Constructor for class uk.org.ury.library.viewer.LibraryViewer -
Construct a new LibraryViewer as a frontend object. +
Constructs a new LibraryViewer as a frontend object.
LibraryViewerPanel - Class in uk.org.ury.library.viewer
Frontend panel providing access to an underlying library viewer.
LibraryViewerPanel(LibraryViewer, FrontendMaster) - Constructor for class uk.org.ury.library.viewer.LibraryViewerPanel
Construct a new LibraryViewerPanel. diff --git a/doc/index-files/index-11.html b/doc/index-files/index-11.html index 6cae7cd..b738199 100644 --- a/doc/index-files/index-11.html +++ b/doc/index-files/index-11.html @@ -2,12 +2,12 @@ - + M-Index - + diff --git a/doc/index-files/index-12.html b/doc/index-files/index-12.html index 98ffbc9..b877693 100644 --- a/doc/index-files/index-12.html +++ b/doc/index-files/index-12.html @@ -2,12 +2,12 @@ - + N-Index - + diff --git a/doc/index-files/index-13.html b/doc/index-files/index-13.html index 0d582d8..49ff9e4 100644 --- a/doc/index-files/index-13.html +++ b/doc/index-files/index-13.html @@ -2,12 +2,12 @@ - + P-Index - + @@ -82,16 +82,6 @@ function windowTitle()

P

-
parseQueryString(String) - -Method in class uk.org.ury.server.Server -
Parse a query string, populating a key-value map of the - URL-unescaped results. -
processBuffer(List<String>, PrintWriter) - -Method in class uk.org.ury.server.Server -
  -
processInput(String) - -Method in class uk.org.ury.server.ServerProtocol -
 
ProtocolUtils - Class in uk.org.ury.protocol
Utilities for converting between strings encoded in the response protocol and collections of items, as well as validating and unpicking protocol messages.
ProtocolUtils() - Constructor for class uk.org.ury.protocol.ProtocolUtils diff --git a/doc/index-files/index-14.html b/doc/index-files/index-14.html index 6811312..a57941e 100644 --- a/doc/index-files/index-14.html +++ b/doc/index-files/index-14.html @@ -2,12 +2,12 @@ - + Q-Index - + diff --git a/doc/index-files/index-15.html b/doc/index-files/index-15.html index 933479c..66f3b7a 100644 --- a/doc/index-files/index-15.html +++ b/doc/index-files/index-15.html @@ -2,12 +2,12 @@ - + R-Index - + @@ -88,8 +88,7 @@ Static method in class uk.org.ury.frontend.reportFatal(String, FrontendApplet) - Static method in class uk.org.ury.frontend.FrontendError
  -
RequestHandler - Interface in uk.org.ury.server
Interface for classes that can handle requests addressed to their - class name from the main server.
responseIsOK(Map<?, ?>) - +
responseIsOK(Map<?, ?>) - Static method in class uk.org.ury.protocol.ProtocolUtils
Check if a response is flagged as having OK status.
restoreModule(FrontendModulePanel, FrontendControlPanel) - @@ -103,6 +102,12 @@ Method in class uk.org.ury.frontend.FrontendMaster
Restore an existing module and control panel into the frontend master. +
run() - +Method in class uk.org.ury.server.HttpListenerThread +
Thread execution body. +
run() - +Method in class uk.org.ury.server.HttpWorkerThread +
Thread execution body.
run() - Method in class uk.org.ury.testrig.DemoMenu
Run the demo menu, creating a user interface. @@ -111,7 +116,7 @@ Method in interface uk.org.ury.frontend.runFrontend(FrontendMaster) - Method in class uk.org.ury.library.viewer.LibraryViewer -
Run the library viewer frontend. +
Runs the library viewer frontend.
runFrontend(FrontendMaster) - Method in class uk.org.ury.show.viewer.ShowViewer
Run the library viewer frontend. diff --git a/doc/index-files/index-16.html b/doc/index-files/index-16.html index 3eab2a9..2f1a287 100644 --- a/doc/index-files/index-16.html +++ b/doc/index-files/index-16.html @@ -2,12 +2,12 @@ - + S-Index - + @@ -96,8 +96,8 @@ Method in class uk.org.ury.show.viewer.Server - Class in uk.org.ury.server
The unified URY server, accepting requests over HTTP.
Server() - Constructor for class uk.org.ury.server.Server
  -
ServerProtocol - Class in uk.org.ury.server
The BAPS server protocol (a minimal implementation of HTTP 1.1) handler.
ServerProtocol() - -Constructor for class uk.org.ury.server.ServerProtocol +
SERVER_VERSION - +Static variable in class uk.org.ury.server.Server
 
ServerRequestHandler - Class in uk.org.ury.server
A request handler for server queries.
ServerRequestHandler() - Constructor for class uk.org.ury.server.ServerRequestHandler @@ -134,12 +134,12 @@ Method in interface uk.org.ury.frontend.ShowChannel - Class in uk.org.ury.show
A channel of ShowItems in a show.
ShowChannel() - Constructor for class uk.org.ury.show.ShowChannel -
Construct a new, empty channel. +
Constructs a new, empty channel.
ShowItem - Class in uk.org.ury.show.item
An item in the show database.
ShowItem(Map<ShowItemProperty, String>) - Constructor for class uk.org.ury.show.item.ShowItem
Construct a new ShowItem. -
ShowItemProperty - Enum in uk.org.ury.show.item
Enumeration of the parameters that are stored in a ShowItem.
ShowUtils - Class in uk.org.ury.show
A set of common utility routines to facilitate the extraction of - show items from the show storage areas of the URY database.
ShowUtils() - +
ShowItemProperty - Enum in uk.org.ury.show.item
Enumeration of the parameters that are stored in a ShowItem.
ShowUtils - Class in uk.org.ury.show
A set of common utility routines to facilitate the extraction of show items + from the show storage areas of the URY database.
ShowUtils() - Constructor for class uk.org.ury.show.ShowUtils
 
ShowViewer - Class in uk.org.ury.show.viewer
Frontend module for viewing show details.
ShowViewer() - diff --git a/doc/index-files/index-17.html b/doc/index-files/index-17.html index 2e809b2..e288e13 100644 --- a/doc/index-files/index-17.html +++ b/doc/index-files/index-17.html @@ -2,12 +2,12 @@ - + T-Index - + @@ -87,7 +87,7 @@ Method in class uk.org.ury.client.test.testGet() - Method in class uk.org.ury.client.test.ClientTest -
Test method for Client.get(java.lang.String). +
Test method for Client.get(java.lang.String).
toString() - Method in class uk.org.ury.show.item.ShowItem
  diff --git a/doc/index-files/index-18.html b/doc/index-files/index-18.html index 47e99d5..4fe25ef 100644 --- a/doc/index-files/index-18.html +++ b/doc/index-files/index-18.html @@ -2,12 +2,12 @@ - + U-Index - + @@ -89,7 +89,11 @@ Constructor for exception uk.org.ury.frontend.exceptions.UICreationFailureException(String) - Constructor for exception uk.org.ury.frontend.exceptions.UICreationFailureException
Construct a new UICreationFailureException. -
uk.org.ury.client - package uk.org.ury.client
 
uk.org.ury.client.test - package uk.org.ury.client.test
 
uk.org.ury.config - package uk.org.ury.config
 
uk.org.ury.database - package uk.org.ury.database
 
uk.org.ury.database.exceptions - package uk.org.ury.database.exceptions
 
uk.org.ury.frontend - package uk.org.ury.frontend
 
uk.org.ury.frontend.exceptions - package uk.org.ury.frontend.exceptions
 
uk.org.ury.library - package uk.org.ury.library
 
uk.org.ury.library.exceptions - package uk.org.ury.library.exceptions
 
uk.org.ury.library.item - package uk.org.ury.library.item
 
uk.org.ury.library.viewer - package uk.org.ury.library.viewer
 
uk.org.ury.protocol - package uk.org.ury.protocol
 
uk.org.ury.protocol.exceptions - package uk.org.ury.protocol.exceptions
 
uk.org.ury.server - package uk.org.ury.server
 
uk.org.ury.server.exceptions - package uk.org.ury.server.exceptions
 
uk.org.ury.show - package uk.org.ury.show
 
uk.org.ury.show.item - package uk.org.ury.show.item
 
uk.org.ury.show.viewer - package uk.org.ury.show.viewer
 
uk.org.ury.testrig - package uk.org.ury.testrig
 
UserClass - Enum in uk.org.ury.database
The various user classes of the database driver.
+
uk.org.ury.client - package uk.org.ury.client
 
uk.org.ury.client.test - package uk.org.ury.client.test
 
uk.org.ury.config - package uk.org.ury.config
 
uk.org.ury.database - package uk.org.ury.database
Database services for the URY Presenter Suite.
uk.org.ury.database.exceptions - package uk.org.ury.database.exceptions
Exceptions thrown by the database services classes.
uk.org.ury.frontend - package uk.org.ury.frontend
 
uk.org.ury.frontend.exceptions - package uk.org.ury.frontend.exceptions
 
uk.org.ury.library - package uk.org.ury.library
 
uk.org.ury.library.exceptions - package uk.org.ury.library.exceptions
 
uk.org.ury.library.item - package uk.org.ury.library.item
 
uk.org.ury.library.viewer - package uk.org.ury.library.viewer
 
uk.org.ury.protocol - package uk.org.ury.protocol
 
uk.org.ury.protocol.exceptions - package uk.org.ury.protocol.exceptions
 
uk.org.ury.server - package uk.org.ury.server
The URY Server kernel.
uk.org.ury.server.exceptions - package uk.org.ury.server.exceptions
 
uk.org.ury.show - package uk.org.ury.show
 
uk.org.ury.show.item - package uk.org.ury.show.item
The show item class and related properties.
uk.org.ury.show.viewer - package uk.org.ury.show.viewer
 
uk.org.ury.testrig - package uk.org.ury.testrig
 
UnknownFunctionException - Exception in uk.org.ury.server.exceptions
Exception thrown when a handler receives a request for a path that does not + correspond to one of its functions.
UnknownFunctionException(String) - +Constructor for exception uk.org.ury.server.exceptions.UnknownFunctionException +
Construct a new UnknownFunctionException. +
UserClass - Enum in uk.org.ury.database
The various user classes of the database driver.
diff --git a/doc/index-files/index-19.html b/doc/index-files/index-19.html index 64fc42e..9a8c337 100644 --- a/doc/index-files/index-19.html +++ b/doc/index-files/index-19.html @@ -2,12 +2,12 @@ - + V-Index - + diff --git a/doc/index-files/index-2.html b/doc/index-files/index-2.html index 9e90266..dd331cb 100644 --- a/doc/index-files/index-2.html +++ b/doc/index-files/index-2.html @@ -2,12 +2,12 @@ - + B-Index - + @@ -96,9 +96,6 @@ Constructor for exception uk.org.ury.server.exceptions.BadRequestException
Construct a new HandlerNotFoundException with a chained exception. -
buffer - -Variable in class uk.org.ury.server.ServerProtocol -
 
diff --git a/doc/index-files/index-3.html b/doc/index-files/index-3.html index 87e13f7..73b5ed5 100644 --- a/doc/index-files/index-3.html +++ b/doc/index-files/index-3.html @@ -2,12 +2,12 @@ - + C-Index - + @@ -93,8 +93,8 @@ Constructor for class uk.org.ury.client.test.configName - Variable in enum uk.org.ury.database.UserClass -
The name of the tag in the configuration file that contains - the credentials for this user class. +
The name of the tag in the configuration file that contains the + credentials for this user class.
ConfigReader - Class in uk.org.ury.config
Reads in an XML config file and creates config objects
ConfigReader(String) - Constructor for class uk.org.ury.config.ConfigReader
Read in the config file and create the Database and Auth configuration objects. diff --git a/doc/index-files/index-4.html b/doc/index-files/index-4.html index 0b2e075..bee8054 100644 --- a/doc/index-files/index-4.html +++ b/doc/index-files/index-4.html @@ -2,12 +2,12 @@ - + D-Index - + @@ -85,14 +85,12 @@ function windowTitle()
Database - Class in uk.org.ury.config
A Database Server configuration
Database(String, int, String) - Constructor for class uk.org.ury.config.Database
Create a database object -
DatabaseDriver - Class in uk.org.ury.database
A database connection manager that connects to the URY databases - using suitably privileged accounts, and handles the processing - of SQL queries.
DatabaseDriver(ConfigReader, UserClass) - +
DatabaseDriver - Class in uk.org.ury.database
A database connection manager that connects to the URY databases using + suitably privileged accounts, and handles the processing of SQL queries.
DatabaseDriver(ConfigReader, UserClass) - Constructor for class uk.org.ury.database.DatabaseDriver
Construct a new DatabaseDriver with the given user class. -
DatabaseItem<E,T> - Class in uk.org.ury.database
An abstract class presenting a template for objects serving as - a data structure for collections of properties retrieved from - a SQL database.
DatabaseItem(Map<E, T>) - +
DatabaseItem<E,T> - Class in uk.org.ury.database
An abstract class presenting a template for objects serving as a data + structure for collections of properties retrieved from a SQL database.
DatabaseItem(Map<E, T>) - Constructor for class uk.org.ury.database.DatabaseItem
Construct a new item from an existing list of properties.
decode(String) - @@ -113,12 +111,12 @@ Constructor for class uk.org.ury.testrig.DemoMenuPanel - Class in uk.org.ury.testrig
 
DemoMenuPanel(FrontendMaster) - Constructor for class uk.org.ury.testrig.DemoMenuPanel
Construct a new DemoMenuPanel. -
Directive - Enum in uk.org.ury.protocol
Directives supported by the protocol.
doConnection(Socket) - -Method in class uk.org.ury.server.Server +
Directive - Enum in uk.org.ury.protocol
Directives supported by the protocol.
DOCTYPE - +Static variable in class uk.org.ury.server.Server
 
doSearch(String) - Method in class uk.org.ury.library.viewer.LibraryViewer -
Do a library search. +
Does a library search.
diff --git a/doc/index-files/index-5.html b/doc/index-files/index-5.html index 563446c..fb8364f 100644 --- a/doc/index-files/index-5.html +++ b/doc/index-files/index-5.html @@ -2,12 +2,12 @@ - + E-Index - + diff --git a/doc/index-files/index-6.html b/doc/index-files/index-6.html index ae3effa..706c871 100644 --- a/doc/index-files/index-6.html +++ b/doc/index-files/index-6.html @@ -2,12 +2,12 @@ - + F-Index - + diff --git a/doc/index-files/index-7.html b/doc/index-files/index-7.html index 6fac977..46b54f2 100644 --- a/doc/index-files/index-7.html +++ b/doc/index-files/index-7.html @@ -2,12 +2,12 @@ - + G-Index - + @@ -90,17 +90,14 @@ Method in class uk.org.ury.database.get(int) - Method in class uk.org.ury.show.ShowChannel -
Retrieve an item from the channel. -
GET_HEADER - -Static variable in class uk.org.ury.server.ServerProtocol -
  +
Retrieves an item from the channel.
getBins() - Method in class uk.org.ury.show.viewer.ShowViewer
 
getChannelList(DatabaseDriver, int, int) - Static method in class uk.org.ury.show.ShowUtils -
Given a show and a channel, retrieve a list of all show items - bound to that channel for the show. +
Given a show and a channel, retrieve a list of all show items bound to + that channel for the show.
getChannels() - Method in class uk.org.ury.show.viewer.ShowViewer
  @@ -118,7 +115,7 @@ Method in class uk.org.ury.config.getDatabaseConnection(UserClass) - Method in class uk.org.ury.server.Server -
Get a database connection using the given user class. +
Gets a database connection using the given user class.
getDb() - Method in class uk.org.ury.config.Database
Get the name of the database diff --git a/doc/index-files/index-8.html b/doc/index-files/index-8.html index 86db5a8..2af44bd 100644 --- a/doc/index-files/index-8.html +++ b/doc/index-files/index-8.html @@ -2,12 +2,12 @@ - + H-Index - + @@ -82,6 +82,9 @@ function windowTitle()

H

+
handle(HttpRequest, HttpResponse, HttpContext) - +Method in class uk.org.ury.server.AbstractRequestHandler +
Begins handling of a HTTP request.
HandleFailureException - Exception in uk.org.ury.server.exceptions
Generic exception thrown when a server request handler fails to handle a request.
HandleFailureException() - Constructor for exception uk.org.ury.server.exceptions.HandleFailureException @@ -90,15 +93,14 @@ Constructor for exception uk.org.ury.server.exceptions.HandleFailureException(String) - Constructor for exception uk.org.ury.server.exceptions.HandleFailureException
Construct a new HandleFailureException. -
handleGet(List<String>) - -Method in class uk.org.ury.server.Server -
Handle a HTTP GET request. -
handleGetRequest(Map<String, String>, Server) - +
handleGet(HttpRequest, HttpResponse, HttpContext) - Method in class uk.org.ury.library.LibraryRequestHandler -
Handle a server GET request (that is, a request for data - output). -
handleGetRequest(Map<String, String>, Server) - -Method in interface uk.org.ury.server.RequestHandler +
Handle a HTTP GET request. +
handleGet(HttpRequest, HttpResponse, HttpContext) - +Method in class uk.org.ury.server.HttpHandler +
Handle a HTTP GET request. +
handleGetRequest(Map<String, String>, Server) - +Method in interface uk.org.ury.server.ApiRequestHandler
Handle a server GET request (that is, a request for data output).
handleGetRequest(Map<String, String>, Server) - @@ -140,6 +142,15 @@ Constructor for class uk.org.ury.frontend.HintField(String) - Constructor for class uk.org.ury.frontend.HintField
Construct a new HintField. +
HttpHandler - Class in uk.org.ury.server
 
HttpHandler(Server, String) - +Constructor for class uk.org.ury.server.HttpHandler +
Construct a new HttpHandler. +
HttpListenerThread - Class in uk.org.ury.server
Listener thread for the URY server HTTP interface.
HttpListenerThread(int, Server) - +Constructor for class uk.org.ury.server.HttpListenerThread +
  +
HttpWorkerThread - Class in uk.org.ury.server
A worker thread in the server HTTP interface.
HttpWorkerThread(HttpService, HttpServerConnection) - +Constructor for class uk.org.ury.server.HttpWorkerThread +
Construct a new HttpWorkerThread.
diff --git a/doc/index-files/index-9.html b/doc/index-files/index-9.html index 1abc931..78d445b 100644 --- a/doc/index-files/index-9.html +++ b/doc/index-files/index-9.html @@ -2,12 +2,12 @@ - + I-Index - + @@ -82,6 +82,9 @@ function windowTitle()

I

+
INDEX_HTML - +Static variable in class uk.org.ury.server.Server +
 
init() - Method in class uk.org.ury.frontend.FrontendApplet
Main method. diff --git a/doc/index.html b/doc/index.html index 4e70ba9..4ab3057 100644 --- a/doc/index.html +++ b/doc/index.html @@ -2,7 +2,7 @@ - + Generated Documentation (Untitled) diff --git a/doc/overview-frame.html b/doc/overview-frame.html index f7d4b10..0f01024 100644 --- a/doc/overview-frame.html +++ b/doc/overview-frame.html @@ -2,12 +2,12 @@ - + Overview List - + diff --git a/doc/overview-summary.html b/doc/overview-summary.html index a671d89..813d6aa 100644 --- a/doc/overview-summary.html +++ b/doc/overview-summary.html @@ -2,12 +2,12 @@ - + Overview - + @@ -79,6 +79,12 @@ function windowTitle()
+The URY broadcasting and presentation suite. +

+See: +
+          Description +

uk.org.ury.server.ServerProtocoluk.org.ury.server.Server
+ public static final java.lang.StringGET_HEADER"HTTP/1.1 200 OK\n"DOCTYPE"<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01//EN\"\"http://www.w3.org/TR/html4/strict.dtd\">"
+public static final java.lang.StringINDEX_HTML"\n<html>\n <head>\n <title>SLUT 0.0</title>\n </head>\n <body>\n <h1>Welcome to the SLUT 0.0 server</h1>\n <p>This server exposes a class-based API for accessing\n the internals of the SLUT 0.0 system.</p>\n <p>See the documentation for details.</p>\n </body>\n</html>"
+public static final java.lang.StringSERVER_VERSION"SLUT 0.0"
@@ -99,11 +105,11 @@ function windowTitle() - + - + @@ -139,7 +145,7 @@ function windowTitle() - + @@ -151,7 +157,7 @@ function windowTitle() - + @@ -164,7 +170,29 @@ function windowTitle()
uk.org.ury.database Database services for the URY Presenter Suite.
uk.org.ury.database.exceptions Exceptions thrown by the database services classes.
uk.org.ury.frontend
uk.org.ury.server The URY Server kernel.
uk.org.ury.server.exceptions
uk.org.ury.show.item The show item class and related properties.
uk.org.ury.show.viewer

- 

+  +

+

The URY broadcasting and presentation suite.

+

This system, which goes under the working title SLUT + (Streaming Library of URY Tracks), is intended as a + replacement for the current (as of March 2011) system + in use at University Radio York, BAPS.

+

Contents

+

The system comprises:

+ +

+ +

+

diff --git a/doc/overview-tree.html b/doc/overview-tree.html index adf3094..c72579a 100644 --- a/doc/overview-tree.html +++ b/doc/overview-tree.html @@ -2,12 +2,12 @@ - + Class Hierarchy - + @@ -97,6 +97,10 @@ Class Hierarchy
  • javax.swing.AbstractListModel (implements javax.swing.ListModel, java.io.Serializable) +
  • uk.org.ury.server.AbstractRequestHandler (implements org.apache.http.protocol.HttpRequestHandler) +
  • javax.swing.table.AbstractTableModel (implements java.io.Serializable, javax.swing.table.TableModel) @@ -147,13 +151,15 @@ Class Hierarchy
  • uk.org.ury.config.ConfigReader
  • uk.org.ury.config.Database
  • uk.org.ury.database.DatabaseDriver
  • uk.org.ury.database.DatabaseItem<E,T> -
  • uk.org.ury.frontend.FrontendError
  • uk.org.ury.library.LibraryRequestHandler (implements uk.org.ury.server.RequestHandler) -
  • uk.org.ury.library.LibraryUtils
  • uk.org.ury.protocol.ProtocolUtils
  • uk.org.ury.server.Server
  • uk.org.ury.server.ServerProtocol
  • uk.org.ury.server.ServerRequestHandler (implements uk.org.ury.server.RequestHandler) -
  • uk.org.ury.show.ShowUtils
  • java.lang.Throwable (implements java.io.Serializable) +
  • uk.org.ury.frontend.FrontendError
  • uk.org.ury.library.LibraryUtils
  • uk.org.ury.protocol.ProtocolUtils
  • uk.org.ury.server.Server
  • uk.org.ury.server.ServerRequestHandler (implements uk.org.ury.server.ApiRequestHandler) +
  • uk.org.ury.show.ShowUtils
  • java.lang.Thread (implements java.lang.Runnable) + +
  • java.lang.Throwable (implements java.io.Serializable) @@ -162,7 +168,7 @@ Class Hierarchy Interface Hierarchy +
  • uk.org.ury.server.ApiRequestHandler
  • uk.org.ury.frontend.FrontendMaster
  • uk.org.ury.frontend.FrontendModule
  • uk.org.ury.testrig.Launcher

    Enum Hierarchy

    diff --git a/doc/serialized-form.html b/doc/serialized-form.html index 119b4c6..a9a17a3 100644 --- a/doc/serialized-form.html +++ b/doc/serialized-form.html @@ -2,12 +2,12 @@ - + Serialized Form - + @@ -760,6 +760,20 @@ java.util.ResourceBundle rb

    serialVersionUID: -7268289187311868036L +

    + +

    + + + + + +
    +Class uk.org.ury.server.exceptions.UnknownFunctionException extends HandlingException implements Serializable
    + +

    +serialVersionUID: -7557785978712465975L +

    diff --git a/doc/uk/org/ury/client/Client.html b/doc/uk/org/ury/client/Client.html index bcebbd1..844d3e3 100644 --- a/doc/uk/org/ury/client/Client.html +++ b/doc/uk/org/ury/client/Client.html @@ -2,12 +2,12 @@ - + Client - + @@ -186,8 +186,8 @@ public java.util.Map<?,?> get(java.lang.String file)
    Get a raw response from the server.

    -
    Parameters:
    file - The "file", including path and query string, to - fetch from the server. +
    Parameters:
    file - The "file", including path and query string, to fetch from the + server.
    Returns:
    The response from the server, as a key-value map.
    Throws:
    DecodeFailureException - if the decode failed.
    diff --git a/doc/uk/org/ury/client/class-use/Client.html b/doc/uk/org/ury/client/class-use/Client.html index 8c4a5ad..033f5a9 100644 --- a/doc/uk/org/ury/client/class-use/Client.html +++ b/doc/uk/org/ury/client/class-use/Client.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.client.Client - + diff --git a/doc/uk/org/ury/client/package-frame.html b/doc/uk/org/ury/client/package-frame.html index 9705c67..91454ed 100644 --- a/doc/uk/org/ury/client/package-frame.html +++ b/doc/uk/org/ury/client/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.client - + diff --git a/doc/uk/org/ury/client/package-summary.html b/doc/uk/org/ury/client/package-summary.html index e4e7b74..318e521 100644 --- a/doc/uk/org/ury/client/package-summary.html +++ b/doc/uk/org/ury/client/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.client - + diff --git a/doc/uk/org/ury/client/package-tree.html b/doc/uk/org/ury/client/package-tree.html index 0254747..f89e4a3 100644 --- a/doc/uk/org/ury/client/package-tree.html +++ b/doc/uk/org/ury/client/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.client Class Hierarchy - + diff --git a/doc/uk/org/ury/client/package-use.html b/doc/uk/org/ury/client/package-use.html index c30a691..e8414f2 100644 --- a/doc/uk/org/ury/client/package-use.html +++ b/doc/uk/org/ury/client/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.client - + diff --git a/doc/uk/org/ury/client/test/ClientTest.html b/doc/uk/org/ury/client/test/ClientTest.html index b0c3c74..548808d 100644 --- a/doc/uk/org/ury/client/test/ClientTest.html +++ b/doc/uk/org/ury/client/test/ClientTest.html @@ -2,12 +2,12 @@ - + ClientTest - + @@ -159,7 +159,7 @@ JUnit test for the low-level client logic. testGet()
    -          Test method for Client.get(java.lang.String). +          Test method for Client.get(java.lang.String).   @@ -234,7 +234,7 @@ testGet 
     public void testGet()
    -
    Test method for Client.get(java.lang.String). +
    Test method for Client.get(java.lang.String).

    diff --git a/doc/uk/org/ury/client/test/class-use/ClientTest.html b/doc/uk/org/ury/client/test/class-use/ClientTest.html index 67b587f..7df5d8f 100644 --- a/doc/uk/org/ury/client/test/class-use/ClientTest.html +++ b/doc/uk/org/ury/client/test/class-use/ClientTest.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.client.test.ClientTest - + diff --git a/doc/uk/org/ury/client/test/package-frame.html b/doc/uk/org/ury/client/test/package-frame.html index 4e0ac01..f4f22d4 100644 --- a/doc/uk/org/ury/client/test/package-frame.html +++ b/doc/uk/org/ury/client/test/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.client.test - + diff --git a/doc/uk/org/ury/client/test/package-summary.html b/doc/uk/org/ury/client/test/package-summary.html index aae901a..7ee0d5a 100644 --- a/doc/uk/org/ury/client/test/package-summary.html +++ b/doc/uk/org/ury/client/test/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.client.test - + diff --git a/doc/uk/org/ury/client/test/package-tree.html b/doc/uk/org/ury/client/test/package-tree.html index 5125d90..d9fc90f 100644 --- a/doc/uk/org/ury/client/test/package-tree.html +++ b/doc/uk/org/ury/client/test/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.client.test Class Hierarchy - + diff --git a/doc/uk/org/ury/client/test/package-use.html b/doc/uk/org/ury/client/test/package-use.html index 299afcd..91828d6 100644 --- a/doc/uk/org/ury/client/test/package-use.html +++ b/doc/uk/org/ury/client/test/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.client.test - + diff --git a/doc/uk/org/ury/config/Auth.html b/doc/uk/org/ury/config/Auth.html index 733df47..8eb6162 100644 --- a/doc/uk/org/ury/config/Auth.html +++ b/doc/uk/org/ury/config/Auth.html @@ -2,12 +2,12 @@ - + Auth - + diff --git a/doc/uk/org/ury/config/ConfigReader.html b/doc/uk/org/ury/config/ConfigReader.html index 4f7e8b5..dc668f0 100644 --- a/doc/uk/org/ury/config/ConfigReader.html +++ b/doc/uk/org/ury/config/ConfigReader.html @@ -2,12 +2,12 @@ - + ConfigReader - + diff --git a/doc/uk/org/ury/config/Database.html b/doc/uk/org/ury/config/Database.html index c763c87..3ccf841 100644 --- a/doc/uk/org/ury/config/Database.html +++ b/doc/uk/org/ury/config/Database.html @@ -2,12 +2,12 @@ - + Database - + diff --git a/doc/uk/org/ury/config/class-use/Auth.html b/doc/uk/org/ury/config/class-use/Auth.html index f787985..64edfd6 100644 --- a/doc/uk/org/ury/config/class-use/Auth.html +++ b/doc/uk/org/ury/config/class-use/Auth.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.config.Auth - + diff --git a/doc/uk/org/ury/config/class-use/ConfigReader.html b/doc/uk/org/ury/config/class-use/ConfigReader.html index 65de08e..651942c 100644 --- a/doc/uk/org/ury/config/class-use/ConfigReader.html +++ b/doc/uk/org/ury/config/class-use/ConfigReader.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.config.ConfigReader - + @@ -91,7 +91,7 @@ Packages that use uk.org.ury.database -   +Database services for the URY Presenter Suite.    diff --git a/doc/uk/org/ury/config/class-use/Database.html b/doc/uk/org/ury/config/class-use/Database.html index bd90ceb..6a2f42a 100644 --- a/doc/uk/org/ury/config/class-use/Database.html +++ b/doc/uk/org/ury/config/class-use/Database.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.config.Database - + diff --git a/doc/uk/org/ury/config/package-frame.html b/doc/uk/org/ury/config/package-frame.html index 2f81a57..4749b09 100644 --- a/doc/uk/org/ury/config/package-frame.html +++ b/doc/uk/org/ury/config/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.config - + diff --git a/doc/uk/org/ury/config/package-summary.html b/doc/uk/org/ury/config/package-summary.html index d70da45..bd3b849 100644 --- a/doc/uk/org/ury/config/package-summary.html +++ b/doc/uk/org/ury/config/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.config - + diff --git a/doc/uk/org/ury/config/package-tree.html b/doc/uk/org/ury/config/package-tree.html index a0b9c8b..666c4d0 100644 --- a/doc/uk/org/ury/config/package-tree.html +++ b/doc/uk/org/ury/config/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.config Class Hierarchy - + diff --git a/doc/uk/org/ury/config/package-use.html b/doc/uk/org/ury/config/package-use.html index b97766d..b929446 100644 --- a/doc/uk/org/ury/config/package-use.html +++ b/doc/uk/org/ury/config/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.config - + @@ -95,7 +95,7 @@ Packages that use u uk.org.ury.database -   +Database services for the URY Presenter Suite.    diff --git a/doc/uk/org/ury/database/DatabaseDriver.html b/doc/uk/org/ury/database/DatabaseDriver.html index 7bd5c25..e308ac0 100644 --- a/doc/uk/org/ury/database/DatabaseDriver.html +++ b/doc/uk/org/ury/database/DatabaseDriver.html @@ -2,12 +2,12 @@ - + DatabaseDriver - + @@ -101,9 +101,8 @@ java.lang.Object

    -A database connection manager that connects to the URY databases - using suitably privileged accounts, and handles the processing - of SQL queries. +A database connection manager that connects to the URY databases using + suitably privileged accounts, and handles the processing of SQL queries.

    @@ -195,13 +194,10 @@ public DatabaseDriver(MissingCredentialsException - if the user class - login credentials could not be loaded. -

    ConnectionFailureException - if the database - backend failed to connect to the database - server.
    +
    java.lang.IllegalArgumentException - if the user class is not supported (this should not happen). +
    MissingCredentialsException - if the user class login credentials could not be loaded. +
    ConnectionFailureException - if the database backend failed to connect to the database + server. @@ -242,17 +238,16 @@ public java.sql.ResultSet executeQuery(java.lang.String sql,
    Perform a SQL statement with arguments. - This accepts an array of parameter objects, which must each - either be String or Integer objects. The objects will be used - sequentially to fill in '?' placeholders in the query text. + This accepts an array of parameter objects, which must each either be + String or Integer objects. The objects will be used sequentially to fill + in '?' placeholders in the query text.

    Parameters:
    sql - The SQL statement to execute.
    params - A list of parameter objects.
    fetchSize - The maximum number of query rows to return.
    Returns:
    the set of results from the query.
    Throws: -
    java.lang.IllegalArgumentException - if any of the - parameters is unsupported by the database as - a statement parameter. +
    java.lang.IllegalArgumentException - if any of the parameters is unsupported by the database as a + statement parameter.
    java.sql.SQLException - if a SQL error occurs.
    diff --git a/doc/uk/org/ury/database/DatabaseItem.html b/doc/uk/org/ury/database/DatabaseItem.html index 1f2da1b..434c9f9 100644 --- a/doc/uk/org/ury/database/DatabaseItem.html +++ b/doc/uk/org/ury/database/DatabaseItem.html @@ -2,12 +2,12 @@ - + DatabaseItem - + @@ -104,9 +104,8 @@ java.lang.Object

    -An abstract class presenting a template for objects serving as - a data structure for collections of properties retrieved from - a SQL database. +An abstract class presenting a template for objects serving as a data + structure for collections of properties retrieved from a SQL database.

    @@ -197,8 +196,7 @@ public DatabaseItem(java.util.Map<MissingPropertyException - if the property does - not exist. +

    MissingPropertyException - if the property does not exist.
    diff --git a/doc/uk/org/ury/database/UserClass.html b/doc/uk/org/ury/database/UserClass.html index d9231d8..4fcd92e 100644 --- a/doc/uk/org/ury/database/UserClass.html +++ b/doc/uk/org/ury/database/UserClass.html @@ -2,12 +2,12 @@ - + UserClass - + @@ -107,11 +107,11 @@ java.lang.Object

    The various user classes of the database driver. - These refer to various users in the database proper, and thus - grant various levels of permission to the program. + These refer to various users in the database proper, and thus grant various + levels of permission to the program. - Please use the least privileged user class that works. For most - cases, READ_ONLY should work perfectly. + Please use the least privileged user class that works. For most cases, + READ_ONLY should work perfectly.

    @@ -157,8 +157,8 @@ The various user classes of the database driver. configName
    -          The name of the tag in the configuration file that contains - the credentials for this user class. +          The name of the tag in the configuration file that contains the + credentials for this user class.   @@ -253,8 +253,8 @@ configName 

     public java.lang.String configName
    -
    The name of the tag in the configuration file that contains - the credentials for this user class. +
    The name of the tag in the configuration file that contains the + credentials for this user class.

    diff --git a/doc/uk/org/ury/database/class-use/DatabaseDriver.html b/doc/uk/org/ury/database/class-use/DatabaseDriver.html index ac09e36..96209b1 100644 --- a/doc/uk/org/ury/database/class-use/DatabaseDriver.html +++ b/doc/uk/org/ury/database/class-use/DatabaseDriver.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.database.DatabaseDriver - + @@ -95,7 +95,7 @@ Packages that use uk.org.ury.server -   +The URY Server kernel.  uk.org.ury.show @@ -150,7 +150,7 @@ Uses of getDatabaseConnection(UserClass userClass)
    -          Get a database connection using the given user class. +          Gets a database connection using the given user class.   @@ -177,8 +177,8 @@ Uses of diff --git a/doc/uk/org/ury/database/class-use/DatabaseItem.html b/doc/uk/org/ury/database/class-use/DatabaseItem.html index e0d5953..b326c06 100644 --- a/doc/uk/org/ury/database/class-use/DatabaseItem.html +++ b/doc/uk/org/ury/database/class-use/DatabaseItem.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.database.DatabaseItem - + @@ -95,7 +95,7 @@ Packages that use uk.org.ury.show.item -   +The show item class and related properties.    diff --git a/doc/uk/org/ury/database/class-use/UserClass.html b/doc/uk/org/ury/database/class-use/UserClass.html index 8859b2c..9737548 100644 --- a/doc/uk/org/ury/database/class-use/UserClass.html +++ b/doc/uk/org/ury/database/class-use/UserClass.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.database.UserClass - + @@ -91,11 +91,11 @@ Packages that use uk.org.ury.database -   +Database services for the URY Presenter Suite.  uk.org.ury.server -   +The URY Server kernel.    @@ -169,7 +169,7 @@ Uses of getDatabaseConnection(UserClass userClass)
    -          Get a database connection using the given user class. +          Gets a database connection using the given user class.   diff --git a/doc/uk/org/ury/database/exceptions/ConnectionFailureException.html b/doc/uk/org/ury/database/exceptions/ConnectionFailureException.html index 66133bf..1c903a2 100644 --- a/doc/uk/org/ury/database/exceptions/ConnectionFailureException.html +++ b/doc/uk/org/ury/database/exceptions/ConnectionFailureException.html @@ -2,12 +2,12 @@ - + ConnectionFailureException - + diff --git a/doc/uk/org/ury/database/exceptions/MissingCredentialsException.html b/doc/uk/org/ury/database/exceptions/MissingCredentialsException.html index 9c54154..a0be23f 100644 --- a/doc/uk/org/ury/database/exceptions/MissingCredentialsException.html +++ b/doc/uk/org/ury/database/exceptions/MissingCredentialsException.html @@ -2,12 +2,12 @@ - + MissingCredentialsException - + diff --git a/doc/uk/org/ury/database/exceptions/MissingPropertyException.html b/doc/uk/org/ury/database/exceptions/MissingPropertyException.html index b31fb44..90079f5 100644 --- a/doc/uk/org/ury/database/exceptions/MissingPropertyException.html +++ b/doc/uk/org/ury/database/exceptions/MissingPropertyException.html @@ -2,12 +2,12 @@ - + MissingPropertyException - + diff --git a/doc/uk/org/ury/database/exceptions/QueryFailureException.html b/doc/uk/org/ury/database/exceptions/QueryFailureException.html index ecb2a3b..f6c3ffc 100644 --- a/doc/uk/org/ury/database/exceptions/QueryFailureException.html +++ b/doc/uk/org/ury/database/exceptions/QueryFailureException.html @@ -2,12 +2,12 @@ - + QueryFailureException - + diff --git a/doc/uk/org/ury/database/exceptions/class-use/ConnectionFailureException.html b/doc/uk/org/ury/database/exceptions/class-use/ConnectionFailureException.html index ea4b6e8..538b71f 100644 --- a/doc/uk/org/ury/database/exceptions/class-use/ConnectionFailureException.html +++ b/doc/uk/org/ury/database/exceptions/class-use/ConnectionFailureException.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.database.exceptions.ConnectionFailureException - + @@ -91,11 +91,11 @@ Packages that use uk.org.ury.database -   +Database services for the URY Presenter Suite.  uk.org.ury.server -   +The URY Server kernel.    @@ -144,7 +144,7 @@ Uses of getDatabaseConnection(UserClass userClass)
    -          Get a database connection using the given user class. +          Gets a database connection using the given user class.   diff --git a/doc/uk/org/ury/database/exceptions/class-use/MissingCredentialsException.html b/doc/uk/org/ury/database/exceptions/class-use/MissingCredentialsException.html index c622c6e..9bf9fa0 100644 --- a/doc/uk/org/ury/database/exceptions/class-use/MissingCredentialsException.html +++ b/doc/uk/org/ury/database/exceptions/class-use/MissingCredentialsException.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.database.exceptions.MissingCredentialsException - + @@ -95,11 +95,11 @@ Packages that use uk.org.ury.database -   +Database services for the URY Presenter Suite.  uk.org.ury.server -   +The URY Server kernel.    @@ -171,7 +171,7 @@ Uses of getDatabaseConnection(UserClass userClass)
    -          Get a database connection using the given user class. +          Gets a database connection using the given user class.   diff --git a/doc/uk/org/ury/database/exceptions/class-use/MissingPropertyException.html b/doc/uk/org/ury/database/exceptions/class-use/MissingPropertyException.html index 98d49a6..01efe6a 100644 --- a/doc/uk/org/ury/database/exceptions/class-use/MissingPropertyException.html +++ b/doc/uk/org/ury/database/exceptions/class-use/MissingPropertyException.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.database.exceptions.MissingPropertyException - + @@ -91,7 +91,7 @@ Packages that use uk.org.ury.database -   +Database services for the URY Presenter Suite.    diff --git a/doc/uk/org/ury/database/exceptions/class-use/QueryFailureException.html b/doc/uk/org/ury/database/exceptions/class-use/QueryFailureException.html index 80e07cc..7a1cb2d 100644 --- a/doc/uk/org/ury/database/exceptions/class-use/QueryFailureException.html +++ b/doc/uk/org/ury/database/exceptions/class-use/QueryFailureException.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.database.exceptions.QueryFailureException - + @@ -152,8 +152,8 @@ Uses of diff --git a/doc/uk/org/ury/database/exceptions/package-frame.html b/doc/uk/org/ury/database/exceptions/package-frame.html index e04436e..ee2ee10 100644 --- a/doc/uk/org/ury/database/exceptions/package-frame.html +++ b/doc/uk/org/ury/database/exceptions/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.database.exceptions - + diff --git a/doc/uk/org/ury/database/exceptions/package-summary.html b/doc/uk/org/ury/database/exceptions/package-summary.html index cf790ff..2742df1 100644 --- a/doc/uk/org/ury/database/exceptions/package-summary.html +++ b/doc/uk/org/ury/database/exceptions/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.database.exceptions - + @@ -82,6 +82,12 @@ function windowTitle()

    Package uk.org.ury.database.exceptions

    +Exceptions thrown by the database services classes. +

    +See: +
    +              Description +

    @@ -112,6 +118,15 @@ Package uk.org.ury.database.exceptions
      +

    +

    +Package uk.org.ury.database.exceptions Description +

    + +

    +

    Exceptions thrown by the database services classes.

    +

    +

    diff --git a/doc/uk/org/ury/database/exceptions/package-tree.html b/doc/uk/org/ury/database/exceptions/package-tree.html index 6db51a7..4cb2755 100644 --- a/doc/uk/org/ury/database/exceptions/package-tree.html +++ b/doc/uk/org/ury/database/exceptions/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.database.exceptions Class Hierarchy - + diff --git a/doc/uk/org/ury/database/exceptions/package-use.html b/doc/uk/org/ury/database/exceptions/package-use.html index 881f707..857af19 100644 --- a/doc/uk/org/ury/database/exceptions/package-use.html +++ b/doc/uk/org/ury/database/exceptions/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.database.exceptions - + @@ -95,7 +95,7 @@ Packages that use uk.org.ury.database -   +Database services for the URY Presenter Suite.  uk.org.ury.library @@ -103,7 +103,7 @@ Packages that use uk.org.ury.server -   +The URY Server kernel.  uk.org.ury.show diff --git a/doc/uk/org/ury/database/package-frame.html b/doc/uk/org/ury/database/package-frame.html index 80be895..3f3d02c 100644 --- a/doc/uk/org/ury/database/package-frame.html +++ b/doc/uk/org/ury/database/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.database - + diff --git a/doc/uk/org/ury/database/package-summary.html b/doc/uk/org/ury/database/package-summary.html index 1f8e620..bbb8812 100644 --- a/doc/uk/org/ury/database/package-summary.html +++ b/doc/uk/org/ury/database/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.database - + @@ -82,6 +82,12 @@ function windowTitle()

    Package uk.org.ury.database

    +Database services for the URY Presenter Suite. +

    +See: +
    +          Description +

    @@ -90,15 +96,13 @@ Package uk.org.ury.database - + - +
    DatabaseDriverA database connection manager that connects to the URY databases - using suitably privileged accounts, and handles the processing - of SQL queries.A database connection manager that connects to the URY databases using + suitably privileged accounts, and handles the processing of SQL queries.
    DatabaseItem<E,T>An abstract class presenting a template for objects serving as - a data structure for collections of properties retrieved from - a SQL database.An abstract class presenting a template for objects serving as a data + structure for collections of properties retrieved from a SQL database.
      @@ -117,6 +121,19 @@ Package uk.org.ury.database   +

    +

    +Package uk.org.ury.database Description +

    + +

    +

    Database services for the URY Presenter Suite.

    +

    The classes provided within this package are expected to be + used by the back-end through utility classes, and not + by the frontend, which should use the server API to indirectly + query the database.

    +

    +

    diff --git a/doc/uk/org/ury/database/package-tree.html b/doc/uk/org/ury/database/package-tree.html index b2ff806..fa6cbdf 100644 --- a/doc/uk/org/ury/database/package-tree.html +++ b/doc/uk/org/ury/database/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.database Class Hierarchy - + diff --git a/doc/uk/org/ury/database/package-use.html b/doc/uk/org/ury/database/package-use.html index 9a72514..25e0a60 100644 --- a/doc/uk/org/ury/database/package-use.html +++ b/doc/uk/org/ury/database/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.database - + @@ -91,7 +91,7 @@ Packages that use uk.org.ury.database -   +Database services for the URY Presenter Suite.  uk.org.ury.library @@ -103,7 +103,7 @@ Packages that use uk.org.ury.server -   +The URY Server kernel.  uk.org.ury.show @@ -111,7 +111,7 @@ Packages that use uk.org.ury.show.item -   +The show item class and related properties.    @@ -141,9 +141,8 @@ Classes in uk.org DatabaseDriver
    -          A database connection manager that connects to the URY databases - using suitably privileged accounts, and handles the processing - of SQL queries. +          A database connection manager that connects to the URY databases using + suitably privileged accounts, and handles the processing of SQL queries.   @@ -158,9 +157,8 @@ Classes in uk.org DatabaseItem
    -          An abstract class presenting a template for objects serving as - a data structure for collections of properties retrieved from - a SQL database. +          An abstract class presenting a template for objects serving as a data + structure for collections of properties retrieved from a SQL database.   @@ -175,9 +173,8 @@ Classes in uk.org DatabaseDriver
    -          A database connection manager that connects to the URY databases - using suitably privileged accounts, and handles the processing - of SQL queries. +          A database connection manager that connects to the URY databases using + suitably privileged accounts, and handles the processing of SQL queries. UserClass @@ -198,9 +195,8 @@ Classes in uk.org DatabaseDriver
    -          A database connection manager that connects to the URY databases - using suitably privileged accounts, and handles the processing - of SQL queries. +          A database connection manager that connects to the URY databases using + suitably privileged accounts, and handles the processing of SQL queries.   @@ -215,9 +211,8 @@ Classes in uk.org DatabaseItem
    -          An abstract class presenting a template for objects serving as - a data structure for collections of properties retrieved from - a SQL database. +          An abstract class presenting a template for objects serving as a data + structure for collections of properties retrieved from a SQL database.   diff --git a/doc/uk/org/ury/frontend/AbstractFrontendModule.html b/doc/uk/org/ury/frontend/AbstractFrontendModule.html index ecac485..0eea2a6 100644 --- a/doc/uk/org/ury/frontend/AbstractFrontendModule.html +++ b/doc/uk/org/ury/frontend/AbstractFrontendModule.html @@ -2,12 +2,12 @@ - + AbstractFrontendModule - + diff --git a/doc/uk/org/ury/frontend/FrontendApplet.html b/doc/uk/org/ury/frontend/FrontendApplet.html index 3ed1e9a..757e506 100644 --- a/doc/uk/org/ury/frontend/FrontendApplet.html +++ b/doc/uk/org/ury/frontend/FrontendApplet.html @@ -2,12 +2,12 @@ - + FrontendApplet - + diff --git a/doc/uk/org/ury/frontend/FrontendBanner.html b/doc/uk/org/ury/frontend/FrontendBanner.html index 77cac68..4d015e1 100644 --- a/doc/uk/org/ury/frontend/FrontendBanner.html +++ b/doc/uk/org/ury/frontend/FrontendBanner.html @@ -2,12 +2,12 @@ - + FrontendBanner - + diff --git a/doc/uk/org/ury/frontend/FrontendControlPanel.html b/doc/uk/org/ury/frontend/FrontendControlPanel.html index 1b43dca..fd5d1c3 100644 --- a/doc/uk/org/ury/frontend/FrontendControlPanel.html +++ b/doc/uk/org/ury/frontend/FrontendControlPanel.html @@ -2,12 +2,12 @@ - + FrontendControlPanel - + diff --git a/doc/uk/org/ury/frontend/FrontendError.html b/doc/uk/org/ury/frontend/FrontendError.html index 1858ac8..741ddab 100644 --- a/doc/uk/org/ury/frontend/FrontendError.html +++ b/doc/uk/org/ury/frontend/FrontendError.html @@ -2,12 +2,12 @@ - + FrontendError - + diff --git a/doc/uk/org/ury/frontend/FrontendFrame.html b/doc/uk/org/ury/frontend/FrontendFrame.html index 57b1dae..8f2f727 100644 --- a/doc/uk/org/ury/frontend/FrontendFrame.html +++ b/doc/uk/org/ury/frontend/FrontendFrame.html @@ -2,12 +2,12 @@ - + FrontendFrame - + diff --git a/doc/uk/org/ury/frontend/FrontendMaster.html b/doc/uk/org/ury/frontend/FrontendMaster.html index 08e34a5..4045ace 100644 --- a/doc/uk/org/ury/frontend/FrontendMaster.html +++ b/doc/uk/org/ury/frontend/FrontendMaster.html @@ -2,12 +2,12 @@ - + FrontendMaster - + diff --git a/doc/uk/org/ury/frontend/FrontendModule.html b/doc/uk/org/ury/frontend/FrontendModule.html index 4f728da..f5acde2 100644 --- a/doc/uk/org/ury/frontend/FrontendModule.html +++ b/doc/uk/org/ury/frontend/FrontendModule.html @@ -2,12 +2,12 @@ - + FrontendModule - + diff --git a/doc/uk/org/ury/frontend/FrontendModulePanel.html b/doc/uk/org/ury/frontend/FrontendModulePanel.html index aa6603e..b6c91e4 100644 --- a/doc/uk/org/ury/frontend/FrontendModulePanel.html +++ b/doc/uk/org/ury/frontend/FrontendModulePanel.html @@ -2,12 +2,12 @@ - + FrontendModulePanel - + diff --git a/doc/uk/org/ury/frontend/FrontendPanel.html b/doc/uk/org/ury/frontend/FrontendPanel.html index 719bd6b..25a85ca 100644 --- a/doc/uk/org/ury/frontend/FrontendPanel.html +++ b/doc/uk/org/ury/frontend/FrontendPanel.html @@ -2,12 +2,12 @@ - + FrontendPanel - + diff --git a/doc/uk/org/ury/frontend/FrontendSubBanner.html b/doc/uk/org/ury/frontend/FrontendSubBanner.html index ea28af1..ed98791 100644 --- a/doc/uk/org/ury/frontend/FrontendSubBanner.html +++ b/doc/uk/org/ury/frontend/FrontendSubBanner.html @@ -2,12 +2,12 @@ - + FrontendSubBanner - + diff --git a/doc/uk/org/ury/frontend/HintField.html b/doc/uk/org/ury/frontend/HintField.html index 12e6e08..ffe7760 100644 --- a/doc/uk/org/ury/frontend/HintField.html +++ b/doc/uk/org/ury/frontend/HintField.html @@ -2,12 +2,12 @@ - + HintField - + diff --git a/doc/uk/org/ury/frontend/class-use/AbstractFrontendModule.html b/doc/uk/org/ury/frontend/class-use/AbstractFrontendModule.html index f36bd08..9606536 100644 --- a/doc/uk/org/ury/frontend/class-use/AbstractFrontendModule.html +++ b/doc/uk/org/ury/frontend/class-use/AbstractFrontendModule.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.frontend.AbstractFrontendModule - + diff --git a/doc/uk/org/ury/frontend/class-use/FrontendApplet.html b/doc/uk/org/ury/frontend/class-use/FrontendApplet.html index cfc7c7b..275c9ec 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendApplet.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendApplet.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.frontend.FrontendApplet - + diff --git a/doc/uk/org/ury/frontend/class-use/FrontendBanner.html b/doc/uk/org/ury/frontend/class-use/FrontendBanner.html index 230ca1b..01d308f 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendBanner.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendBanner.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.frontend.FrontendBanner - + diff --git a/doc/uk/org/ury/frontend/class-use/FrontendControlPanel.html b/doc/uk/org/ury/frontend/class-use/FrontendControlPanel.html index c7aa65c..b870f01 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendControlPanel.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendControlPanel.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.frontend.FrontendControlPanel - + diff --git a/doc/uk/org/ury/frontend/class-use/FrontendError.html b/doc/uk/org/ury/frontend/class-use/FrontendError.html index 40ed92f..3b23715 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendError.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendError.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.frontend.FrontendError - + diff --git a/doc/uk/org/ury/frontend/class-use/FrontendFrame.html b/doc/uk/org/ury/frontend/class-use/FrontendFrame.html index 0d9b825..f73cc31 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendFrame.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendFrame.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.frontend.FrontendFrame - + diff --git a/doc/uk/org/ury/frontend/class-use/FrontendMaster.html b/doc/uk/org/ury/frontend/class-use/FrontendMaster.html index 528d5cb..ca79312 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendMaster.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendMaster.html @@ -2,12 +2,12 @@ - + Uses of Interface uk.org.ury.frontend.FrontendMaster - + @@ -223,7 +223,7 @@ Uses of runFrontend(FrontendMaster master)
    -          Run the library viewer frontend. +          Runs the library viewer frontend.   diff --git a/doc/uk/org/ury/frontend/class-use/FrontendModule.html b/doc/uk/org/ury/frontend/class-use/FrontendModule.html index 88c88f0..edecafc 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendModule.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendModule.html @@ -2,12 +2,12 @@ - + Uses of Interface uk.org.ury.frontend.FrontendModule - + diff --git a/doc/uk/org/ury/frontend/class-use/FrontendModulePanel.html b/doc/uk/org/ury/frontend/class-use/FrontendModulePanel.html index 5e5edb7..05972a9 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendModulePanel.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendModulePanel.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.frontend.FrontendModulePanel - + @@ -216,7 +216,7 @@ Uses of LibraryViewer.runFrontend(FrontendMaster master)
    -          Run the library viewer frontend. +          Runs the library viewer frontend.   diff --git a/doc/uk/org/ury/frontend/class-use/FrontendPanel.html b/doc/uk/org/ury/frontend/class-use/FrontendPanel.html index f7f386a..3ae79e6 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendPanel.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendPanel.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.frontend.FrontendPanel - + diff --git a/doc/uk/org/ury/frontend/class-use/FrontendSubBanner.html b/doc/uk/org/ury/frontend/class-use/FrontendSubBanner.html index e5c50cb..8bcae14 100644 --- a/doc/uk/org/ury/frontend/class-use/FrontendSubBanner.html +++ b/doc/uk/org/ury/frontend/class-use/FrontendSubBanner.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.frontend.FrontendSubBanner - + diff --git a/doc/uk/org/ury/frontend/class-use/HintField.html b/doc/uk/org/ury/frontend/class-use/HintField.html index feb6a66..e830fd0 100644 --- a/doc/uk/org/ury/frontend/class-use/HintField.html +++ b/doc/uk/org/ury/frontend/class-use/HintField.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.frontend.HintField - + diff --git a/doc/uk/org/ury/frontend/exceptions/LoadFailureException.html b/doc/uk/org/ury/frontend/exceptions/LoadFailureException.html index 33acf70..c3cc03c 100644 --- a/doc/uk/org/ury/frontend/exceptions/LoadFailureException.html +++ b/doc/uk/org/ury/frontend/exceptions/LoadFailureException.html @@ -2,12 +2,12 @@ - + LoadFailureException - + diff --git a/doc/uk/org/ury/frontend/exceptions/UICreationFailureException.html b/doc/uk/org/ury/frontend/exceptions/UICreationFailureException.html index 753628e..b01b412 100644 --- a/doc/uk/org/ury/frontend/exceptions/UICreationFailureException.html +++ b/doc/uk/org/ury/frontend/exceptions/UICreationFailureException.html @@ -2,12 +2,12 @@ - + UICreationFailureException - + diff --git a/doc/uk/org/ury/frontend/exceptions/class-use/LoadFailureException.html b/doc/uk/org/ury/frontend/exceptions/class-use/LoadFailureException.html index 2434645..c80e812 100644 --- a/doc/uk/org/ury/frontend/exceptions/class-use/LoadFailureException.html +++ b/doc/uk/org/ury/frontend/exceptions/class-use/LoadFailureException.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.frontend.exceptions.LoadFailureException - + diff --git a/doc/uk/org/ury/frontend/exceptions/class-use/UICreationFailureException.html b/doc/uk/org/ury/frontend/exceptions/class-use/UICreationFailureException.html index ea8a2fa..ad9a179 100644 --- a/doc/uk/org/ury/frontend/exceptions/class-use/UICreationFailureException.html +++ b/doc/uk/org/ury/frontend/exceptions/class-use/UICreationFailureException.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.frontend.exceptions.UICreationFailureException - + diff --git a/doc/uk/org/ury/frontend/exceptions/package-frame.html b/doc/uk/org/ury/frontend/exceptions/package-frame.html index de032c1..36fa46e 100644 --- a/doc/uk/org/ury/frontend/exceptions/package-frame.html +++ b/doc/uk/org/ury/frontend/exceptions/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.frontend.exceptions - + diff --git a/doc/uk/org/ury/frontend/exceptions/package-summary.html b/doc/uk/org/ury/frontend/exceptions/package-summary.html index 2127de2..55af0ac 100644 --- a/doc/uk/org/ury/frontend/exceptions/package-summary.html +++ b/doc/uk/org/ury/frontend/exceptions/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.frontend.exceptions - + diff --git a/doc/uk/org/ury/frontend/exceptions/package-tree.html b/doc/uk/org/ury/frontend/exceptions/package-tree.html index d3764fa..7018784 100644 --- a/doc/uk/org/ury/frontend/exceptions/package-tree.html +++ b/doc/uk/org/ury/frontend/exceptions/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.frontend.exceptions Class Hierarchy - + diff --git a/doc/uk/org/ury/frontend/exceptions/package-use.html b/doc/uk/org/ury/frontend/exceptions/package-use.html index 93d545d..9680c18 100644 --- a/doc/uk/org/ury/frontend/exceptions/package-use.html +++ b/doc/uk/org/ury/frontend/exceptions/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.frontend.exceptions - + diff --git a/doc/uk/org/ury/frontend/package-frame.html b/doc/uk/org/ury/frontend/package-frame.html index e35b4b8..fe3138d 100644 --- a/doc/uk/org/ury/frontend/package-frame.html +++ b/doc/uk/org/ury/frontend/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.frontend - + diff --git a/doc/uk/org/ury/frontend/package-summary.html b/doc/uk/org/ury/frontend/package-summary.html index 119ce35..1428153 100644 --- a/doc/uk/org/ury/frontend/package-summary.html +++ b/doc/uk/org/ury/frontend/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.frontend - + diff --git a/doc/uk/org/ury/frontend/package-tree.html b/doc/uk/org/ury/frontend/package-tree.html index 6ead817..bf3fd81 100644 --- a/doc/uk/org/ury/frontend/package-tree.html +++ b/doc/uk/org/ury/frontend/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.frontend Class Hierarchy - + diff --git a/doc/uk/org/ury/frontend/package-use.html b/doc/uk/org/ury/frontend/package-use.html index 4868ed8..b2251ef 100644 --- a/doc/uk/org/ury/frontend/package-use.html +++ b/doc/uk/org/ury/frontend/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.frontend - + diff --git a/doc/uk/org/ury/library/LibraryRequestHandler.html b/doc/uk/org/ury/library/LibraryRequestHandler.html index cf88582..6779f19 100644 --- a/doc/uk/org/ury/library/LibraryRequestHandler.html +++ b/doc/uk/org/ury/library/LibraryRequestHandler.html @@ -2,12 +2,12 @@ - + LibraryRequestHandler - + @@ -93,14 +93,15 @@ uk.org.ury.library     Class LibraryRequestHandler 
     java.lang.Object
-  extended by uk.org.ury.library.LibraryRequestHandler
+  extended by uk.org.ury.server.AbstractRequestHandler
+      extended by uk.org.ury.library.LibraryRequestHandler
    -
    All Implemented Interfaces:
    RequestHandler
    +
    All Implemented Interfaces:
    org.apache.http.protocol.HttpRequestHandler
    -
    public class LibraryRequestHandler
    extends java.lang.Object
    implements RequestHandler
    +
    public class LibraryRequestHandler
    extends AbstractRequestHandler

    @@ -125,10 +126,11 @@ A request handler for library queries. Constructor Summary -LibraryRequestHandler() +LibraryRequestHandler(Server server, + java.lang.String mount)
    -            +          Construct a new LibraryRequestHandler.   @@ -142,13 +144,22 @@ A request handler for library queries. - java.util.Map<java.lang.String,java.lang.Object> -handleGetRequest(java.util.Map<java.lang.String,java.lang.String> parameters, - Server server) + void +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. + + +  + + + + + +
    Methods inherited from class uk.org.ury.server.AbstractRequestHandler
    handle
      @@ -173,11 +184,16 @@ A request handler for library queries. -

    +

    LibraryRequestHandler

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

    +
    Parameters:
    server - The instance of the URY server responsible for the request.
    mount - The directory to which this handler is to be mounted.
    @@ -190,31 +206,39 @@ public LibraryRequestHandler() -

    -handleGetRequest

    +

    +handleGet

    -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
    +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, + UnknownFunctionException
    -
    Handle a server GET request (that is, a request for data - output). +
    Handle a HTTP GET request.

    -
    Specified by:
    handleGetRequest in interface RequestHandler
    +
    -
    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. +
    Parameters:
    request - The HTTP request.
    response - The response that the handler will populate during the + handling of the request.
    context - The HTTP context.
    Throws: -
    HandleFailureException - if the handler cannot - handle the request.
    +
    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. +
    UnknownFunctionException - if the request is for a path that does not correspond to one + of this handler's functions.
    diff --git a/doc/uk/org/ury/library/LibraryUtils.html b/doc/uk/org/ury/library/LibraryUtils.html index 5d72605..1b35a2e 100644 --- a/doc/uk/org/ury/library/LibraryUtils.html +++ b/doc/uk/org/ury/library/LibraryUtils.html @@ -2,12 +2,12 @@ - + LibraryUtils - + diff --git a/doc/uk/org/ury/library/class-use/LibraryRequestHandler.html b/doc/uk/org/ury/library/class-use/LibraryRequestHandler.html index b7ad76f..eade63b 100644 --- a/doc/uk/org/ury/library/class-use/LibraryRequestHandler.html +++ b/doc/uk/org/ury/library/class-use/LibraryRequestHandler.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.library.LibraryRequestHandler - + diff --git a/doc/uk/org/ury/library/class-use/LibraryUtils.html b/doc/uk/org/ury/library/class-use/LibraryUtils.html index 7990e0e..aeb0c9f 100644 --- a/doc/uk/org/ury/library/class-use/LibraryUtils.html +++ b/doc/uk/org/ury/library/class-use/LibraryUtils.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.library.LibraryUtils - + diff --git a/doc/uk/org/ury/library/exceptions/EmptySearchException.html b/doc/uk/org/ury/library/exceptions/EmptySearchException.html index 6718556..44364b1 100644 --- a/doc/uk/org/ury/library/exceptions/EmptySearchException.html +++ b/doc/uk/org/ury/library/exceptions/EmptySearchException.html @@ -2,12 +2,12 @@ - + EmptySearchException - + diff --git a/doc/uk/org/ury/library/exceptions/class-use/EmptySearchException.html b/doc/uk/org/ury/library/exceptions/class-use/EmptySearchException.html index d10019e..300d6a3 100644 --- a/doc/uk/org/ury/library/exceptions/class-use/EmptySearchException.html +++ b/doc/uk/org/ury/library/exceptions/class-use/EmptySearchException.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.library.exceptions.EmptySearchException - + @@ -146,7 +146,7 @@ Uses of doSearch(java.lang.String search)
    -          Do a library search. +          Does a library search.   diff --git a/doc/uk/org/ury/library/exceptions/package-frame.html b/doc/uk/org/ury/library/exceptions/package-frame.html index 4d9997b..d8ca128 100644 --- a/doc/uk/org/ury/library/exceptions/package-frame.html +++ b/doc/uk/org/ury/library/exceptions/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.library.exceptions - + diff --git a/doc/uk/org/ury/library/exceptions/package-summary.html b/doc/uk/org/ury/library/exceptions/package-summary.html index 29f7dcc..4f89569 100644 --- a/doc/uk/org/ury/library/exceptions/package-summary.html +++ b/doc/uk/org/ury/library/exceptions/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.library.exceptions - + diff --git a/doc/uk/org/ury/library/exceptions/package-tree.html b/doc/uk/org/ury/library/exceptions/package-tree.html index d6803f6..4399d2b 100644 --- a/doc/uk/org/ury/library/exceptions/package-tree.html +++ b/doc/uk/org/ury/library/exceptions/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.library.exceptions Class Hierarchy - + diff --git a/doc/uk/org/ury/library/exceptions/package-use.html b/doc/uk/org/ury/library/exceptions/package-use.html index eef9aa1..1f41838 100644 --- a/doc/uk/org/ury/library/exceptions/package-use.html +++ b/doc/uk/org/ury/library/exceptions/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.library.exceptions - + diff --git a/doc/uk/org/ury/library/item/LibraryItem.html b/doc/uk/org/ury/library/item/LibraryItem.html index f112b8c..f6d9b0c 100644 --- a/doc/uk/org/ury/library/item/LibraryItem.html +++ b/doc/uk/org/ury/library/item/LibraryItem.html @@ -2,12 +2,12 @@ - + LibraryItem - + diff --git a/doc/uk/org/ury/library/item/LibraryItemProperty.html b/doc/uk/org/ury/library/item/LibraryItemProperty.html index 2356980..6b81af2 100644 --- a/doc/uk/org/ury/library/item/LibraryItemProperty.html +++ b/doc/uk/org/ury/library/item/LibraryItemProperty.html @@ -2,12 +2,12 @@ - + LibraryItemProperty - + diff --git a/doc/uk/org/ury/library/item/class-use/LibraryItem.html b/doc/uk/org/ury/library/item/class-use/LibraryItem.html index 8fbcc26..da696d2 100644 --- a/doc/uk/org/ury/library/item/class-use/LibraryItem.html +++ b/doc/uk/org/ury/library/item/class-use/LibraryItem.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.library.item.LibraryItem - + diff --git a/doc/uk/org/ury/library/item/class-use/LibraryItemProperty.html b/doc/uk/org/ury/library/item/class-use/LibraryItemProperty.html index 2d5c3a6..39d4d88 100644 --- a/doc/uk/org/ury/library/item/class-use/LibraryItemProperty.html +++ b/doc/uk/org/ury/library/item/class-use/LibraryItemProperty.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.library.item.LibraryItemProperty - + diff --git a/doc/uk/org/ury/library/item/package-frame.html b/doc/uk/org/ury/library/item/package-frame.html index d4f571c..774e04c 100644 --- a/doc/uk/org/ury/library/item/package-frame.html +++ b/doc/uk/org/ury/library/item/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.library.item - + diff --git a/doc/uk/org/ury/library/item/package-summary.html b/doc/uk/org/ury/library/item/package-summary.html index 6e2f33c..0dd3752 100644 --- a/doc/uk/org/ury/library/item/package-summary.html +++ b/doc/uk/org/ury/library/item/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.library.item - + diff --git a/doc/uk/org/ury/library/item/package-tree.html b/doc/uk/org/ury/library/item/package-tree.html index 25a19e3..3462b07 100644 --- a/doc/uk/org/ury/library/item/package-tree.html +++ b/doc/uk/org/ury/library/item/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.library.item Class Hierarchy - + diff --git a/doc/uk/org/ury/library/item/package-use.html b/doc/uk/org/ury/library/item/package-use.html index 98be535..f270bf3 100644 --- a/doc/uk/org/ury/library/item/package-use.html +++ b/doc/uk/org/ury/library/item/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.library.item - + diff --git a/doc/uk/org/ury/library/package-frame.html b/doc/uk/org/ury/library/package-frame.html index 1bc8298..890a6e0 100644 --- a/doc/uk/org/ury/library/package-frame.html +++ b/doc/uk/org/ury/library/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.library - + diff --git a/doc/uk/org/ury/library/package-summary.html b/doc/uk/org/ury/library/package-summary.html index 6ca2cbd..97cfa80 100644 --- a/doc/uk/org/ury/library/package-summary.html +++ b/doc/uk/org/ury/library/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.library - + diff --git a/doc/uk/org/ury/library/package-tree.html b/doc/uk/org/ury/library/package-tree.html index 52546f1..1aef993 100644 --- a/doc/uk/org/ury/library/package-tree.html +++ b/doc/uk/org/ury/library/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.library Class Hierarchy - + @@ -92,7 +92,9 @@ Class Hierarchy
    diff --git a/doc/uk/org/ury/library/package-use.html b/doc/uk/org/ury/library/package-use.html index 57b1b08..c924530 100644 --- a/doc/uk/org/ury/library/package-use.html +++ b/doc/uk/org/ury/library/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.library - + diff --git a/doc/uk/org/ury/library/viewer/LibraryTableModel.html b/doc/uk/org/ury/library/viewer/LibraryTableModel.html index ca0bc2b..d6782c4 100644 --- a/doc/uk/org/ury/library/viewer/LibraryTableModel.html +++ b/doc/uk/org/ury/library/viewer/LibraryTableModel.html @@ -2,12 +2,12 @@ - + LibraryTableModel - + diff --git a/doc/uk/org/ury/library/viewer/LibraryViewer.html b/doc/uk/org/ury/library/viewer/LibraryViewer.html index e1f328e..a3a532b 100644 --- a/doc/uk/org/ury/library/viewer/LibraryViewer.html +++ b/doc/uk/org/ury/library/viewer/LibraryViewer.html @@ -2,12 +2,12 @@ - + LibraryViewer - + @@ -106,6 +106,14 @@ java.lang.Object

    Module for investigating the track library. + + The LibraryViewer and its corresponding user + interface, LibraryViewerPanel, provide a + user interface for querying the server's library services + for track information. + + Subclasses of this module provide editing features for + the track library.

    @@ -129,7 +137,7 @@ Module for investigating the track library. LibraryViewer()
    -          Construct a new LibraryViewer as a frontend object. +          Constructs a new LibraryViewer as a frontend object.   @@ -147,7 +155,7 @@ Module for investigating the track library. doSearch(java.lang.String search)
    -          Do a library search. +          Does a library search. @@ -163,7 +171,7 @@ Module for investigating the track library. runFrontend(FrontendMaster master)
    -          Run the library viewer frontend. +          Runs the library viewer frontend.   @@ -193,7 +201,7 @@ LibraryViewer 

     public LibraryViewer()
    -
    Construct a new LibraryViewer as a frontend object. +
    Constructs a new LibraryViewer as a frontend object.

    @@ -212,7 +220,7 @@ runFrontend 
     public FrontendModulePanel runFrontend(FrontendMaster master)
    -
    Run the library viewer frontend. +
    Runs the library viewer frontend.

    Parameters:
    master - The FrontendMaster driving the frontend. @@ -229,7 +237,7 @@ public void doSearch(java.lang.String search) throws EmptySearchException, InvalidMessageException
    -
    Do a library search. +
    Does a library search. This will update the library list to reflect the results of the search.

    diff --git a/doc/uk/org/ury/library/viewer/LibraryViewerPanel.html b/doc/uk/org/ury/library/viewer/LibraryViewerPanel.html index da89669..7cc7e7c 100644 --- a/doc/uk/org/ury/library/viewer/LibraryViewerPanel.html +++ b/doc/uk/org/ury/library/viewer/LibraryViewerPanel.html @@ -2,12 +2,12 @@ - + LibraryViewerPanel - + diff --git a/doc/uk/org/ury/library/viewer/class-use/LibraryTableModel.html b/doc/uk/org/ury/library/viewer/class-use/LibraryTableModel.html index 51f7375..9c6faf9 100644 --- a/doc/uk/org/ury/library/viewer/class-use/LibraryTableModel.html +++ b/doc/uk/org/ury/library/viewer/class-use/LibraryTableModel.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.library.viewer.LibraryTableModel - + diff --git a/doc/uk/org/ury/library/viewer/class-use/LibraryViewer.html b/doc/uk/org/ury/library/viewer/class-use/LibraryViewer.html index 1888cf8..2697f24 100644 --- a/doc/uk/org/ury/library/viewer/class-use/LibraryViewer.html +++ b/doc/uk/org/ury/library/viewer/class-use/LibraryViewer.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.library.viewer.LibraryViewer - + diff --git a/doc/uk/org/ury/library/viewer/class-use/LibraryViewerPanel.html b/doc/uk/org/ury/library/viewer/class-use/LibraryViewerPanel.html index 3097d7f..95ccb6a 100644 --- a/doc/uk/org/ury/library/viewer/class-use/LibraryViewerPanel.html +++ b/doc/uk/org/ury/library/viewer/class-use/LibraryViewerPanel.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.library.viewer.LibraryViewerPanel - + diff --git a/doc/uk/org/ury/library/viewer/package-frame.html b/doc/uk/org/ury/library/viewer/package-frame.html index 546a460..5ef64da 100644 --- a/doc/uk/org/ury/library/viewer/package-frame.html +++ b/doc/uk/org/ury/library/viewer/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.library.viewer - + diff --git a/doc/uk/org/ury/library/viewer/package-summary.html b/doc/uk/org/ury/library/viewer/package-summary.html index 28b86ee..ab6428e 100644 --- a/doc/uk/org/ury/library/viewer/package-summary.html +++ b/doc/uk/org/ury/library/viewer/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.library.viewer - + diff --git a/doc/uk/org/ury/library/viewer/package-tree.html b/doc/uk/org/ury/library/viewer/package-tree.html index 43aaab4..a50282f 100644 --- a/doc/uk/org/ury/library/viewer/package-tree.html +++ b/doc/uk/org/ury/library/viewer/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.library.viewer Class Hierarchy - + diff --git a/doc/uk/org/ury/library/viewer/package-use.html b/doc/uk/org/ury/library/viewer/package-use.html index 8023f8c..35b65aa 100644 --- a/doc/uk/org/ury/library/viewer/package-use.html +++ b/doc/uk/org/ury/library/viewer/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.library.viewer - + diff --git a/doc/uk/org/ury/protocol/Directive.html b/doc/uk/org/ury/protocol/Directive.html index 4b55fd9..efa34c5 100644 --- a/doc/uk/org/ury/protocol/Directive.html +++ b/doc/uk/org/ury/protocol/Directive.html @@ -2,12 +2,12 @@ - + Directive - + diff --git a/doc/uk/org/ury/protocol/ProtocolUtils.html b/doc/uk/org/ury/protocol/ProtocolUtils.html index 5ccdde4..b84f0ed 100644 --- a/doc/uk/org/ury/protocol/ProtocolUtils.html +++ b/doc/uk/org/ury/protocol/ProtocolUtils.html @@ -2,12 +2,12 @@ - + ProtocolUtils - + diff --git a/doc/uk/org/ury/protocol/Status.html b/doc/uk/org/ury/protocol/Status.html index fb4e4b1..be04f68 100644 --- a/doc/uk/org/ury/protocol/Status.html +++ b/doc/uk/org/ury/protocol/Status.html @@ -2,12 +2,12 @@ - + Status - + diff --git a/doc/uk/org/ury/protocol/class-use/Directive.html b/doc/uk/org/ury/protocol/class-use/Directive.html index 556645c..02dfc4b 100644 --- a/doc/uk/org/ury/protocol/class-use/Directive.html +++ b/doc/uk/org/ury/protocol/class-use/Directive.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.protocol.Directive - + diff --git a/doc/uk/org/ury/protocol/class-use/ProtocolUtils.html b/doc/uk/org/ury/protocol/class-use/ProtocolUtils.html index 5426d5e..8ca5c88 100644 --- a/doc/uk/org/ury/protocol/class-use/ProtocolUtils.html +++ b/doc/uk/org/ury/protocol/class-use/ProtocolUtils.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.protocol.ProtocolUtils - + diff --git a/doc/uk/org/ury/protocol/class-use/Status.html b/doc/uk/org/ury/protocol/class-use/Status.html index 9775f61..79aa2ae 100644 --- a/doc/uk/org/ury/protocol/class-use/Status.html +++ b/doc/uk/org/ury/protocol/class-use/Status.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.protocol.Status - + diff --git a/doc/uk/org/ury/protocol/exceptions/DecodeFailureException.html b/doc/uk/org/ury/protocol/exceptions/DecodeFailureException.html index 60358ee..a765978 100644 --- a/doc/uk/org/ury/protocol/exceptions/DecodeFailureException.html +++ b/doc/uk/org/ury/protocol/exceptions/DecodeFailureException.html @@ -2,12 +2,12 @@ - + DecodeFailureException - + diff --git a/doc/uk/org/ury/protocol/exceptions/InvalidMessageException.html b/doc/uk/org/ury/protocol/exceptions/InvalidMessageException.html index 9d4eea3..20ae235 100644 --- a/doc/uk/org/ury/protocol/exceptions/InvalidMessageException.html +++ b/doc/uk/org/ury/protocol/exceptions/InvalidMessageException.html @@ -2,12 +2,12 @@ - + InvalidMessageException - + diff --git a/doc/uk/org/ury/protocol/exceptions/class-use/DecodeFailureException.html b/doc/uk/org/ury/protocol/exceptions/class-use/DecodeFailureException.html index 5560a27..e6eac50 100644 --- a/doc/uk/org/ury/protocol/exceptions/class-use/DecodeFailureException.html +++ b/doc/uk/org/ury/protocol/exceptions/class-use/DecodeFailureException.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.protocol.exceptions.DecodeFailureException - + diff --git a/doc/uk/org/ury/protocol/exceptions/class-use/InvalidMessageException.html b/doc/uk/org/ury/protocol/exceptions/class-use/InvalidMessageException.html index fd74688..7b40eaa 100644 --- a/doc/uk/org/ury/protocol/exceptions/class-use/InvalidMessageException.html +++ b/doc/uk/org/ury/protocol/exceptions/class-use/InvalidMessageException.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.protocol.exceptions.InvalidMessageException - + @@ -120,7 +120,7 @@ Uses of doSearch(java.lang.String search)
    -          Do a library search. +          Does a library search.   diff --git a/doc/uk/org/ury/protocol/exceptions/package-frame.html b/doc/uk/org/ury/protocol/exceptions/package-frame.html index db1d0de..2a96000 100644 --- a/doc/uk/org/ury/protocol/exceptions/package-frame.html +++ b/doc/uk/org/ury/protocol/exceptions/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.protocol.exceptions - + diff --git a/doc/uk/org/ury/protocol/exceptions/package-summary.html b/doc/uk/org/ury/protocol/exceptions/package-summary.html index 45e4348..4cf235b 100644 --- a/doc/uk/org/ury/protocol/exceptions/package-summary.html +++ b/doc/uk/org/ury/protocol/exceptions/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.protocol.exceptions - + diff --git a/doc/uk/org/ury/protocol/exceptions/package-tree.html b/doc/uk/org/ury/protocol/exceptions/package-tree.html index 8636471..adb4d54 100644 --- a/doc/uk/org/ury/protocol/exceptions/package-tree.html +++ b/doc/uk/org/ury/protocol/exceptions/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.protocol.exceptions Class Hierarchy - + diff --git a/doc/uk/org/ury/protocol/exceptions/package-use.html b/doc/uk/org/ury/protocol/exceptions/package-use.html index d6b9dea..d653e32 100644 --- a/doc/uk/org/ury/protocol/exceptions/package-use.html +++ b/doc/uk/org/ury/protocol/exceptions/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.protocol.exceptions - + diff --git a/doc/uk/org/ury/protocol/package-frame.html b/doc/uk/org/ury/protocol/package-frame.html index c1b7dea..3a7047d 100644 --- a/doc/uk/org/ury/protocol/package-frame.html +++ b/doc/uk/org/ury/protocol/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.protocol - + diff --git a/doc/uk/org/ury/protocol/package-summary.html b/doc/uk/org/ury/protocol/package-summary.html index b4dc33b..d1dd76b 100644 --- a/doc/uk/org/ury/protocol/package-summary.html +++ b/doc/uk/org/ury/protocol/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.protocol - + diff --git a/doc/uk/org/ury/protocol/package-tree.html b/doc/uk/org/ury/protocol/package-tree.html index 62ae66f..9845495 100644 --- a/doc/uk/org/ury/protocol/package-tree.html +++ b/doc/uk/org/ury/protocol/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.protocol Class Hierarchy - + diff --git a/doc/uk/org/ury/protocol/package-use.html b/doc/uk/org/ury/protocol/package-use.html index 16b3f92..07f9ffd 100644 --- a/doc/uk/org/ury/protocol/package-use.html +++ b/doc/uk/org/ury/protocol/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.protocol - + 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 diff --git a/doc/uk/org/ury/show/ShowChannel.html b/doc/uk/org/ury/show/ShowChannel.html index d04bb5f..11a3a54 100644 --- a/doc/uk/org/ury/show/ShowChannel.html +++ b/doc/uk/org/ury/show/ShowChannel.html @@ -2,12 +2,12 @@ - + ShowChannel - + @@ -129,7 +129,7 @@ A channel of ShowItems in a show. ShowChannel()
    -          Construct a new, empty channel. +          Constructs a new, empty channel.   @@ -148,7 +148,7 @@ A channel of ShowItems in a show. ShowItem item)
    -          Add a new item to the channel. +          Adds a new item to the channel. @@ -156,7 +156,7 @@ A channel of ShowItems in a show. add(ShowItem item)
    -          Add a new item to the end of the channel. +          Adds a new item to the end of the channel. @@ -164,7 +164,7 @@ A channel of ShowItems in a show. get(int index)
    -          Retrieve an item from the channel. +          Retrieves an item from the channel. @@ -219,7 +219,7 @@ ShowChannel 
     public ShowChannel()
    -
    Construct a new, empty channel. +
    Constructs a new, empty channel.

    @@ -239,14 +239,13 @@ add public void add(int index, ShowItem item)
    -
    Add a new item to the channel. +
    Adds a new item to the channel.

    Parameters:
    index - The position at which to add the item.
    item - The new item to add.
    Throws: -
    java.lang.IllegalArgumentException - if the item is - null, the index is negative or the index - is out of bounds.
    +
    java.lang.IllegalArgumentException - if the item is null, the index is negative or the index is + out of bounds.
    • @@ -256,7 +255,7 @@ add 
     public void add(ShowItem item)
    -
    Add a new item to the end of the channel. +
    Adds a new item to the end of the channel.

    Parameters:
    item - The new item to add.
    @@ -269,14 +268,13 @@ get 
     public ShowItem get(int index)
    -
    Retrieve an item from the channel. +
    Retrieves an item from the channel.

    Parameters:
    index - The index of the item to retrieve from the channel.
    Returns:
    the item at the given index in the list.
    Throws: -
    java.lang.IllegalArgumentException - if the index is negative - or overflowing.
    +
    java.lang.IllegalArgumentException - if the index is negative or overflowing.
    diff --git a/doc/uk/org/ury/show/ShowUtils.html b/doc/uk/org/ury/show/ShowUtils.html index c4bd122..8fa89c4 100644 --- a/doc/uk/org/ury/show/ShowUtils.html +++ b/doc/uk/org/ury/show/ShowUtils.html @@ -2,12 +2,12 @@ - + ShowUtils - + @@ -101,8 +101,8 @@ java.lang.Object

    -A set of common utility routines to facilitate the extraction of - show items from the show storage areas of the URY database. +A set of common utility routines to facilitate the extraction of show items + from the show storage areas of the URY database.

    @@ -163,8 +163,8 @@ A set of common utility routines to facilitate the extraction of int channel)
    -          Given a show and a channel, retrieve a list of all show items - bound to that channel for the show. +          Given a show and a channel, retrieve a list of all show items bound to + that channel for the show. @@ -247,15 +247,12 @@ public static java.util.List<java.lang.String> getPublicFolders(

    Parameters:
    db - The database to query. -
    Returns:
    a list of the public folder names. - The list may be empty. +
    Returns:
    a list of the public folder names. The list may be empty.
    Throws: -
    java.lang.IllegalArgumentException - if the database is - null, the show ID is negative or the - channel index falls out of bounds. -
    QueryFailureException - if the database backend - yielded an error while executing the search - query.
    +
    java.lang.IllegalArgumentException - if the database is null, the show ID is negative or the + channel index falls out of bounds. +
    QueryFailureException - if the database backend yielded an error while executing the + search query.
    @@ -268,20 +265,18 @@ public static java.util.List<QueryFailureException
    -
    Given a show and a channel, retrieve a list of all show items - bound to that channel for the show. +
    Given a show and a channel, retrieve a list of all show items bound to + that channel for the show.

    Parameters:
    db - The database to query.
    showID - The unique number that identifies the show.
    channel - The index of the channel to query. -
    Returns:
    a list of ShowItems extracted from the show and - channel. The list may be empty. +
    Returns:
    a list of ShowItems extracted from the show and channel. The list + may be empty.
    Throws: -
    java.lang.IllegalArgumentException - if the database is - null, the show ID is negative or the - channel index falls out of bounds. -
    QueryFailureException - if the database backend - yielded an error while executing the search - query.
    +
    java.lang.IllegalArgumentException - if the database is null, the show ID is negative or the + channel index falls out of bounds. +
    QueryFailureException - if the database backend yielded an error while executing the + search query.
    diff --git a/doc/uk/org/ury/show/class-use/ShowChannel.html b/doc/uk/org/ury/show/class-use/ShowChannel.html index bbf6194..acb1bb8 100644 --- a/doc/uk/org/ury/show/class-use/ShowChannel.html +++ b/doc/uk/org/ury/show/class-use/ShowChannel.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.show.ShowChannel - + diff --git a/doc/uk/org/ury/show/class-use/ShowUtils.html b/doc/uk/org/ury/show/class-use/ShowUtils.html index 8dc38f1..5c6b311 100644 --- a/doc/uk/org/ury/show/class-use/ShowUtils.html +++ b/doc/uk/org/ury/show/class-use/ShowUtils.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.show.ShowUtils - + diff --git a/doc/uk/org/ury/show/item/ShowItem.html b/doc/uk/org/ury/show/item/ShowItem.html index 5c48bf4..5cd18a6 100644 --- a/doc/uk/org/ury/show/item/ShowItem.html +++ b/doc/uk/org/ury/show/item/ShowItem.html @@ -2,12 +2,12 @@ - + ShowItem - + diff --git a/doc/uk/org/ury/show/item/ShowItemProperty.html b/doc/uk/org/ury/show/item/ShowItemProperty.html index 35cb996..19c7edc 100644 --- a/doc/uk/org/ury/show/item/ShowItemProperty.html +++ b/doc/uk/org/ury/show/item/ShowItemProperty.html @@ -2,12 +2,12 @@ - + ShowItemProperty - + diff --git a/doc/uk/org/ury/show/item/class-use/ShowItem.html b/doc/uk/org/ury/show/item/class-use/ShowItem.html index 35b6def..7bb934f 100644 --- a/doc/uk/org/ury/show/item/class-use/ShowItem.html +++ b/doc/uk/org/ury/show/item/class-use/ShowItem.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.show.item.ShowItem - + @@ -116,7 +116,7 @@ Uses of get    (int index)
    -          Retrieve an item from the channel. +          Retrieves an item from the channel.   @@ -134,8 +134,8 @@ Uses of ShowItem item)
    -          Add a new item to the channel. +          Adds a new item to the channel. @@ -160,7 +160,7 @@ Uses of add(ShowItem item)
    -          Add a new item to the end of the channel. +          Adds a new item to the end of the channel.   diff --git a/doc/uk/org/ury/show/item/class-use/ShowItemProperty.html b/doc/uk/org/ury/show/item/class-use/ShowItemProperty.html index 66a0d20..fcfec33 100644 --- a/doc/uk/org/ury/show/item/class-use/ShowItemProperty.html +++ b/doc/uk/org/ury/show/item/class-use/ShowItemProperty.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.show.item.ShowItemProperty - + @@ -91,7 +91,7 @@ Packages that use uk.org.ury.show.item -   +The show item class and related properties.    diff --git a/doc/uk/org/ury/show/item/package-frame.html b/doc/uk/org/ury/show/item/package-frame.html index 9fe2752..bc4c85c 100644 --- a/doc/uk/org/ury/show/item/package-frame.html +++ b/doc/uk/org/ury/show/item/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.show.item - + diff --git a/doc/uk/org/ury/show/item/package-summary.html b/doc/uk/org/ury/show/item/package-summary.html index 3207cb5..fbfbd47 100644 --- a/doc/uk/org/ury/show/item/package-summary.html +++ b/doc/uk/org/ury/show/item/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.show.item - + @@ -82,6 +82,12 @@ function windowTitle()

    Package uk.org.ury.show.item

    +The show item class and related properties. +

    +See: +
    +          Description +

    @@ -109,6 +115,18 @@ Package uk.org.ury.show.item
      +

    +

    +Package uk.org.ury.show.item Description +

    + +

    +

    The show item class and related properties.

    +

    The two contained classes, ShowItem and ShowItemProperty, + implement the storage of items (songs, audio tracks, etc) that + can be placed in show channels.

    +

    +

    diff --git a/doc/uk/org/ury/show/item/package-tree.html b/doc/uk/org/ury/show/item/package-tree.html index 16d5326..4d18cd4 100644 --- a/doc/uk/org/ury/show/item/package-tree.html +++ b/doc/uk/org/ury/show/item/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.show.item Class Hierarchy - + diff --git a/doc/uk/org/ury/show/item/package-use.html b/doc/uk/org/ury/show/item/package-use.html index adf545c..561cdeb 100644 --- a/doc/uk/org/ury/show/item/package-use.html +++ b/doc/uk/org/ury/show/item/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.show.item - + @@ -95,7 +95,7 @@ Packages that use uk.org.ury.show.item -   +The show item class and related properties.    diff --git a/doc/uk/org/ury/show/package-frame.html b/doc/uk/org/ury/show/package-frame.html index 716012e..a52e43e 100644 --- a/doc/uk/org/ury/show/package-frame.html +++ b/doc/uk/org/ury/show/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.show - + diff --git a/doc/uk/org/ury/show/package-summary.html b/doc/uk/org/ury/show/package-summary.html index 239f944..2eabe9f 100644 --- a/doc/uk/org/ury/show/package-summary.html +++ b/doc/uk/org/ury/show/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.show - + @@ -94,8 +94,8 @@ Package uk.org.ury.show ShowUtils -A set of common utility routines to facilitate the extraction of - show items from the show storage areas of the URY database. +A set of common utility routines to facilitate the extraction of show items + from the show storage areas of the URY database.   diff --git a/doc/uk/org/ury/show/package-tree.html b/doc/uk/org/ury/show/package-tree.html index 7b1eafb..46c63be 100644 --- a/doc/uk/org/ury/show/package-tree.html +++ b/doc/uk/org/ury/show/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.show Class Hierarchy - + diff --git a/doc/uk/org/ury/show/package-use.html b/doc/uk/org/ury/show/package-use.html index e6d9e71..ca0e2b3 100644 --- a/doc/uk/org/ury/show/package-use.html +++ b/doc/uk/org/ury/show/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.show - + diff --git a/doc/uk/org/ury/show/viewer/ChannelPanel.html b/doc/uk/org/ury/show/viewer/ChannelPanel.html index 47a2da3..882a749 100644 --- a/doc/uk/org/ury/show/viewer/ChannelPanel.html +++ b/doc/uk/org/ury/show/viewer/ChannelPanel.html @@ -2,12 +2,12 @@ - + ChannelPanel - + diff --git a/doc/uk/org/ury/show/viewer/LibraryControlPanel.html b/doc/uk/org/ury/show/viewer/LibraryControlPanel.html index 2bcd13e..3210c50 100644 --- a/doc/uk/org/ury/show/viewer/LibraryControlPanel.html +++ b/doc/uk/org/ury/show/viewer/LibraryControlPanel.html @@ -2,12 +2,12 @@ - + LibraryControlPanel - + diff --git a/doc/uk/org/ury/show/viewer/ShowViewer.html b/doc/uk/org/ury/show/viewer/ShowViewer.html index 23c2d4b..efa337c 100644 --- a/doc/uk/org/ury/show/viewer/ShowViewer.html +++ b/doc/uk/org/ury/show/viewer/ShowViewer.html @@ -2,12 +2,12 @@ - + ShowViewer - + diff --git a/doc/uk/org/ury/show/viewer/ShowViewerPanel.html b/doc/uk/org/ury/show/viewer/ShowViewerPanel.html index d94a1b2..7876140 100644 --- a/doc/uk/org/ury/show/viewer/ShowViewerPanel.html +++ b/doc/uk/org/ury/show/viewer/ShowViewerPanel.html @@ -2,12 +2,12 @@ - + ShowViewerPanel - + diff --git a/doc/uk/org/ury/show/viewer/TrackBin.html b/doc/uk/org/ury/show/viewer/TrackBin.html index 9ff644d..90f6a3c 100644 --- a/doc/uk/org/ury/show/viewer/TrackBin.html +++ b/doc/uk/org/ury/show/viewer/TrackBin.html @@ -2,12 +2,12 @@ - + TrackBin - + diff --git a/doc/uk/org/ury/show/viewer/class-use/ChannelPanel.html b/doc/uk/org/ury/show/viewer/class-use/ChannelPanel.html index b787161..a10cbee 100644 --- a/doc/uk/org/ury/show/viewer/class-use/ChannelPanel.html +++ b/doc/uk/org/ury/show/viewer/class-use/ChannelPanel.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.show.viewer.ChannelPanel - + diff --git a/doc/uk/org/ury/show/viewer/class-use/LibraryControlPanel.html b/doc/uk/org/ury/show/viewer/class-use/LibraryControlPanel.html index 4336617..5031797 100644 --- a/doc/uk/org/ury/show/viewer/class-use/LibraryControlPanel.html +++ b/doc/uk/org/ury/show/viewer/class-use/LibraryControlPanel.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.show.viewer.LibraryControlPanel - + diff --git a/doc/uk/org/ury/show/viewer/class-use/ShowViewer.html b/doc/uk/org/ury/show/viewer/class-use/ShowViewer.html index 8c5bab3..6660dab 100644 --- a/doc/uk/org/ury/show/viewer/class-use/ShowViewer.html +++ b/doc/uk/org/ury/show/viewer/class-use/ShowViewer.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.show.viewer.ShowViewer - + diff --git a/doc/uk/org/ury/show/viewer/class-use/ShowViewerPanel.html b/doc/uk/org/ury/show/viewer/class-use/ShowViewerPanel.html index faed83f..b3099b8 100644 --- a/doc/uk/org/ury/show/viewer/class-use/ShowViewerPanel.html +++ b/doc/uk/org/ury/show/viewer/class-use/ShowViewerPanel.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.show.viewer.ShowViewerPanel - + diff --git a/doc/uk/org/ury/show/viewer/class-use/TrackBin.html b/doc/uk/org/ury/show/viewer/class-use/TrackBin.html index 679dd80..f000f14 100644 --- a/doc/uk/org/ury/show/viewer/class-use/TrackBin.html +++ b/doc/uk/org/ury/show/viewer/class-use/TrackBin.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.show.viewer.TrackBin - + diff --git a/doc/uk/org/ury/show/viewer/package-frame.html b/doc/uk/org/ury/show/viewer/package-frame.html index 456b466..36d0828 100644 --- a/doc/uk/org/ury/show/viewer/package-frame.html +++ b/doc/uk/org/ury/show/viewer/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.show.viewer - + diff --git a/doc/uk/org/ury/show/viewer/package-summary.html b/doc/uk/org/ury/show/viewer/package-summary.html index 692da14..4ecce41 100644 --- a/doc/uk/org/ury/show/viewer/package-summary.html +++ b/doc/uk/org/ury/show/viewer/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.show.viewer - + diff --git a/doc/uk/org/ury/show/viewer/package-tree.html b/doc/uk/org/ury/show/viewer/package-tree.html index 1194356..7bd6f26 100644 --- a/doc/uk/org/ury/show/viewer/package-tree.html +++ b/doc/uk/org/ury/show/viewer/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.show.viewer Class Hierarchy - + diff --git a/doc/uk/org/ury/show/viewer/package-use.html b/doc/uk/org/ury/show/viewer/package-use.html index 5d2a5c3..d7bdb69 100644 --- a/doc/uk/org/ury/show/viewer/package-use.html +++ b/doc/uk/org/ury/show/viewer/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.show.viewer - + diff --git a/doc/uk/org/ury/testrig/ApplicationLauncher.html b/doc/uk/org/ury/testrig/ApplicationLauncher.html index 53b3516..454406d 100644 --- a/doc/uk/org/ury/testrig/ApplicationLauncher.html +++ b/doc/uk/org/ury/testrig/ApplicationLauncher.html @@ -2,12 +2,12 @@ - + ApplicationLauncher - + diff --git a/doc/uk/org/ury/testrig/DemoControlPanel.html b/doc/uk/org/ury/testrig/DemoControlPanel.html index c6a2724..1f1833d 100644 --- a/doc/uk/org/ury/testrig/DemoControlPanel.html +++ b/doc/uk/org/ury/testrig/DemoControlPanel.html @@ -2,12 +2,12 @@ - + DemoControlPanel - + diff --git a/doc/uk/org/ury/testrig/DemoMenu.html b/doc/uk/org/ury/testrig/DemoMenu.html index 33b290c..695eed9 100644 --- a/doc/uk/org/ury/testrig/DemoMenu.html +++ b/doc/uk/org/ury/testrig/DemoMenu.html @@ -2,12 +2,12 @@ - + DemoMenu - + diff --git a/doc/uk/org/ury/testrig/DemoMenuPanel.html b/doc/uk/org/ury/testrig/DemoMenuPanel.html index a197bb5..8dbd141 100644 --- a/doc/uk/org/ury/testrig/DemoMenuPanel.html +++ b/doc/uk/org/ury/testrig/DemoMenuPanel.html @@ -2,12 +2,12 @@ - + DemoMenuPanel - + diff --git a/doc/uk/org/ury/testrig/Launcher.html b/doc/uk/org/ury/testrig/Launcher.html index c8a673f..f4f98f1 100644 --- a/doc/uk/org/ury/testrig/Launcher.html +++ b/doc/uk/org/ury/testrig/Launcher.html @@ -2,12 +2,12 @@ - + Launcher - + diff --git a/doc/uk/org/ury/testrig/class-use/ApplicationLauncher.html b/doc/uk/org/ury/testrig/class-use/ApplicationLauncher.html index 78d1ab2..caaca4d 100644 --- a/doc/uk/org/ury/testrig/class-use/ApplicationLauncher.html +++ b/doc/uk/org/ury/testrig/class-use/ApplicationLauncher.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.testrig.ApplicationLauncher - + diff --git a/doc/uk/org/ury/testrig/class-use/DemoControlPanel.html b/doc/uk/org/ury/testrig/class-use/DemoControlPanel.html index 11a75bc..7746d60 100644 --- a/doc/uk/org/ury/testrig/class-use/DemoControlPanel.html +++ b/doc/uk/org/ury/testrig/class-use/DemoControlPanel.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.testrig.DemoControlPanel - + diff --git a/doc/uk/org/ury/testrig/class-use/DemoMenu.html b/doc/uk/org/ury/testrig/class-use/DemoMenu.html index ff1bc13..bab3168 100644 --- a/doc/uk/org/ury/testrig/class-use/DemoMenu.html +++ b/doc/uk/org/ury/testrig/class-use/DemoMenu.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.testrig.DemoMenu - + diff --git a/doc/uk/org/ury/testrig/class-use/DemoMenuPanel.html b/doc/uk/org/ury/testrig/class-use/DemoMenuPanel.html index dfff911..65760c9 100644 --- a/doc/uk/org/ury/testrig/class-use/DemoMenuPanel.html +++ b/doc/uk/org/ury/testrig/class-use/DemoMenuPanel.html @@ -2,12 +2,12 @@ - + Uses of Class uk.org.ury.testrig.DemoMenuPanel - + diff --git a/doc/uk/org/ury/testrig/class-use/Launcher.html b/doc/uk/org/ury/testrig/class-use/Launcher.html index 38b34c1..3885e20 100644 --- a/doc/uk/org/ury/testrig/class-use/Launcher.html +++ b/doc/uk/org/ury/testrig/class-use/Launcher.html @@ -2,12 +2,12 @@ - + Uses of Interface uk.org.ury.testrig.Launcher - + diff --git a/doc/uk/org/ury/testrig/package-frame.html b/doc/uk/org/ury/testrig/package-frame.html index b590174..f165abd 100644 --- a/doc/uk/org/ury/testrig/package-frame.html +++ b/doc/uk/org/ury/testrig/package-frame.html @@ -2,12 +2,12 @@ - + uk.org.ury.testrig - + diff --git a/doc/uk/org/ury/testrig/package-summary.html b/doc/uk/org/ury/testrig/package-summary.html index 1630fe3..d3c11ac 100644 --- a/doc/uk/org/ury/testrig/package-summary.html +++ b/doc/uk/org/ury/testrig/package-summary.html @@ -2,12 +2,12 @@ - + uk.org.ury.testrig - + diff --git a/doc/uk/org/ury/testrig/package-tree.html b/doc/uk/org/ury/testrig/package-tree.html index aee9f84..1483525 100644 --- a/doc/uk/org/ury/testrig/package-tree.html +++ b/doc/uk/org/ury/testrig/package-tree.html @@ -2,12 +2,12 @@ - + uk.org.ury.testrig Class Hierarchy - + diff --git a/doc/uk/org/ury/testrig/package-use.html b/doc/uk/org/ury/testrig/package-use.html index dced520..83cd220 100644 --- a/doc/uk/org/ury/testrig/package-use.html +++ b/doc/uk/org/ury/testrig/package-use.html @@ -2,12 +2,12 @@ - + Uses of Package uk.org.ury.testrig - + -- cgit v1.2.3