http://git-wip-us.apache.org/repos/asf/airavata-php-gateway/blob/d55608f1/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 deleted file mode 100644 index 540911f..0000000 --- a/airavata-api/airavata-api-stubs/src/main/java/org/apache/airavata/api/Airavata.java +++ /dev/null @@ -1,261412 +0,0 @@ -/** - * 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. - */ - -/** - * Autogenerated by Thrift Compiler (0.9.3) - * - * DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING - * @generated - */ -package org.apache.airavata.api; - -import org.apache.thrift.scheme.IScheme; -import org.apache.thrift.scheme.SchemeFactory; -import org.apache.thrift.scheme.StandardScheme; - -import org.apache.thrift.scheme.TupleScheme; -import org.apache.thrift.protocol.TTupleProtocol; -import org.apache.thrift.protocol.TProtocolException; -import org.apache.thrift.EncodingUtils; -import org.apache.thrift.TException; -import org.apache.thrift.async.AsyncMethodCallback; -import org.apache.thrift.server.AbstractNonblockingServer.*; -import java.util.List; -import java.util.ArrayList; -import java.util.Map; -import java.util.HashMap; -import java.util.EnumMap; -import java.util.Set; -import java.util.HashSet; -import java.util.EnumSet; -import java.util.Collections; -import java.util.BitSet; -import java.nio.ByteBuffer; -import java.util.Arrays; -import javax.annotation.Generated; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -@SuppressWarnings({"cast", "rawtypes", "serial", "unchecked"}) -@Generated(value = "Autogenerated by Thrift Compiler (0.9.3)") -public class Airavata { - - public interface Iface { - - /** - * Fetch Apache Airavata API version - * - * - * @param authzToken - */ - public String getAPIVersion(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; - - /** - * Verify if User Exists within Airavata. - * - * @param gatewayId - * - * @param userName - * - * @return true/false - * - * - * - * @param authzToken - * @param gatewayId - * @param userName - */ - public boolean isUserExists(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, String userName) 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 Gateway with Airavata. - * - * @param gateway - * The gateway data model. - * - * @return gatewayId - * Th unique identifier of the newly registered gateway. - * - * - * - * @param authzToken - * @param gateway - */ - public String addGateway(org.apache.airavata.model.security.AuthzToken authzToken, org.apache.airavata.model.workspace.Gateway gateway) 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 users in the gateway - * - * @param gatewayId - * The gateway data model. - * - * @return users - * list of usernames of the users in the gateway - * - * - * - * @param authzToken - * @param gatewayId - */ - public List<String> getAllUsersInGateway(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; - - /** - * Update previously registered Gateway metadata. - * - * @param gatewayId - * The gateway Id of the Gateway which require an update. - * - * @return gateway - * Modified gateway obejct. - * - * @exception AiravataClientException - * - * - * - * @param authzToken - * @param gatewayId - * @param updatedGateway - */ - public boolean updateGateway(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, org.apache.airavata.model.workspace.Gateway updatedGateway) 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 Gateway details by providing gatewayId - * - * @param gatewayId - * The gateway Id of the Gateway. - * - * @return gateway - * Gateway obejct. - * - * - * - * @param authzToken - * @param gatewayId - */ - public org.apache.airavata.model.workspace.Gateway getGateway(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 Gateway - * - * @param gatewayId - * The gateway Id of the Gateway to be deleted. - * - * @return boolean - * Boolean identifier for the success or failure of the deletion operation. - * - * - * - * @param authzToken - * @param gatewayId - */ - public boolean deleteGateway(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; - - /** - * Get All the Gateways Connected to Airavata. - * - * - * @param authzToken - */ - public List<org.apache.airavata.model.workspace.Gateway> getAllGateways(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; - - /** - * Check for the Existance of a Gateway within Airavata - * - * @param gatewayId - * Provide the gatewayId of the gateway you want to check the existancy - * - * @return boolean - * Boolean idetifier for the existance or non-existane of the gatewayId - * - * @return gatewayId - * return the gatewayId of the existing gateway. - * - * - * - * @param authzToken - * @param gatewayId - */ - public boolean isGatewayExist(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; - - /** - * * API methods to retrieve notifications - * * - * - * @param authzToken - * @param notification - */ - public String createNotification(org.apache.airavata.model.security.AuthzToken authzToken, org.apache.airavata.model.workspace.Notification notification) 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 updateNotification(org.apache.airavata.model.security.AuthzToken authzToken, org.apache.airavata.model.workspace.Notification notification) 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 deleteNotification(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, String notificationId) 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.workspace.Notification getNotification(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, String notificationId) 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 List<org.apache.airavata.model.workspace.Notification> getAllNotifications(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; - - /** - * Generate and Register SSH Key Pair with Airavata Credential Store. - * - * @param gatewayId - * The identifier for the requested Gateway. - * - * @param userName - * The User for which the credential should be registered. For community accounts, this user is the name of the - * community user name. For computational resources, this user name need not be the same user name on resoruces. - * - * @param description - * The description field for a credential type, all type of credential can have a description. - * - * @param credentialOwnerType - * The type of owner of this credential. Two possible values: GATEWAY (default) and USER - * - * @return airavataCredStoreToken - * An SSH Key pair is generated and stored in the credential store and associated with users or community account - * belonging to a Gateway. - * - * - * - * @param authzToken - * @param gatewayId - * @param userName - * @param description - * @param credentialOwnerType - */ - public String generateAndRegisterSSHKeys(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, String userName, String description, org.apache.airavata.credential.store.datamodel.CredentialOwnerType credentialOwnerType) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.thrift.TException; - - /** - * Generate and Register Username PWD Pair with Airavata Credential Store. - * - * @param gatewayId - * The identifier for the requested Gateway. - * - * @param portalUserName - * The User for which the credential should be registered. For community accounts, this user is the name of the - * community user name. For computational resources, this user name need not be the same user name on resoruces. - * - * @param loginUserName - * - * @param password - * - * @return airavataCredStoreToken - * An SSH Key pair is generated and stored in the credential store and associated with users or community account - * belonging to a Gateway. - * - * - * - * @param authzToken - * @param gatewayId - * @param portalUserName - * @param loginUserName - * @param password - * @param description - */ - public String registerPwdCredential(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, String portalUserName, String loginUserName, String password, String description) 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 - * Credential Store Token which you want to find the Public Key for. - * - * @param gatewayId - * This is the unique identifier of your gateway where the token and public key was generated from. - * - * @return publicKey - * - * - * - * @param authzToken - * @param airavataCredStoreToken - * @param gatewayId - */ - 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 all Public Keys of the Gateway - * - * @param CredStoreToken - * Credential Store Token which you want to find the Public Key for. - * - * @param gatewayId - * This is the unique identifier of your gateway where the token and public key was generated from. - * - * @return publicKey - * - * - * - * @param authzToken - * @param gatewayId - */ - 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; - - /** - * - * Get all Public Keys of the Gateway - * - * @param CredStoreToken - * Credential Store Token which you want to find the Public Key for. - * - * @param gatewayId - * This is the unique identifier of your gateway where the token and public key was generated from. - * - * @return publicKey - * - * - * - * @param authzToken - * @param gatewayId - */ - public List<org.apache.airavata.model.appcatalog.credentialsummary.CredentialSummary> getAllGatewaySSHPubKeysSummary(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; - - /** - * - * Get all Public Key summaries for user in a Gateway - * - * @param CredStoreToken - * Credential Store Token which you want to find the Public Key for. - * - * @param gatewayId - * This is the unique identifier of your gateway where the token and public key was generated from. - * - * @param userId - * This is the unique identifier of user whose public keys are to be fetched. - * - * @return CredentialSummary - * - * - * - * @param authzToken - * @param gatewayId - * @param userId - */ - public List<org.apache.airavata.model.appcatalog.credentialsummary.CredentialSummary> getAllSSHPubKeysSummaryForUserInGateway(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, String userId) throws org.apache.airavata.model.error.InvalidRequestException, org.apache.airavata.model.error.AiravataClientException, org.apache.airavata.model.error.AiravataSystemException, org.apache.thrift.TException; - - public Map<String,String> getAllGatewayPWDCredentials(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 - * The gateway Id of the Gateway to be deleted. - * - * @return boolean - * Boolean identifier for the success or failure of the deletion operation. - * - * - * - * @param authzToken - * @param airavataCredStoreToken - * @param gatewayId - */ - 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; - - public boolean deletePWDCredential(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. - * - * @param gatewayId - * The identifier for the requested gateway. - * - * @param Project - * The Project Object described in the workspace_model. - * - * - * - * @param authzToken - * @param gatewayId - * @param project - */ - 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 - * The projectId of the project needed an update. - * - * @return void - * Currently this does not return any value. - * - * - * - * @param authzToken - * @param projectId - * @param updatedProject - */ - 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. - * - * @param projectId - * projectId of the project you require. - * - * @return project - * project data model will be returned. - * - * - * - * @param authzToken - * @param projectId - */ - 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. - * - * @param projectId - * 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 - * @param projectId - */ - 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 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. - * - * @param limit - * The amount results to be fetched. - * - * @param offset - * The starting point of the results to be fetched. - * - * - * - * @param authzToken - * @param gatewayId - * @param userName - * @param limit - * @param offset - */ - 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; - - /** - * - * Search User Projects - * Search and get all Projects for user by project description or/and project name with pagination. - * Results will be ordered based on creation time DESC. - * - * @param gatewayId - * The unique identifier of the gateway making the request. - * - * @param userName - * The identifier of the user. - * - * @param filters - * Map of multiple filter criteria. Currenlt search filters includes Project Name and Project Description - * - * @param limit - * The amount results to be fetched. - * - * @param offset - * The starting point of the results to be fetched. - * - * - * - * @param authzToken - * @param gatewayId - * @param userName - * @param filters - * @param limit - * @param offset - */ - public List<org.apache.airavata.model.workspace.Project> searchProjects(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, String userName, Map<org.apache.airavata.model.experiment.ProjectSearchFields,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; - - /** - * 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. - * - * @param userName - * Username of the user requesting the search function. - * - * @param filters - * Map of multiple filter criteria. Currenlt search filters includes Experiment Name, Description, Application, etc.... - * - * @param limit - * Amount of results to be fetched. - * - * @param offset - * 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 - * @param gatewayId - * @param userName - * @param filters - * @param limit - * @param offset - */ - 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 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 - * Unique identifier of the gateway making the request to fetch statistics. - * - * @param fromTime - * Starting date time. - * - * @param toTime - * Ending data time. - * - * @param userName - * Gateway username substring with which to further filter statistics. - * - * @param applicationName - * Application id substring with which to further filter statistics. - * - * @param resourceHostName - * Hostname id substring with which to further filter statistics. - * - * - * - * @param authzToken - * @param gatewayId - * @param fromTime - * @param toTime - * @param userName - * @param applicationName - * @param resourceHostName - */ - public org.apache.airavata.model.experiment.ExperimentStatistics getExperimentStatistics(org.apache.airavata.model.security.AuthzToken authzToken, String gatewayId, long fromTime, long toTime, String userName, String applicationName, String resourceHostName) 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 Experiments of the Project - * Get Experiments within project with pagination. Results will be sorted based on creation time DESC. - * - * @param projectId - * Uniqie identifier of the project. - * - * @param limit - * Amount of results to be fetched. - * - * @param offset - * The starting point of the results to be fetched. - * - * - * - * @param authzToken - * @param projectId - * @param limit - * @param offset - */ - 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 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. - * - * @param userName - * Username of the requested end user. - * - * @param limit - * Amount of results to be fetched. - * - * @param offset - * The starting point of the results to be fetched. - * - * - * - * @param authzToken - * @param gatewayId - * @param userName - * @param limit - * @param offset - */ - 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 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. - * * - * * @return - * * The server-side generated.airavata.registry.core.experiment.globally unique identifier. - * * - * * @throws org.apache.airavata.model.error.InvalidRequestException - * * For any incorrect forming of the request itself. - * * - * * @throws org.apache.airavata.model.error.AiravataClientException - * * The following list of exceptions are thrown which Airavata Client can take corrective actions to resolve: - * * - * * UNKNOWN_GATEWAY_ID - If a Gateway is not registered with Airavata as a one time administrative - * * step, then Airavata Registry will not have a provenance area setup. The client has to follow - * * gateway registration steps and retry this request. - * * - * * AUTHENTICATION_FAILURE - How Authentication will be implemented is yet to be determined. - * * For now this is a place holder. - * * - * * INVALID_AUTHORIZATION - This will throw an authorization exception. When a more robust security hand-shake - * * is implemented, the authorization will be more substantial. - * * - * * @throws org.apache.airavata.model.error.AiravataSystemException - * * This exception will be thrown for any Airavata Server side issues and if the problem cannot be corrected by the client - * * rather an Airavata Administrator will be notified to take corrective action. - * * - * * - * - * @param authzToken - * @param gatewayId - * @param experiment - */ - 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 - * If the experiment is not already launched experiment can be deleted. - * - * @param authzToken - * - * @param experiementId - * Experiment ID of the experimnet you want to delete. - * - * @return boolean - * Identifier for the success or failure of the deletion operation. - * - * - * - * @param authzToken - * @param experimentId - */ - 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 unique identifier of the requested experiment. This ID is returned during the create experiment step. - * * - * * @return ExperimentModel - * * This method will return the previously stored experiment metadata. - * * - * * @throws org.apache.airavata.model.error.InvalidRequestException - * * For any incorrect forming of the request itself. - * * - * * @throws org.apache.airavata.model.error.ExperimentNotFoundException - * * If the specified experiment is not previously created, then an Experiment Not Found Exception is thrown. - * * - * * @throws org.apache.airavata.model.error.AiravataClientException - * * The following list of exceptions are thrown which Airavata Client can take corrective actions to resolve: - * * - * * UNKNOWN_GATEWAY_ID - If a Gateway is not registered with Airavata as a one time administrative - * * step, then Airavata Registry will not have a provenance area setup. The client has to follow - * * gateway registration steps and retry this request. - * * - * * AUTHENTICATION_FAILURE - How Authentication will be implemented is yet to be determined. - * * For now this is a place holder. - * * - * * INVALID_AUTHORIZATION - This will throw an authorization exception. When a more robust security hand-shake - * * is implemented, the authorization will be more substantial. - * * - * * @throws org.apache.airavata.model.error.AiravataSystemException - * * This exception will be thrown for any Airavata Server side issues and if the problem cannot be corrected by the client - * * rather an Airavata Administrator will be notified to take corrective action. - * * - * * - * - * @param authzToken - * @param airavataExperimentId - */ - 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 Experiment by an admin user - * * - * * Used by an admin user to fetch previously created experiment metadata. - * * - * * @param airavataExperimentId - * * The unique identifier of the requested experiment. This ID is returned during the create experiment step. - * * - * * @return ExperimentModel - * * This method will return the previously stored experiment metadata. - * * - * * @throws org.apache.airavata.model.error.InvalidRequestException - * * For any incorrect forming of the request itself. - * * - * * @throws org.apache.airavata.model.error.ExperimentNotFoundException - * * If the specified experiment is not previously created, then an Experiment Not Found Exception is thrown. - * * - * * @throws org.apache.airavata.model.error.AiravataClientException - * * The following list of exceptions are thrown which Airavata Client can take corrective actions to resolve: - * * - * * UNKNOWN_GATEWAY_ID - If a Gateway is not registered with Airavata as a one time administrative - * * step, then Airavata Registry will not have a provenance area setup. The client has to follow - * * gateway registration steps and retry this request. - * * - * * AUTHENTICATION_FAILURE - How Authentication will be implemented is yet to be determined. - * * For now this is a place holder. - * * - * * INVALID_AUTHORIZATION - This will throw an authorization exception. When a more robust security hand-shake - * * is implemented, the authorization will be more substantial. - * * - * * @throws org.apache.airavata.model.error.AiravataSystemException - * * This exception will be thrown for any Airavata Server side issues and if the problem cannot be corrected by the client - * * rather an Airavata Administrator will be notified to take corrective action. - * * - * * - * - * @param authzToken - * @param airavataExperimentId - */ - public org.apache.airavata.model.experiment.ExperimentModel getExperimentByAdmin(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 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. - * - * @throws org.apache.airavata.model.error.ExperimentNotFoundException - * If the specified experiment is not previously created, then an Experiment Not Found Exception is thrown. - * - * @throws org.apache.airavata.model.error.AiravataClientException - * The following list of exceptions are thrown which Airavata Client can take corrective actions to resolve: - * - * UNKNOWN_GATEWAY_ID - If a Gateway is not registered with Airavata as a one time administrative - * step, then Airavata Registry will not have a provenance area setup. The client has to follow - * gateway registration steps and retry this request. - * - * AUTHENTICATION_FAILURE - How Authentication will be implemented is yet to be determined. - * For now this is a place holder. - * - * INVALID_AUTHORIZATION - This will throw an authorization exception. When a more robust security hand-shake - * is implemented, the authorization will be more substantial. - * - * @throws org.apache.airavata.model.error.AiravataSystemException - * This exception will be thrown for any Airavata Server side issues and if the problem cannot be corrected by the client - * rather an Airavata Administrator will be notified to take corrective action. - * - * - * @param authzToken - * @param airavataExperimentId - */ - 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; - - /** - * - * 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 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. - * - * @return - * This method call does not have a return value. - * - * @throws org.apache.airavata.model.error.InvalidRequestException - * For any incorrect forming of the request itself. - * - * @throws org.apache.airavata.model.error.ExperimentNotFoundException - * If the specified experiment is not previously created, then an Experiment Not Found Exception is thrown. - * - * @throws org.apache.airavata.model.error.AiravataClientException - * The following list of exceptions are thrown which Airavata Client can take corrective actions to resolve: - * - * UNKNOWN_GATEWAY_ID - If a Gateway is not registered with Airavata as a one time administrative - * step, then Airavata Registry will not have a provenance area setup. The client has to follow - * gateway registration steps and retry this request. - * - * AUTHENTICATION_FAILURE - How Authentication will be implemented is yet to be determined. - * For now this is a place holder. - * - * INVALID_AUTHORIZATION - This will throw an authorization exception. When a more robust security hand-shake - * is implemented, the authorization will be more substantial. - * - * @throws org.apache.airavata.model.error.AiravataSystemException - * This exception will be thrown for any Airavata Server side issues and if the problem cannot be corrected by the client - * rather an Airavata Administrator will be notified to take corrective action. - * - * - * @param authzToken - * @param airavataExperimentId - * @param experiment - */ - public void updateExperiment(org.apache.airavata.model.security.AuthzToken authzToken, String airavataExperimentId, org.apache.airavata.model.experiment.ExperimentModel experiment) 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; - - public void updateExperimentConfiguration(org.apache.airavata.model.security.AuthzToken authzToken, String airavataExperimentId, org.apache.airavata.model.experiment.UserConfigurationDataModel userConfiguration) throws org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException; - - public void updateResourceScheduleing(org.apache.airavata.model.security.AuthzToken authzToken, String airavataExperimentId, org.apache.airavata.model.scheduling.ComputationalResourceSchedulingModel resourceScheduling) throws org.apache.airavata.model.error.AuthorizationException, org.apache.thrift.TException; - - /** - * * - * * 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. - * * - * * - * - * @param authzToken - * @param airavataExperimentId - */ - 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 & 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. - * - * @return - * This method call does not have a return value. - * - * @throws org.apache.airavata.model.error.InvalidRequestException - * For any incorrect forming of the request itself. - * - * @throws org.apache.airavata.model.error.ExperimentNotFoundException - * If the specified experiment is not previously created, then an Experiment Not Found Exception is thrown. - * - * @throws org.apache.airavata.model.error.AiravataClientException - * The following list of exceptions are thrown which Airavata Client can take corrective actions to resolve: - * - * UNKNOWN_GATEWAY_ID - If a Gateway is not registered with Airavata as a one time administrative - * step, then Airavata Registry will not have a provenance area setup. The client has to follow - * gateway registration steps and retry this request. - * - * AUTHENTICATION_FAILURE - How Authentication will be implemented is yet to be determined. - * For now this is a place holder. - * - * INVALID_AUTHORIZATION - This will throw an authorization exception. When a more robust security hand-shake - * is implemented, the authorization will be more substantial. - * - * @throws org.apache.airavata.model.error.AiravataSystemException - * This exception will be thrown for any Airavata Server side issues and if the problem cannot be corrected by the client - * rather an Airavata Administrator will be notified to take corrective action. - * - * - * @param authzToken - * @param airavataExperimentId - * @param gatewayId - */ - 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 of an experiment by providing the Experiment Id - * - * @param authzToken - * - * @param airavataExperimentId - * Experiment ID of the experimnet you require the status. - * - * @return ExperimentStatus - * ExperimentStatus model with the current status will be returned. - * - * - * - * @param authzToken - * @param airavataExperimentId - */ - 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 final outputs of a certain Experiment - * - * @param authzToken - * - * @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. - * - * - * - * @param authzToken - * @param airavataExperimentId - */ - 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 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. - * - * - * - * @param authzToken - * @param airavataExperimentId - */ - 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 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 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 - * - * - * - * @param authzToken - * @param airavataExperimentId - */ - 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. - * 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. - * - * @return list of JobDetails - * Job details. - * - * - * - * @param authzToken - * @param airavataExperimentId - */ - 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 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 - * experiment name that should be used in the cloned experiment - * - * @param updatedExperiment - * Once an experiment is cloned, to disambiguate, the users are suggested to provide new metadata. This will again require - * the basic experiment metadata like the name and description, intended user, the gateway identifier and if the experiment - * should be shared public by default. - * @param newExperimentProjectId - * The project in which to create the cloned experiment. This is optional and if null the experiment will be created - * in the same project as the existing experiment. - * - * @return - * 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. - * - * @throws org.apache.airavata.model.error.ExperimentNotFoundException - * If the specified experiment is not previously created, then an Experiment Not Found Exception is thrown. - * - * @throws org.apache.airavata.model.error.AiravataClientException - * The following list of exceptions are thrown which Airavata Client can take corrective actions to resolve: - * - * UNKNOWN_GATEWAY_ID - If a Gateway is not registered with Airavata as a one time administrative - * step, then Airavata Registry will not have a provenance area setup. The client has to follow - * gateway registration steps and retry this request. - * - * AUTHENTICATION_FAILURE - How Authentication will be implemented is yet to be determined. - * For now this is a place holder. - * - * INVALID_AUTHORIZATION - This will throw an authorization exception. When a more robust security hand-shake - * is implemented, the authorization will be more substantial. - * - * @throws org.apache.airavata.model.error.AiravataSystemException - * This exception will be thrown for any Airavata Server side issues and if the problem cannot be corrected by the client - * rather an Airavata Administrator will be notified to take corrective action. - * - * - * @param authzToken - * @param existingExperimentID - * @param newExperimentName - * @param newExperimentProjectId - */ - public String cloneExperiment(org.apache.airavata.model.security.AuthzToken authzToken, String existingExperimentID, String newExperimentName, String newExperimentProjectId) 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.airavata.model.error.ProjectNotFoundException, org.apache.thrift.TException; - - /** - * - * Clone an Existing Experiment by an admin user - * 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 - * experiment name that should be used in the cloned experiment - * - * @param updatedExperiment - * Once an experiment is cloned, to disambiguate, the users are suggested to provide new metadata. This will again require - * the basic experiment metadata like the name and description, intended user, the gateway identifier and if the experiment - * should be shared public by default. - * @param newExperimentProjectId - * The project in which to create the cloned experiment. This is optional and if null the experiment will be created - * in the same project as the existing experiment. - * - * @return - * 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. - * - * @throws org.apache.airavata.model.error.ExperimentNotFoundException - * If the specified experiment is not previously created, then an Experiment Not Found Exception is thrown. - * - * @throws org.apache.airavata.model.error.AiravataClientException - * The following list of exceptions are thrown which Airavata Client can take corrective actions to resolve: - * - * UNKNOWN_GATEWAY_ID - If a Gateway is not registered with Airavata as a one time administrative - * step, then Airavata Registry will not have a provenance area setup. The client has to follow - * gateway registration steps and retry this request. - * - * AUTHENTICATION_FAILURE - How Authentication will be implemented is yet to be determined. - * For now this is a place holder. - * - * INVALID_AUTHORIZATION - This will throw an authorization exception. When a more robust security hand-shake - * is implemented, the authorization will be more substantial. - * - * @throws org.apache.airavata.model.error.AiravataSystemException - * This exception will be thrown for any Airavata Server side issues and if the problem cannot be corrected by the client - * rather an Airavata Administrator will be notified to take corrective action. - * - * - * @param authzToken - * @param existingExperimentID - * @param newExperimentName - * @param newExperimentProjectId - */ - public String cloneExperimentByAdmin(org.apache.airavata.model.security.AuthzToken authzToken, String existingExperimentID, String newExperimentName, String newExperimentProjectId) 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.airavata.model.error.ProjectNotFoundException, org.apache.thrift.TException; - - /** - * - * Terminate a running Experiment. - * - * @gatewayId - * ID of the gateway which will terminate the running Experiment. - * - * @param airavataExperimentId - * The identifier of the experiment required termination. This ID is returned during the create experiment step. - * - * @return status - * This method call does not have a return value. - * - * @throws org.apache.airavata.model.error.InvalidRequestException - * For any incorrect forming of the request itself. - * - * @throws org.apache.airavata.model.error.ExperimentNotFoundException - * If the specified experiment is not previously created, then an Experiment Not Found Exception is thrown. - * - * @throws org.apache.airavata.model.error.AiravataClientException - * The following list of exceptions are thrown which Airavata Client can take corrective actions to resolve: - * - * UNKNOWN_GATEWAY_ID - If a Gateway is not registered with Airavata as a one time administrative - * step, then Airavata Registry will not have a provenance area setup. The client has to follow - * gateway registration steps and retry this request. - * - * AUTHENTICATION_FAILURE - How Authentication will be implemented is yet to be determined. - * For now this is a place holder. - * - * INVALID_AUTHORIZATION - This will throw an authorization exception. When a more robust security hand-shake - * is implemented, the authorization will be more substantial. - * - * @throws org.apache.airavata.model.error.AiravataSystemException - * This exception will be thrown for any Airavata Server side issues and if the problem cannot be corrected by the client - * rather an Airavata Administrator will be notified to take corrective action. - * - * - * @param authzToken - * @param airavataExperimentId - * @param gatewayId - */ - 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 the server-side generated airavata appModule globally unique identifier. - * - * - * @param authzToken - * @param gatewayId - * @param applicationModule - */ - 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 unique identifier of the application module required - * - * @return applicationModule - * Returns an Application Module Object. - * - * - * @param authzToken - * @param appModuleId - */ - 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 - * The identifier for the requested application module to be updated. - * - * @param applicationModule - * Application Module Object created from the datamodel. - * - * @return status - * Returns a success/failure of the update. - * - * - * @param authzToken - * @param appModuleId - * @param applicationModule - */ - 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 an Application Module. - * - * @param appModuleId - * The identifier of the Application Module to be deleted. - * - * @return status - * Returns a success/failure of the deletion. - * - * - * @param authzToken - * @param appModuleId - */ - 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 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 - * Returns a server-side generated airavata appDeployment globally unique identifier. - * - * - * @param authzToken - * @param gatewayId - * @param applicationDeployment - */ - 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 - * The identifier for the requested application module - * - * @return applicationDeployment - * Returns a application Deployment Object. - * - * - * @param authzToken - * @param appDeploymentId - */ - 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 an Application Deployment. - * - * @param appDeploymentId - * The identifier of the requested application deployment to be updated. - * - * @param appDeployment - * Application Deployment Object created from the datamodel. - * - * @return status - * Returns a success/failure of the update. - * - * - * @param authzToken - * @param appDeploymentId - * @param applicationDeployment - */ - 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 an Application Deployment. - * - * @param appDeploymentId - * The unique identifier of application deployment to be deleted. - * - * @return status - * Returns a success/failure of the deletion. - * - * - * @param authzToken - * @param appDeploymentId - */ - 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. - * - * - * @param authzToken - * @param gatewayId - */ - public List<org.apache.airavata.model.appcatalog.appdeployment.ApplicationDeploymentDescription> getAllApplicationDeployments(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 a list of Deployed Compute Hosts. - * - * @param appModuleId - * The identifier for the requested application module - * - * @return list<string> - * Returns a list of Deployed Resources. - * - * - * @param authzToken - * @param appModuleId - */ - 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 applicationInterface - * Application Module Object created from the datamodel. - * - * @return appInterfaceId - * Returns a server-side generated airavata application interface globally unique identifier. - * - * - * @param authzToken - * @param gatewayId - * @param applicationInterface - */ - 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 an Application Interface. - * - * @param appInterfaceId - * The identifier for the requested application interface. - * - * @return applicationInterface - * Returns an application Interface Object. - * - * - * @param authzToken - * @param appInterfaceId - */ - 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 of the requested application deployment to be updated. - * - * @param appInterface - * Application Interface Object created from the datamodel. - * - * @return status - * Returns a success/failure of the update. - * - * - * @param authzToken - * @param appInterfaceId - * @param applicationInterface - */ - 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 an Application Interface. - * - * @param appInterfaceId - * The identifier for the requested application interface to be deleted. - * - * @return status - * 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. - * - * - * @return map<applicationId, applicationInterfaceNames> - * Returns a list of application interfaces with corresponsing ID's - * - * - * @param authzToken - * @param gatewayId - */ - 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 (Application Interface ID, name, description, Inputs and Outputs objects). - * - * - * @param authzToken - * @param gatewayId - */ - 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 of the application interface which need inputs to be fetched. - * - * @return list<application_interface_model.InputDataObjectType> - * Returns a list of application inputs. - * - * - * @param authzToken - * @param appInterfaceId - */ - 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 list of Application Outputs. - * - * @param appInterfaceId - * The identifier of the application interface which need outputs to be fetched. - * - * @return list<application_interface_model.OutputDataObjectType> - * Returns a list of application outputs. - * - * - * @param authzToken - * @param appInterfaceId - */ - 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. - * - * @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. - * - * - * @param authzToken - * @param appInterfaceId - */ - public Map<String,String> getAvailableAppInterfaceComputeResources(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; - - /** - * Register a Compute Resource. - * - * @param computeResourceDescription - * Compute Resource Object created from the datamodel. - * - * @return computeResourceId - * Returns a server-side generated airavata compute resource globally unique identifier. - * - * - * @param authzToken - * @param computeResourceDescription - */ - public String registerComputeResource(org.apache.airavata.model.security.AuthzToken authzToken, org.apache.airavata.model.appcatalog.computeresource.ComputeResourceDescription computeResourceDescription) 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 given Compute Resource. - * - * @param computeResourceId - * The identifier for the requested compute resource - * - * @return computeResourceDescription - * Compute Resource Object created from the datamodel.. - * - * - * @param authzToken - * @param computeResourceId - */ - 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. - * Compute Resource Object created from the datamodel.. - * - * - * @param authzToken - */ - public Map<String,String> getAllComputeResourceNames(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. - * - * @param computeResourceId - * The identifier for the requested compute resource to be updated. - * - * @param computeResourceDescription - * Compute Resource Object created from the datamodel. - * - * @return status - * Returns a success/failure of the update. - * - * - * @param authzToken - * @param computeResourceId - * @param computeResourceDescription - */ - public boolean updateComputeResource(org.apache.airavata.model.security.AuthzToken authzToken, String computeResourceId, org.apache.airavata.model.appcatalog.computeresource.ComputeResourceDescription computeResourceDescription) 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 Compute Resource. - * - * @param computeResourceId - * The identifier for the requested compute resource to be deleted. - * - * @return status - * Returns a success/failure of the deletion. - * - * - * @param authzToken - * @param computeResourceId - */ - public boolean deleteComputeResource(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; - - /** - * Register a Storage Resource. - * - * @param storageResourceDescription - * Storge Resource Object created from the datamodel. - * - * @return storageResourceId - * Returns a server-side generated airavata storage resource globally unique identifier. - * - * - * @param authzToken - * @param storageResourceDescription - */ - public String registerStorageResource(org.apache.airavata.model.security.AuthzToken authzToken, org.apache.airavata.model.appcatalog.storageresource.StorageResourceDescription storageResourceDescription) 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 given Storage Resource. - * - * @param storageResourceId - * The identifier for the requested storage resource - * - * @return storageResourceDescription - * Storage Resource Object created from the datamodel.. - * - * - * @param authzToken - * @param storageResourceId - */ - public org.apache.airavata.model.appcatalog.storageresource.StorageResourceDescription getStorageResource(org.apache.airavata.model.security.AuthzToken authzToken, 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 registered Storage Resources. - * - * @return A map of registered compute resource id's and thier corresponding hostnames. - * Compute Resource Object created from the datamodel.. - * - * - * @param authzToken - */ - 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 Storage Resource. - * - * @param storageResourceId - * The identifier for the requested compute resource to be updated. - * - * @param storageResourceDescription - * Storage Resource Object created from the datamodel. - * - * @return status - * Returns a success/failure of the update. - * - * - * @param authzToken - * @param storageResourceId - * @param storageResourceDescription - */ - public boolean updateStorageResource(org.apache.airavata.model.security.AuthzToken authzToken, String storageResourceId, org.apache.airavata.model.appcatalog.storageresource.StorageResourceDescription storageResourceDescription) 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.TEx
<TRUNCATED>
