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. --- .../exceptions/ConnectionFailureException.html | 269 +++++++++++++++++++ .../exceptions/MissingCredentialsException.html | 275 +++++++++++++++++++ .../exceptions/MissingPropertyException.html | 271 +++++++++++++++++++ .../database/exceptions/QueryFailureException.html | 269 +++++++++++++++++++ .../class-use/ConnectionFailureException.html | 208 +++++++++++++++ .../class-use/MissingCredentialsException.html | 235 ++++++++++++++++ .../class-use/MissingPropertyException.html | 180 +++++++++++++ .../class-use/QueryFailureException.html | 250 +++++++++++++++++ .../backend/database/exceptions/package-frame.html | 38 +++ .../database/exceptions/package-summary.html | 189 +++++++++++++ .../backend/database/exceptions/package-tree.html | 158 +++++++++++ .../backend/database/exceptions/package-use.html | 295 +++++++++++++++++++++ 12 files changed, 2637 insertions(+) create mode 100644 doc/uk/org/ury/backend/database/exceptions/ConnectionFailureException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/MissingCredentialsException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/MissingPropertyException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/QueryFailureException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/class-use/ConnectionFailureException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/class-use/MissingCredentialsException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/class-use/MissingPropertyException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/class-use/QueryFailureException.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/package-frame.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/package-summary.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/package-tree.html create mode 100644 doc/uk/org/ury/backend/database/exceptions/package-use.html (limited to 'doc/uk/org/ury/backend/database/exceptions') diff --git a/doc/uk/org/ury/backend/database/exceptions/ConnectionFailureException.html b/doc/uk/org/ury/backend/database/exceptions/ConnectionFailureException.html new file mode 100644 index 0000000..0315bcd --- /dev/null +++ b/doc/uk/org/ury/backend/database/exceptions/ConnectionFailureException.html @@ -0,0 +1,269 @@ + + + + + + +ConnectionFailureException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +uk.org.ury.backend.database.exceptions +
+Class ConnectionFailureException

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

+Exception thrown when the database backend fails to connect to + the database server, in absence of a more specific exception. +

+ +

+

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

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

+ConnectionFailureException

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

+

+
+ +

+ConnectionFailureException

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

+

+
Parameters:
reason - The explanation for the exception.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/exceptions/MissingCredentialsException.html b/doc/uk/org/ury/backend/database/exceptions/MissingCredentialsException.html new file mode 100644 index 0000000..0be114f --- /dev/null +++ b/doc/uk/org/ury/backend/database/exceptions/MissingCredentialsException.html @@ -0,0 +1,275 @@ + + + + + + +MissingCredentialsException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +uk.org.ury.backend.database.exceptions +
+Class MissingCredentialsException

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

+Exception thrown when the database credentials required to + log into the URY database under a user class are missing, + and thus the log-in cannot continue. + + The best practice for handling a MissingCredentialsException + is to attempt to log into the database with a less privileged + user class or, if the credentials for read-only access are + missing, give up. +

+ +

+

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

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

+MissingCredentialsException

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

+

+
+ +

+MissingCredentialsException

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

+

+
Parameters:
reason - The explanation for the exception.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/exceptions/MissingPropertyException.html b/doc/uk/org/ury/backend/database/exceptions/MissingPropertyException.html new file mode 100644 index 0000000..aa2d24e --- /dev/null +++ b/doc/uk/org/ury/backend/database/exceptions/MissingPropertyException.html @@ -0,0 +1,271 @@ + + + + + + +MissingPropertyException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +uk.org.ury.backend.database.exceptions +
+Class MissingPropertyException

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

+Exception thrown when a DatabaseItem is queried for a property + that does not exist. + + This is (usually) not a fatal error. +

+ +

+

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

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

+MissingPropertyException

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

+

+
+ +

+MissingPropertyException

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

+

+
Parameters:
reason - The explanation for the exception.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/exceptions/QueryFailureException.html b/doc/uk/org/ury/backend/database/exceptions/QueryFailureException.html new file mode 100644 index 0000000..2b65c39 --- /dev/null +++ b/doc/uk/org/ury/backend/database/exceptions/QueryFailureException.html @@ -0,0 +1,269 @@ + + + + + + +QueryFailureException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +uk.org.ury.backend.database.exceptions +
+Class QueryFailureException

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

+Exception thrown when the database backend fails to execute + a query. +

+ +

+

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

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

+QueryFailureException

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

+

+
+ +

+QueryFailureException

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

+

+
Parameters:
reason - The explanation for the exception.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/exceptions/class-use/ConnectionFailureException.html b/doc/uk/org/ury/backend/database/exceptions/class-use/ConnectionFailureException.html new file mode 100644 index 0000000..f12e2aa --- /dev/null +++ b/doc/uk/org/ury/backend/database/exceptions/class-use/ConnectionFailureException.html @@ -0,0 +1,208 @@ + + + + + + +Uses of Class uk.org.ury.backend.database.exceptions.ConnectionFailureException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
uk.org.ury.backend.database.exceptions.ConnectionFailureException

+
+ + + + + + + + + + + + + +
+Packages that use ConnectionFailureException
uk.org.ury.backend.databaseDatabase services for the URY Presenter Suite. 
uk.org.ury.backend.serverThe URY Server kernel. 
+  +

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

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

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

+ + + + + + + + + +
Methods in uk.org.ury.backend.server that throw ConnectionFailureException
+ DatabaseDriverServer.getDatabaseConnection(UserClass userClass) + +
+          Gets a database connection using the given user class.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/exceptions/class-use/MissingCredentialsException.html b/doc/uk/org/ury/backend/database/exceptions/class-use/MissingCredentialsException.html new file mode 100644 index 0000000..b24cb60 --- /dev/null +++ b/doc/uk/org/ury/backend/database/exceptions/class-use/MissingCredentialsException.html @@ -0,0 +1,235 @@ + + + + + + +Uses of Class uk.org.ury.backend.database.exceptions.MissingCredentialsException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
uk.org.ury.backend.database.exceptions.MissingCredentialsException

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

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

+ + + + + + + + +
Constructors in uk.org.ury.backend.config that throw MissingCredentialsException
ConfigReader(java.lang.String configFile) + +
+          Read in the config file and create the Database and Auth configuration objects.
+  +

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

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

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

+ + + + + + + + + +
Methods in uk.org.ury.backend.server that throw MissingCredentialsException
+ DatabaseDriverServer.getDatabaseConnection(UserClass userClass) + +
+          Gets a database connection using the given user class.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/exceptions/class-use/MissingPropertyException.html b/doc/uk/org/ury/backend/database/exceptions/class-use/MissingPropertyException.html new file mode 100644 index 0000000..eaf9af0 --- /dev/null +++ b/doc/uk/org/ury/backend/database/exceptions/class-use/MissingPropertyException.html @@ -0,0 +1,180 @@ + + + + + + +Uses of Class uk.org.ury.backend.database.exceptions.MissingPropertyException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
uk.org.ury.backend.database.exceptions.MissingPropertyException

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

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

+ + + + + + + + + +
Methods in uk.org.ury.backend.database that throw MissingPropertyException
+ TDatabaseItem.get(E property) + +
+          Query this item for a property.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/exceptions/class-use/QueryFailureException.html b/doc/uk/org/ury/backend/database/exceptions/class-use/QueryFailureException.html new file mode 100644 index 0000000..4efbbd2 --- /dev/null +++ b/doc/uk/org/ury/backend/database/exceptions/class-use/QueryFailureException.html @@ -0,0 +1,250 @@ + + + + + + +Uses of Class uk.org.ury.backend.database.exceptions.QueryFailureException + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

+Uses of Class
uk.org.ury.backend.database.exceptions.QueryFailureException

+
+ + + + + + + + + + + + + + + + + +
+Packages that use QueryFailureException
uk.org.ury.common.library  
uk.org.ury.common.show  
uk.org.ury.frontend.modules.show  
+  +

+ + + + + +
+Uses of QueryFailureException in uk.org.ury.common.library
+  +

+ + + + + + + + + +
Methods in uk.org.ury.common.library that throw QueryFailureException
+static java.util.List<LibraryItem>LibraryUtils.search(DatabaseDriver db, + java.lang.String search) + +
+          Perform a library search.
+  +

+ + + + + +
+Uses of QueryFailureException in uk.org.ury.common.show
+  +

+ + + + + + + + + + + + + +
Methods in uk.org.ury.common.show that throw QueryFailureException
+static java.util.List<ShowItem>ShowUtils.getChannelList(DatabaseDriver db, + int showID, + int channel) + +
+          Given a show and a channel, retrieve a list of all show items bound to + that channel for the show.
+static java.util.List<java.lang.String>ShowUtils.getPublicFolders(DatabaseDriver db) + +
+          Return the names of the public track folders, or "bins".
+  +

+ + + + + +
+Uses of QueryFailureException in uk.org.ury.frontend.modules.show
+  +

+ + + + + + + + + +
Methods in uk.org.ury.frontend.modules.show that throw QueryFailureException
+ java.util.List<java.lang.String>ShowViewer.getBins() + +
+           
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/exceptions/package-frame.html b/doc/uk/org/ury/backend/database/exceptions/package-frame.html new file mode 100644 index 0000000..f55b853 --- /dev/null +++ b/doc/uk/org/ury/backend/database/exceptions/package-frame.html @@ -0,0 +1,38 @@ + + + + + + +uk.org.ury.backend.database.exceptions + + + + + + + + + + + +uk.org.ury.backend.database.exceptions + + + + +
+Exceptions  + +
+ConnectionFailureException +
+MissingCredentialsException +
+MissingPropertyException +
+QueryFailureException
+ + + + diff --git a/doc/uk/org/ury/backend/database/exceptions/package-summary.html b/doc/uk/org/ury/backend/database/exceptions/package-summary.html new file mode 100644 index 0000000..f1673c6 --- /dev/null +++ b/doc/uk/org/ury/backend/database/exceptions/package-summary.html @@ -0,0 +1,189 @@ + + + + + + +uk.org.ury.backend.database.exceptions + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+

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

+Exceptions thrown by the database services classes. +

+See: +
+          Description +

+ + + + + + + + + + + + + + + + + + + + + +
+Exception Summary
ConnectionFailureExceptionException thrown when the database backend fails to connect to + the database server, in absence of a more specific exception.
MissingCredentialsExceptionException thrown when the database credentials required to + log into the URY database under a user class are missing, + and thus the log-in cannot continue.
MissingPropertyExceptionException thrown when a DatabaseItem is queried for a property + that does not exist.
QueryFailureExceptionException thrown when the database backend fails to execute + a query.
+  + +

+

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

+ +

+

Exceptions thrown by the database services classes.

+

+ +

+

+
+
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/exceptions/package-tree.html b/doc/uk/org/ury/backend/database/exceptions/package-tree.html new file mode 100644 index 0000000..3bc67be --- /dev/null +++ b/doc/uk/org/ury/backend/database/exceptions/package-tree.html @@ -0,0 +1,158 @@ + + + + + + +uk.org.ury.backend.database.exceptions Class Hierarchy + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

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

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + diff --git a/doc/uk/org/ury/backend/database/exceptions/package-use.html b/doc/uk/org/ury/backend/database/exceptions/package-use.html new file mode 100644 index 0000000..605325a --- /dev/null +++ b/doc/uk/org/ury/backend/database/exceptions/package-use.html @@ -0,0 +1,295 @@ + + + + + + +Uses of Package uk.org.ury.backend.database.exceptions + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ +
+ + + +
+
+

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

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Packages that use uk.org.ury.backend.database.exceptions
uk.org.ury.backend.config  
uk.org.ury.backend.databaseDatabase services for the URY Presenter Suite. 
uk.org.ury.backend.serverThe URY Server kernel. 
uk.org.ury.common.library  
uk.org.ury.common.show  
uk.org.ury.frontend.modules.show  
+  +

+ + + + + + + + +
+Classes in uk.org.ury.backend.database.exceptions used by uk.org.ury.backend.config
MissingCredentialsException + +
+          Exception thrown when the database credentials required to + log into the URY database under a user class are missing, + and thus the log-in cannot continue.
+  +

+ + + + + + + + + + + + + + +
+Classes in uk.org.ury.backend.database.exceptions used by uk.org.ury.backend.database
ConnectionFailureException + +
+          Exception thrown when the database backend fails to connect to + the database server, in absence of a more specific exception.
MissingCredentialsException + +
+          Exception thrown when the database credentials required to + log into the URY database under a user class are missing, + and thus the log-in cannot continue.
MissingPropertyException + +
+          Exception thrown when a DatabaseItem is queried for a property + that does not exist.
+  +

+ + + + + + + + + + + +
+Classes in uk.org.ury.backend.database.exceptions used by uk.org.ury.backend.server
ConnectionFailureException + +
+          Exception thrown when the database backend fails to connect to + the database server, in absence of a more specific exception.
MissingCredentialsException + +
+          Exception thrown when the database credentials required to + log into the URY database under a user class are missing, + and thus the log-in cannot continue.
+  +

+ + + + + + + + +
+Classes in uk.org.ury.backend.database.exceptions used by uk.org.ury.common.library
QueryFailureException + +
+          Exception thrown when the database backend fails to execute + a query.
+  +

+ + + + + + + + +
+Classes in uk.org.ury.backend.database.exceptions used by uk.org.ury.common.show
QueryFailureException + +
+          Exception thrown when the database backend fails to execute + a query.
+  +

+ + + + + + + + +
+Classes in uk.org.ury.backend.database.exceptions used by uk.org.ury.frontend.modules.show
QueryFailureException + +
+          Exception thrown when the database backend fails to execute + a query.
+  +

+


+ + + + + + + + + + + + + + + +
+ +
+ + + +
+ + + -- cgit v1.2.3