rename packages, updated docs

doc/index.html

@@ -257,7 +257,7 @@ <h4>OdbResource</h4>
               </li>
               <li>
                 The factory attribute must have a value of
-                "com.ashtonit.odb.OPDPFObjectFactory".
+                "com.ashtonit.odb.jndi.OPDPFObjectFactory".
               </li>
               <li>
                 The type attribute must have a value of
@@ -277,7 +277,7 @@ <h4>OdbResource</h4>
                  auth="Container"
                  closeMethod="close"
                  configFile="/opt/orientdb-community-2.1.3/config/orientdb-server-config.xml"
-                 factory="com.ashtonit.odb.OPDPFObjectFactory"
+                 factory="com.ashtonit.odb.jndi.OPDPFObjectFactory"
                  name="opdpfactory"
                  singleton="true"
                  type="com.orientechnologies.orient.core.db.OPartitionedDatabasePoolFactory"

src/com/ashtonit/odb/OPDPFObjectFactory.java → src/com/ashtonit/odb/jndi/OPDPFObjectFactory.java

@@ -1,4 +1,4 @@
-package com.ashtonit.odb;
+package com.ashtonit.odb.jndi;
 
 import java.io.File;
 import java.util.Enumeration;
@@ -32,13 +32,14 @@
  * com.orientechnologies.orient.core.db.OPartitionedDatabasePoolFactory. The resource should always be a singleton and a
  * closeMethod attribute with the value "close" should also be present. The auth attribute should have the value
  * "Container". The server config file for OrientDB should be passed in with the attribute "configFile" if you wish to
- * run an embedded OrientDB server.<br>
+ * run an embedded OrientDB server. The maximum number of connections can be set with the attribute, "capacity".<br>
  * e.g.
  * </p>
  * 
  * <pre>
  * &lt;Resource
  *   auth="Container"
+ *   capacity="100"
  *   closeMethod="close"
  *   configFile="/mnt/share/orientdb-community-2.1.3/config/orientdb-server-config.xml"
  *   factory="com.ashtonit.odb.OPDPFObjectFactory"
@@ -63,8 +64,9 @@ public class OPDPFObjectFactory implements ObjectFactory {
 
 
     /**
-     * Returns an OrientGraphPool instance and initialises the embedded OServer instance with the config file specified
-     * as an attribute. This instance is always a singleton, regardless of attributes in server.xml files etc.
+     * Returns an OrientGraphPool instance and initialises an embedded OServer instance with the config file specified
+     * as an attribute, if it is present. This instance is always a singleton, regardless of attributes in server.xml
+     * files etc.
      *
      * @param obj the naming reference
      * @param name not used

src/com/ashtonit/odb/jndi/package-info.java

@@ -0,0 +1,19 @@
+/**
+ * Contains one class used to manage {@link OPartitionedDatabasePool} pools of OrientDB instances in a Tomcat web
+ * application.
+ * <p>
+ * {@link OPDPFObjectFactory} implements {@link ObjectFactory} and allows lookup of an
+ * {@link OPartitionedDatabasePoolFactory} instance from a JNDI service.
+ * </p>
+ * 
+ * @author Bruce Ashton
+ */
+package com.ashtonit.odb;
+
+import com.orientechnologies.orient.core.db.OPartitionedDatabasePool;
+import com.orientechnologies.orient.core.db.OPartitionedDatabasePoolFactory;
+import com.tinkerpop.blueprints.impls.orient.OrientGraph;
+
+import javax.naming.spi.ObjectFactory;
+
+

src/com/ashtonit/odb/package-info.java

@@ -1,19 +1,7 @@
 /**
- * Contains one class used to manage {@link OPartitionedDatabasePool} pools of {@link OrientGraph} instances in a
- * Tomcat web application.
- * <p>
- * {@link OPDPFObjectFactory} implements {@link ObjectFactory} and allows lookup of an
- * {@link OPartitionedDatabasePoolFactory} instance from a JNDI service.
- * </p>
+ * The base package for the OdbResource library contains no classes.
  * 
  * @author Bruce Ashton
  */
 package com.ashtonit.odb;
 
-import com.orientechnologies.orient.core.db.OPartitionedDatabasePool;
-import com.orientechnologies.orient.core.db.OPartitionedDatabasePoolFactory;
-import com.tinkerpop.blueprints.impls.orient.OrientGraph;
-
-import javax.naming.spi.ObjectFactory;
-
-

src/com/ashtonit/odb/realm/OdbRealm.java

@@ -26,7 +26,7 @@
 
 
 /**
- * A Tomcat Realm class for OrientDB graph databases.
+ * A Tomcat Realm class for OrientDB databases.
  * <p>
  * OdbRealm allows a web application to authenticate users against an embedded or standalone OrientDB database.
  * Authentication is for actual database users, not just arbitrary records in the database.
@@ -51,7 +51,7 @@
  *     className="com.ashtonit.odb.realm.OdbRealm"
  *     dbPass="admin"
  *     dbResource="opdpfactory"
- *     dbUrl="plocal:/opt/odb/mygraphdb"
+ *     dbUrl="plocal:/opt/odb/mydb"
  *     dbUser="admin"
  *   /&gt;
  * </pre>

src/com/ashtonit/odb/realm/package-info.java

@@ -1,8 +1,8 @@
 /**
  * Contains the Tomcat realm implementation and the {@link OdbPrincipal} class.
  * <p>
- * {@link OdbRealm} is configured in the web application or server context. {@link OdbPrincipal} is required for
- * to allow OrientDB user logins to be used as web application logins.
+ * {@link OdbRealm} is configured in the web application or server context. {@link OdbPrincipal} is required to allow
+ * OrientDB user logins to be used as web application logins.
  * </p>
  * 
  * @author Bruce Ashton

src/overview.html

@@ -1,5 +1,8 @@
 <body>
-	<strong>OdbResource</strong> provides a JNDI object factory
-	implementation for OPartitionedDatabasePoolFactory instances and a
-	Tomcat realm implementation for OrientDB.
+	<p>
+		<strong>OdbResource</strong> provides a JNDI object factory
+		implementation for OPartitionedDatabasePoolFactory instances and a
+		Tomcat realm implementation for OrientDB.
+	</p>
+	<p>OdbResource has been tested with Tomcat version 8.0</p>
 </body>