• Home
• org.apache.airavata
• airavata-client-api
• 0.9
• source code
• ExperimentAdvanceOptions.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

/*
 *
 * 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 org.apache.airavata.client.api.exception.AiravataAPIInvocationException;
import org.apache.airavata.client.impl.SecuritySettingsImpl;
import org.apache.airavata.client.impl.WorkflowOutputDataSettingsImpl;
import org.apache.airavata.client.impl.WorkflowSchedulingSettingsImpl;

import java.util.UUID;

public class ExperimentAdvanceOptions {
	private String executionUser;
	private String metadata;
	private String experimentName;
	private String customExperimentId;
	private WorkflowSchedulingSettings schedulingSettings;
	private WorkflowOutputDataSettings outputDataSettings;
    private SecuritySettings securitySettings;
//	private AiravataAPI api;
//
//	public ExperimentAdvanceOptions(AiravataAPI api) {
//		this.api=api;
//	}
	
	/**
	 * Get the user who will be running the experiment if different from the experiment
	 * submitting user.
	 * @return String representing the execution user
	 */
	public String getExperimentExecutionUser(){
		return executionUser;
	}
	
	/**
	 * Get the metadata for the experiment.
	 * @return String representing the custom metadata.
	 */
	public String getExperimentMetadata(){
		return metadata;
	}
	
	/**
	 * Get the name of the experiment
	 * @return String representing the experiment name.
	 */
	public String getExperimentName(){
		return experimentName;
	}
	
	/**
	 * Get the custom Id that will be used as the experiment Id.
	 * @return String representing the custom experiment Id.
	 */
	public String getCustomExperimentId(){
		return customExperimentId;
	}
	
	/**
	 * Set a 3rd party user identity as the user who performed this experiment. If not specified 
	 * the experiment submission user will be used as the execution user.
	 * @param experimentExecutionUser - String representing the user.
	 */
	public void setExperimentExecutionUser(String experimentExecutionUser){
		this.executionUser=experimentExecutionUser;
	}
	
	/**
	 * Set custom metadata for the experiment.

	 * Note: Users can store custom data related to experiment along with the experiment and 
	 * retrieve them later on. 
	 * @param experimentMetadata - String representing the metadata.
	 */
	public void setExperimentCustomMetadata(String experimentMetadata){
		this.metadata=experimentMetadata;
	}
	
	/**
	 * Set the name of the experiment. Must be unique. If not defined the name will be 
	 * auto-generated using the worklfow template Id & & time of experiment submission .
	 * @param experimentName - String representing experiment name.
	 */
	public void setExperimentName(String experimentName){
		this.experimentName=experimentName;
	}
	
	/**
	 * Set a custom id as an experiment Id. If not specified the system will autogenerate an 
	 * experiment id.
	 * @param customExperimentId - String representing the experiment Id.
	 */
	public void setCustomExperimentId(String customExperimentId){
		this.customExperimentId=customExperimentId;
	}
	
	/**
	 * Create a unique experiment Id.

	 * Note: This will not be set as the experiment Id for the experiment. Users should use the
	 * function setCustomExperimentId(...) to do so.
	 * @return A string representing a unique id.
	 */
	public String generatExperimentId(){
		return UUID.randomUUID().toString();
	}
	
	/**
	 * Get custom workflow scheduling settings 
	 * @return
	 * @throws AiravataAPIInvocationException
	 */
	public WorkflowSchedulingSettings getCustomWorkflowSchedulingSettings() throws AiravataAPIInvocationException{
		if (schedulingSettings==null){
			schedulingSettings=new WorkflowSchedulingSettingsImpl();
		}
		return schedulingSettings;
	}
	
	/**
	 * Get workflow intermediate output data settings for application executions
	 * @return
	 * @throws AiravataAPIInvocationException
	 */
	public WorkflowOutputDataSettings getCustomWorkflowOutputDataSettings() throws AiravataAPIInvocationException{
		if (outputDataSettings==null){
			outputDataSettings=new WorkflowOutputDataSettingsImpl();
		}
		return outputDataSettings;
	}
	
	/**
	 * Get the custom security settings for running the experiment
	 * @return
	 * @throws AiravataAPIInvocationException
	 */
	public SecuritySettings getCustomSecuritySettings() throws AiravataAPIInvocationException{
        if (securitySettings==null){
            securitySettings= new SecuritySettingsImpl();
        }
        return securitySettings;
	}
}