From df7d7981b56a4560c95ea7e9b194080e93398ecf Mon Sep 17 00:00:00 2001 From: Matt Windsor Date: Mon, 21 Mar 2011 21:54:31 +0000 Subject: GREAT PACKAGE RESHUFFLE: Everything is now organised into frontend, backend and common (to frontend and backend) packages. Things may have been broken. Doc refresh. --- doc/uk/org/ury/backend/config/Auth.html | 291 +++++++++++++++++++ doc/uk/org/ury/backend/config/ConfigReader.html | 315 +++++++++++++++++++++ doc/uk/org/ury/backend/config/Database.html | 315 +++++++++++++++++++++ doc/uk/org/ury/backend/config/class-use/Auth.html | 188 ++++++++++++ .../ury/backend/config/class-use/ConfigReader.html | 179 ++++++++++++ .../org/ury/backend/config/class-use/Database.html | 180 ++++++++++++ doc/uk/org/ury/backend/config/package-frame.html | 36 +++ doc/uk/org/ury/backend/config/package-summary.html | 165 +++++++++++ doc/uk/org/ury/backend/config/package-tree.html | 153 ++++++++++ doc/uk/org/ury/backend/config/package-use.html | 195 +++++++++++++ 10 files changed, 2017 insertions(+) create mode 100644 doc/uk/org/ury/backend/config/Auth.html create mode 100644 doc/uk/org/ury/backend/config/ConfigReader.html create mode 100644 doc/uk/org/ury/backend/config/Database.html create mode 100644 doc/uk/org/ury/backend/config/class-use/Auth.html create mode 100644 doc/uk/org/ury/backend/config/class-use/ConfigReader.html create mode 100644 doc/uk/org/ury/backend/config/class-use/Database.html create mode 100644 doc/uk/org/ury/backend/config/package-frame.html create mode 100644 doc/uk/org/ury/backend/config/package-summary.html create mode 100644 doc/uk/org/ury/backend/config/package-tree.html create mode 100644 doc/uk/org/ury/backend/config/package-use.html (limited to 'doc/uk/org/ury/backend/config') diff --git a/doc/uk/org/ury/backend/config/Auth.html b/doc/uk/org/ury/backend/config/Auth.html new file mode 100644 index 0000000..4393cbc --- /dev/null +++ b/doc/uk/org/ury/backend/config/Auth.html @@ -0,0 +1,291 @@ + + + + + + +Auth + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.backend.config +
+Class Auth

+
+java.lang.Object
+  extended by uk.org.ury.backend.config.Auth
+
+
+
+
public class Auth
extends java.lang.Object
+ + +

+A login authorisation configuration +

+ +

+

+
Author:
+
Nathan Lasseter
+
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
Auth(java.lang.String user, + java.lang.String pass) + +
+          Create a login auth object
+  + + + + + + + + + + + + + + + +
+Method Summary
+ java.lang.StringgetPass() + +
+          Get the password of the login
+ java.lang.StringgetUser() + +
+          Get the username of the login
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

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

+Auth

+
+public Auth(java.lang.String user,
+            java.lang.String pass)
+
+
Create a login auth object +

+

+
Parameters:
user - The username for the login
pass - The password for the login
+
+ + + + + + + + +
+Method Detail
+ +

+getUser

+
+public java.lang.String getUser()
+
+
Get the username of the login +

+

+ +
Returns:
String username
+
+
+
+ +

+getPass

+
+public java.lang.String getPass()
+
+
Get the password of the login +

+

+ +
Returns:
String password
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/config/ConfigReader.html b/doc/uk/org/ury/backend/config/ConfigReader.html new file mode 100644 index 0000000..8a3a618 --- /dev/null +++ b/doc/uk/org/ury/backend/config/ConfigReader.html @@ -0,0 +1,315 @@ + + + + + + +ConfigReader + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.backend.config +
+Class ConfigReader

+
+java.lang.Object
+  extended by uk.org.ury.backend.config.ConfigReader
+
+
+
+
public class ConfigReader
extends java.lang.Object
+ + +

+Reads in an XML config file and creates config objects +

+ +

+

+
Author:
+
Nathan Lasseter
+
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
ConfigReader(java.lang.String configFile) + +
+          Read in the config file and create the Database and Auth configuration objects.
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ DatabasegetDatabase() + +
+          Get the database configuration
+ AuthgetRoAuth() + +
+          Get the read only login auth configuration
+ AuthgetRwAuth() + +
+          Get the read write login auth configuration
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

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

+ConfigReader

+
+public ConfigReader(java.lang.String configFile)
+             throws MissingCredentialsException
+
+
Read in the config file and create the Database and Auth configuration objects. + Specify a config file. +

+

+ +
Throws: +
MissingCredentialsException
+
+ + + + + + + + +
+Method Detail
+ +

+getDatabase

+
+public Database getDatabase()
+
+
Get the database configuration +

+

+ +
Returns:
Database database
+
+
+
+ +

+getRoAuth

+
+public Auth getRoAuth()
+
+
Get the read only login auth configuration +

+

+ +
Returns:
Auth roAauth
+
+
+
+ +

+getRwAuth

+
+public Auth getRwAuth()
+
+
Get the read write login auth configuration +

+

+ +
Returns:
Auth rwAauth
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/config/Database.html b/doc/uk/org/ury/backend/config/Database.html new file mode 100644 index 0000000..ec0f77c --- /dev/null +++ b/doc/uk/org/ury/backend/config/Database.html @@ -0,0 +1,315 @@ + + + + + + +Database + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +uk.org.ury.backend.config +
+Class Database

+
+java.lang.Object
+  extended by uk.org.ury.backend.config.Database
+
+
+
+
public class Database
extends java.lang.Object
+ + +

+A Database Server configuration +

+ +

+

+
Author:
+
Nathan Lasseter
+
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
Database(java.lang.String host, + int port, + java.lang.String db) + +
+          Create a database object
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ java.lang.StringgetDb() + +
+          Get the name of the database
+ java.lang.StringgetHost() + +
+          Get the hostname of the database server
+ intgetPort() + +
+          Get the port the database server is running on
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

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

+Database

+
+public Database(java.lang.String host,
+                int port,
+                java.lang.String db)
+
+
Create a database object +

+

+
Parameters:
host - The hostname of the database server
port - The port that the database server listens on
db - The name of the database on the server
+
+ + + + + + + + +
+Method Detail
+ +

+getHost

+
+public java.lang.String getHost()
+
+
Get the hostname of the database server +

+

+ +
Returns:
String hostname
+
+
+
+ +

+getPort

+
+public int getPort()
+
+
Get the port the database server is running on +

+

+ +
Returns:
int port
+
+
+
+ +

+getDb

+
+public java.lang.String getDb()
+
+
Get the name of the database +

+

+ +
Returns:
String database name
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/config/class-use/Auth.html b/doc/uk/org/ury/backend/config/class-use/Auth.html new file mode 100644 index 0000000..9292ac4 --- /dev/null +++ b/doc/uk/org/ury/backend/config/class-use/Auth.html @@ -0,0 +1,188 @@ + + + + + + +Uses of Class uk.org.ury.backend.config.Auth + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
uk.org.ury.backend.config.Auth

+
+ + + + + + + + + +
+Packages that use Auth
uk.org.ury.backend.config  
+  +

+ + + + + +
+Uses of Auth in uk.org.ury.backend.config
+  +

+ + + + + + + + + + + + + +
Methods in uk.org.ury.backend.config that return Auth
+ AuthConfigReader.getRoAuth() + +
+          Get the read only login auth configuration
+ AuthConfigReader.getRwAuth() + +
+          Get the read write login auth configuration
+  +

+

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

+Uses of Class
uk.org.ury.backend.config.ConfigReader

+
+ + + + + + + + + +
+Packages that use ConfigReader
uk.org.ury.backend.databaseDatabase services for the URY Presenter Suite. 
+  +

+ + + + + +
+Uses of ConfigReader in uk.org.ury.backend.database
+  +

+ + + + + + + + +
Constructors in uk.org.ury.backend.database with parameters of type ConfigReader
DatabaseDriver(ConfigReader config, + UserClass type) + +
+          Construct a new DatabaseDriver with the given user class.
+  +

+

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

+Uses of Class
uk.org.ury.backend.config.Database

+
+ + + + + + + + + +
+Packages that use Database
uk.org.ury.backend.config  
+  +

+ + + + + +
+Uses of Database in uk.org.ury.backend.config
+  +

+ + + + + + + + + +
Methods in uk.org.ury.backend.config that return Database
+ DatabaseConfigReader.getDatabase() + +
+          Get the database configuration
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/config/package-frame.html b/doc/uk/org/ury/backend/config/package-frame.html new file mode 100644 index 0000000..082e1a1 --- /dev/null +++ b/doc/uk/org/ury/backend/config/package-frame.html @@ -0,0 +1,36 @@ + + + + + + +uk.org.ury.backend.config + + + + + + + + + + + +uk.org.ury.backend.config + + + + +
+Classes  + +
+Auth +
+ConfigReader +
+Database
+ + + + diff --git a/doc/uk/org/ury/backend/config/package-summary.html b/doc/uk/org/ury/backend/config/package-summary.html new file mode 100644 index 0000000..2130ac0 --- /dev/null +++ b/doc/uk/org/ury/backend/config/package-summary.html @@ -0,0 +1,165 @@ + + + + + + +uk.org.ury.backend.config + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package uk.org.ury.backend.config +

+ + + + + + + + + + + + + + + + + +
+Class Summary
AuthA login authorisation configuration
ConfigReaderReads in an XML config file and creates config objects
DatabaseA Database Server configuration
+  + +

+

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

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

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

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

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

+
+ + + + + + + + + + + + + +
+Packages that use uk.org.ury.backend.config
uk.org.ury.backend.config  
uk.org.ury.backend.databaseDatabase services for the URY Presenter Suite. 
+  +

+ + + + + + + + + + + +
+Classes in uk.org.ury.backend.config used by uk.org.ury.backend.config
Auth + +
+          A login authorisation configuration
Database + +
+          A Database Server configuration
+  +

+ + + + + + + + +
+Classes in uk.org.ury.backend.config used by uk.org.ury.backend.database
ConfigReader + +
+          Reads in an XML config file and creates config objects
+  +

+

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