org.apache.airavata.client.api.ExecutionManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of airavata-client-api Show documentation
Client API for accessing Airavata Services
There is a newer version: 0.14
/*
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.airavata.client.api;

import java.util.List;

import org.apache.airavata.common.workflow.execution.context.WorkflowContextHeaderBuilder;
import org.apache.airavata.workflow.model.wf.Workflow;
import org.apache.airavata.workflow.model.wf.WorkflowInput;
import org.apache.airavata.ws.monitor.Monitor;
import org.apache.airavata.ws.monitor.EventDataListener;

public interface ExecutionManager {
    /**
     * Run an experiment containing single workflow
     * @param workflow - Workflow template Id or Workflow Graph XML
     * @param inputs
     * @return
     * @throws AiravataAPIInvocationException
     */
	public String runExperiment(String workflow,List inputs) throws AiravataAPIInvocationException;

    /**
     * Run an experiment containing single workflow with custom settings for the experiment
     * @param workflow - Workflow template Id or Workflow Graph XML
     * @param inputs
     * @param options
     * @return
     * @throws AiravataAPIInvocationException
     */
	public String runExperiment(String workflow,List inputs, ExperimentAdvanceOptions options) throws AiravataAPIInvocationException;

    /**
     * Run an experiment containing single workflow with custom settings for the experiment & listen 
     * for notification events 
     * @param workflow - Workflow template Id or Workflow Graph XML
     * @param inputs
     * @param options
     * @return
     * @throws AiravataAPIInvocationException
     */
	public String runExperiment(String workflow,List inputs, ExperimentAdvanceOptions options, EventDataListener listener) throws AiravataAPIInvocationException;
	
    /**
     * Run an experiment containing single workflow
     * @param workflow
     * @param inputs
     * @return
     * @throws AiravataAPIInvocationException
     */
	public String runExperiment(Workflow workflow,List inputs, ExperimentAdvanceOptions options) throws AiravataAPIInvocationException;

    /**
     * @deprecated Use the function runExperiment(String,List<WorkflowInput>,ExperimentAdvanceOptions) instead. 

     * Run an experiment containing single workflow
     * @param workflowTemplateId
     * @param inputs
     * @param user
     * @param metadata
     * @param workflowInstanceName
     * @return
     * @throws AiravataAPIInvocationException
     */
	public String runExperiment(String workflowTemplateId,List inputs, String user, String metadata, String workflowInstanceName)throws AiravataAPIInvocationException;

	/**
	 * @deprecated Use the function runExperiment(String,List<WorkflowInput>,ExperimentAdvanceOptions) instead. 

     * Run an experiment containing single workflow
     * @param workflowTemplateId
     * @param inputs
     * @param user
     * @param metadata
     * @param workflowInstanceName
     * @return
     * @throws AiravataAPIInvocationException
     */
	public String runExperiment(String workflowTemplateId,List inputs, String user, String metadata, String workflowInstanceName, String experimentName)throws AiravataAPIInvocationException;

	/**
	 * @deprecated Use the function runExperiment(String,List<WorkflowInput>,ExperimentAdvanceOptions) instead. 

	 * Run an experiment containing single workflow
	 * @param workflowTemplateId
	 * @param inputs
	 * @param user
	 * @param metadata
	 * @param workflowInstanceName
	 * @param builder
	 * @return
	 * @throws AiravataAPIInvocationException
	 */
	public String runExperiment(String workflowTemplateId,List inputs, String user, String metadata, String workflowInstanceName, WorkflowContextHeaderBuilder builder)throws AiravataAPIInvocationException;

    /**
     * @deprecated Use the function runExperiment(String,List<WorkflowInput>,ExperimentAdvanceOptions) instead. 

     * Run an experiment containing single workflow
     * @param workflow
     * @param inputs
     * @param user
     * @param metadata
     * @return
     * @throws AiravataAPIInvocationException
     */
	public String runExperiment(Workflow workflow,List inputs, String user, String metadata)throws AiravataAPIInvocationException;

    /**
     * Get a monitor for a running experiment
     * @param experimentId
     * @return
     * @throws AiravataAPIInvocationException
     */
	public Monitor getExperimentMonitor(String experimentId)throws AiravataAPIInvocationException;

    /**
     * Get a monitor for a running experiment
     * @param experimentId
     * @param listener
     * @return
     * @throws AiravataAPIInvocationException
     */
	public Monitor getExperimentMonitor(String experimentId, EventDataListener listener) throws AiravataAPIInvocationException;
	
	/**
	 * @deprecated
	 * Creates a WorkflowContextHeaderBuilder object that can be used to customize the scheduling of a workflow execution.
	 * Once configured this object run the workflow using
	 *   runWorkflow(String workflowTemplateId,List inputs, String user, String metadata, String workflowInstanceName, WorkflowContextHeaderBuilder builder)
	 * @return
	 * @throws AiravataAPIInvocationException
	 */
	public WorkflowContextHeaderBuilder createWorkflowContextHeader() throws AiravataAPIInvocationException;

	/**
	 * Create a new experiment advance options
	 * @return
	 * @throws AiravataAPIInvocationException
	 */
    public ExperimentAdvanceOptions createExperimentAdvanceOptions() throws AiravataAPIInvocationException;
    
    /**
     * Create a new experiment advance options
     * @param experimentName - Name of the running experiment
     * @param experimentUser - Experiment submission user
     * @param experimentMetadata - Experiment metadata 
     * @return
     * @throws AiravataAPIInvocationException
     */
    public ExperimentAdvanceOptions createExperimentAdvanceOptions(String experimentName, String experimentUser, String experimentMetadata) throws AiravataAPIInvocationException;
    
    /**
     * Returns when the given experiment has completed
     * @param experimentId
     * @throws AiravataAPIInvocationException
     */
    public void waitForExperimentTermination(String experimentId) throws AiravataAPIInvocationException;

}