Changeset 38769 for main/trunk/greenstone3/src/java/org/greenstone/gsdl3/util

Timestamp:

2024-02-22T18:59:49+13:00 (4 months ago)

Author:

anupama

Message:

Following Dr Bainbridge's task description and with his fixes: changes to get the Networked Derby Driver that we now use to use the shorter URL to the usersDB of the form jdbc:derby://derbyserver:derbyport/usersDB, instead of the full path to usersDB after the protocol. It needed setting derby.system.home JAVA_OPT when starting up the derby server in build.xml, then the tomcat greenstone3.xml file needed to refer to the shorter URL. Then classes that used to pass the full path need to pass the shorter form. And those classes called from the comandline with full usersDB path, like ModifyUsersDB, needed to now pass the shorter path. So build.xml needed further updating when calling ModifyUsersDB. The full path still works (for example, you can connect to both the original jdbc:derby URL and the shorter URL now from Squirrel SQL Client now), but the code now uses the shorter path.

Location:

main/trunk/greenstone3/src/java/org/greenstone/gsdl3/util

Files:

• DerbyWrapper.java (modified) (3 diffs)
• ModifyUsersDB.java (modified) (1 diff)
• txt2usersDB.java (modified) (1 diff)
• usersDB2txt.java (modified) (2 diffs)

main/trunk/greenstone3/src/java/org/greenstone/gsdl3/util/DerbyWrapper.java

@@ -44 +44 @@
     static final String PROTOCOL;   
 
+    static final String DRIVER = "org.apache.derby.jdbc.ClientDriver"; //"org.apache.derby.jdbc.EmbeddedDriver";
+    static final String USERSDB = "usersDB";
+    public static final String USERSDB_DIR;
+    
     // static code block to initialise the above
     static {
@@ -75 +79 @@
     PROTOCOL = "jdbc:derby://"+DERBYSERVER+":"+PORT+"/"; // "jdbc:derby://localhost:8327"; // by default
     //System.out.println("@@@ PROTOCOL:" + PROTOCOL); //check in installer
+
+    // if embedded derby Driver (UNTESTED BRANCH), use the full path to usersDB,
+    // else if networked derby server then just append dbname (usersDB) to protocol
+    if(DRIVER.equals("org.apache.derby.jdbc.EmbeddedDriver")) {
+        USERSDB_DIR = GlobalProperties.getGSDL3Home() + File.separatorChar + "etc" + File.separatorChar + USERSDB;
+    } else { // derby network driver, just go direct to usersDB
+        USERSDB_DIR = USERSDB;
+    }   
     }
-   
-
-    static final String DRIVER = "org.apache.derby.jdbc.ClientDriver"; //"org.apache.derby.jdbc.EmbeddedDriver";
-        static final String USERSDB = "usersDB";
+
     public static final String USERS = "users";
     public static final String ROLES = "roles";
@@ -93 +102 @@
     public static void createDatabaseIfNeeded()
     {
-        String usersDB_dir = GlobalProperties.getGSDL3Home() + File.separatorChar + "etc" + File.separatorChar + "usersDB";
-        protocol_str = PROTOCOL + usersDB_dir;
-        File usersDB_file = new File(usersDB_dir);
+        protocol_str = PROTOCOL + USERSDB_DIR;
+        File usersDB_file = new File(USERSDB_DIR);
         if (!usersDB_file.exists())
         {

main/trunk/greenstone3/src/java/org/greenstone/gsdl3/util/ModifyUsersDB.java

@@ -28 +28 @@
     then run:
 
-    java -Dgsdl3.writablehome=/Scratch/ak19/gs3-svn-2Sep2015/web -cp web/WEB-INF/lib/gsdl3.jar:web/WEB-INF/lib/gutil.jar:web/WEB-INF/lib/derby.jar:web/WEB-INF/lib/derbyclient.jar:web/WEB-INF/lib/log4j-1.2.8.jar:web/WEB-INF/lib/commons-codec-1.7.jar:web/WEB-INF/classes org.greenstone.gsdl3.util.ModifyUsersDB web/etc/usersDB/ <username or 'ALL'> [options specifying user fields to change, e.g.: password=me!]
-    
+    java -Dgsdl3.writablehome=/Scratch/ak19/gs3-svn-2Sep2015/web -cp web/WEB-INF/lib/gsdl3.jar:web/WEB-INF/lib/gutil.jar:web/WEB-INF/lib/derby.jar:web/WEB-INF/lib/derbyclient.jar:web/WEB-INF/lib/log4j-1.2.8.jar:web/WEB-INF/lib/commons-codec-1.7.jar:web/WEB-INF/classes org.greenstone.gsdl3.util.ModifyUsersDB usersDB <username or 'ALL'> [options specifying user fields to change, e.g.: password=me!]
+    
+    Now just pass in "usersDB" for networked derby server, previously web/etc/usersDB/ was needed.
+
     Don't forget to stop the networked derby server again at the end, if you had started it: ant stop-derby
    [[ OLD METHOD ]]

main/trunk/greenstone3/src/java/org/greenstone/gsdl3/util/txt2usersDB.java

@@ -31 +31 @@
     then run:
 
-    java -Dgsdl3.writablehome=/full/path/to/GS3/web -cp web/WEB-INF/lib/gsdl3.jar:web/WEB-INF/lib/gutil.jar:web/WEB-INF/lib/derby.jar:./web/WEB-INF/lib/derbyclient.jar:./web/WEB-INF/lib/log4j-1.2.8.jar:./web/WEB-INF/classes org.greenstone.gsdl3.util.txt2usersDB <filename>.txt web/etc/usersDB/ [-append]
+    java -Dgsdl3.writablehome=/full/path/to/GS3/web -cp web/WEB-INF/lib/gsdl3.jar:web/WEB-INF/lib/gutil.jar:web/WEB-INF/lib/derby.jar:./web/WEB-INF/lib/derbyclient.jar:./web/WEB-INF/lib/log4j-1.2.8.jar:./web/WEB-INF/classes org.greenstone.gsdl3.util.txt2usersDB <filename>.txt usersDB [-append]
+
+    Now just pass in "usersDB" for networked derby server, previously web/etc/usersDB/ was needed.
 
     Don't forget to stop the networked derby server again at the end, if you had started it: ant stop-derby

main/trunk/greenstone3/src/java/org/greenstone/gsdl3/util/usersDB2txt.java

@@ -33 +33 @@
     then run: 
  
-    java -Dgsdl3.writablehome=/full/path/to/GS3/web -cp ./web/WEB-INF/lib/gsdl3.jar:./web/WEB-INF/lib/gutil.jar:./web/WEB-INF/lib/derby.jar:./web/WEB-INF/lib/derbyclient.jar:./web/WEB-INF/lib/log4j-1.2.8.jar:./web/WEB-INF/classes org.greenstone.gsdl3.util.usersDB2txt web/etc/usersDB/
+    java -Dgsdl3.writablehome=/full/path/to/GS3/web -cp ./web/WEB-INF/lib/gsdl3.jar:./web/WEB-INF/lib/gutil.jar:./web/WEB-INF/lib/derby.jar:./web/WEB-INF/lib/derbyclient.jar:./web/WEB-INF/lib/log4j-1.2.8.jar:./web/WEB-INF/classes org.greenstone.gsdl3.util.usersDB2txt usersDB
+
+    Now just pass in "usersDB" for networked derby server, previously web/etc/usersDB/ was needed.
 
     if redirecting to a file append ">& filename.txt" to the above command 
@@ -47 +49 @@
     public static void main(String[] args) throws SQLException{
     if (args.length!=1){
-        System.out.println("The path of usersDB has to be given!");
+        System.out.println("Set parameter to \"usersDB\" for a derby networked server or usersDB path if using an embedded derby server");
         System.exit(0);
     }