ExecutionModulesManager.java

   1 /*
   2  * Copyright (C) 2010 Mathieu Baudier <mbaudier@argeo.org>
   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
  17 package org.argeo.slc.execution;
  18
  19 import java.util.List;
  20 import java.util.Map;
  21
  22 import org.argeo.slc.deploy.ModulesManager;
  23 import org.argeo.slc.process.RealizedFlow;
  24
  25 /** Provides access to the execution modules */
  26 public interface ExecutionModulesManager extends ModulesManager {
  27         /** Used to filter event notified to an execution notifier. */
  28         public static String SLC_PROCESS_ID = "slc.process.id";
  29
  30         /** @return a full fledged module descriptor. */
  31         public ExecutionModuleDescriptor getExecutionModuleDescriptor(
  32                         String moduleName, String version);
  33
  34         /**
  35          * @return a list of minimal execution module descriptors (only the module
  36          *         meta data, not the flows)
  37          */
  38         public List<ExecutionModuleDescriptor> listExecutionModules();
  39
  40         /** Synchronously finds and executes an {@link ExecutionFlow}. */
  41         public void execute(RealizedFlow realizedFlow);
  42
  43         /** Notify of a status update status of the {@link ExecutionProcess} */
  44         public void dispatchUpdateStatus(ExecutionProcess process,
  45                         String oldStatus, String newStatus);
  46
  47         /** Notify that a step was added in an {@link ExecutionProcess} */
  48         public void dispatchAddSteps(ExecutionProcess process,
  49                         List<ExecutionStep> steps);
  50
  51         /**
  52          * Register a notifier which will be notified based on the provided
  53          * properties.
  54          */
  55         public void registerProcessNotifier(ExecutionProcessNotifier notifier,
  56                         Map<String, String> properties);
  57
  58         /** Unregisters a notifier */
  59         public void unregisterProcessNotifier(ExecutionProcessNotifier notifier,
  60                         Map<String, String> properties);
  61 }