BIS-21 SP-137 : Improvments to documentation and names of properties as a result of documentation

SVN: 25898

datastore_server/source/java/ch/systemsx/cisd/etlserver/ThreadParameters.java

@@ -101,18 +101,17 @@ public final class ThreadParameters
      * The properties that control the process of retrying registration by jython dropboxes
      */
     public static final String DATASET_REGISTRATION_MAX_RETRY_COUNT =
-            "dataset-registration-max-retry-count";
+            "metadata-registration-max-retry-count";
 
     public static final String DATASET_REGISTRATION_RETRY_PAUSE_IN_SEC =
-            "dataset-registration-retry-pause-in-sec";
+            "metadata-registration-retry-pause-in-sec";
 
     /*
      * The properties that control the process of retrying registration by jython dropboxes
      */
     public static final String PROCESS_MAX_RETRY_COUNT = "process-max-retry-count";
 
-    public static final String PROCESS_RETRY_PAUSE_IN_SEC =
-            "process-registration-retry-pause-in-sec";
+    public static final String PROCESS_RETRY_PAUSE_IN_SEC = "process-retry-pause-in-sec";
 
     /**
      * The (local) directory to monitor for new files and directories to move to the remote side.

datastore_server/source/java/ch/systemsx/cisd/etlserver/registrator/DataSetRegistrationContext.java

+package ch.systemsx.cisd.etlserver.registrator;
+
+import net.lemnik.eodsql.DynamicTransactionQuery;
+import ch.systemsx.cisd.etlserver.TopLevelDataSetRegistratorGlobalState;
+
+/**
+ * An object that provides the context for a data set registration.
+ * 
+ * @author Chandrasekhar Ramakrishnan
+ */
+public class DataSetRegistrationContext
+{
+    public static interface IHolder
+    {
+        DataSetRegistrationContext getRegistrationContext();
+    }
+
+    private final DataSetRegistrationPersistentMap persistentMap;
+
+    private final TopLevelDataSetRegistratorGlobalState globalState;
+
+    public DataSetRegistrationContext(DataSetRegistrationPersistentMap persistentMap,
+            TopLevelDataSetRegistratorGlobalState globalState)
+    {
+        this.persistentMap = persistentMap;
+        this.globalState = globalState;
+    }
+
+    public DataSetRegistrationPersistentMap getPersistentMap()
+    {
+        return persistentMap;
+    }
+
+    public TopLevelDataSetRegistratorGlobalState getGlobalState()
+    {
+        return globalState;
+    }
+
+    DynamicTransactionQuery getDatabaseQuery(String dataSourceName)
+    {
+        return globalState.getDynamicTransactionQueryFactory().createDynamicTransactionQuery(
+                dataSourceName);
+    }
+
+}

datastore_server/source/java/ch/systemsx/cisd/etlserver/registrator/JythonTopLevelDataSetHandler.java

@@ -55,17 +55,17 @@ public class JythonTopLevelDataSetHandler<T extends DataSetInformation> extends
         PROCESS_FUNCTION("process", 1),
 
         /**
-         * The name of the function to define to hook into the service rollback mechanism.
+         * The name of the function to define to hook into the service rollback mechanism. V1 only.
          */
         ROLLBACK_SERVICE_FUNCTION_NAME("rollback_service", 2),
 
         /**
-         * The name of the function to define to hook into the transaction rollback mechanism.
+         * The name of the function to define to hook into the transaction rollback mechanism. V1 only.
          */
         ROLLBACK_TRANSACTION_FUNCTION_NAME("rollback_transaction", 4),
 
         /**
-         * The name of the function called after successful transaction commit.
+         * The name of the function called after successful transaction commit. V1 only.
          */
         COMMIT_TRANSACTION_FUNCTION_NAME("commit_transaction", 2),
 

datastore_server/source/java/ch/systemsx/cisd/etlserver/registrator/api/v1/IDataSetRegistrationTransaction.java

@@ -248,10 +248,10 @@ public interface IDataSetRegistrationTransaction
     ISearchService getSearchService();
 
     /**
-     * @return the authorization service
+     * @return A service which can be used to get authorization information about a user.
      */
     IAuthorizationService getAuthorizationService();
-    
+
     /**
      * Gets a database query object for the data source with the specified name.
      * <p>
@@ -289,12 +289,13 @@ public interface IDataSetRegistrationTransaction
     OmniscientTopLevelDataSetRegistratorState getRegistratorContext();
 
     /**
-     * @return the global state
+     * @return Global state for this dropbox, including configuration properties specified by the
+     *         user.
      */
     TopLevelDataSetRegistratorGlobalState getGlobalState();
 
     /**
-     * @return the logical incoming file.
+     * @return The logical incoming file.
      */
     File getIncoming();
 

datastore_server/source/java/ch/systemsx/cisd/etlserver/registrator/api/v2/IDataSetRegistrationTransactionV2.java

@@ -235,7 +235,7 @@ public interface IDataSetRegistrationTransactionV2
     ISearchService getSearchService();
 
     /**
-     * @return the authorization service
+     * @return A service which can be used to get authorization information about a user.
      */
     IAuthorizationService getAuthorizationService();
 
@@ -268,7 +268,8 @@ public interface IDataSetRegistrationTransactionV2
     DataSetRegistrationPersistentMap getRegistrationContext();
 
     /**
-     * @return the global state
+     * @return Global state for this dropbox, including configuration properties specified by the
+     *         user.
      */
     TopLevelDataSetRegistratorGlobalState getGlobalState();