From ba6b1253b5593f72ac673e545a908dba00e1b184 Mon Sep 17 00:00:00 2001
From: brinn <brinn>
Date: Sun, 29 Jul 2012 15:52:14 +0000
Subject: [PATCH] Rename PluginTaskProviders to PluginTaskInfoProvider.

SVN: 26253
---
 .../dss/generic/server/DataStoreService.java  |  8 ++---
 .../OpenBISAuthenticationInterceptor.java     |  4 +--
 ...iders.java => PluginTaskInfoProvider.java} | 31 ++++++++++++-------
 .../TransferredDataSetHandlerTest.java        |  4 +--
 .../generic/server/DataStoreServiceTest.java  |  6 ++--
 .../tasks/PluginTaskParametersTest.java       |  8 ++---
 .../generic/shared/utils/PluginUtilTest.java  |  6 ++--
 7 files changed, 38 insertions(+), 29 deletions(-)
 rename datastore_server/source/java/ch/systemsx/cisd/openbis/dss/generic/server/plugins/tasks/{PluginTaskProviders.java => PluginTaskInfoProvider.java} (87%)

diff --git a/datastore_server/source/java/ch/systemsx/cisd/openbis/dss/generic/server/DataStoreService.java b/datastore_server/source/java/ch/systemsx/cisd/openbis/dss/generic/server/DataStoreService.java
index 8b82e7cca4a..5419d242e67 100644
--- a/datastore_server/source/java/ch/systemsx/cisd/openbis/dss/generic/server/DataStoreService.java
+++ b/datastore_server/source/java/ch/systemsx/cisd/openbis/dss/generic/server/DataStoreService.java
@@ -42,8 +42,8 @@ import ch.systemsx.cisd.etlserver.api.v1.PutDataSetService;
 import ch.systemsx.cisd.openbis.dss.generic.server.plugins.tasks.ArchiverPluginFactory;
 import ch.systemsx.cisd.openbis.dss.generic.server.plugins.tasks.IProcessingPluginTask;
 import ch.systemsx.cisd.openbis.dss.generic.server.plugins.tasks.IReportingPluginTask;
+import ch.systemsx.cisd.openbis.dss.generic.server.plugins.tasks.PluginTaskInfoProvider;
 import ch.systemsx.cisd.openbis.dss.generic.server.plugins.tasks.PluginTaskProvider;
-import ch.systemsx.cisd.openbis.dss.generic.server.plugins.tasks.PluginTaskProviders;
 import ch.systemsx.cisd.openbis.dss.generic.shared.ArchiverTaskContext;
 import ch.systemsx.cisd.openbis.dss.generic.shared.Constants;
 import ch.systemsx.cisd.openbis.dss.generic.shared.DataSetDirectoryProvider;
@@ -82,7 +82,7 @@ public class DataStoreService extends AbstractServiceWithLogger<IDataStoreServic
 
     private final MailClientParameters mailClientParameters;
 
-    private final PluginTaskProviders pluginTaskParameters;
+    private final PluginTaskInfoProvider pluginTaskParameters;
 
     private IHierarchicalContentProvider hierarchicalContentProvider;
 
@@ -101,7 +101,7 @@ public class DataStoreService extends AbstractServiceWithLogger<IDataStoreServic
     private PutDataSetService putService;
 
     public DataStoreService(SessionTokenManager sessionTokenManager,
-            MailClientParameters mailClientParameters, PluginTaskProviders pluginTaskParameters)
+            MailClientParameters mailClientParameters, PluginTaskInfoProvider pluginTaskParameters)
     {
         this(sessionTokenManager, new IDataSetCommandExecutorFactory()
             {
@@ -115,7 +115,7 @@ public class DataStoreService extends AbstractServiceWithLogger<IDataStoreServic
 
     DataStoreService(SessionTokenManager sessionTokenManager,
             IDataSetCommandExecutorFactory commandExecutorFactory,
-            MailClientParameters mailClientParameters, PluginTaskProviders pluginTaskParameters)
+            MailClientParameters mailClientParameters, PluginTaskInfoProvider pluginTaskParameters)
     {
         this.sessionTokenManager = sessionTokenManager;
         this.commandExecutorFactory = commandExecutorFactory;
diff --git a/datastore_server/source/java/ch/systemsx/cisd/openbis/dss/generic/server/openbisauth/OpenBISAuthenticationInterceptor.java b/datastore_server/source/java/ch/systemsx/cisd/openbis/dss/generic/server/openbisauth/OpenBISAuthenticationInterceptor.java
index 2d5dc9d73c7..8870707d6ef 100644
--- a/datastore_server/source/java/ch/systemsx/cisd/openbis/dss/generic/server/openbisauth/OpenBISAuthenticationInterceptor.java
+++ b/datastore_server/source/java/ch/systemsx/cisd/openbis/dss/generic/server/openbisauth/OpenBISAuthenticationInterceptor.java
@@ -27,7 +27,7 @@ import ch.systemsx.cisd.common.logging.LogFactory;
 import ch.systemsx.cisd.common.shared.basic.utils.StringUtils;
 import ch.systemsx.cisd.openbis.dss.generic.server.EncapsulatedOpenBISService;
 import ch.systemsx.cisd.openbis.dss.generic.server.SessionTokenManager;
-import ch.systemsx.cisd.openbis.dss.generic.server.plugins.tasks.PluginTaskProviders;
+import ch.systemsx.cisd.openbis.dss.generic.server.plugins.tasks.PluginTaskInfoProvider;
 import ch.systemsx.cisd.openbis.dss.generic.shared.ManagedAuthentication;
 import ch.systemsx.cisd.openbis.dss.generic.shared.utils.DssPropertyParametersUtil;
 import ch.systemsx.cisd.openbis.generic.shared.IETLLIMSService;
@@ -84,7 +84,7 @@ public class OpenBISAuthenticationInterceptor implements MethodInterceptor
     private final IETLLIMSService service;
 
     public OpenBISAuthenticationInterceptor(SessionTokenManager sessionTokenManager,
-            IETLLIMSService service, PluginTaskProviders pluginTaskParameters,
+            IETLLIMSService service, PluginTaskInfoProvider pluginTaskParameters,
             OpenBISSessionHolder sessionHolder)
     {
         assert sessionTokenManager != null : "Unspecified session token manager.";
diff --git a/datastore_server/source/java/ch/systemsx/cisd/openbis/dss/generic/server/plugins/tasks/PluginTaskProviders.java b/datastore_server/source/java/ch/systemsx/cisd/openbis/dss/generic/server/plugins/tasks/PluginTaskInfoProvider.java
similarity index 87%
rename from datastore_server/source/java/ch/systemsx/cisd/openbis/dss/generic/server/plugins/tasks/PluginTaskProviders.java
rename to datastore_server/source/java/ch/systemsx/cisd/openbis/dss/generic/server/plugins/tasks/PluginTaskInfoProvider.java
index b3f08c1f4f1..df99ca82084 100644
--- a/datastore_server/source/java/ch/systemsx/cisd/openbis/dss/generic/server/plugins/tasks/PluginTaskProviders.java
+++ b/datastore_server/source/java/ch/systemsx/cisd/openbis/dss/generic/server/plugins/tasks/PluginTaskInfoProvider.java
@@ -29,9 +29,11 @@ import ch.systemsx.cisd.openbis.dss.generic.shared.utils.DssPropertyParametersUt
 import ch.systemsx.cisd.openbis.generic.shared.dto.DatastoreServiceDescriptions;
 
 /**
+ * Info provider for plugin tasks.
+ * 
  * @author Tomasz Pylak
  */
-public class PluginTaskProviders
+public class PluginTaskInfoProvider
 {
     public static final String STOREROOT_DIR_KEY = "storeroot-dir";
 
@@ -48,14 +50,14 @@ public class PluginTaskProviders
     private final File storeRoot;
 
     /** for external injections */
-    public static PluginTaskProviders create()
+    public static PluginTaskInfoProvider create()
     {
         IServletPropertiesManager servletPropertiesManager = DataStoreServer.getConfigParameters();
         Properties properties = DssPropertyParametersUtil.loadServiceProperties();
-        String property = properties.getProperty(STOREROOT_DIR_KEY);
-        File storeRoot = new File(property);
-        PluginTaskProviders providers =
-                new PluginTaskProviders(properties, servletPropertiesManager, storeRoot);
+        final String storeRootDir = properties.getProperty(STOREROOT_DIR_KEY);
+        final File storeRoot = new File(storeRootDir);
+        final PluginTaskInfoProvider providers =
+                new PluginTaskInfoProvider(properties, servletPropertiesManager, storeRoot);
         providers.check();
         providers.logConfigurations();
         return providers;
@@ -63,7 +65,7 @@ public class PluginTaskProviders
 
     @Private
     // public only for tests
-    public PluginTaskProviders(Properties serviceProperties,
+    public PluginTaskInfoProvider(Properties serviceProperties,
             IServletPropertiesManager servletPropertiesManager, File storeRoot)
     {
         this.storeRoot = storeRoot;
@@ -77,6 +79,9 @@ public class PluginTaskProviders
         this.archiverTaskFactory = createArchiverTaskFactory(serviceProperties, datastoreCode);
     }
 
+    /**
+     * Returns the root directory of the data store.
+     */
     public final File getStoreRoot()
     {
         return storeRoot;
@@ -112,7 +117,8 @@ public class PluginTaskProviders
 
     @Private
     static PluginTaskProvider<IReportingPluginTask> createReportingPluginsFactories(
-            Properties serviceProperties, IServletPropertiesManager configParameters, String datastoreCode, File storeRoot)
+            Properties serviceProperties, IServletPropertiesManager configParameters,
+            String datastoreCode, File storeRoot)
     {
         SectionProperties[] sectionsProperties =
                 extractSectionProperties(serviceProperties, Constants.REPORTING_PLUGIN_NAMES);
@@ -121,14 +127,16 @@ public class PluginTaskProviders
         for (int i = 0; i < factories.length; i++)
         {
             factories[i] =
-                    new ReportingPluginTaskFactory(configParameters, sectionsProperties[i], datastoreCode, storeRoot);
+                    new ReportingPluginTaskFactory(configParameters, sectionsProperties[i],
+                            datastoreCode, storeRoot);
         }
         return new PluginTaskProvider<IReportingPluginTask>(factories);
     }
 
     @Private
     static PluginTaskProvider<IProcessingPluginTask> createProcessingPluginsFactories(
-            Properties serviceProperties, IServletPropertiesManager configParameters, String datastoreCode, File storeRoot)
+            Properties serviceProperties, IServletPropertiesManager configParameters,
+            String datastoreCode, File storeRoot)
     {
         SectionProperties[] sectionsProperties =
                 extractSectionProperties(serviceProperties, Constants.PROCESSING_PLUGIN_NAMES);
@@ -137,7 +145,8 @@ public class PluginTaskProviders
         for (int i = 0; i < factories.length; i++)
         {
             factories[i] =
-                    new ProcessingPluginTaskFactory(configParameters, sectionsProperties[i], datastoreCode, storeRoot);
+                    new ProcessingPluginTaskFactory(configParameters, sectionsProperties[i],
+                            datastoreCode, storeRoot);
         }
         return new PluginTaskProvider<IProcessingPluginTask>(factories);
     }
diff --git a/datastore_server/sourceTest/java/ch/systemsx/cisd/etlserver/TransferredDataSetHandlerTest.java b/datastore_server/sourceTest/java/ch/systemsx/cisd/etlserver/TransferredDataSetHandlerTest.java
index 2b01e2b1b2a..383040f247a 100644
--- a/datastore_server/sourceTest/java/ch/systemsx/cisd/etlserver/TransferredDataSetHandlerTest.java
+++ b/datastore_server/sourceTest/java/ch/systemsx/cisd/etlserver/TransferredDataSetHandlerTest.java
@@ -56,7 +56,7 @@ import ch.systemsx.cisd.etlserver.IStorageProcessorTransactional.UnstoreDataActi
 import ch.systemsx.cisd.etlserver.registrator.recovery.DataSetStorageRecoveryManager;
 import ch.systemsx.cisd.etlserver.validation.IDataSetValidator;
 import ch.systemsx.cisd.openbis.dss.generic.server.EncapsulatedOpenBISService;
-import ch.systemsx.cisd.openbis.dss.generic.server.plugins.tasks.PluginTaskProviders;
+import ch.systemsx.cisd.openbis.dss.generic.server.plugins.tasks.PluginTaskInfoProvider;
 import ch.systemsx.cisd.openbis.dss.generic.shared.IEncapsulatedOpenBISService;
 import ch.systemsx.cisd.openbis.dss.generic.shared.IShareIdManager;
 import ch.systemsx.cisd.openbis.dss.generic.shared.dto.DataSetInformation;
@@ -84,7 +84,7 @@ import ch.systemsx.cisd.openbis.generic.shared.dto.identifier.ExperimentIdentifi
  */
 @Friend(toClasses =
     { TransferredDataSetHandler.class, DataSetRegistrationHelper.class,
-            IdentifiedDataStrategy.class, PluginTaskProviders.class,
+            IdentifiedDataStrategy.class, PluginTaskInfoProvider.class,
             DssPropertyParametersUtil.class })
 public final class TransferredDataSetHandlerTest extends AbstractFileSystemTestCase
 {
diff --git a/datastore_server/sourceTest/java/ch/systemsx/cisd/openbis/dss/generic/server/DataStoreServiceTest.java b/datastore_server/sourceTest/java/ch/systemsx/cisd/openbis/dss/generic/server/DataStoreServiceTest.java
index 34a1ddff792..7cd999a4ffd 100644
--- a/datastore_server/sourceTest/java/ch/systemsx/cisd/openbis/dss/generic/server/DataStoreServiceTest.java
+++ b/datastore_server/sourceTest/java/ch/systemsx/cisd/openbis/dss/generic/server/DataStoreServiceTest.java
@@ -34,7 +34,7 @@ import ch.systemsx.cisd.common.exceptions.InvalidAuthenticationException;
 import ch.systemsx.cisd.common.exceptions.InvalidSessionException;
 import ch.systemsx.cisd.common.filesystem.FileUtilities;
 import ch.systemsx.cisd.common.mail.MailClientParameters;
-import ch.systemsx.cisd.openbis.dss.generic.server.plugins.tasks.PluginTaskProviders;
+import ch.systemsx.cisd.openbis.dss.generic.server.plugins.tasks.PluginTaskInfoProvider;
 import ch.systemsx.cisd.openbis.dss.generic.shared.IShareIdManager;
 import ch.systemsx.cisd.openbis.dss.generic.shared.utils.PluginUtilTest;
 import ch.systemsx.cisd.openbis.generic.shared.IDataStoreService;
@@ -65,7 +65,7 @@ public class DataStoreServiceTest extends AssertJUnit
                 IDataSetCommandExecutorFactory commandExecutorFactory,
                 MailClientParameters mailClientParameters,
                 ICIFEXRPCServiceFactory cifexServiceFactory, String expectedCIFEXURL,
-                PluginTaskProviders pluginTaskParameters)
+                PluginTaskInfoProvider pluginTaskParameters)
         {
             super(sessionTokenManager, commandExecutorFactory, mailClientParameters,
                     pluginTaskParameters);
@@ -97,7 +97,7 @@ public class DataStoreServiceTest extends AssertJUnit
 
     private ICIFEXComponent cifex;
 
-    private PluginTaskProviders pluginTaskParameters;
+    private PluginTaskInfoProvider pluginTaskParameters;
 
     private IShareIdManager shareIdManager;
 
diff --git a/datastore_server/sourceTest/java/ch/systemsx/cisd/openbis/dss/generic/server/plugins/tasks/PluginTaskParametersTest.java b/datastore_server/sourceTest/java/ch/systemsx/cisd/openbis/dss/generic/server/plugins/tasks/PluginTaskParametersTest.java
index 305f996943e..78074aaea2e 100644
--- a/datastore_server/sourceTest/java/ch/systemsx/cisd/openbis/dss/generic/server/plugins/tasks/PluginTaskParametersTest.java
+++ b/datastore_server/sourceTest/java/ch/systemsx/cisd/openbis/dss/generic/server/plugins/tasks/PluginTaskParametersTest.java
@@ -55,12 +55,12 @@ import ch.systemsx.cisd.openbis.generic.shared.basic.dto.IDatasetLocation;
 import ch.systemsx.cisd.openbis.generic.shared.dto.DatasetDescription;
 
 /**
- * Tests for {@link PluginTaskProviders} class.
+ * Tests for {@link PluginTaskInfoProvider} class.
  * 
  * @author Tomasz Pylak
  */
 @Friend(toClasses =
-    { PluginTaskProviders.class, AbstractPluginTaskFactory.class })
+    { PluginTaskInfoProvider.class, AbstractPluginTaskFactory.class })
 public class PluginTaskParametersTest extends AbstractFileSystemTestCase
 {
     private static final File STORE_ROOT = new File("../datastore_server/resource/test-data/"
@@ -206,14 +206,14 @@ public class PluginTaskParametersTest extends AbstractFileSystemTestCase
     private PluginTaskProvider<IReportingPluginTask> createReportingPluginsFactories(
             Properties props)
     {
-        return PluginTaskProviders.createReportingPluginsFactories(props, servletPropertiesManager,
+        return PluginTaskInfoProvider.createReportingPluginsFactories(props, servletPropertiesManager,
                 "dss", STORE_ROOT);
     }
 
     private PluginTaskProvider<IProcessingPluginTask> createProcessingPluginsFactories(
             Properties props)
     {
-        return PluginTaskProviders.createProcessingPluginsFactories(props,
+        return PluginTaskInfoProvider.createProcessingPluginsFactories(props,
                 servletPropertiesManager, "dss", STORE_ROOT);
     }
 
diff --git a/datastore_server/sourceTest/java/ch/systemsx/cisd/openbis/dss/generic/shared/utils/PluginUtilTest.java b/datastore_server/sourceTest/java/ch/systemsx/cisd/openbis/dss/generic/shared/utils/PluginUtilTest.java
index 764868584d2..d25f0e3333c 100644
--- a/datastore_server/sourceTest/java/ch/systemsx/cisd/openbis/dss/generic/shared/utils/PluginUtilTest.java
+++ b/datastore_server/sourceTest/java/ch/systemsx/cisd/openbis/dss/generic/shared/utils/PluginUtilTest.java
@@ -20,7 +20,7 @@ import java.io.File;
 import java.util.Properties;
 
 import ch.rinn.restrictions.Friend;
-import ch.systemsx.cisd.openbis.dss.generic.server.plugins.tasks.PluginTaskProviders;
+import ch.systemsx.cisd.openbis.dss.generic.server.plugins.tasks.PluginTaskInfoProvider;
 
 /**
  * @author Tomasz Pylak
@@ -28,10 +28,10 @@ import ch.systemsx.cisd.openbis.dss.generic.server.plugins.tasks.PluginTaskProvi
 @Friend(toClasses = DssPropertyParametersUtil.class)
 public class PluginUtilTest
 {
-    public static PluginTaskProviders createPluginTaskProviders(File storeRoot)
+    public static PluginTaskInfoProvider createPluginTaskProviders(File storeRoot)
     {
         Properties serviceProperties = new Properties();
         serviceProperties.put(DssPropertyParametersUtil.DSS_CODE_KEY, "dss");
-        return new PluginTaskProviders(serviceProperties, null, storeRoot);
+        return new PluginTaskInfoProvider(serviceProperties, null, storeRoot, new File("workspace"));
     }
 }
-- 
GitLab