runtime/org.argeo.slc.specs/src/main/java/org/argeo/slc/execution/ExecutionModulesManager.java

   1 /*
   2  * Copyright (C) 2007-2012 Argeo GmbH
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *         http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.argeo.slc.execution;
  17
  18 import java.util.List;
  19 import java.util.Map;
  20
  21 import org.argeo.slc.deploy.ModulesManager;
  22
  23 /** Provides access to the execution modules */
  24 public interface ExecutionModulesManager extends ModulesManager {
  25         /** Used to filter event notified to an execution notifier. */
  26         public static String SLC_PROCESS_ID = "slc.process.id";
  27
  28         /** Unique launch module */
  29         public static String UNIQUE_LAUNCH_MODULE_PROPERTY = "slc.launch.module";
  30
  31         /** Unique launch flow */
  32         public static String UNIQUE_LAUNCH_FLOW_PROPERTY = "slc.launch.flow";
  33
  34         /** @return a full fledged module descriptor. */
  35         public ExecutionModuleDescriptor getExecutionModuleDescriptor(
  36                         String moduleName, String version);
  37
  38         /**
  39          * @return a list of minimal execution module descriptors (only the module
  40          *         meta data, not the flows)
  41          */
  42         public List<ExecutionModuleDescriptor> listExecutionModules();
  43
  44         /** Synchronously finds and executes an {@link ExecutionFlow}. */
  45         public void execute(RealizedFlow realizedFlow);
  46
  47         /** Notify of a status update status of the {@link ExecutionProcess} */
  48         public void dispatchUpdateStatus(ExecutionProcess process,
  49                         String oldStatus, String newStatus);
  50
  51         /** Notify that a step was added in an {@link ExecutionProcess} */
  52         public void dispatchAddSteps(ExecutionProcess process,
  53                         List<ExecutionStep> steps);
  54
  55         /**
  56          * Register a notifier which will be notified based on the provided
  57          * properties.
  58          */
  59         public void registerProcessNotifier(ExecutionProcessNotifier notifier,
  60                         Map<String, String> properties);
  61
  62         /** Unregisters a notifier */
  63         public void unregisterProcessNotifier(ExecutionProcessNotifier notifier,
  64                         Map<String, String> properties);
  65 }