You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airavata.apache.org by ch...@apache.org on 2016/02/08 17:49:31 UTC
[49/50] [abbrv] airavata git commit: update generated code and fixing
compilation issues
http://git-wip-us.apache.org/repos/asf/airavata/blob/4c790770/airavata-api/airavata-api-stubs/src/main/java/org/apache/airavata/api/Airavata.java
----------------------------------------------------------------------
diff --git a/airavata-api/airavata-api-stubs/src/main/java/org/apache/airavata/api/Airavata.java b/airavata-api/airavata-api-stubs/src/main/java/org/apache/airavata/api/Airavata.java
index 3deb9d1..1ad3333 100644
--- a/airavata-api/airavata-api-stubs/src/main/java/org/apache/airavata/api/Airavata.java
+++ b/airavata-api/airavata-api-stubs/src/main/java/org/apache/airavata/api/Airavata.java
@@ -51,7 +51,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@SuppressWarnings({"cast", "rawtypes", "serial", "unchecked"})
-@Generated(value = "Autogenerated by Thrift Compiler (0.9.3)", date = "2016-01-15")
+@Generated(value = "Autogenerated by Thrift Compiler (0.9.3)", date = "2016-02-08")
public class Airavata {
public interface Iface {
@@ -200,6 +200,7 @@ public class Airavata {
public String getSSHPubKey(org.apache.airavata.model.security.AuthzToken authzToken, String airavataCredStoreToken, String gatewayId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.thrift.TException;
/**
+ *
* Get a Public Key by Providing the Token
*
* @param CredStoreToken
@@ -218,6 +219,7 @@ public class Airavata {
public Map<String,String> getAllUserSSHPubKeys(org.apache.airavata.model.security.AuthzToken authzToken, String userName) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.thrift.TException;
/**
+ *
* Get all Public Keys of the Gateway
*
* @param CredStoreToken
@@ -236,6 +238,7 @@ public class Airavata {
public Map<String,String> getAllGatewaySSHPubKeys(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.thrift.TException;
/**
+ *
* Delete a Gateway
*
* @param gatewayId
@@ -253,6 +256,7 @@ public class Airavata {
public boolean deleteSSHPubKey(org.apache.airavata.model.security.AuthzToken authzToken, String airavataCredStoreToken, String gatewayId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.thrift.TException;
/**
+ *
* Creates a Project with basic metadata.
* A Project is a container of experiments.
*
@@ -260,7 +264,7 @@ public class Airavata {
* The identifier for the requested gateway.
*
* @param Project
- * The Project Object described in the workspace_model
+ * The Project Object described in the workspace_model.
*
*
*
@@ -271,6 +275,7 @@ public class Airavata {
public String createProject(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, org.apache.airavata.model.workspace.Project project) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Update an Existing Project
*
* @param projectId
@@ -288,14 +293,15 @@ public class Airavata {
public void updateProject(org.apache.airavata.model.security.AuthzToken authzToken, String projectId, org.apache.airavata.model.workspace.Project updatedProject) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.ProjectNotFoundException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Get a Project by ID
- * This method is to obtain a project by providing a projectId
+ * This method is to obtain a project by providing a projectId.
*
* @param projectId
- * projectId of the project you require
+ * projectId of the project you require.
*
* @return project
- * project data model will be returned
+ * project data model will be returned.
*
*
*
@@ -305,15 +311,18 @@ public class Airavata {
public org.apache.airavata.model.workspace.Project getProject(org.apache.airavata.model.security.AuthzToken authzToken, String projectId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.ProjectNotFoundException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Delete a Project
- * This method is used to delete an existing Project
+ * This method is used to delete an existing Project.
*
* @param projectId
- * projectId of the project you want to delete
+ * projectId of the project you want to delete.
*
* @return boolean
* Boolean identifier for the success or failure of the deletion operation.
*
+ * NOTE: This method is not used within gateways connected with Airavata.
+ *
*
*
* @param authzToken
@@ -322,20 +331,21 @@ public class Airavata {
public boolean deleteProject(org.apache.airavata.model.security.AuthzToken authzToken, String projectId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.ProjectNotFoundException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Get all Project by user with pagination. Results will be ordered based
- * on creation time DESC
+ *
+ * Get All User Projects
+ * Get all Project for the user with pagination. Results will be ordered based on creation time DESC.
*
* @param gatewayId
* The identifier for the requested gateway.
*
* @param userName
- * The identifier of the user
+ * The identifier of the user.
*
* @param limit
- * The amount results to be fetched
+ * The amount results to be fetched.
*
* @param offset
- * The starting point of the results to be fetched
+ * The starting point of the results to be fetched.
*
*
*
@@ -348,19 +358,25 @@ public class Airavata {
public List<org.apache.airavata.model.workspace.Project> getUserProjects(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, String userName, int limit, int offset) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Get all Project for user by project name with pagination.Results will be ordered based
- * on creation time DESC
+ *
+ * Search User Projects by Project Name
+ * Get all Project for user by project name with pagination.Results will be ordered based on creation time DESC.
*
* @param gatewayId
- * The identifier for the requested gateway.
+ * The unique identifier for the requested gateway.
+ *
* @param userName
- * The identifier of the user
+ * The identifier of the user.
+ *
* @param projectName
- * The name of the project on which the results to be fetched
+ * The name of the project on which the results to be fetched.
+ *
* @param limit
- * The amount results to be fetched
+ * The amount results to be fetched.
+ *
* @param offset
- * The starting point of the results to be fetched
+ * The starting point of the results to be fetched.
+ *
*
*
* @param authzToken
@@ -373,19 +389,25 @@ public class Airavata {
public List<org.apache.airavata.model.workspace.Project> searchProjectsByProjectName(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, String userName, String projectName, int limit, int offset) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Search and get all Projects for user by project description with pagination. Results
- * will be ordered based on creation time DESC
+ *
+ * Search User Projects by Project Description
+ * Search and get all Projects for user by project description with pagination. Results will be ordered based on creation time DESC.
*
* @param gatewayId
- * The identifier for the requested gateway.
+ * The unique identifier of the gateway making the request.
+ *
* @param userName
- * The identifier of the user
+ * The identifier of the user.
+ *
* @param description
- * The description to be matched
+ * The description to be matched.
+ *
* @param limit
- * The amount results to be fetched
+ * The amount results to be fetched.
+ *
* @param offset
- * The starting point of the results to be fetched
+ * The starting point of the results to be fetched.
+ *
*
*
* @param authzToken
@@ -398,19 +420,25 @@ public class Airavata {
public List<org.apache.airavata.model.workspace.Project> searchProjectsByProjectDesc(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, String userName, String description, int limit, int offset) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Search Experiments by experiment name with pagination. Results will be sorted
- * based on creation time DESC
+ *
+ * Search User Experiments by Name
+ * Search user Experiments using experiment name with pagination. Results will be sorted based on creation time DESC.
*
* @param gatewayId
- * Identifier of the requested gateway
+ * Unique identifier of the requested gateway.
+ *
* @param userName
- * Username of the requested user
+ * Username of the user who created the experiments.
+ *
* @param expName
- * Experiment name to be matched
+ * Experiment name to be matched.
+ *
* @param limit
- * Amount of results to be fetched
+ * Amount of results to be fetched.
+ *
* @param offset
- * The starting point of the results to be fetched
+ * The starting point of the results to be fetched.
+ *
*
*
* @param authzToken
@@ -423,19 +451,25 @@ public class Airavata {
public List<org.apache.airavata.model.experiment.ExperimentSummaryModel> searchExperimentsByName(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, String userName, String expName, int limit, int offset) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Search Experiments by experiment name with pagination. Results will be sorted
- * based on creation time DESC
+ *
+ * Search By Experiment Description
+ * Search Experiments by experiment description with pagination. Results will be sorted based on creation time DESC.
*
* @param gatewayId
- * Identifier of the requested gateway
+ * Unique identifier of the requested gateway.
+ *
* @param userName
- * Username of the requested user
+ * Username of the requested user.
+ *
* @param description
- * Experiment description to be matched
+ * Experiment description to be matched.
+ *
* @param limit
- * Amount of results to be fetched
+ * Amount of results to be fetched.
+ *
* @param offset
- * The starting point of the results to be fetched
+ * The starting point of the results to be fetched.
+ *
*
*
* @param authzToken
@@ -448,19 +482,25 @@ public class Airavata {
public List<org.apache.airavata.model.experiment.ExperimentSummaryModel> searchExperimentsByDesc(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, String userName, String description, int limit, int offset) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Search Experiments by application id with pagination. Results will be sorted
- * based on creation time DESC
+ *
+ * Search Experiment By the Application
+ * Search Experiments of a particular application id with pagination. Results will be sorted based on creation time DESC
*
* @param gatewayId
- * Identifier of the requested gateway
+ * Unique identifier of the requested gateway.
+ *
* @param userName
- * Username of the requested user
+ * Username of the requested user.
+ *
* @param applicationId
- * Application id to be matched
+ * Application id to be matched.
+ *
* @param limit
- * Amount of results to be fetched
+ * Amount of results to be fetched.
+ *
* @param offset
- * The starting point of the results to be fetched
+ * The starting point of the results to be fetched.
+ *
*
*
* @param authzToken
@@ -473,19 +513,25 @@ public class Airavata {
public List<org.apache.airavata.model.experiment.ExperimentSummaryModel> searchExperimentsByApplication(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, String userName, String applicationId, int limit, int offset) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Search Experiments by experiment status with pagination. Results will be sorted
- * based on creation time DESC
+ *
+ * Search User Experiments by Status
+ * Search all the Experiments of the given user by experiment status with pagination. Results will be sorted based on creation time DESC
*
* @param gatewayId
- * Identifier of the requested gateway
+ * Unique identifier of the requested gateway.
+ *
* @param userName
- * Username of the requested user
+ * Username of the user making the request.
+ *
* @param experimentState
- * Experiement state to be matched
+ * Experiement state to be matched.
+ *
* @param limit
- * Amount of results to be fetched
+ * Amount of results to be fetched.
+ *
* @param offset
- * The starting point of the results to be fetched
+ * The starting point of the results to be fetched.
+ *
*
*
* @param authzToken
@@ -498,21 +544,31 @@ public class Airavata {
public List<org.apache.airavata.model.experiment.ExperimentSummaryModel> searchExperimentsByStatus(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, String userName, org.apache.airavata.model.status.ExperimentState experimentState, int limit, int offset) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Search Experiments by experiment creation time with pagination. Results will be sorted
- * based on creation time DESC
+ *
+ * Search User Experiments by the Creation Time
+ * This will search all the experiments of the given user by experiment creation time with pagination. Results will be sorted based on creation time DESC.
*
* @param gatewayId
- * Identifier of the requested gateway
+ * Unique identifier of the requested gateway.
+ *
* @param userName
- * Username of the requested user
+ * Username of the requested user.
+ *
* @param fromTime
- * Start time of the experiments creation time
+ * Start time of the experiments creation time.
+ *
* @param toTime
- * End time of the experiement creation time
+ * End time of the experiement creation time.
+ *
* @param limit
- * Amount of results to be fetched
+ * Amount of results to be fetched.
+ *
* @param offset
- * The starting point of the results to be fetched
+ * The starting point of the results to be fetched.
+ *
+ * @return ExperimentSummaryModel
+ * List of experiments for the given search filter. Here only the Experiment summary will be returned.
+ *
*
*
* @param authzToken
@@ -526,19 +582,27 @@ public class Airavata {
public List<org.apache.airavata.model.experiment.ExperimentSummaryModel> searchExperimentsByCreationTime(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, String userName, long fromTime, long toTime, int limit, int offset) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Search Experiments by using multiple filter criteria with pagination. Results will be sorted
- * based on creation time DESC
+ * Search Experiments.
+ * Search Experiments by using multiple filter criteria with pagination. Results will be sorted based on creation time DESC.
*
* @param gatewayId
- * Identifier of the requested gateway
+ * Identifier of the requested gateway.
+ *
* @param userName
- * Username of the requested user
+ * Username of the user requesting the search function.
+ *
* @param filters
- * map of multiple filter criteria.
+ * Map of multiple filter criteria. Currenlt search filters includes Experiment Name, Description, Application, etc....
+ *
* @param limit
- * Amount of results to be fetched
+ * Amount of results to be fetched.
+ *
* @param offset
- * The starting point of the results to be fetched
+ * The starting point of the results to be fetched.
+ *
+ * @return ExperimentSummaryModel
+ * List of experiments for the given search filter. Here only the Experiment summary will be returned.
+ *
*
*
* @param authzToken
@@ -551,13 +615,19 @@ public class Airavata {
public List<org.apache.airavata.model.experiment.ExperimentSummaryModel> searchExperiments(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, String userName, Map<org.apache.airavata.model.experiment.ExperimentSearchFields,String> filters, int limit, int offset) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Get Experiment Statisitics for the given gateway for a specific time period
+ *
+ * Get Experiment Statistics
+ * Get Experiment Statisitics for a given gateway for a specific time period. This feature is available only for admins of a particular gateway. Gateway admin access is managed by the user roles.
+ *
* @param gatewayId
- * Identifier of the requested gateway
+ * Unique identifier of the gateway making the request to fetch statistics.
+ *
* @param fromTime
- * Starting date time
+ * Starting date time.
+ *
* @param toTime
- * Ending data time
+ * Ending data time.
+ *
*
*
* @param authzToken
@@ -568,15 +638,19 @@ public class Airavata {
public org.apache.airavata.model.experiment.ExperimentStatistics getExperimentStatistics(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, long fromTime, long toTime) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Get Experiments within project with pagination. Results will be sorted
- * based on creation time DESC
+ *
+ * Get All Experiments of the Project
+ * Get Experiments within project with pagination. Results will be sorted based on creation time DESC.
*
* @param projectId
- * Identifier of the project
+ * Uniqie identifier of the project.
+ *
* @param limit
- * Amount of results to be fetched
+ * Amount of results to be fetched.
+ *
* @param offset
- * The starting point of the results to be fetched
+ * The starting point of the results to be fetched.
+ *
*
*
* @param authzToken
@@ -587,17 +661,22 @@ public class Airavata {
public List<org.apache.airavata.model.experiment.ExperimentModel> getExperimentsInProject(org.apache.airavata.model.security.AuthzToken authzToken, String projectId, int limit, int offset) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.ProjectNotFoundException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Get experiments by user with pagination. Results will be sorted
- * based on creation time DESC
+ *
+ * Get All Experiments of the User
+ * Get experiments by user with pagination. Results will be sorted based on creation time DESC.
*
* @param gatewayId
- * Identifier of the requesting gateway
+ * Identifier of the requesting gateway.
+ *
* @param userName
- * Username of the requested user
+ * Username of the requested end user.
+ *
* @param limit
- * Amount of results to be fetched
+ * Amount of results to be fetched.
+ *
* @param offset
- * The starting point of the results to be fetched
+ * The starting point of the results to be fetched.
+ *
*
*
* @param authzToken
@@ -609,12 +688,17 @@ public class Airavata {
public List<org.apache.airavata.model.experiment.ExperimentModel> getUserExperiments(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, String userName, int limit, int offset) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ * *
+ * * Create New Experiment
* * Create an experiment for the specified user belonging to the gateway. The gateway identity is not explicitly passed
* * but inferred from the sshKeyAuthentication header. This experiment is just a persistent place holder. The client
* * has to subsequently configure and launch the created experiment. No action is taken on Airavata Server except
* * registering the experiment in a persistent store.
* *
- * * @param basicExperimentMetadata
+ * * @param gatewayId
+ * * The unique ID of the gateway where the experiment is been created.
+ * *
+ * * @param ExperimentModel
* * The create experiment will require the basic experiment metadata like the name and description, intended user,
* * the gateway identifer and if the experiment should be shared public by defualt. During the creation of an experiment
* * the ExperimentMetadata is a required field.
@@ -651,8 +735,8 @@ public class Airavata {
public String createExperiment(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, org.apache.airavata.model.experiment.ExperimentModel experiment) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Delete an Experiment
*
+ * Delete an Experiment
* If the experiment is not already launched experiment can be deleted.
*
* @param authzToken
@@ -661,7 +745,7 @@ public class Airavata {
* Experiment ID of the experimnet you want to delete.
*
* @return boolean
- * Identifier for the success or failure of the deletion operation
+ * Identifier for the success or failure of the deletion operation.
*
*
*
@@ -671,12 +755,14 @@ public class Airavata {
public boolean deleteExperiment(org.apache.airavata.model.security.AuthzToken authzToken, String experimentId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ * *
+ * * Get Experiment
* * Fetch previously created experiment metadata.
* *
* * @param airavataExperimentId
- * * The identifier for the requested experiment. This is returned during the create experiment step.
+ * * The unique identifier of the requested experiment. This ID is returned during the create experiment step.
* *
- * * @return experimentMetada
+ * * @return ExperimentModel
* * This method will return the previously stored experiment metadata.
* *
* * @throws org.apache.airavata.model.error.InvalidRequestException
@@ -710,14 +796,17 @@ public class Airavata {
public org.apache.airavata.model.experiment.ExperimentModel getExperiment(org.apache.airavata.model.security.AuthzToken authzToken, String airavataExperimentId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.ExperimentNotFoundException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
+ * Get Complete Experiment Details
* Fetch the completed nested tree structue of previously created experiment metadata which includes processes ->
* tasks -> jobs information.
*
* @param airavataExperimentId
* The identifier for the requested experiment. This is returned during the create experiment step.
*
- * @return experimentMetada
- * This method will return the previously stored experiment metadata.
+ * @return ExperimentModel
+ * This method will return the previously stored experiment metadata including application input parameters, computational resource scheduling
+ * information, special input output handling and additional quality of service parameters.
*
* @throws org.apache.airavata.model.error.InvalidRequestException
* For any incorrect forming of the request itself.
@@ -749,14 +838,15 @@ public class Airavata {
public org.apache.airavata.model.experiment.ExperimentModel getDetailedExperimentTree(org.apache.airavata.model.security.AuthzToken authzToken, String airavataExperimentId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.ExperimentNotFoundException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Configure a previously created experiment with required inputs, scheduling and other quality of service
- * parameters. This method only updates the experiment object within the registry. The experiment has to be launched
- * to make it actionable by the server.
+ *
+ * Update a Previously Created Experiment
+ * Configure the CREATED experiment with required inputs, scheduling and other quality of service parameters. This method only updates the experiment object within the registry.
+ * The experiment has to be launched to make it actionable by the server.
*
* @param airavataExperimentId
* The identifier for the requested experiment. This is returned during the create experiment step.
*
- * @param experimentConfigurationData
+ * @param ExperimentModel
* The configuration information of the experiment with application input parameters, computational resource scheduling
* information, special input output handling and additional quality of service parameters.
*
@@ -799,13 +889,14 @@ public class Airavata {
/**
* *
- * * Validate experiment configuration. A true in general indicates, the experiment is ready to be launched.
- * *
- * * @param experimentId
+ * * Validate experiment configuration.
+ * * A true in general indicates, the experiment is ready to be launched.
* *
+ * * @param airavataExperimentId
+ * * Unique identifier of the experiment (Experimnent ID) of the experiment which need to be validated.
* *
* * @return boolean
- * * Identifier for the success or failure of the validation operation
+ * * Identifier for the success or failure of the validation operation.
* *
* *
*
@@ -815,8 +906,12 @@ public class Airavata {
public boolean validateExperiment(org.apache.airavata.model.security.AuthzToken authzToken, String airavataExperimentId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.ExperimentNotFoundException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Launch a previously created and configured experiment. Airavata Server will then start processing the request and appropriate
- * notifications and intermediate and output data will be subsequently available for this experiment.
+ *
+ * Launch a Previously Created & Configured Experiment.
+ * Airavata Server will then start processing the request and appropriate notifications and intermediate and output data will be subsequently available for this experiment.
+ *
+ * @gatewayId
+ * ID of the gateway which will launch the experiment.
*
* @param airavataExperimentId
* The identifier for the requested experiment. This is returned during the create experiment step.
@@ -855,17 +950,18 @@ public class Airavata {
public void launchExperiment(org.apache.airavata.model.security.AuthzToken authzToken, String airavataExperimentId, String gatewayId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.ExperimentNotFoundException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Get Experiment Status
*
- * Obtain the status os an experiment by providing the Experiment Id
+ * Obtain the status of an experiment by providing the Experiment Id
*
* @param authzToken
*
- * @param experiementId
- * Experiment ID of the experimnet you require the status
+ * @param airavataExperimentId
+ * Experiment ID of the experimnet you require the status.
*
* @return ExperimentStatus
- * ExperimentStatus model with current status will be returned.
+ * ExperimentStatus model with the current status will be returned.
*
*
*
@@ -875,16 +971,17 @@ public class Airavata {
public org.apache.airavata.model.status.ExperimentStatus getExperimentStatus(org.apache.airavata.model.security.AuthzToken authzToken, String airavataExperimentId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.ExperimentNotFoundException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Get Experiment Outputs
- * This method to be used when need to obtain outputs of a certain Experiment
+ * This method to be used when need to obtain final outputs of a certain Experiment
*
* @param authzToken
*
- * @param experiementId
- * Experiment ID of the experimnet you need the outputs
+ * @param airavataExperimentId
+ * Experiment ID of the experimnet you need the outputs.
*
* @return list
- * List of experiment outputs will be returned. They will be returned as a list of OutputDataObjectType for the experiment
+ * List of experiment outputs will be returned. They will be returned as a list of OutputDataObjectType for the experiment.
*
*
*
@@ -894,16 +991,17 @@ public class Airavata {
public List<org.apache.airavata.model.application.io.OutputDataObjectType> getExperimentOutputs(org.apache.airavata.model.security.AuthzToken authzToken, String airavataExperimentId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.ExperimentNotFoundException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Get Intermediate Experiment Outputs
* This method to be used when need to obtain intermediate outputs of a certain Experiment
*
* @param authzToken
*
- * @param experiementId
- * Experiment ID of the experimnet you need the intermediate outputs
+ * @param airavataExperimentId
+ * Experiment ID of the experimnet you need intermediate outputs.
*
* @return list
- * List of intermediate experiment outputs will be returned. They will be returned as a list of OutputDataObjectType for the experiment
+ * List of intermediate experiment outputs will be returned. They will be returned as a list of OutputDataObjectType for the experiment.
*
*
*
@@ -913,13 +1011,14 @@ public class Airavata {
public List<org.apache.airavata.model.application.io.OutputDataObjectType> getIntermediateOutputs(org.apache.airavata.model.security.AuthzToken authzToken, String airavataExperimentId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.ExperimentNotFoundException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Get Job Status for an Experiment
+ *
+ * Get Job Statuses for an Experiment
* This method to be used when need to get the job status of an Experiment. An experiment may have one or many jobs; there for one or many job statuses may turnup
*
* @param authzToken
*
* @param experiementId
- * Experiment ID of the experimnet you need the intermediate outputs
+ * Experiment ID of the experimnet you need the job statuses.
*
* @return JobStatus
* Job status (string) for all all the existing jobs for the experiment will be returned in the form of a map
@@ -932,16 +1031,17 @@ public class Airavata {
public Map<String,org.apache.airavata.model.status.JobStatus> getJobStatuses(org.apache.airavata.model.security.AuthzToken authzToken, String airavataExperimentId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.ExperimentNotFoundException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Get Job Details for all the jobs within an Experiment
+ *
+ * Get Job Details for all the jobs within an Experiment.
* This method to be used when need to get the job details for one or many jobs of an Experiment.
*
* @param authzToken
*
* @param experiementId
- * Experiment ID of the experimnet you need job details
+ * Experiment ID of the experimnet you need job details.
*
* @return list of JobDetails
- * Job details
+ * Job details.
*
*
*
@@ -951,7 +1051,9 @@ public class Airavata {
public List<org.apache.airavata.model.job.JobModel> getJobDetails(org.apache.airavata.model.security.AuthzToken authzToken, String airavataExperimentId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.ExperimentNotFoundException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Clone an specified experiment with a new name. A copy of the experiment configuration is made and is persisted with new metadata.
+ *
+ * Clone an Existing Experiment
+ * Existing specified experiment is cloned and a new name is provided. A copy of the experiment configuration is made and is persisted with new metadata.
* The client has to subsequently update this configuration if needed and launch the cloned experiment.
*
* @param newExperimentName
@@ -963,7 +1065,7 @@ public class Airavata {
* should be shared public by default.
*
* @return
- * The server-side generated.airavata.registry.core.experiment.globally unique identifier for the newly cloned experiment.
+ * The server-side generated.airavata.registry.core.experiment.globally unique identifier (Experiment ID) for the newly cloned experiment.
*
* @throws org.apache.airavata.model.error.InvalidRequestException
* For any incorrect forming of the request itself.
@@ -996,12 +1098,16 @@ public class Airavata {
public String cloneExperiment(org.apache.airavata.model.security.AuthzToken authzToken, String existingExperimentID, String newExperimentName) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.ExperimentNotFoundException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Terminate a running experiment.
+ *
+ * Terminate a running Experiment.
+ *
+ * @gatewayId
+ * ID of the gateway which will terminate the running Experiment.
*
* @param airavataExperimentId
- * The identifier for the requested experiment. This is returned during the create experiment step.
+ * The identifier of the experiment required termination. This ID is returned during the create experiment step.
*
- * @return
+ * @return status
* This method call does not have a return value.
*
* @throws org.apache.airavata.model.error.InvalidRequestException
@@ -1035,13 +1141,17 @@ public class Airavata {
public void terminateExperiment(org.apache.airavata.model.security.AuthzToken authzToken, String airavataExperimentId, String gatewayId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.ExperimentNotFoundException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Register a Application Module.
*
+ * @gatewayId
+ * ID of the gateway which is registering the new Application Module.
+ *
* @param applicationModule
* Application Module Object created from the datamodel.
*
* @return appModuleId
- * Returns a server-side generated airavata appModule globally unique identifier.
+ * Returns the server-side generated airavata appModule globally unique identifier.
*
*
* @param authzToken
@@ -1051,13 +1161,14 @@ public class Airavata {
public String registerApplicationModule(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, org.apache.airavata.model.appcatalog.appdeployment.ApplicationModule applicationModule) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Fetch a Application Module.
*
* @param appModuleId
- * The identifier for the requested application module
+ * The unique identifier of the application module required
*
* @return applicationModule
- * Returns a application Module Object.
+ * Returns an Application Module Object.
*
*
* @param authzToken
@@ -1066,6 +1177,7 @@ public class Airavata {
public org.apache.airavata.model.appcatalog.appdeployment.ApplicationModule getApplicationModule(org.apache.airavata.model.security.AuthzToken authzToken, String appModuleId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Update a Application Module.
*
* @param appModuleId
@@ -1084,13 +1196,28 @@ public class Airavata {
*/
public boolean updateApplicationModule(org.apache.airavata.model.security.AuthzToken authzToken, String appModuleId, org.apache.airavata.model.appcatalog.appdeployment.ApplicationModule applicationModule) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
+ /**
+ *
+ * Fetch all Application Module Descriptions.
+ *
+ * @param gatewayId
+ * ID of the gateway which need to list all available application deployment documentation.
+ *
+ * @return list
+ * Returns the list of all Application Module Objects.
+ *
+ *
+ * @param authzToken
+ * @param gatewayId
+ */
public List<org.apache.airavata.model.appcatalog.appdeployment.ApplicationModule> getAllAppModules(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Delete a Application Module.
+ *
+ * Delete an Application Module.
*
* @param appModuleId
- * The identifier for the requested application module to be deleted.
+ * The identifier of the Application Module to be deleted.
*
* @return status
* Returns a success/failure of the deletion.
@@ -1102,9 +1229,13 @@ public class Airavata {
public boolean deleteApplicationModule(org.apache.airavata.model.security.AuthzToken authzToken, String appModuleId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Register a Application Deployment.
*
- * @param applicationModule
+ * Register an Application Deployment.
+ *
+ * @param gatewayId
+ * ID of the gateway which is registering the new Application Deployment.
+ *
+ * @param applicationDeployment
* Application Module Object created from the datamodel.
*
* @return appDeploymentId
@@ -1118,6 +1249,7 @@ public class Airavata {
public String registerApplicationDeployment(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, org.apache.airavata.model.appcatalog.appdeployment.ApplicationDeploymentDescription applicationDeployment) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Fetch a Application Deployment.
*
* @param appDeploymentId
@@ -1133,10 +1265,11 @@ public class Airavata {
public org.apache.airavata.model.appcatalog.appdeployment.ApplicationDeploymentDescription getApplicationDeployment(org.apache.airavata.model.security.AuthzToken authzToken, String appDeploymentId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Update a Application Deployment.
+ *
+ * Update an Application Deployment.
*
* @param appDeploymentId
- * The identifier for the requested application deployment to be updated.
+ * The identifier of the requested application deployment to be updated.
*
* @param appDeployment
* Application Deployment Object created from the datamodel.
@@ -1152,10 +1285,11 @@ public class Airavata {
public boolean updateApplicationDeployment(org.apache.airavata.model.security.AuthzToken authzToken, String appDeploymentId, org.apache.airavata.model.appcatalog.appdeployment.ApplicationDeploymentDescription applicationDeployment) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Delete a Application deployment.
+ *
+ * Delete an Application Deployment.
*
* @param appDeploymentId
- * The identifier for the requested application deployment to be deleted.
+ * The unique identifier of application deployment to be deleted.
*
* @return status
* Returns a success/failure of the deletion.
@@ -1167,10 +1301,14 @@ public class Airavata {
public boolean deleteApplicationDeployment(org.apache.airavata.model.security.AuthzToken authzToken, String appDeploymentId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Fetch all Application Deployment Descriptions.
*
+ * @param gatewayId
+ * ID of the gateway which need to list all available application deployment documentation.
+ *
* @return list<applicationDeployment.
- * Returns the list of all application Deployment Objects.
+ * Returns the list of all application Deployment Objects.
*
*
* @param authzToken
@@ -1194,9 +1332,10 @@ public class Airavata {
public List<String> getAppModuleDeployedResources(org.apache.airavata.model.security.AuthzToken authzToken, String appModuleId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Register a Application Interface.
*
- * @param applicationModule
+ * @param applicationInterface
* Application Module Object created from the datamodel.
*
* @return appInterfaceId
@@ -1209,17 +1348,39 @@ public class Airavata {
*/
public String registerApplicationInterface(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, org.apache.airavata.model.appcatalog.appinterface.ApplicationInterfaceDescription applicationInterface) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
+ /**
+ *
+ * Clone an Application Interface.
+ *
+ * @gatewayId
+ * The identifier for the gateway profile to be requested
+ *
+ * @param existingAppInterfaceID
+ * Identifier of the existing Application interface you wich to clone.
+ *
+ * @param newApplicationName
+ * Name for the new application interface.
+ *
+ * @return appInterfaceId
+ * Returns a server-side generated globally unique identifier for the newly cloned application interface.
+ *
+ *
+ * @param authzToken
+ * @param existingAppInterfaceID
+ * @param newApplicationName
+ * @param gatewayId
+ */
public String cloneApplicationInterface(org.apache.airavata.model.security.AuthzToken authzToken, String existingAppInterfaceID, String newApplicationName, String gatewayId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Fetch a Application Interface.
+ *
+ * Fetch an Application Interface.
*
* @param appInterfaceId
- * The identifier for the requested application module
+ * The identifier for the requested application interface.
*
* @return applicationInterface
- * Returns a application Interface Object.
- *
+ * Returns an application Interface Object.
*
*
* @param authzToken
@@ -1228,10 +1389,11 @@ public class Airavata {
public org.apache.airavata.model.appcatalog.appinterface.ApplicationInterfaceDescription getApplicationInterface(org.apache.airavata.model.security.AuthzToken authzToken, String appInterfaceId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Update a Application Interface.
*
* @param appInterfaceId
- * The identifier for the requested application deployment to be updated.
+ * The identifier of the requested application deployment to be updated.
*
* @param appInterface
* Application Interface Object created from the datamodel.
@@ -1240,7 +1402,6 @@ public class Airavata {
* Returns a success/failure of the update.
*
*
- *
* @param authzToken
* @param appInterfaceId
* @param applicationInterface
@@ -1248,7 +1409,8 @@ public class Airavata {
public boolean updateApplicationInterface(org.apache.airavata.model.security.AuthzToken authzToken, String appInterfaceId, org.apache.airavata.model.appcatalog.appinterface.ApplicationInterfaceDescription applicationInterface) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Delete a Application Interface.
+ *
+ * Delete an Application Interface.
*
* @param appInterfaceId
* The identifier for the requested application interface to be deleted.
@@ -1257,18 +1419,18 @@ public class Airavata {
* Returns a success/failure of the deletion.
*
*
- *
* @param authzToken
* @param appInterfaceId
*/
public boolean deleteApplicationInterface(org.apache.airavata.model.security.AuthzToken authzToken, String appInterfaceId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Fetch name and id of Application Interface documents.
+ *
+ * Fetch name and ID of Application Interface documents.
*
*
* @return map<applicationId, applicationInterfaceNames>
- * Returns a list of application interfaces with corresponsing id's
+ * Returns a list of application interfaces with corresponsing ID's
*
*
* @param authzToken
@@ -1277,11 +1439,12 @@ public class Airavata {
public Map<String,String> getAllApplicationInterfaceNames(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Fetch all Application Interface documents.
*
*
* @return map<applicationId, applicationInterfaceNames>
- * Returns a list of application interfaces documents
+ * Returns a list of application interfaces documents (Application Interface ID, name, description, Inputs and Outputs objects).
*
*
* @param authzToken
@@ -1290,10 +1453,11 @@ public class Airavata {
public List<org.apache.airavata.model.appcatalog.appinterface.ApplicationInterfaceDescription> getAllApplicationInterfaces(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Fetch the list of Application Inputs.
*
* @param appInterfaceId
- * The identifier for the requested application interface
+ * The identifier of the application interface which need inputs to be fetched.
*
* @return list<application_interface_model.InputDataObjectType>
* Returns a list of application inputs.
@@ -1305,10 +1469,11 @@ public class Airavata {
public List<org.apache.airavata.model.application.io.InputDataObjectType> getApplicationInputs(org.apache.airavata.model.security.AuthzToken authzToken, String appInterfaceId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Fetch the list of Application Outputs.
+ *
+ * Fetch list of Application Outputs.
*
* @param appInterfaceId
- * The identifier for the requested application interface
+ * The identifier of the application interface which need outputs to be fetched.
*
* @return list<application_interface_model.OutputDataObjectType>
* Returns a list of application outputs.
@@ -1320,14 +1485,15 @@ public class Airavata {
public List<org.apache.airavata.model.application.io.OutputDataObjectType> getApplicationOutputs(org.apache.airavata.model.security.AuthzToken authzToken, String appInterfaceId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Fetch a list of all deployed Compute Hosts for a given application interfaces.
*
* @param appInterfaceId
- * The identifier for the requested application interface
+ * The identifier for the requested application interface.
*
* @return map<computeResourceId, computeResourceName>
* A map of registered compute resource id's and their corresponding hostnames.
- * Deployments of each modules listed within the interfaces will be listed.
+ * Deployments of each modules listed within the interfaces will be listed.
*
*
* @param authzToken
@@ -1366,6 +1532,7 @@ public class Airavata {
public org.apache.airavata.model.appcatalog.computeresource.ComputeResourceDescription getComputeResource(org.apache.airavata.model.security.AuthzToken authzToken, String computeResourceId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Fetch all registered Compute Resources.
*
* @return A map of registered compute resource id's and thier corresponding hostnames.
@@ -1452,7 +1619,7 @@ public class Airavata {
public Map<String,String> getAllStorageResourceNames(org.apache.airavata.model.security.AuthzToken authzToken) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Update a Compute Resource.
+ * Update a Storage Resource.
*
* @param storageResourceId
* The identifier for the requested compute resource to be updated.
@@ -1474,7 +1641,7 @@ public class Airavata {
* Delete a Storage Resource.
*
* @param storageResourceId
- * The identifier for the requested compute resource to be deleted.
+ * The identifier of the requested compute resource to be deleted.
*
* @return status
* Returns a success/failure of the deletion.
@@ -1601,6 +1768,7 @@ public class Airavata {
public org.apache.airavata.model.appcatalog.computeresource.SSHJobSubmission getSSHJobSubmission(org.apache.airavata.model.security.AuthzToken authzToken, String jobSubmissionId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Add a UNICORE Job Submission details to a compute resource
* App catalog will return a jobSubmissionInterfaceId which will be added to the jobSubmissionInterfaces.
*
@@ -1625,10 +1793,13 @@ public class Airavata {
public String addUNICOREJobSubmissionDetails(org.apache.airavata.model.security.AuthzToken authzToken, String computeResourceId, int priorityOrder, org.apache.airavata.model.appcatalog.computeresource.UnicoreJobSubmission unicoreJobSubmission) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ * *
* * This method returns UnicoreJobSubmission object
+ * *
* * @param jobSubmissionInterfaceId
* * The identifier of the JobSubmission Interface to be retrieved.
* * @return UnicoreJobSubmission instance
+ * *
* *
*
* @param authzToken
@@ -1637,6 +1808,7 @@ public class Airavata {
public org.apache.airavata.model.appcatalog.computeresource.UnicoreJobSubmission getUnicoreJobSubmission(org.apache.airavata.model.security.AuthzToken authzToken, String jobSubmissionId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ * *
* * Add a Cloud Job Submission details to a compute resource
* * App catalog will return a jobSubmissionInterfaceId which will be added to the jobSubmissionInterfaces.
* *
@@ -1651,6 +1823,7 @@ public class Airavata {
* *
* * @return status
* * Returns the unique job submission id.
+ * *
* *
*
* @param authzToken
@@ -1661,6 +1834,7 @@ public class Airavata {
public String addCloudJobSubmissionDetails(org.apache.airavata.model.security.AuthzToken authzToken, String computeResourceId, int priorityOrder, org.apache.airavata.model.appcatalog.computeresource.CloudJobSubmission cloudSubmission) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ * *
* * This method returns cloudJobSubmission object
* * @param jobSubmissionInterfaceI
* * The identifier of the JobSubmission Interface to be retrieved.
@@ -1673,6 +1847,7 @@ public class Airavata {
public org.apache.airavata.model.appcatalog.computeresource.CloudJobSubmission getCloudJobSubmission(org.apache.airavata.model.security.AuthzToken authzToken, String jobSubmissionId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Update the given SSH Job Submission details
*
* @param jobSubmissionInterfaceId
@@ -1692,6 +1867,7 @@ public class Airavata {
public boolean updateSSHJobSubmissionDetails(org.apache.airavata.model.security.AuthzToken authzToken, String jobSubmissionInterfaceId, org.apache.airavata.model.appcatalog.computeresource.SSHJobSubmission sshJobSubmission) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Update the cloud Job Submission details
*
* @param jobSubmissionInterfaceId
@@ -1711,6 +1887,7 @@ public class Airavata {
public boolean updateCloudJobSubmissionDetails(org.apache.airavata.model.security.AuthzToken authzToken, String jobSubmissionInterfaceId, org.apache.airavata.model.appcatalog.computeresource.CloudJobSubmission sshJobSubmission) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Update the UNIOCRE Job Submission details
*
* @param jobSubmissionInterfaceId
@@ -1731,6 +1908,7 @@ public class Airavata {
public boolean updateUnicoreJobSubmissionDetails(org.apache.airavata.model.security.AuthzToken authzToken, String jobSubmissionInterfaceId, org.apache.airavata.model.appcatalog.computeresource.UnicoreJobSubmission unicoreJobSubmission) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Add a Local data movement details to a compute resource
* App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
*
@@ -1760,6 +1938,7 @@ public class Airavata {
public String addLocalDataMovementDetails(org.apache.airavata.model.security.AuthzToken authzToken, String resourceId, org.apache.airavata.model.data.movement.DMType dataMoveType, int priorityOrder, org.apache.airavata.model.data.movement.LOCALDataMovement localDataMovement) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Update the given Local data movement details
*
* @param dataMovementInterfaceId
@@ -1780,7 +1959,8 @@ public class Airavata {
public boolean updateLocalDataMovementDetails(org.apache.airavata.model.security.AuthzToken authzToken, String dataMovementInterfaceId, org.apache.airavata.model.data.movement.LOCALDataMovement localDataMovement) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * This method returns local datamovement object
+ *
+ * This method returns local datamovement object.
*
* @param dataMovementId
* The identifier of the datamovement Interface to be retrieved.
@@ -1795,6 +1975,7 @@ public class Airavata {
public org.apache.airavata.model.data.movement.LOCALDataMovement getLocalDataMovement(org.apache.airavata.model.security.AuthzToken authzToken, String dataMovementId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Add a SCP data movement details to a compute resource
* App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
*
@@ -1820,6 +2001,7 @@ public class Airavata {
public String addSCPDataMovementDetails(org.apache.airavata.model.security.AuthzToken authzToken, String resourceId, org.apache.airavata.model.data.movement.DMType dataMoveType, int priorityOrder, org.apache.airavata.model.data.movement.SCPDataMovement scpDataMovement) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Update the given scp data movement details
* App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
*
@@ -1855,6 +2037,7 @@ public class Airavata {
public org.apache.airavata.model.data.movement.SCPDataMovement getSCPDataMovement(org.apache.airavata.model.security.AuthzToken authzToken, String dataMovementId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Add a UNICORE data movement details to a compute resource
* App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
*
@@ -1880,6 +2063,7 @@ public class Airavata {
public String addUnicoreDataMovementDetails(org.apache.airavata.model.security.AuthzToken authzToken, String resourceId, org.apache.airavata.model.data.movement.DMType dataMoveType, int priorityOrder, org.apache.airavata.model.data.movement.UnicoreDataMovement unicoreDataMovement) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Update a selected UNICORE data movement details
* App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
*
@@ -1901,6 +2085,7 @@ public class Airavata {
public boolean updateUnicoreDataMovementDetails(org.apache.airavata.model.security.AuthzToken authzToken, String dataMovementInterfaceId, org.apache.airavata.model.data.movement.UnicoreDataMovement unicoreDataMovement) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* This method returns UNICORE datamovement object
*
* @param dataMovementId
@@ -1916,6 +2101,7 @@ public class Airavata {
public org.apache.airavata.model.data.movement.UnicoreDataMovement getUnicoreDataMovement(org.apache.airavata.model.security.AuthzToken authzToken, String dataMovementId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Add a GridFTP data movement details to a compute resource
* App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
*
@@ -2134,7 +2320,7 @@ public class Airavata {
* Fetch the given Gateway Resource Profile.
*
* @param gatewayID
- * The identifier for the requested gateway resource
+ * The identifier for the requested gateway resource.
*
* @return gatewayResourceProfile
* Gateway Resource Profile Object.
@@ -2203,9 +2389,32 @@ public class Airavata {
*/
public boolean addGatewayComputeResourcePreference(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayID, String computeResourceId, org.apache.airavata.model.appcatalog.gatewayprofile.ComputeResourcePreference computeResourcePreference) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
+ /**
+ * Add a Storage Resource Preference to a registered gateway profile.
+ *
+ * @param gatewayID
+ * The identifier of the gateway profile to be added.
+ *
+ * @param storageResourceId
+ * Preferences related to a particular compute resource
+ *
+ * @param computeResourcePreference
+ * The ComputeResourcePreference object to be added to the resource profile.
+ *
+ * @return status
+ * Returns a success/failure of the addition. If a profile already exists, this operation will fail.
+ * Instead an update should be used.
+ *
+ *
+ * @param authzToken
+ * @param gatewayID
+ * @param storageResourceId
+ * @param storagePreference
+ */
public boolean addGatewayStoragePreference(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayID, String storageResourceId, org.apache.airavata.model.appcatalog.gatewayprofile.StoragePreference storagePreference) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Fetch a Compute Resource Preference of a registered gateway profile.
*
* @param gatewayID
@@ -2224,9 +2433,28 @@ public class Airavata {
*/
public org.apache.airavata.model.appcatalog.gatewayprofile.ComputeResourcePreference getGatewayComputeResourcePreference(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayID, String computeResourceId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
+ /**
+ *
+ * Fetch a Storage Resource Preference of a registered gateway profile.
+ *
+ * @param gatewayID
+ * The identifier of the gateway profile to request to fetch the particular storage resource preference.
+ *
+ * @param storageResourceId
+ * Identifier of the Stprage Preference required to be fetched.
+ *
+ * @return StoragePreference
+ * Returns the StoragePreference object.
+ *
+ *
+ * @param authzToken
+ * @param gatewayID
+ * @param storageResourceId
+ */
public org.apache.airavata.model.appcatalog.gatewayprofile.StoragePreference getGatewayStoragePreference(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayID, String storageResourceId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
+ *
* Fetch all Compute Resource Preferences of a registered gateway profile.
*
* @param gatewayID
@@ -2241,10 +2469,28 @@ public class Airavata {
*/
public List<org.apache.airavata.model.appcatalog.gatewayprofile.ComputeResourcePreference> getAllGatewayComputeResourcePreferences(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayID) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
+ /**
+ * Fetch all Storage Resource Preferences of a registered gateway profile.
+ *
+ * @param gatewayID
+ * The identifier for the gateway profile to be requested
+ *
+ * @return StoragePreference
+ * Returns the StoragePreference object.
+ *
+ *
+ * @param authzToken
+ * @param gatewayID
+ */
public List<org.apache.airavata.model.appcatalog.gatewayprofile.StoragePreference> getAllGatewayStoragePreferences(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayID) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * Fetch all gateway profiles registered
+ *
+ * Fetch all Gateway Profiles registered
+ *
+ * @return GatewayResourceProfile
+ * Returns all the GatewayResourcePrifle list object.
+ *
*
*
* @param authzToken
@@ -2274,6 +2520,27 @@ public class Airavata {
*/
public boolean updateGatewayComputeResourcePreference(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayID, String computeResourceId, org.apache.airavata.model.appcatalog.gatewayprofile.ComputeResourcePreference computeResourcePreference) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
+ /**
+ * Update a Storage Resource Preference of a registered gateway profile.
+ *
+ * @param gatewayID
+ * The identifier of the gateway profile to be updated.
+ *
+ * @param storageId
+ * The Storage resource identifier of the one that you want to update
+ *
+ * @param storagePreference
+ * The storagePreference object to be updated to the resource profile.
+ *
+ * @return status
+ * Returns a success/failure of the updation.
+ *
+ *
+ * @param authzToken
+ * @param gatewayID
+ * @param storageId
+ * @param storagePreference
+ */
public boolean updateGatewayStoragePreference(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayID, String storageId, org.apache.airavata.model.appcatalog.gatewayprofile.StoragePreference storagePreference) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
@@ -2295,24 +2562,67 @@ public class Airavata {
*/
public boolean deleteGatewayComputeResourcePreference(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayID, String computeResourceId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
+ /**
+ * Delete the Storage Resource Preference of a registered gateway profile.
+ *
+ * @param gatewayID
+ * The identifier of the gateway profile to be deleted.
+ *
+ * @param storageId
+ * ID of the storage preference you want to delete.
+ *
+ * @return status
+ * Returns a success/failure of the deletion.
+ *
+ *
+ * @param authzToken
+ * @param gatewayID
+ * @param storageId
+ */
public boolean deleteGatewayStoragePreference(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayID, String storageId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
+ /**
+ * Delete the Storage Resource Preference of a registered gateway profile.
+ *
+ * @param gatewayID
+ * The identifier of the gateway profile to be deleted.
+ *
+ * @param storageId
+ * ID of the storage preference you want to delete.
+ *
+ * @return status
+ * Returns a success/failure of the deletion.
+ *
+ *
+ * @param authzToken
+ * @param gatewayId
+ */
public List<String> getAllWorkflows(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
- public org.apache.airavata.model.Workflow getWorkflow(org.apache.airavata.model.security.AuthzToken authzToken, String workflowTemplateId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
+ /**
+ *
+ * API Methods Related for Work-Flow Submission Features.
+ *
+ *
+ * @param authzToken
+ * @param workflowTemplateId
+ */
+ public org.apache.airavata.model.WorkflowModel getWorkflow(org.apache.airavata.model.security.AuthzToken authzToken, String workflowTemplateId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
public void deleteWorkflow(org.apache.airavata.model.security.AuthzToken authzToken, String workflowTemplateId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
- public String registerWorkflow(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, org.apache.airavata.model.Workflow workflow) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
+ public String registerWorkflow(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, org.apache.airavata.model.WorkflowModel workflow) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
- public void updateWorkflow(org.apache.airavata.model.security.AuthzToken authzToken, String workflowTemplateId, org.apache.airavata.model.Workflow workflow) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
+ public void updateWorkflow(org.apache.airavata.model.security.AuthzToken authzToken, String workflowTemplateId, org.apache.airavata.model.WorkflowModel workflow) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
public String getWorkflowTemplateId(org.apache.airavata.model.security.AuthzToken authzToken, String workflowName) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
public boolean isWorkflowExistWithName(org.apache.airavata.model.security.AuthzToken authzToken, String workflowName) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException;
/**
- * * Data Manager Related API Methods
+ * *
+ * * Data Manager Related API Methods.
+ * *
* *
*
* @param authzToken
@@ -2592,9 +2902,9 @@ public class Airavata {
public void deleteWorkflow(org.apache.airavata.model.security.AuthzToken authzToken, String workflowTemplateId, org.apache.thrift.async.AsyncMethodCallback resultHandler) throws org.apache.thrift.TException;
- public void registerWorkflow(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, org.apache.airavata.model.Workflow workflow, org.apache.thrift.async.AsyncMethodCallback resultHandler) throws org.apache.thrift.TException;
+ public void registerWorkflow(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, org.apache.airavata.model.WorkflowModel workflow, org.apache.thrift.async.AsyncMethodCallback resultHandler) throws org.apache.thrift.TException;
- public void updateWorkflow(org.apache.airavata.model.security.AuthzToken authzToken, String workflowTemplateId, org.apache.airavata.model.Workflow workflow, org.apache.thrift.async.AsyncMethodCallback resultHandler) throws org.apache.thrift.TException;
+ public void updateWorkflow(org.apache.airavata.model.security.AuthzToken authzToken, String workflowTemplateId, org.apache.airavata.model.WorkflowModel workflow, org.apache.thrift.async.AsyncMethodCallback resultHandler) throws org.apache.thrift.TException;
public void getWorkflowTemplateId(org.apache.airavata.model.security.AuthzToken authzToken, String workflowName, org.apache.thrift.async.AsyncMethodCallback resultHandler) throws org.apache.thrift.TException;
@@ -7310,7 +7620,7 @@ public class Airavata {
throw new org.apache.thrift.TApplicationException(org.apache.thrift.TApplicationException.MISSING_RESULT, "getAllWorkflows failed: unknown result");
}
- public org.apache.airavata.model.Workflow getWorkflow(org.apache.airavata.model.security.AuthzToken authzToken, String workflowTemplateId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException
+ public org.apache.airavata.model.WorkflowModel getWorkflow(org.apache.airavata.model.security.AuthzToken authzToken, String workflowTemplateId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientExcepti
<TRUNCATED>