SSDM-2718: Introducing ExecutionOptions replacing parameters map.

SVN: 35358

openbis/source/java/ch/ethz/sis/openbis/generic/server/api/v3/ApplicationServerApi.java

@@ -69,6 +69,7 @@ import ch.ethz.sis.openbis.generic.as.api.v3.dto.sample.id.ISampleId;
 import ch.ethz.sis.openbis.generic.as.api.v3.dto.sample.id.SamplePermId;
 import ch.ethz.sis.openbis.generic.as.api.v3.dto.sample.search.SampleSearchCriteria;
 import ch.ethz.sis.openbis.generic.as.api.v3.dto.sample.update.SampleUpdate;
+import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.ExecutionOptions;
 import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.Service;
 import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.fetchoptions.ServiceFetchOptions;
 import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.id.IServiceId;
@@ -608,9 +609,9 @@ public class ApplicationServerApi extends AbstractServer<IApplicationServerApi>
     @Override
     @RolesAllowed({ RoleWithHierarchy.SPACE_OBSERVER, RoleWithHierarchy.SPACE_ETL_SERVER })
     @Capability("EXECUTE_SERVICE")
-    public Serializable executeService(String sessionToken, IServiceId serviceId, Map<String, Serializable> parameters)
+    public Serializable executeService(String sessionToken, IServiceId serviceId, ExecutionOptions options)
     {
-        return executeServiceExecutor.executeService(sessionToken, serviceId, parameters);
+        return executeServiceExecutor.executeService(sessionToken, serviceId, options);
     }
 
     @Override

openbis/source/java/ch/ethz/sis/openbis/generic/server/api/v3/ApplicationServerApiLogger.java

@@ -65,6 +65,7 @@ import ch.ethz.sis.openbis.generic.as.api.v3.dto.sample.id.ISampleId;
 import ch.ethz.sis.openbis.generic.as.api.v3.dto.sample.id.SamplePermId;
 import ch.ethz.sis.openbis.generic.as.api.v3.dto.sample.search.SampleSearchCriteria;
 import ch.ethz.sis.openbis.generic.as.api.v3.dto.sample.update.SampleUpdate;
+import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.ExecutionOptions;
 import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.Service;
 import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.fetchoptions.ServiceFetchOptions;
 import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.id.IServiceId;
@@ -350,14 +351,14 @@ public class ApplicationServerApiLogger extends AbstractServerLogger implements
     @Override
     public SearchResult<Service> searchServices(String sessionToken, ServiceSearchCriteria searchCriteria, ServiceFetchOptions fetchOptions)
     {
-        logAccess(sessionToken, "search-services", "SEARCH_CRITERIA(%s) FETCH_OPTIONS(%s)", searchCriteria, fetchOptions);
+        logAccess(sessionToken, "search-services", "SEARCH_CRITERIA:\n%s\nFETCH_OPTIONS:\n%s\n", searchCriteria, fetchOptions);
         return null;
     }
 
     @Override
-    public Serializable executeService(String sessionToken, IServiceId serviceId, Map<String, Serializable> parameters)
+    public Serializable executeService(String sessionToken, IServiceId serviceId, ExecutionOptions options)
     {
-        logAccess(sessionToken, "execute-service", "SERVICE_ID(%s) PARAMETERS(%s)", serviceId, parameters);
+        logAccess(sessionToken, "execute-service", "SERVICE_ID(%s) EXECUTION_OPTIONS(%s)", serviceId, options);
         return null;
     }
 

openbis/source/java/ch/ethz/sis/openbis/generic/server/api/v3/executor/method/ExecuteServiceMethodExecutor.java

@@ -22,12 +22,13 @@ import java.util.Map;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
 
+import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.ExecutionOptions;
 import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.id.IServiceId;
 import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.id.ServiceCode;
 import ch.ethz.sis.openbis.generic.as.api.v3.exceptions.ObjectNotFoundException;
 import ch.ethz.sis.openbis.generic.as.api.v3.exceptions.UnsupportedObjectIdException;
-import ch.ethz.sis.openbis.generic.as.api.v3.plugin.IServiceExecutor;
-import ch.ethz.sis.openbis.generic.as.api.v3.plugin.context.ServiceContext;
+import ch.ethz.sis.openbis.generic.as.api.v3.plugin.service.IServiceExecutor;
+import ch.ethz.sis.openbis.generic.as.api.v3.plugin.service.context.ServiceContext;
 
 /**
  * 
@@ -41,7 +42,7 @@ public class ExecuteServiceMethodExecutor implements IExecuteServiceMethodExecut
     private IServiceProvider serviceProvider;
 
     @Override
-    public Serializable executeService(String sessionToken, IServiceId serviceId, Map<String, Serializable> parameters)
+    public Serializable executeService(String sessionToken, IServiceId serviceId, ExecutionOptions options)
     {
         if (serviceId instanceof ServiceCode == false)
         {
@@ -55,7 +56,7 @@ public class ExecuteServiceMethodExecutor implements IExecuteServiceMethodExecut
         }
         ServiceContext serviceContext = new ServiceContext();
         serviceContext.setSessionToken(sessionToken);
-        return serviceExecutor.executeService(parameters, serviceContext);
+        return serviceExecutor.executeService(serviceContext, options);
     }
 
 }

openbis/source/java/ch/ethz/sis/openbis/generic/server/api/v3/executor/method/IExecuteServiceMethodExecutor.java

@@ -17,8 +17,8 @@
 package ch.ethz.sis.openbis.generic.server.api.v3.executor.method;
 
 import java.io.Serializable;
-import java.util.Map;
 
+import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.ExecutionOptions;
 import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.id.IServiceId;
 
 /**
@@ -28,5 +28,5 @@ import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.id.IServiceId;
  */
 public interface IExecuteServiceMethodExecutor
 {
-    public Serializable executeService(String sessionToken, IServiceId serviceId, Map<String, Serializable> parameters);
+    public Serializable executeService(String sessionToken, IServiceId serviceId, ExecutionOptions options);
 }

openbis/source/java/ch/ethz/sis/openbis/generic/server/api/v3/executor/method/IServiceProvider.java

@@ -19,7 +19,7 @@ package ch.ethz.sis.openbis.generic.server.api.v3.executor.method;
 import java.util.List;
 
 import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.Service;
-import ch.ethz.sis.openbis.generic.as.api.v3.plugin.IServiceExecutor;
+import ch.ethz.sis.openbis.generic.as.api.v3.plugin.service.IServiceExecutor;
 
 /**
  * 

openbis/source/java/ch/ethz/sis/openbis/generic/server/api/v3/executor/method/ServiceProvider.java

@@ -30,7 +30,7 @@ import org.springframework.stereotype.Component;
 
 import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.Service;
 import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.id.ServiceCode;
-import ch.ethz.sis.openbis.generic.as.api.v3.plugin.IServiceExecutor;
+import ch.ethz.sis.openbis.generic.as.api.v3.plugin.service.IServiceExecutor;
 import ch.systemsx.cisd.common.properties.PropertyParametersUtil;
 import ch.systemsx.cisd.common.properties.PropertyParametersUtil.SectionProperties;
 import ch.systemsx.cisd.common.properties.PropertyUtils;

openbis/source/java/ch/ethz/sis/openbis/generic/server/api/v3/helper/service/IScriptRunnerFactory.java

@@ -16,7 +16,7 @@
 
 package ch.ethz.sis.openbis.generic.server.api.v3.helper.service;
 
-import ch.ethz.sis.openbis.generic.as.api.v3.plugin.context.ServiceContext;
+import ch.ethz.sis.openbis.generic.as.api.v3.plugin.service.context.ServiceContext;
 
 /**
  * 

openbis/source/java/ch/ethz/sis/openbis/generic/server/api/v3/helper/service/IServiceScriptRunner.java

@@ -17,7 +17,8 @@
 package ch.ethz.sis.openbis.generic.server.api.v3.helper.service;
 
 import java.io.Serializable;
-import java.util.Map;
+
+import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.ExecutionOptions;
 
 /**
  * 
@@ -26,5 +27,5 @@ import java.util.Map;
  */
 public interface IServiceScriptRunner
 {
-    public Serializable process(Map<String, Serializable> parameters);
+    public Serializable process(ExecutionOptions options);
 }

openbis/source/java/ch/ethz/sis/openbis/generic/server/api/v3/helper/service/JythonBasedServiceExecutor.java

 /*
+
  * Copyright 2015 ETH Zuerich, SIS
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,12 +18,12 @@
 package ch.ethz.sis.openbis.generic.server.api.v3.helper.service;
 
 import java.io.Serializable;
-import java.util.Map;
 import java.util.Properties;
 
 import ch.ethz.sis.openbis.generic.as.api.v3.IApplicationServerApi;
-import ch.ethz.sis.openbis.generic.as.api.v3.plugin.IServiceExecutor;
-import ch.ethz.sis.openbis.generic.as.api.v3.plugin.context.ServiceContext;
+import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.ExecutionOptions;
+import ch.ethz.sis.openbis.generic.as.api.v3.plugin.service.IServiceExecutor;
+import ch.ethz.sis.openbis.generic.as.api.v3.plugin.service.context.ServiceContext;
 import ch.systemsx.cisd.common.properties.PropertyUtils;
 import ch.systemsx.cisd.openbis.generic.server.CommonServiceProvider;
 
@@ -48,9 +49,9 @@ public class JythonBasedServiceExecutor implements IServiceExecutor
     }
 
     @Override
-    public Serializable executeService(Map<String, Serializable> parameters, ServiceContext context)
+    public Serializable executeService(ServiceContext context, ExecutionOptions options)
     {
-        return factory.createServiceRunner(context).process(parameters);
+        return factory.createServiceRunner(context).process(options);
     }
 
 }

openbis/source/java/ch/ethz/sis/openbis/generic/server/api/v3/helper/service/ScriptRunnerFactory.java

@@ -17,10 +17,10 @@
 package ch.ethz.sis.openbis.generic.server.api.v3.helper.service;
 
 import java.io.Serializable;
-import java.util.Map;
 
 import ch.ethz.sis.openbis.generic.as.api.v3.IApplicationServerApi;
-import ch.ethz.sis.openbis.generic.as.api.v3.plugin.context.ServiceContext;
+import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.ExecutionOptions;
+import ch.ethz.sis.openbis.generic.as.api.v3.plugin.service.context.ServiceContext;
 import ch.systemsx.cisd.common.jython.JythonUtils;
 import ch.systemsx.cisd.common.jython.evaluator.Evaluator;
 import ch.systemsx.cisd.common.jython.evaluator.EvaluatorException;
@@ -84,9 +84,9 @@ class ScriptRunnerFactory implements IScriptRunnerFactory
         }
 
         @Override
-        public Serializable process(Map<String, Serializable> parameters)
+        public Serializable process(ExecutionOptions options)
         {
-            Object result = evaluator.evalFunction(PROCESS_FUNCTION_NAME, parameters);
+            Object result = evaluator.evalFunction(PROCESS_FUNCTION_NAME, options.getParameters());
             if (result == null || result instanceof Serializable)
             {
                 return (Serializable) result;

openbis_api/source/java/ch/ethz/sis/openbis/generic/as/api/v3/IApplicationServerApi.java

@@ -64,6 +64,7 @@ import ch.ethz.sis.openbis.generic.as.api.v3.dto.sample.id.ISampleId;
 import ch.ethz.sis.openbis.generic.as.api.v3.dto.sample.id.SamplePermId;
 import ch.ethz.sis.openbis.generic.as.api.v3.dto.sample.search.SampleSearchCriteria;
 import ch.ethz.sis.openbis.generic.as.api.v3.dto.sample.update.SampleUpdate;
+import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.ExecutionOptions;
 import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.Service;
 import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.fetchoptions.ServiceFetchOptions;
 import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.id.IServiceId;
@@ -175,6 +176,6 @@ public interface IApplicationServerApi extends IRpcService
 
     public void confirmDeletions(String sessionToken, List<? extends IDeletionId> deletionIds);
     
-    public Serializable executeService(String sessionToken, IServiceId serviceId, Map<String, Serializable> parameters);
+    public Serializable executeService(String sessionToken, IServiceId serviceId, ExecutionOptions options);
 
 }

openbis_api/source/java/ch/ethz/sis/openbis/generic/as/api/v3/dto/service/ExecutionOptions.java

+/*
+ * Copyright 2015 ETH Zuerich, SIS
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package ch.ethz.sis.openbis.generic.as.api.v3.dto.service;
+
+import java.io.Serializable;
+import java.util.HashMap;
+import java.util.Map;
+
+import ch.systemsx.cisd.base.annotation.JsonObject;
+
+/**
+ * 
+ *
+ * @author Franz-Josef Elmer
+ */
+@JsonObject("dto.service.ExecutionOptions")
+public class ExecutionOptions implements Serializable
+{
+    private static final long serialVersionUID = 1L;
+    
+    private final Map<String, Serializable> parameters = new HashMap<String, Serializable>();
+    
+    public ExecutionOptions withParameter(String parameterName, Serializable value)
+    {
+        parameters.put(parameterName, value);
+        return this;
+    }
+    
+    public Map<String, Serializable> getParameters()
+    {
+        return parameters;
+    }
+}

openbis_api/source/java/ch/ethz/sis/openbis/generic/as/api/v3/plugin/IServiceExecutor.java → openbis_api/source/java/ch/ethz/sis/openbis/generic/as/api/v3/plugin/service/IServiceExecutor.java

@@ -14,13 +14,13 @@
  * limitations under the License.
  */
 
-package ch.ethz.sis.openbis.generic.as.api.v3.plugin;
+package ch.ethz.sis.openbis.generic.as.api.v3.plugin.service;
 
 import java.io.Serializable;
-import java.util.Map;
 
+import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.ExecutionOptions;
 import ch.ethz.sis.openbis.generic.as.api.v3.dto.service.Service;
-import ch.ethz.sis.openbis.generic.as.api.v3.plugin.context.ServiceContext;
+import ch.ethz.sis.openbis.generic.as.api.v3.plugin.service.context.ServiceContext;
 
 /**
  * Executor of a {@link Service}.
@@ -29,5 +29,5 @@ import ch.ethz.sis.openbis.generic.as.api.v3.plugin.context.ServiceContext;
  */
 public interface IServiceExecutor
 {
-    public Serializable executeService(Map<String, Serializable> parameters, ServiceContext context);
+    public Serializable executeService(ServiceContext context, ExecutionOptions options);
 }

openbis_api/source/java/ch/ethz/sis/openbis/generic/as/api/v3/plugin/context/ServiceContext.java → openbis_api/source/java/ch/ethz/sis/openbis/generic/as/api/v3/plugin/service/context/ServiceContext.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package ch.ethz.sis.openbis.generic.as.api.v3.plugin.context;
+package ch.ethz.sis.openbis.generic.as.api.v3.plugin.service.context;
 
 /**
  *