thrift-interface-descriptions/airavata-apis/airavata_api.thrift

/*
 * 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.
 *
*/

/**
 * Application Programming Interface definition for Apache Airavata Services.
 *   this parent thrift file is contains all service interfaces. The data models are 
 *   described in respective thrift files.
*/

include "airavata_errors.thrift"
include "security_model.thrift"
include "../data-models/airavata_data_models.thrift"
include "../data-models/credential-store-models/credential_store_data_models.thrift"
include "../data-models/experiment-catalog-models/status_models.thrift"
include "../data-models/experiment-catalog-models/job_model.thrift"
include "../data-models/experiment-catalog-models/experiment_model.thrift"
include "../data-models/experiment-catalog-models/workspace_model.thrift"
include "../data-models/experiment-catalog-models/scheduling_model.thrift"
include "../data-models/app-catalog-models/application_io_models.thrift"
include "../data-models/app-catalog-models/application_deployment_model.thrift"
include "../data-models/app-catalog-models/application_interface_model.thrift"
include "../data-models/app-catalog-models/parser_model.thrift"
include "../data-models/resource-catalog-models/account_provisioning_model.thrift"
include "../data-models/resource-catalog-models/compute_resource_model.thrift"
include "../data-models/resource-catalog-models/storage_resource_model.thrift"
include "../data-models/resource-catalog-models/gateway_resource_profile_model.thrift"
include "../data-models/resource-catalog-models/group_resource_profile_model.thrift"
include "../data-models/resource-catalog-models/user_resource_profile_model.thrift"
include "../data-models/resource-catalog-models/data_movement_models.thrift"
include "../data-models/resource-catalog-models/gateway_groups_model.thrift"
include "../data-models/replica-catalog-models/replica_catalog_models.thrift"
include "../data-models/user-tenant-group-models/group_manager_model.thrift"
include "../data-models/user-tenant-group-models/user_profile_model.thrift"
include "../base-api/base_api.thrift"

namespace java org.apache.airavata.api
namespace php Airavata.API
namespace cpp apache.airavata.api
namespace perl ApacheAiravataAPI
namespace py airavata.api
namespace js ApacheAiravataAPI

/**
 * Airavata Interface Versions depend upon this Thrift Interface File. When making changes, please edit the
 *  Version Constants according to Semantic Versioning Specification (SemVer) http://semver.org.
 *
 * Note: The Airavata API version may be different from the Airavata software release versions.
 *
 * The Airavata API version is composed as a dot delimited string with major, minor, and patch level components.
 *
 *  - Major: Incremented for backward incompatible changes. An example would be changes to interfaces.
 *  - Minor: Incremented for backward compatible changes. An example would be the addition of a new optional methods.
 *  - Patch: Incremented for bug fixes. The patch level should be increased for every edit that doesn't result
 *              in a change to major/minor version numbers.
 *
*/
const string AIRAVATA_API_VERSION = "0.18.0"

service Airavata extends base_api.BaseAPI {

/**
 * Apache Airavata API Service Methods. For data structures associated in the signatures, please see included thrift files
*/

 /**
 * Verify if User Exists within Airavata.
 *
 * @param gatewayId
 *
 *  @param userName
 *
 * @return true/false
 *
 **/
  bool isUserExists (1: required security_model.AuthzToken authzToken,
                     2: required string gatewayId,
                     3: required string userName)
          throws (1: airavata_errors.InvalidRequestException ire,
                  2: airavata_errors.AiravataClientException ace,
                  3: airavata_errors.AiravataSystemException ase,
                  4: airavata_errors.AuthorizationException ae)

   /**
   * Register a Gateway with Airavata.
   *
   * @param gateway
   *    The gateway data model.
   * 
   * @return gatewayId
   *   Th unique identifier of the  newly registered gateway.
   *
   **/
  string addGateway(1: required security_model.AuthzToken authzToken, 2: required workspace_model.Gateway gateway)
         throws (1: airavata_errors.InvalidRequestException ire,
                 2: airavata_errors.AiravataClientException ace,
                 3: airavata_errors.AiravataSystemException ase,
                 4: airavata_errors.AuthorizationException ae)


  /**
     * Get all users in the gateway
     *
     * @param gatewayId
     *    The gateway data model.
     *
     * @return users
     *   list of usernames of the users in the gateway
     *
     **/
  list<string> getAllUsersInGateway(1: required security_model.AuthzToken authzToken, 2: required string gatewayId)
        throws (1: airavata_errors.InvalidRequestException ire,
                         2: airavata_errors.AiravataClientException ace,
                         3: airavata_errors.AiravataSystemException ase,
                         4: airavata_errors.AuthorizationException ae)

   /**
   * Update previously registered Gateway metadata.
   *
   * @param gatewayId
   *    The gateway Id of the Gateway which require an update.
   *
   * @return gateway
   *    Modified gateway obejct.
   *
   * @exception AiravataClientException
   *
   **/

  bool updateGateway(1: required security_model.AuthzToken authzToken, 2: required string gatewayId, 3: required workspace_model.Gateway updatedGateway)
         throws (1: airavata_errors.InvalidRequestException ire,
                 2: airavata_errors.AiravataClientException ace,
                 3: airavata_errors.AiravataSystemException ase,
                 4: airavata_errors.AuthorizationException ae)

    /**
    * Get Gateway details by providing gatewayId
    *
    * @param gatewayId
    *    The gateway Id of the Gateway.
    *
    * @return gateway
    *    Gateway obejct.
    *
    **/

  workspace_model.Gateway getGateway(1: required security_model.AuthzToken authzToken, 2: required string gatewayId)
           throws (1: airavata_errors.InvalidRequestException ire,
                   2: airavata_errors.AiravataClientException ace,
                   3: airavata_errors.AiravataSystemException ase,
                   4: airavata_errors.AuthorizationException ae)

    /**
    * 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.
    *
    **/

  bool deleteGateway(1: required security_model.AuthzToken authzToken, 2: required string gatewayId)
             throws (1: airavata_errors.InvalidRequestException ire,
                     2: airavata_errors.AiravataClientException ace,
                     3: airavata_errors.AiravataSystemException ase,
                     4: airavata_errors.AuthorizationException ae)

    /**
    * Get All the Gateways Connected to Airavata.
    **/

  list<workspace_model.Gateway> getAllGateways(1: required security_model.AuthzToken authzToken)
             throws (1: airavata_errors.InvalidRequestException ire,
                     2: airavata_errors.AiravataClientException ace,
                     3: airavata_errors.AiravataSystemException ase,
                     4: airavata_errors.AuthorizationException ae)

    /**
    * 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.
    *
    **/

  bool isGatewayExist(1: required security_model.AuthzToken authzToken, 2: required string gatewayId)
           throws (1: airavata_errors.InvalidRequestException ire,
                   2: airavata_errors.AiravataClientException ace,
                   3: airavata_errors.AiravataSystemException ase,
                   4: airavata_errors.AuthorizationException ae)

  /**
  * API methods to retrieve notifications
**/
   string createNotification(1: required security_model.AuthzToken authzToken, 2: required workspace_model.Notification notification)
        throws (1: airavata_errors.InvalidRequestException ire,
                   2: airavata_errors.AiravataClientException ace,
                   3: airavata_errors.AiravataSystemException ase,
                   4: airavata_errors.AuthorizationException ae)

   bool updateNotification(1: required security_model.AuthzToken authzToken, 2: required workspace_model.Notification notification)
           throws (1: airavata_errors.InvalidRequestException ire,
                      2: airavata_errors.AiravataClientException ace,
                      3: airavata_errors.AiravataSystemException ase,
                      4: airavata_errors.AuthorizationException ae)


  bool deleteNotification(1: required security_model.AuthzToken authzToken, 2: required string gatewayId, 3: required string notificationId)
             throws (1: airavata_errors.InvalidRequestException ire,
                        2: airavata_errors.AiravataClientException ace,
                        3: airavata_errors.AiravataSystemException ase,
                        4: airavata_errors.AuthorizationException ae)

  workspace_model.Notification getNotification(1: required security_model.AuthzToken authzToken, 2: required string gatewayId, 3: required string notificationId)
             throws (1: airavata_errors.InvalidRequestException ire,
                        2: airavata_errors.AiravataClientException ace,
                        3: airavata_errors.AiravataSystemException ase,
                        4: airavata_errors.AuthorizationException ae)

  list<workspace_model.Notification> getAllNotifications(1: required security_model.AuthzToken authzToken, 2: required string gatewayId)
             throws (1: airavata_errors.InvalidRequestException ire,
                        2: airavata_errors.AiravataClientException ace,
                        3: airavata_errors.AiravataSystemException ase,
                        4: airavata_errors.AuthorizationException ae)

    /**
    * Airavata Adminstrative Funcationality
    **/


   /**
   * Generate and Register SSH Key Pair with Airavata Credential Store.
   *
   * @param description
   *    The description field for a credential type, all type of credential can have a description.
   *
   * @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.
   *
   **/
   string generateAndRegisterSSHKeys (1: required security_model.AuthzToken authzToken,
                    4: string description)
           throws (1: airavata_errors.InvalidRequestException ire,
                   2: airavata_errors.AiravataClientException ace,
                   3: airavata_errors.AiravataSystemException ase)

 /**
   * Generate and Register Username PWD Pair with Airavata Credential Store.
   *
   * @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.
   *
   **/
  string registerPwdCredential (1: required security_model.AuthzToken authzToken,
                      4: required string loginUserName,
                      5: required string password,
                      6: required string description)
             throws (1: airavata_errors.InvalidRequestException ire,
                     2: airavata_errors.AiravataClientException ace,
                     3: airavata_errors.AiravataSystemException ase)

  credential_store_data_models.CredentialSummary getCredentialSummary(1: required security_model.AuthzToken authzToken, 2: required string tokenId)
             throws (1: airavata_errors.InvalidRequestException ire,
                     2: airavata_errors.AiravataClientException ace,
                     3: airavata_errors.AiravataSystemException ase,
                     4: airavata_errors.AuthorizationException ae)

  list<credential_store_data_models.CredentialSummary> getAllCredentialSummaries(1: required security_model.AuthzToken authzToken, 2: required credential_store_data_models.SummaryType type)
             throws (1: airavata_errors.InvalidRequestException ire,
                     2: airavata_errors.AiravataClientException ace,
                     3: airavata_errors.AiravataSystemException ase)

  bool deleteSSHPubKey (1: required security_model.AuthzToken authzToken,
                          2: required string airavataCredStoreToken)
             throws (1: airavata_errors.InvalidRequestException ire,
                     2: airavata_errors.AiravataClientException ace,
                     3: airavata_errors.AiravataSystemException ase,
                     4: airavata_errors.AuthorizationException ae)


  bool deletePWDCredential (1: required security_model.AuthzToken authzToken,
                            2: required string airavataCredStoreToken)
               throws (1: airavata_errors.InvalidRequestException ire,
                       2: airavata_errors.AiravataClientException ace,
                       3: airavata_errors.AiravataSystemException ase,
                       4: airavata_errors.AuthorizationException ae)

   /**
   *
   * 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.
   *
   **/
  string createProject (1: required security_model.AuthzToken authzToken,
                        2: required string gatewayId,
                        3: required workspace_model.Project project)
          throws (1: airavata_errors.InvalidRequestException ire,
                  2: airavata_errors.AiravataClientException ace,
                  3: airavata_errors.AiravataSystemException ase,
                  4: airavata_errors.AuthorizationException ae)

   /**
   *
   * Update an Existing Project
   *
   * @param projectId
   *    The projectId of the project needed an update.
   *
   * @return void
   *    Currently this does not return any value.
   *
   **/
  void updateProject (1: required security_model.AuthzToken authzToken,
                      2: required string projectId,
                      3: required workspace_model.Project updatedProject)
      throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.AiravataClientException ace,
              3: airavata_errors.AiravataSystemException ase,
              4: airavata_errors.ProjectNotFoundException pnfe,
              5: airavata_errors.AuthorizationException ae)

   /**
   *
   * 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.
   *
   **/
  workspace_model.Project getProject (1: required security_model.AuthzToken authzToken, 2: required string projectId)
        throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.ProjectNotFoundException pnfe,
                5: airavata_errors.AuthorizationException ae)

   /**
   *
   * 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.
   *
   **/
  bool deleteProject (1: required security_model.AuthzToken authzToken, 2: required string projectId)
          throws (1: airavata_errors.InvalidRequestException ire,
                  2: airavata_errors.AiravataClientException ace,
                  3: airavata_errors.AiravataSystemException ase,
                  4: airavata_errors.ProjectNotFoundException pnfe,
                  5: airavata_errors.AuthorizationException ae)

   /**
   *
   * 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.
   *
   **/
  list<workspace_model.Project> getUserProjects(1: required security_model.AuthzToken authzToken,
                                                   2: required string gatewayId,
                                                   3: required string userName,
                                                   4: required i32 limit,
                                                   5: required i32 offset)
        throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)


    /**
    *
    * 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.
    *
    **/
  list<workspace_model.Project> searchProjects(1: required security_model.AuthzToken authzToken,
                              2: required string gatewayId,
                              3: required string userName,
                              4: map<experiment_model.ProjectSearchFields, string> filters,
                              5: required i32 limit,
                              6: required i32 offset)
                  throws (1: airavata_errors.InvalidRequestException ire,
                          2: airavata_errors.AiravataClientException ace,
                          3: airavata_errors.AiravataSystemException ase,
                          4: airavata_errors.AuthorizationException ae)

   /**
   * 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.
   *
   **/

    list<experiment_model.ExperimentSummaryModel> searchExperiments(1: required security_model.AuthzToken authzToken,
                            2: required string gatewayId,
                            3: required string userName,
                            4: map<experiment_model.ExperimentSearchFields, string> filters,
                            5: required i32 limit,
                            6: required i32 offset)
                throws (1: airavata_errors.InvalidRequestException ire,
                        2: airavata_errors.AiravataClientException ace,
                        3: airavata_errors.AiravataSystemException ase,
                        4: airavata_errors.AuthorizationException ae)

    /**
     *
     * 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 limit
     *       Amount of results to be fetched.
     *
     * @param offset
     *       The starting point of the results to be fetched.
     *
     **/
    experiment_model.ExperimentStatistics getExperimentStatistics(1: required security_model.AuthzToken authzToken,
                            2: required string gatewayId,
                            3: required i64 fromTime,
                            4: required i64 toTime,
                            5: string userName,
                            6: string applicationName,
                            7: string resourceHostName,
                            8: i32 limit = 50,
                            9: i32 offset = 0)
                throws (1: airavata_errors.InvalidRequestException ire,
                        2: airavata_errors.AiravataClientException ace,
                        3: airavata_errors.AiravataSystemException ase,
                        4: airavata_errors.AuthorizationException ae)


  /**
   *
   * 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.
   *
   **/
  list<experiment_model.ExperimentModel> getExperimentsInProject(1: required security_model.AuthzToken authzToken,
                  2: required string projectId,
                  3: required i32 limit,
                  4: required i32 offset)
          throws (1: airavata_errors.InvalidRequestException ire,
                  2: airavata_errors.AiravataClientException ace,
                  3: airavata_errors.AiravataSystemException ase,
                  4: airavata_errors.ProjectNotFoundException pnfe,
                  5: airavata_errors.AuthorizationException ae)

   /**
   *
   * 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.
   *
   **/
  list<experiment_model.ExperimentModel> getUserExperiments(1: required security_model.AuthzToken authzToken,
                        2: required string gatewayId,
                        3: required string userName,
                        4: required i32 limit,
                        5: required i32 offset)
            throws (1: airavata_errors.InvalidRequestException ire,
                    2: airavata_errors.AiravataClientException ace,
                    3: airavata_errors.AiravataSystemException ase,
                    4: airavata_errors.AuthorizationException ae)

   /**
     *
     * 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.
     *
   **/
  string createExperiment(1: required security_model.AuthzToken authzToken,
                          2: required string gatewayId,
                          3: required experiment_model.ExperimentModel experiment)
    throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)

  /**
  *
  * 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.
  *
  **/
  bool deleteExperiment(1: required security_model.AuthzToken authzToken,
                          2: required string experimentId)
    throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)


  /**
   *
   * 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.
   *
 **/
  experiment_model.ExperimentModel getExperiment(1: required security_model.AuthzToken authzToken,
                                                 2: required string airavataExperimentId)
    throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.ExperimentNotFoundException enf,
            3: airavata_errors.AiravataClientException ace,
            4: airavata_errors.AiravataSystemException ase,
            5: airavata_errors.AuthorizationException ae)


  /**
   *
   * 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.
   *
 **/
  experiment_model.ExperimentModel getExperimentByAdmin(1: required security_model.AuthzToken authzToken,
                                                 2: required string airavataExperimentId)
    throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.ExperimentNotFoundException enf,
            3: airavata_errors.AiravataClientException ace,
            4: airavata_errors.AiravataSystemException ase,
            5: airavata_errors.AuthorizationException ae)
  /**
   *
   * 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.
   *
  */
  experiment_model.ExperimentModel getDetailedExperimentTree(1: required security_model.AuthzToken authzToken,
                                                   2: required string airavataExperimentId)
      throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.ExperimentNotFoundException enf,
              3: airavata_errors.AiravataClientException ace,
              4: airavata_errors.AiravataSystemException ase,
              5: airavata_errors.AuthorizationException ae)


  /**
   *
   * 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.
   *
  */
  void updateExperiment(1: required security_model.AuthzToken authzToken,
                        2: required string airavataExperimentId,
                        3: required experiment_model.ExperimentModel experiment)
    throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.ExperimentNotFoundException enf,
            3: airavata_errors.AiravataClientException ace,
            4: airavata_errors.AiravataSystemException ase,
            5: airavata_errors.AuthorizationException ae)

  void updateExperimentConfiguration(1: required security_model.AuthzToken authzToken,
                                     2: required string airavataExperimentId,
                                     3: required experiment_model.UserConfigurationDataModel userConfiguration)
    throws (1: airavata_errors.AuthorizationException ae)

  void updateResourceScheduleing(1: required security_model.AuthzToken authzToken,
                                 2: required string airavataExperimentId,
                                 3: required scheduling_model.ComputationalResourceSchedulingModel resourceScheduling)
    throws (1: airavata_errors.AuthorizationException ae)

    /**
     *
     * 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.
     *
    **/
  bool validateExperiment(1: required security_model.AuthzToken authzToken,
                          2: required string airavataExperimentId)
      throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.ExperimentNotFoundException enf,
              3: airavata_errors.AiravataClientException ace,
              4: airavata_errors.AiravataSystemException ase,
              5: airavata_errors.AuthorizationException ae)

  /**
   *
   * 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.
   *
  */
  void launchExperiment(1: required security_model.AuthzToken authzToken,
                        2: required string airavataExperimentId,
                        3: required string gatewayId)
    throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.ExperimentNotFoundException enf,
            3: airavata_errors.AiravataClientException ace,
            4: airavata_errors.AiravataSystemException ase,
            5: airavata_errors.AuthorizationException ae)

  /**
  *
  * 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.
  *
  **/
   status_models.ExperimentStatus getExperimentStatus(1: required security_model.AuthzToken authzToken,
                                                      2: required string airavataExperimentId)
      throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.ExperimentNotFoundException enf,
              3: airavata_errors.AiravataClientException ace,
              4: airavata_errors.AiravataSystemException ase,
              5: airavata_errors.AuthorizationException ae)

  /**
  *
  * 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.
  *
  **/
  list<application_io_models.OutputDataObjectType> getExperimentOutputs (1: required security_model.AuthzToken authzToken,
                2: required string airavataExperimentId)
      throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.ExperimentNotFoundException enf,
              3: airavata_errors.AiravataClientException ace,
              4: airavata_errors.AiravataSystemException ase,
              5: airavata_errors.AuthorizationException ae)

  /**
  *
  * 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.
  *
  **/
   list<application_io_models.OutputDataObjectType> getIntermediateOutputs (1: required security_model.AuthzToken authzToken,
                2: required string airavataExperimentId)
        throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.ExperimentNotFoundException enf,
                3: airavata_errors.AiravataClientException ace,
                4: airavata_errors.AiravataSystemException ase,
                5: airavata_errors.AuthorizationException ae)

  /**
   * Request fetching of output files for an experiment that is still executing.
   * This method results in a new Process being created for the Experiment with
   * tasks for fetching each output file.
   *
   * @param authzToken
   *
   * @param airavataExperimentId
   *     Experiment ID of the experiment
   *
   * @param outputNames
   *     List of names of the experiment's outputs to fetch.
   *
   */
  void fetchIntermediateOutputs(1: required security_model.AuthzToken authzToken, 2: required string airavataExperimentId,
                3: required list<string> outputNames)
        throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.ExperimentNotFoundException enf,
                3: airavata_errors.AiravataClientException ace,
                4: airavata_errors.AiravataSystemException ase,
                5: airavata_errors.AuthorizationException ae)

  /**
   * Get the status of the most recent intermediate output fetching process for the given output names.
   *
   * @param authzToken
   *
   * @param airavataExperimentId
   *     Experiment ID of the experiment
   *
   * @param outputNames
   *     List of names of the experiment's outputs to fetch.
   *
   */
  status_models.ProcessStatus getIntermediateOutputProcessStatus(1: required security_model.AuthzToken authzToken, 2: required string airavataExperimentId,
                3: required list<string> outputNames)
        throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.ExperimentNotFoundException enf,
                3: airavata_errors.AiravataClientException ace,
                4: airavata_errors.AiravataSystemException ase,
                5: airavata_errors.AuthorizationException ae)

  /**
  *
  * 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
  *
  **/
  map<string, status_models.JobStatus> getJobStatuses(1: required security_model.AuthzToken authzToken,
                      2: required string airavataExperimentId)
              throws (1: airavata_errors.InvalidRequestException ire,
                      2: airavata_errors.ExperimentNotFoundException enf,
                      3: airavata_errors.AiravataClientException ace,
                      4: airavata_errors.AiravataSystemException ase,
                      5: airavata_errors.AuthorizationException ae)

  /**
  *
  * 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.
  *
  **/
  list<job_model.JobModel> getJobDetails(1: required security_model.AuthzToken authzToken,
                                         2: required string airavataExperimentId)
                throws (1: airavata_errors.InvalidRequestException ire,
                        2: airavata_errors.ExperimentNotFoundException enf,
                        3: airavata_errors.AiravataClientException ace,
                        4: airavata_errors.AiravataSystemException ase,
                        5: airavata_errors.AuthorizationException ae)

  /**
   *
   * 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.
   *
  */
  string cloneExperiment(1: required security_model.AuthzToken authzToken,
                         2: string existingExperimentID,
                         3: string newExperimentName,
                         4: string newExperimentProjectId)
    throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.ExperimentNotFoundException enf,
            3: airavata_errors.AiravataClientException ace,
            4: airavata_errors.AiravataSystemException ase,
            5: airavata_errors.AuthorizationException ae,
            6: airavata_errors.ProjectNotFoundException pnfe)

  /**
   *
   * 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.
   *
  */
  string cloneExperimentByAdmin(1: required security_model.AuthzToken authzToken,
                                2: string existingExperimentID,
                                3: string newExperimentName,
                                4: string newExperimentProjectId)
    throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.ExperimentNotFoundException enf,
            3: airavata_errors.AiravataClientException ace,
            4: airavata_errors.AiravataSystemException ase,
            5: airavata_errors.AuthorizationException ae,
            6: airavata_errors.ProjectNotFoundException pnfe)
  /**
   *
   * 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.
   *
  */
  void terminateExperiment(1: required security_model.AuthzToken authzToken,
                           2: string airavataExperimentId,
                           3: string gatewayId)
    throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.ExperimentNotFoundException enf,
            3: airavata_errors.AiravataClientException ace,
            4: airavata_errors.AiravataSystemException ase,
            5: airavata_errors.AuthorizationException ae)

/*
 *
 * API definitions for App Catalog related operations
 *
*/

/*
 *
 * Application Module
 *  A specific computational application. Many applications, particularly scientific applications
 *  are really a suite of applications or encompass of an ecosystem. For instance, Amber is referred to dozens of binaries.
 *  WRF is referred for an ecosystem of applications. In this context, we refer to module as a single binary.
 *
 * Note: A module has to be defined before a deployment can be registered.
 *
*/

  /**
   *
   * 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.
   *
  */
  string registerApplicationModule(1: required security_model.AuthzToken authzToken,
                        2: required string gatewayId,
                        3: required application_deployment_model.ApplicationModule applicationModule)
    	throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.AiravataClientException ace,
              3: airavata_errors.AiravataSystemException ase,
              4: airavata_errors.AuthorizationException ae)

  /**
   *
   * Fetch a Application Module.
   *
   * @param appModuleId
   *   The unique identifier of the application module required
   *
   * @return applicationModule
   *   Returns an Application Module Object.
   *
  */
  application_deployment_model.ApplicationModule getApplicationModule(1: required security_model.AuthzToken authzToken,
                2: required string appModuleId)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

  /**
   *
   * 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.
   *
  */
  bool updateApplicationModule(1: required security_model.AuthzToken authzToken,
            2: required string appModuleId,
            3: required application_deployment_model.ApplicationModule applicationModule)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

  /**
   *
   * 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.
   *
  */
  list<application_deployment_model.ApplicationModule> getAllAppModules (1: required security_model.AuthzToken authzToken,
                2: required string gatewayId)
        throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

  /**
   *
   * Fetch all accessible Application Module Descriptions.
   *
   * @param gatewayId
   *    ID of the gateway which need to list all accessible application deployment documentation.
   *
   * @return list
   *    Returns the list of all Application Module Objects that are accessible to the user.
   *
  */
  list<application_deployment_model.ApplicationModule> getAccessibleAppModules (1: required security_model.AuthzToken authzToken,
                2: required string gatewayId)
        throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)


  /**
   *
   * Delete an Application Module.
   *
   * @param appModuleId
   *   The identifier of the Application Module to be deleted.
   *
   * @return status
   *   Returns a success/failure of the deletion.
   *
  */
  bool deleteApplicationModule(1: required security_model.AuthzToken authzToken,
                               2: required string appModuleId)
         	throws (1: airavata_errors.InvalidRequestException ire,
                   2: airavata_errors.AiravataClientException ace,
                   3: airavata_errors.AiravataSystemException ase,
                   4: airavata_errors.AuthorizationException ae)

/*
 *
 * Application Deployment
 *  Registers a deployment of an Application Module on a Compute Resource.
 *
*/

  /**
   *
   * 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.
   *
  */
  string registerApplicationDeployment(1: required security_model.AuthzToken authzToken,
                2: required string gatewayId,
                3: required application_deployment_model.ApplicationDeploymentDescription applicationDeployment)
    	throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.AiravataClientException ace,
              3: airavata_errors.AiravataSystemException ase,
              4: airavata_errors.AuthorizationException ae)

  /**
   *
   * Fetch a Application Deployment.
   *
   * @param appDeploymentId
   *   The identifier for the requested application module
   *
   * @return applicationDeployment
   *   Returns a application Deployment Object.
   *
  */
  application_deployment_model.ApplicationDeploymentDescription getApplicationDeployment(1: required security_model.AuthzToken authzToken,
                2: required string appDeploymentId)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

  /**
   *
   * 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.
   *
  */
  bool updateApplicationDeployment(1: required security_model.AuthzToken authzToken,
            2: required string appDeploymentId,
            3: required application_deployment_model.ApplicationDeploymentDescription applicationDeployment)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

  /**
   *
   * Delete an Application Deployment.
   *
   * @param appDeploymentId
   *   The unique identifier of application deployment to be deleted.
   *
   * @return status
   *   Returns a success/failure of the deletion.
   *
  */
  bool deleteApplicationDeployment(1: required security_model.AuthzToken authzToken,
                    2: required string appDeploymentId)
         	throws (1: airavata_errors.InvalidRequestException ire,
                   2: airavata_errors.AiravataClientException ace,
                   3: airavata_errors.AiravataSystemException ase,
                   4: airavata_errors.AuthorizationException ae)

  /**
   *
   * 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.
   *
  */
  list<application_deployment_model.ApplicationDeploymentDescription> getAllApplicationDeployments(1: required security_model.AuthzToken authzToken,
                2: required string gatewayId)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

  /**
   *
   * Fetch all accessible Application Deployment Descriptions.
   *
   * @param gatewayId
   *    ID of the gateway which need to list all accessible application deployment documentation.
   * @param permissionType
   *    ResourcePermissionType to check for this user
   *
   * @return list<applicationDeployment.
   *    Returns the list of all application Deployment Objects that are accessible to the user.
   *
  */
  list<application_deployment_model.ApplicationDeploymentDescription> getAccessibleApplicationDeployments(1: required security_model.AuthzToken authzToken,
                  2: required string gatewayId, 3: required group_manager_model.ResourcePermissionType permissionType)
        throws (1: airavata_errors.InvalidRequestException ire,
                  2: airavata_errors.AiravataClientException ace,
                  3: airavata_errors.AiravataSystemException ase,
                  4: airavata_errors.AuthorizationException ae)

  /**
   * 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.
   *
  */
  // FIXME: Deprecated, use getApplicationDeploymentsForAppModuleAndGroupResourceProfile instead
  list<string> getAppModuleDeployedResources(1: required security_model.AuthzToken authzToken, 2: required string appModuleId)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

  /**
   * Fetch a list of Application Deployments that this user can use for executing the given Application Module using the given Group Resource Profile.
   * The user must have at least READ access to the Group Resource Profile.
   *
   * @param appModuleId
   *    The identifier for the Application Module
   *
   * @param groupResourceProfileId
   *    The identifier for the Group Resource Profile
   *
   * @return list<ApplicationDeploymentDescription>
   *    Returns a list of Application Deployments
   */
  list<application_deployment_model.ApplicationDeploymentDescription> getApplicationDeploymentsForAppModuleAndGroupResourceProfile(
          1: required security_model.AuthzToken authzToken, 2: required string appModuleId, 3: required string groupResourceProfileId)
      throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.AiravataClientException ace,
              3: airavata_errors.AiravataSystemException ase,
              4: airavata_errors.AuthorizationException ae)

/*
 *
 * Application Interface
 *
*/

  /**
   *
   * 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.
   *
  */
  string registerApplicationInterface(1: required security_model.AuthzToken authzToken, 2: required string gatewayId,
                3: required application_interface_model.ApplicationInterfaceDescription applicationInterface)
    	throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.AiravataClientException ace,
              3: airavata_errors.AiravataSystemException ase,
              4: airavata_errors.AuthorizationException ae)

  /**
   *
   * 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.
   *
  */
  string cloneApplicationInterface(1: required security_model.AuthzToken authzToken,
                         2: string existingAppInterfaceID,
                         3: string newApplicationName,
                         4: string gatewayId)
    throws (1: airavata_errors.InvalidRequestException ire,
                  2: airavata_errors.AiravataClientException ace,
                  3: airavata_errors.AiravataSystemException ase,
                  4: airavata_errors.AuthorizationException ae)

  /**
   *
   * Fetch an Application Interface.
   *
   * @param appInterfaceId
   *   The identifier for the requested application interface.
   *
   * @return applicationInterface
   *   Returns an application Interface Object.
   *
  */
  application_interface_model.ApplicationInterfaceDescription getApplicationInterface(1: required security_model.AuthzToken authzToken,
                2: required string appInterfaceId)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

  /**
   *
   * 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.
   *
  */
  bool updateApplicationInterface(1: required security_model.AuthzToken authzToken,
            2: required string appInterfaceId,
            3: required application_interface_model.ApplicationInterfaceDescription applicationInterface)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

  /**
   *
   * 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.
   *
  */
  bool deleteApplicationInterface(1: required security_model.AuthzToken authzToken, 2: required string appInterfaceId)
         	throws (1: airavata_errors.InvalidRequestException ire,
                   2: airavata_errors.AiravataClientException ace,
                   3: airavata_errors.AiravataSystemException ase,
                   4: airavata_errors.AuthorizationException ae)

  /**
   *
   * Fetch name and ID of  Application Interface documents.
   *
   *
   * @return map<applicationId, applicationInterfaceNames>
   *   Returns a list of application interfaces with corresponsing ID's
   *
  */
  map<string, string> getAllApplicationInterfaceNames (1: required security_model.AuthzToken authzToken, 2: required string gatewayId)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

  /**
   *
   * 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).
   *
  */
  list<application_interface_model.ApplicationInterfaceDescription> getAllApplicationInterfaces (1: required security_model.AuthzToken authzToken,
                2: required string gatewayId)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

  /**
   *
   * 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.
   *
  */
  list<application_io_models.InputDataObjectType> getApplicationInputs(1: required security_model.AuthzToken authzToken,
                2: required string appInterfaceId)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

  /**
   *
   * 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.
   *
  */
  list<application_io_models.OutputDataObjectType> getApplicationOutputs(1: required security_model.AuthzToken authzToken,
                2: required string appInterfaceId)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

  /**
   *
   * 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.
   *
  */
  // FIXME: Deprecated, use getApplicationDeploymentsForAppModuleAndGroupResourceProfile instead
  map<string, string> getAvailableAppInterfaceComputeResources(1: required security_model.AuthzToken authzToken, 2: required string appInterfaceId)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

/*
 *
 * Compute Resource
 *
*/

  /**
   * 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.
   *
  */
  string registerComputeResource(1: required security_model.AuthzToken authzToken,
                                 2: required compute_resource_model.ComputeResourceDescription computeResourceDescription)
    	throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.AiravataClientException ace,
              3: airavata_errors.AiravataSystemException ase,
              4: airavata_errors.AuthorizationException ae)

  /**
   * Fetch the given Compute Resource.
   *
   * @param computeResourceId
   *   The identifier for the requested compute resource
   *
   * @return computeResourceDescription
   *    Compute Resource Object created from the datamodel..
   *
  */
  compute_resource_model.ComputeResourceDescription getComputeResource(1: required security_model.AuthzToken authzToken,
                2: required string computeResourceId)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

  /**
   *
   * 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..
   *
  */
  map<string, string> getAllComputeResourceNames(1: required security_model.AuthzToken authzToken)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

  /**
   * 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.
   *
  */

  bool updateComputeResource(1: required security_model.AuthzToken authzToken,
            2: required string computeResourceId,
            3: required compute_resource_model.ComputeResourceDescription computeResourceDescription)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

  /**
   * 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.
   *
  */
  bool deleteComputeResource(1: required security_model.AuthzToken authzToken, 2: required string computeResourceId)
         	throws (1: airavata_errors.InvalidRequestException ire,
                   2: airavata_errors.AiravataClientException ace,
                   3: airavata_errors.AiravataSystemException ase,
                   4: airavata_errors.AuthorizationException ae)

/*
 *
 * Storage Resource
 *
*/

  /**
   * 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.
   *
  */

  string registerStorageResource(1: required security_model.AuthzToken authzToken,
                                 2: required storage_resource_model.StorageResourceDescription storageResourceDescription)
    	throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.AiravataClientException ace,
              3: airavata_errors.AiravataSystemException ase,
              4: airavata_errors.AuthorizationException ae)

  /**
   * Fetch the given Storage Resource.
   *
   * @param storageResourceId
   *   The identifier for the requested storage resource
   *
   * @return storageResourceDescription
   *    Storage Resource Object created from the datamodel..
   *
  */

  storage_resource_model.StorageResourceDescription getStorageResource(1: required security_model.AuthzToken authzToken,
                2: required string storageResourceId)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

  /**
   * 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..
   *
  */

  map<string, string> getAllStorageResourceNames(1: required security_model.AuthzToken authzToken)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

  /**
   * 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.
   *
  */

  bool updateStorageResource(1: required security_model.AuthzToken authzToken,
            2: required string storageResourceId,
            3: required storage_resource_model.StorageResourceDescription storageResourceDescription)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

  /**
   * Delete a Storage Resource.
   *
   * @param storageResourceId
   *   The identifier of the requested compute resource to be deleted.
   *
   * @return status
   *   Returns a success/failure of the deletion.
   *
  */

  bool deleteStorageResource(1: required security_model.AuthzToken authzToken, 2: required string storageResourceId)
         	throws (1: airavata_errors.InvalidRequestException ire,
                   2: airavata_errors.AiravataClientException ace,
                   3: airavata_errors.AiravataSystemException ase,
                   4: airavata_errors.AuthorizationException ae)

  /**
   * Add a Local Job Submission details to a compute resource
   *  App catalog will return a jobSubmissionInterfaceId which will be added to the jobSubmissionInterfaces.
   *
   * @param computeResourceId
   *   The identifier of the compute resource to which JobSubmission protocol to be added
   *
   * @param priorityOrder
   *   Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero.
   *
   * @param localSubmission
   *   The LOCALSubmission object to be added to the resource.
   *
   * @return status
   *   Returns the unique job submission id.
   *
  */

  string addLocalSubmissionDetails(1: required security_model.AuthzToken authzToken, 2: required string computeResourceId,
            3: required i32 priorityOrder,
            4: required compute_resource_model.LOCALSubmission localSubmission)

  	throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)

  /**
   * Update the given Local Job Submission details
   *
   * @param jobSubmissionInterfaceId
   *   The identifier of the JobSubmission Interface to be updated.
   *
   * @param localSubmission
   *   The LOCALSubmission object to be updated.
   *
   * @return status
   *   Returns a success/failure of the deletion.
   *
  */

  bool updateLocalSubmissionDetails(1: required security_model.AuthzToken authzToken,
            2: required string jobSubmissionInterfaceId,
            3: required compute_resource_model.LOCALSubmission localSubmission)
  	throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)

  /**
  * This method returns localJobSubmission object
  * @param jobSubmissionInterfaceId
  *   The identifier of the JobSubmission Interface to be retrieved.
  *  @return LOCALSubmission instance
  **/

  compute_resource_model.LOCALSubmission getLocalJobSubmission(1: required security_model.AuthzToken authzToken,
                    2: required string jobSubmissionId)
            throws (1: airavata_errors.InvalidRequestException ire,
                    2: airavata_errors.AiravataClientException ace,
                    3: airavata_errors.AiravataSystemException ase,
                    4: airavata_errors.AuthorizationException ae)



  /**
   * Add a SSH Job Submission details to a compute resource
   *  App catalog will return a jobSubmissionInterfaceId which will be added to the jobSubmissionInterfaces.
   *
   * @param computeResourceId
   *   The identifier of the compute resource to which JobSubmission protocol to be added
   *
   * @param priorityOrder
   *   Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero.
   *
   * @param sshJobSubmission
   *   The SSHJobSubmission object to be added to the resource.
   *
   * @return status
   *   Returns the unique job submission id.
   *
  */


  string addSSHJobSubmissionDetails(1: required security_model.AuthzToken authzToken,
            2: required string computeResourceId,
            3: required i32 priorityOrder,
            4: required compute_resource_model.SSHJobSubmission sshJobSubmission)
  	throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)

  /**
   * Add a SSH_FORK Job Submission details to a compute resource
   *  App catalog will return a jobSubmissionInterfaceId which will be added to the jobSubmissionInterfaces.
   *
   * @param computeResourceId
   *   The identifier of the compute resource to which JobSubmission protocol to be added
   *
   * @param priorityOrder
   *   Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero.
   *
   * @param sshJobSubmission
   *   The SSHJobSubmission object to be added to the resource.
   *
   * @return status
   *   Returns the unique job submission id.
   *
  */


  string addSSHForkJobSubmissionDetails(1: required security_model.AuthzToken authzToken,
            2: required string computeResourceId,
            3: required i32 priorityOrder,
            4: required compute_resource_model.SSHJobSubmission sshJobSubmission)
  	throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)

    /**
    * This method returns SSHJobSubmission object
    * @param jobSubmissionInterfaceId
    *   The identifier of the JobSubmission Interface to be retrieved.
    *  @return SSHJobSubmission instance
    **/

    compute_resource_model.SSHJobSubmission getSSHJobSubmission(1: required security_model.AuthzToken authzToken,
                      2: required string jobSubmissionId)
              throws (1: airavata_errors.InvalidRequestException ire,
                      2: airavata_errors.AiravataClientException ace,
                      3: airavata_errors.AiravataSystemException ase,
                      4: airavata_errors.AuthorizationException ae)



  /**
   *
   * Add a UNICORE Job Submission details to a compute resource
   *  App catalog will return a jobSubmissionInterfaceId which will be added to the jobSubmissionInterfaces.
   *
   * @param computeResourceId
   *   The identifier of the compute resource to which JobSubmission protocol to be added
   *
   * @param priorityOrder
   *   Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero.
   *
   * @param unicoreJobSubmission
   *   The UnicoreJobSubmission object to be added to the resource.
   *
   * @return status
   *  Returns the unique job submission id.
   *
  */
  string addUNICOREJobSubmissionDetails(1: required security_model.AuthzToken authzToken,
            2: required string computeResourceId,
            3: required i32 priorityOrder,
            4: required compute_resource_model.UnicoreJobSubmission unicoreJobSubmission)
  	throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)


  /**
    *
    * This method returns UnicoreJobSubmission object
    *
    * @param jobSubmissionInterfaceId
    *   The identifier of the JobSubmission Interface to be retrieved.
    *  @return UnicoreJobSubmission instance
    *
  **/
  compute_resource_model.UnicoreJobSubmission getUnicoreJobSubmission(1: required security_model.AuthzToken authzToken,
                        2: required string jobSubmissionId)
                throws (1: airavata_errors.InvalidRequestException ire,
                        2: airavata_errors.AiravataClientException ace,
                        3: airavata_errors.AiravataSystemException ase,
                        4: airavata_errors.AuthorizationException ae)


 /**
   *
   * Add a Cloud Job Submission details to a compute resource
   *  App catalog will return a jobSubmissionInterfaceId which will be added to the jobSubmissionInterfaces.
   *
   * @param computeResourceId
   *   The identifier of the compute resource to which JobSubmission protocol to be added
   *
   * @param priorityOrder
   *   Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero.
   *
   * @param sshJobSubmission
   *   The SSHJobSubmission object to be added to the resource.
   *
   * @return status
   *   Returns the unique job submission id.
   *
**/
 string addCloudJobSubmissionDetails(1: required security_model.AuthzToken authzToken, 2: required string computeResourceId,
            3: required i32 priorityOrder,
            4: required compute_resource_model.CloudJobSubmission cloudSubmission)
  	throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)

 /**
    *
    * This method returns cloudJobSubmission object
    * @param jobSubmissionInterfaceI
        *   The identifier of the JobSubmission Interface to be retrieved.
    *  @return CloudJobSubmission instance
 **/
 compute_resource_model.CloudJobSubmission getCloudJobSubmission(1: required security_model.AuthzToken authzToken, 2: required string jobSubmissionId)
                  throws (1: airavata_errors.InvalidRequestException ire,
                          2: airavata_errors.AiravataClientException ace,
                          3: airavata_errors.AiravataSystemException ase,
                          4: airavata_errors.AuthorizationException ae)

  /**
   *
   * Update the given SSH Job Submission details
   *
   * @param jobSubmissionInterfaceId
   *   The identifier of the JobSubmission Interface to be updated.
   *
   * @param sshJobSubmission
   *   The SSHJobSubmission object to be updated.
   *
   * @return status
   *   Returns a success/failure of the update.
   *
  */
  bool updateSSHJobSubmissionDetails(1: required security_model.AuthzToken authzToken,
            2: required string jobSubmissionInterfaceId,
            3: required compute_resource_model.SSHJobSubmission sshJobSubmission)
  	throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)

/**
   *
   * Update the cloud Job Submission details
   *
   * @param jobSubmissionInterfaceId
   *   The identifier of the JobSubmission Interface to be updated.
   *
   * @param cloudJobSubmission
   *   The CloudJobSubmission object to be updated.
   *
   * @return status
   *   Returns a success/failure of the update.
   *
  */
  bool updateCloudJobSubmissionDetails(1: required security_model.AuthzToken authzToken,
            2: required string jobSubmissionInterfaceId,
            3: required compute_resource_model.CloudJobSubmission sshJobSubmission)
  	throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)

   /**
   *
   * Update the UNIOCRE Job Submission details
   *
   * @param jobSubmissionInterfaceId
   *   The identifier of the JobSubmission Interface to be updated.
   *
   * @param UnicoreJobSubmission
   *   The UnicoreJobSubmission object to be updated.
   *
   * @return status
   *   Returns a success/failure of the update.
   *
   **/
  bool updateUnicoreJobSubmissionDetails(1: required security_model.AuthzToken authzToken,
              2: required string jobSubmissionInterfaceId,
              3: required compute_resource_model.UnicoreJobSubmission unicoreJobSubmission)
    	throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.AiravataClientException ace,
              3: airavata_errors.AiravataSystemException ase,
              4: airavata_errors.AuthorizationException ae)

   /**
   *
   * Add a Local data movement details to a compute resource
   *  App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
   *
   * @param productUri
   *   The identifier of the compute resource to which JobSubmission protocol to be added
   *
   * @param DMType
   *   DMType object to be added to the resource.
   *
   * @param priorityOrder
   *   Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero.
   *
   * @param localDataMovement
   *   The LOCALDataMovement object to be added to the resource.
   *
   * @return status
   *   Returns the unique job submission id.
   *
   **/
  string addLocalDataMovementDetails(1: required security_model.AuthzToken authzToken,
            2: required string productUri,
            3: required data_movement_models.DMType dataMoveType,
            4: required i32 priorityOrder,
            5: required data_movement_models.LOCALDataMovement localDataMovement)
  	throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)

   /**
   *
   * Update the given Local data movement details
   *
   * @param dataMovementInterfaceId
   *   The identifier of the data movement Interface to be updated.
   *
   * @param localDataMovement
   *   The LOCALDataMovement object to be updated.
   *
   * @return status
   *   Returns a success/failure of the update.
   *
   **/
  bool updateLocalDataMovementDetails(1: required security_model.AuthzToken authzToken,
            2: required string dataMovementInterfaceId,
            3: required data_movement_models.LOCALDataMovement localDataMovement)
  	throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)

  /**
  *
  * This method returns local datamovement object.
  *
  * @param dataMovementId
  *   The identifier of the datamovement Interface to be retrieved.
  *
  *  @return LOCALDataMovement instance
  *
  **/
  data_movement_models.LOCALDataMovement getLocalDataMovement(1: required security_model.AuthzToken authzToken,
                    2: required string dataMovementId)
                    throws (1: airavata_errors.InvalidRequestException ire,
                            2: airavata_errors.AiravataClientException ace,
                            3: airavata_errors.AiravataSystemException ase,
                            4: airavata_errors.AuthorizationException ae)

  /**
   *
   * Add a SCP data movement details to a compute resource
   *  App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
   *
   * @param productUri
   *   The identifier of the compute resource to which JobSubmission protocol to be added
   *
   * @param priorityOrder
   *   Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero.
   *
   * @param scpDataMovement
   *   The SCPDataMovement object to be added to the resource.
   *
   * @return status
   *   Returns the unique job submission id.
   *
  */
  string addSCPDataMovementDetails(1: required security_model.AuthzToken authzToken,
            2: required string productUri,
            3: required data_movement_models.DMType dataMoveType,
            4: required i32 priorityOrder,
            5: required data_movement_models.SCPDataMovement scpDataMovement)
  	throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)

  /**
   *
   * Update the given scp data movement details
   *  App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
   *
   * @param dataMovementInterfaceId
   *   The identifier of the data movement Interface to be updated.
   *
   * @param scpDataMovement
   *   The SCPDataMovement object to be updated.
   *
   * @return status
   *   Returns a success/failure of the update.
   *
  */
  bool updateSCPDataMovementDetails(1: required security_model.AuthzToken authzToken,
            2: required string dataMovementInterfaceId,
            3: required data_movement_models.SCPDataMovement scpDataMovement)
  	throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)

    /**
    * This method returns SCP datamovement object
    *
    * @param dataMovementId
    *   The identifier of the datamovement Interface to be retrieved.
    *
    * @return SCPDataMovement instance
    *
    **/
  data_movement_models.SCPDataMovement getSCPDataMovement(1: required security_model.AuthzToken authzToken, 2: required string dataMovementId)
                    throws (1: airavata_errors.InvalidRequestException ire,
                            2: airavata_errors.AiravataClientException ace,
                            3: airavata_errors.AiravataSystemException ase,
                            4: airavata_errors.AuthorizationException ae)

 /**
   *
   * Add a UNICORE data movement details to a compute resource
   *  App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
   *
   * @param productUri
   *   The identifier of the compute resource to which data movement protocol to be added
   *
   * @param priorityOrder
   *   Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero.
   *
   * @param UnicoreDataMovement
   *   The UnicoreDataMovement object to be added to the resource.
   *
   * @return status
   *   Returns the unique data movement id.
   *
  */
 string addUnicoreDataMovementDetails(1: required security_model.AuthzToken authzToken,
              2: required string productUri,
              3: required data_movement_models.DMType dataMoveType,
              4: required i32 priorityOrder,
              5: required data_movement_models.UnicoreDataMovement unicoreDataMovement)
    	throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.AiravataClientException ace,
              3: airavata_errors.AiravataSystemException ase,
              4: airavata_errors.AuthorizationException ae)

   /**
   *
   * Update a selected UNICORE data movement details
   *  App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
   *
   * @param dataMovementInterfaceId
   *   The identifier of the data movement Interface to be updated.
   *
   * @param UnicoreDataMovement
   *   The UnicoreDataMovement object to be updated.
   *
   * @return status
   *   Returns a success/failure of the update.
   *
   **/

 bool updateUnicoreDataMovementDetails(1: required security_model.AuthzToken authzToken, 2: required string dataMovementInterfaceId,
             3: required data_movement_models.UnicoreDataMovement unicoreDataMovement)
   	throws (1: airavata_errors.InvalidRequestException ire,
             2: airavata_errors.AiravataClientException ace,
             3: airavata_errors.AiravataSystemException ase,
             4: airavata_errors.AuthorizationException ae)

    /**
    *
    * This method returns UNICORE datamovement object
    *
    * @param dataMovementId
    *   The identifier of the datamovement Interface to be retrieved.
    *
    * @return UnicoreDataMovement instance
    *
    **/

 data_movement_models.UnicoreDataMovement getUnicoreDataMovement(1: required security_model.AuthzToken authzToken,
                     2: required string dataMovementId)
                     throws (1: airavata_errors.InvalidRequestException ire,
                             2: airavata_errors.AiravataClientException ace,
                             3: airavata_errors.AiravataSystemException ase,
                             4: airavata_errors.AuthorizationException ae)

   /**
   *
   * Add a GridFTP data movement details to a compute resource
   *  App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
   *
   * @param productUri
   *   The identifier of the compute resource to which dataMovement protocol to be added
   *
   * @param DMType
   *    The DMType object to be added to the resource.
   *
   * @param priorityOrder
   *   Specify the priority of this job manager. If this is the only jobmanager, the priority can be zero.
   *
   * @param gridFTPDataMovement
   *   The GridFTPDataMovement object to be added to the resource.
   *
   * @return status
   *   Returns the unique data movement id.
   *
   **/

  string addGridFTPDataMovementDetails(1: required security_model.AuthzToken authzToken,
            2: required string productUri,
            3: required data_movement_models.DMType dataMoveType,
            4: required i32 priorityOrder,
            5: required data_movement_models.GridFTPDataMovement gridFTPDataMovement)
  	throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)

   /**
   * Update the given GridFTP data movement details to a compute resource
   *  App catalog will return a dataMovementInterfaceId which will be added to the dataMovementInterfaces.
   *
   * @param dataMovementInterfaceId
   *   The identifier of the data movement Interface to be updated.
   *
   * @param gridFTPDataMovement
   *   The GridFTPDataMovement object to be updated.
   *
   * @return boolean
   *   Returns a success/failure of the update.
   *
   **/

  bool updateGridFTPDataMovementDetails(1: required security_model.AuthzToken authzToken, 2: required string dataMovementInterfaceId,
            3: required data_movement_models.GridFTPDataMovement gridFTPDataMovement)
  	throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)

    /**
    * This method returns GridFTP datamovement object
    *
    * @param dataMovementId
    *   The identifier of the datamovement Interface to be retrieved.
    *
    *  @return GridFTPDataMovement instance
    *
    **/

  data_movement_models.GridFTPDataMovement getGridFTPDataMovement(1: required security_model.AuthzToken authzToken, 2: required string dataMovementId)
                    throws (1: airavata_errors.InvalidRequestException ire,
                            2: airavata_errors.AiravataClientException ace,
                            3: airavata_errors.AiravataSystemException ase,
                            4: airavata_errors.AuthorizationException ae)


   /**
   * Change the priority of a given job submisison interface
   *
   * @param jobSubmissionInterfaceId
   *   The identifier of the JobSubmission Interface to be changed
   *
   * @param priorityOrder
   *   The new priority of the job manager interface.
   *
   * @return status
   *   Returns a success/failure of the change.
   *
   **/

  bool changeJobSubmissionPriority(1: required security_model.AuthzToken authzToken, 2: required string jobSubmissionInterfaceId,
            3: required i32 newPriorityOrder)
  	throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)

   /**
   * Change the priority of a given data movement interface
   *
   * @param dataMovementInterfaceId
   *   The identifier of the DataMovement Interface to be changed
   *
   * @param priorityOrder
   *   The new priority of the data movement interface.
   *
   * @return status
   *   Returns a success/failure of the change.
   *
   **/

  bool changeDataMovementPriority(1: required security_model.AuthzToken authzToken, 2: required string dataMovementInterfaceId,
            3: required i32 newPriorityOrder)
  	throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)

  /**
   * Change the priorities of a given set of job submission interfaces
   *
   * @param jobSubmissionPriorityMap
   *   A Map of identifiers of the JobSubmission Interfaces and thier associated priorities to be set.
   *
   * @return status
   *   Returns a success/failure of the changes.
   *
  */

  bool changeJobSubmissionPriorities(1: required security_model.AuthzToken authzToken, 2: required map<string, i32> jobSubmissionPriorityMap)
  	throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)

   /**
   * Change the priorities of a given set of data movement interfaces
   *
   * @param dataMovementPriorityMap
   *   A Map of identifiers of the DataMovement Interfaces and thier associated priorities to be set.
   *
   * @return status
   *   Returns a success/failure of the changes.
   *
   **/

  bool changeDataMovementPriorities(1: required security_model.AuthzToken authzToken, 2: required map<string, i32> dataMovementPriorityMap)
  	throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)

   /**
   * Delete a given job submisison interface
   *
   * @param jobSubmissionInterfaceId
   *   The identifier of the JobSubmission Interface to be changed
   *
   * @return status
   *   Returns a success/failure of the deletion.
   *
   **/

  bool deleteJobSubmissionInterface(1: required security_model.AuthzToken authzToken, 2: required string computeResourceId,
            3: required string jobSubmissionInterfaceId)
  	throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)

   /**
   * Delete a given data movement interface
   *
   * @param dataMovementInterfaceId
   *   The identifier of the DataMovement Interface to be changed
   *
   * @return status
   *   Returns a success/failure of the deletion.
   *
   **/

  bool deleteDataMovementInterface(1: required security_model.AuthzToken authzToken, 2: required string productUri,
            3: required string dataMovementInterfaceId,
            4: required data_movement_models.DMType dataMoveType,)
  	throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)

 string registerResourceJobManager(1: required security_model.AuthzToken authzToken, 2: required compute_resource_model.ResourceJobManager resourceJobManager)
    throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)

 bool updateResourceJobManager(1: required security_model.AuthzToken authzToken, 2: required string resourceJobManagerId,
            3: required compute_resource_model.ResourceJobManager updatedResourceJobManager)
     throws (1: airavata_errors.InvalidRequestException ire,
             2: airavata_errors.AiravataClientException ace,
             3: airavata_errors.AiravataSystemException ase,
             4: airavata_errors.AuthorizationException ae)

 compute_resource_model.ResourceJobManager getResourceJobManager(1: required security_model.AuthzToken authzToken, 2: required string resourceJobManagerId)
      throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.AiravataClientException ace,
              3: airavata_errors.AiravataSystemException ase,
              4: airavata_errors.AuthorizationException ae)

 bool deleteResourceJobManager(1: required security_model.AuthzToken authzToken, 2: required string resourceJobManagerId)
       throws (1: airavata_errors.InvalidRequestException ire,
               2: airavata_errors.AiravataClientException ace,
               3: airavata_errors.AiravataSystemException ase,
               4: airavata_errors.AuthorizationException ae)

  /**
   * Delete a Compute Resource Queue
   *
   * @param computeResourceId
   *   The identifier of the compute resource which has the queue to be deleted
   *
   * @param queueName
   *   Name of the queue need to be deleted. Name is the uniqueue identifier for the queue within a compute resource
   *
   * @return status
   *   Returns a success/failure of the deletion.
   *
   **/

  bool deleteBatchQueue(1: required security_model.AuthzToken authzToken, 2: required string computeResourceId, 3: required string queueName)
        throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)
/*
 * Gateway Resource Profile
 *
*/

  /**
   * Register a Gateway Resource Profile.
   *
   * @param gatewayResourceProfile
   *    Gateway Resource Profile Object.
   *    The GatewayID should be obtained from Airavata gateway registration and passed to register a corresponding
   *      resource profile.
   *
   * @return status
   *   Returns a success/failure of the update.
   *
  */
  string registerGatewayResourceProfile(1: required security_model.AuthzToken authzToken,
                    2: required gateway_resource_profile_model.GatewayResourceProfile gatewayResourceProfile)
    	throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.AiravataClientException ace,
              3: airavata_errors.AiravataSystemException ase,
              4: airavata_errors.AuthorizationException ae)

  /**
   * Fetch the given Gateway Resource Profile.
   *
   * @param gatewayID
   *   The identifier for the requested gateway resource.
   *
   * @return gatewayResourceProfile
   *    Gateway Resource Profile Object.
   *
  */

  gateway_resource_profile_model.GatewayResourceProfile getGatewayResourceProfile(1: required security_model.AuthzToken authzToken,
                2: required string gatewayID)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

  /**
   * Update a Gateway Resource Profile.
   *
   * @param gatewayID
   *   The identifier for the requested gateway resource to be updated.
   *
   * @param gatewayResourceProfile
   *    Gateway Resource Profile Object.
   *
   * @return status
   *   Returns a success/failure of the update.
   *
  */

  bool updateGatewayResourceProfile(1: required security_model.AuthzToken authzToken, 2: required string gatewayID,
            3: required gateway_resource_profile_model.GatewayResourceProfile gatewayResourceProfile)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

  /**
   * Delete the given Gateway Resource Profile.
   *
   * @param gatewayID
   *   The identifier for the requested gateway resource to be deleted.
   *
   * @return status
   *   Returns a success/failure of the deletion.
   *
  */

  bool deleteGatewayResourceProfile(1: required security_model.AuthzToken authzToken, 2: required string gatewayID)
         	throws (1: airavata_errors.InvalidRequestException ire,
                   2: airavata_errors.AiravataClientException ace,
                   3: airavata_errors.AiravataSystemException ase,
                   4: airavata_errors.AuthorizationException ae)

  /**
   * Add a Compute Resource Preference to a registered gateway profile.
   *
   * @param gatewayID
   *   The identifier for the gateway profile to be added.
   *
   * @param computeResourceId
   *   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.
   *
  */
  bool addGatewayComputeResourcePreference(1: required security_model.AuthzToken authzToken, 2: required string gatewayID,
            3: required string computeResourceId,
            4: required gateway_resource_profile_model.ComputeResourcePreference computeResourcePreference)
  	throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)

  /**
   * 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.
   *
  */
  bool addGatewayStoragePreference(1: required security_model.AuthzToken authzToken, 2: required string gatewayID,
              3: required string storageResourceId,
              4: required gateway_resource_profile_model.StoragePreference storagePreference)
    	throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.AiravataClientException ace,
              3: airavata_errors.AiravataSystemException ase,
              4: airavata_errors.AuthorizationException ae)
  /**
   *
   * Fetch a Compute Resource Preference of a registered gateway profile.
   *
   * @param gatewayID
   *   The identifier for the gateway profile to be requested
   *
   * @param computeResourceId
   *   Preferences related to a particular compute resource
   *
   * @return computeResourcePreference
   *   Returns the ComputeResourcePreference object.
   *
  */
  gateway_resource_profile_model.ComputeResourcePreference getGatewayComputeResourcePreference(1: required security_model.AuthzToken authzToken,
            2: required string gatewayID,
            3: required string computeResourceId)
  	throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)

  /**
   *
   * 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.
   *
  */
  gateway_resource_profile_model.StoragePreference getGatewayStoragePreference(1: required security_model.AuthzToken authzToken,
              2: required string gatewayID,
              3: required string storageResourceId)
    	throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.AiravataClientException ace,
              3: airavata_errors.AiravataSystemException ase,
              4: airavata_errors.AuthorizationException ae)

  /**
   *
   * Fetch all Compute Resource Preferences of a registered gateway profile.
   *
   * @param gatewayID
   *   The identifier for the gateway profile to be requested
   *
   * @return computeResourcePreference
   *   Returns the ComputeResourcePreference object.
   *
  */
  list<gateway_resource_profile_model.ComputeResourcePreference>
            getAllGatewayComputeResourcePreferences(1: required security_model.AuthzToken authzToken, 2: required string gatewayID)
  	throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)

  /**
  * 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.
  *
 */

  list<gateway_resource_profile_model.StoragePreference>
              getAllGatewayStoragePreferences(1: required security_model.AuthzToken authzToken, 2: required string gatewayID)
    	throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.AiravataClientException ace,
              3: airavata_errors.AiravataSystemException ase,
              4: airavata_errors.AuthorizationException ae)

  /**
  *
  * Fetch all Gateway Profiles registered
  *
  * @return GatewayResourceProfile
  *   Returns all the GatewayResourcePrifle list object.
  *
  **/
  list<gateway_resource_profile_model.GatewayResourceProfile>
              getAllGatewayResourceProfiles(1: required security_model.AuthzToken authzToken)
    	throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.AiravataClientException ace,
              3: airavata_errors.AiravataSystemException ase,
              4: airavata_errors.AuthorizationException ae)

  /**
   * Update a Compute Resource Preference to a registered gateway profile.
   *
   * @param gatewayID
   *   The identifier for the gateway profile to be updated.
   *
   * @param computeResourceId
   *   Preferences related to a particular compute resource
   *
   * @param computeResourcePreference
   *   The ComputeResourcePreference object to be updated to the resource profile.
   *
   * @return status
   *   Returns a success/failure of the updation.
   *
  */
  bool updateGatewayComputeResourcePreference(1: required security_model.AuthzToken authzToken, 2: required string gatewayID,
            3: required string computeResourceId,
            4: required gateway_resource_profile_model.ComputeResourcePreference computeResourcePreference)
  	throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)

    /**
     * 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.
     *
    */

  bool updateGatewayStoragePreference(1: required security_model.AuthzToken authzToken, 2: required string gatewayID,
              3: required string storageId,
              4: required gateway_resource_profile_model.StoragePreference storagePreference)
    	throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.AiravataClientException ace,
              3: airavata_errors.AiravataSystemException ase,
              4: airavata_errors.AuthorizationException ae)

  /**
   * Delete the Compute Resource Preference of a registered gateway profile.
   *
   * @param gatewayID
   *   The identifier for the gateway profile to be deleted.
   *
   * @param computeResourceId
   *   Preferences related to a particular compute resource
   *
   * @return status
   *   Returns a success/failure of the deletion.
   *
  */
  bool deleteGatewayComputeResourcePreference(1: required security_model.AuthzToken authzToken, 2: required string gatewayID,
            3: required string computeResourceId)
  	throws (1: airavata_errors.InvalidRequestException ire,
            2: airavata_errors.AiravataClientException ace,
            3: airavata_errors.AiravataSystemException ase,
            4: airavata_errors.AuthorizationException ae)


  /**
   * 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.
   *
  */

  bool deleteGatewayStoragePreference(1: required security_model.AuthzToken authzToken, 2: required string gatewayID,
              3: required string storageId)
    	throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.AiravataClientException ace,
              3: airavata_errors.AiravataSystemException ase,
              4: airavata_errors.AuthorizationException ae)

  list<account_provisioning_model.SSHAccountProvisioner> getSSHAccountProvisioners(1: required security_model.AuthzToken authzToken)
    	throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.AiravataClientException ace,
              3: airavata_errors.AiravataSystemException ase,
              4: airavata_errors.AuthorizationException ae)

  /**
   * Check if user has an SSH account on the given compute resource. This
   * method will only work if the compute resource has an SSHAccountProvisioner configured for it.
   */
  bool doesUserHaveSSHAccount(1: required security_model.AuthzToken authzToken, 2: required string computeResourceId, 3: required string userId)
    	throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.AiravataClientException ace,
              3: airavata_errors.AiravataSystemException ase,
              4: airavata_errors.AuthorizationException ae)

  /**
   * Check if SSH account setup is complete for this user on the given compute resource.
   */
  bool isSSHSetupCompleteForUserComputeResourcePreference(1: required security_model.AuthzToken authzToken, 2: required string computeResourceId, 3: required string airavataCredStoreToken)
    	throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.AiravataClientException ace,
              3: airavata_errors.AiravataSystemException ase,
              4: airavata_errors.AuthorizationException ae)

  /**
   * Setup and return a UserComputeResourcePreference object for this user to SSH into the given compute resource with
   * the given SSH credential. This method will only work if the compute resource has an SSHAccountProvisioner
   * configured for it. The returned UserComputeResourcePreference object is not saved; it is up to the client to
   * call addUserComputeResourcePreference to persist it.
   */
  user_resource_profile_model.UserComputeResourcePreference setupUserComputeResourcePreferencesForSSH(1: required security_model.AuthzToken authzToken,
            2: required string computeResourceId, 3: required string userId, 4: required string airavataCredStoreToken)
    	throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.AiravataClientException ace,
              3: airavata_errors.AiravataSystemException ase,
              4: airavata_errors.AuthorizationException ae)

  /*
   * User Resource Profile
   *
  */

    /**
     * Register User Resource Profile.
     *
     * @param UserResourceProfile
     *    User Resource Profile Object.
     *    The userId should be obtained from Airavata user profile data model and passed to register a corresponding
     *      resource profile.
     *
     * @return status
     *   Returns a success/failure of the update.
     *
    */
    string registerUserResourceProfile(1: required security_model.AuthzToken authzToken,
                      2: required user_resource_profile_model.UserResourceProfile userResourceProfile)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

    /**
     * Check if User Resource Profile exists.
     *
     * @param userId
     *   The identifier for the requested user resource profile.
     *
     * @param gatewayID
     *   The identifier to link a gateway for the requested user resource profile.
     *
     * @return bool
     *
    */
    bool isUserResourceProfileExists(1: required security_model.AuthzToken authzToken,
                  2: required string userId, 3: required string gatewayID)
        	throws (1: airavata_errors.InvalidRequestException ire,
                  2: airavata_errors.AiravataClientException ace,
                  3: airavata_errors.AiravataSystemException ase,
                  4: airavata_errors.AuthorizationException ae)
    /**
     * Fetch the given User Resource Profile.
     *
     * @param userId
     *   The identifier for the requested user resource profile.
     *
     * @param gatewayID
     *   The identifier to link a gateway for the requested user resource profile.
     *
     * @return UserResourceProfile
     *    User Resource Profile Object.
     *
    */

    user_resource_profile_model.UserResourceProfile getUserResourceProfile(1: required security_model.AuthzToken authzToken,
                  2: required string userId, 3: required string gatewayID)
        	throws (1: airavata_errors.InvalidRequestException ire,
                  2: airavata_errors.AiravataClientException ace,
                  3: airavata_errors.AiravataSystemException ase,
                  4: airavata_errors.AuthorizationException ae)

    /**
     * Update a User Resource Profile.
     *
     * @param userId
     *   The identifier for the requested user resource to be updated.
     *
     * @param gatewayID
     *   The identifier to link a gateway for the requested user resource profile.
     *
     * @param UserResourceProfile
     *    User Resource Profile Object.
     *
     * @return status
     *   Returns a success/failure of the update.
     *
    */

    bool updateUserResourceProfile(1: required security_model.AuthzToken authzToken, 2: required string userId,
              3: required string gatewayID, 4: required user_resource_profile_model.UserResourceProfile userResourceProfile)
        	throws (1: airavata_errors.InvalidRequestException ire,
                  2: airavata_errors.AiravataClientException ace,
                  3: airavata_errors.AiravataSystemException ase,
                  4: airavata_errors.AuthorizationException ae)

    /**
     * Delete the given User Resource Profile.
     *
     * @param userId
     *   The identifier for the requested user resource to be deleted.
     *
     * @param gatewayID
     *   The identifier to link a gateway for the requested user resource profile.
     *
     * @return status
     *   Returns a success/failure of the deletion.
     *
    */

    bool deleteUserResourceProfile(1: required security_model.AuthzToken authzToken, 2: required string userId,
                3: required string gatewayID)
           	throws (1: airavata_errors.InvalidRequestException ire,
                     2: airavata_errors.AiravataClientException ace,
                     3: airavata_errors.AiravataSystemException ase,
                     4: airavata_errors.AuthorizationException ae)

    /**
     * Add a Compute Resource Preference to a registered User profile.
     *
     * @param userId
     *   The identifier for the User resource profile to be added.
     *
     * @param gatewayID
     *   The identifier to link a gateway for the requested user resource profile.
     *
     * @param computeResourceId
     *   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.
     *
    */
    bool addUserComputeResourcePreference(1: required security_model.AuthzToken authzToken, 2: required string userId,
              3: required string gatewayID, 4: required string userComputeResourceId,
              5: required user_resource_profile_model.UserComputeResourcePreference userComputeResourcePreference)
    	throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.AiravataClientException ace,
              3: airavata_errors.AiravataSystemException ase,
              4: airavata_errors.AuthorizationException ae)

    /**
     * Add a Storage Resource Preference to a registered user resource profile.
     *
     * @param userId
     *   The identifier of the user resource profile to be added.
     *
     * @param gatewayID
     *   The identifier to link a gateway for the requested user resource profile.
     *
     * @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.
     *
    */
    bool addUserStoragePreference(1: required security_model.AuthzToken authzToken, 2: required string userId,
                3: required string gatewayID,
                4: required string userStorageResourceId,
                5: required user_resource_profile_model.UserStoragePreference userStoragePreference)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)
    /**
     *
     * Fetch a Compute Resource Preference of a registered user resource profile.
     *
     * @param userId
     *   The identifier for the user profile to be requested
     *
     * @param gatewayID
     *   The identifier to link a gateway for the requested user resource profile.
     *
     * @param userComputeResourceId
     *   Preferences related to a particular compute resource
     *
     * @return computeResourcePreference
     *   Returns the ComputeResourcePreference object.
     *
    */
    user_resource_profile_model.UserComputeResourcePreference getUserComputeResourcePreference(1: required security_model.AuthzToken authzToken,
              2: required string userId,
              3: required string gatewayID,
              4: required string userComputeResourceId)
    	throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.AiravataClientException ace,
              3: airavata_errors.AiravataSystemException ase,
              4: airavata_errors.AuthorizationException ae)

    /**
     *
     * Fetch a Storage Resource Preference of a registered user resource profile.
     *
     * @param userId
     *   The identifier of the user resource profile to request to fetch the particular storage resource preference.
     *
     * @param gatewayID
     *   The identifier to link a gateway for the requested user resource profile.
     *
     * @param userStorageResourceId
     *   Identifier of the Stprage Preference required to be fetched.
     *
     * @return UserStoragePreference
     *   Returns the StoragePreference object.
     *
    */
    user_resource_profile_model.UserStoragePreference getUserStoragePreference(1: required security_model.AuthzToken authzToken,
                2: required string userId,
                3: required string gatewayID,
                4: required string userStorageResourceId)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)


    /**
       *
       * Fetch all Compute Resource Preferences of a registered gateway profile.
       *
       * @param userId
       *   The identifier of the user resource profile to request to fetch the particular storage resource preference.
       *
       * @param gatewayID
       *   The identifier for the gateway profile to be requested
       *
       * @return computeResourcePreference
       *   Returns the ComputeResourcePreference object.
       *
      */
      list<user_resource_profile_model.UserComputeResourcePreference>
                getAllUserComputeResourcePreferences(1: required security_model.AuthzToken authzToken,
                2: required string userId,
                3: required string gatewayID)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

      /**
      * Fetch all User Storage Resource Preferences of a registered user profile.
      *
      * @param userId
      *   The identifier of the user resource profile to request to fetch the particular storage resource preference.
      *
      * @param gatewayID
      *   The identifier for the gateway profile to be requested
      *
      * @return StoragePreference
      *   Returns the StoragePreference object.
      *
     */

      list<user_resource_profile_model.UserStoragePreference>
                  getAllUserStoragePreferences(1: required security_model.AuthzToken authzToken,
                  2: required string userId,
                  3: required string gatewayID)
        	throws (1: airavata_errors.InvalidRequestException ire,
                  2: airavata_errors.AiravataClientException ace,
                  3: airavata_errors.AiravataSystemException ase,
                  4: airavata_errors.AuthorizationException ae)


    /**
    *
    * Fetch all user resources Profiles registered
    *
    * @return UserResourceProfile
    *   Returns all the UserResourcePrifle list object.
    *
    **/
    list<user_resource_profile_model.UserResourceProfile>
                getAllUserResourceProfiles(1: required security_model.AuthzToken authzToken)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

    /**
     * Update a Compute Resource Preference to a registered user resource profile.
     *
     * @param userId
     *   The identifier for the user profile to be updated.
     *
     * @param gatewayID
     *   The identifier to link a gateway for the requested user resource profile.
     *
     * @param userComputeResourceId
     *   Preferences related to a particular compute resource
     *
     * @param userComputeResourcePreference
     *   The ComputeResourcePreference object to be updated to the resource profile.
     *
     * @return status
     *   Returns a success/failure of the updation.
     *
    */
    bool updateUserComputeResourcePreference(1: required security_model.AuthzToken authzToken, 2: required string userId,
              3: required string gatewayID,
              4: required string userComputeResourceId,
              5: required user_resource_profile_model.UserComputeResourcePreference userComputeResourcePreference)
    	throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.AiravataClientException ace,
              3: airavata_errors.AiravataSystemException ase,
              4: airavata_errors.AuthorizationException ae)

      /**
       * Update a Storage Resource Preference of a registered user resource profile.
       *
       * @param userId
       *   The identifier of the user resource profile to be updated.
       *
       * @param gatewayID
       *   The identifier to link a gateway for the requested user resource profile.
       *
       * @param userStorageId
       *   The Storage resource identifier of the one that you want to update
       *
       * @param userStoragePreference
       *   The storagePreference object to be updated to the resource profile.
       *
       * @return status
       *   Returns a success/failure of the updation.
       *
      */

    bool updateUserStoragePreference(1: required security_model.AuthzToken authzToken, 2: required string userId,
                3: required string gatewayID,
                4: required string userStorageId,
                5: required user_resource_profile_model.UserStoragePreference userStoragePreference)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

    /**
     * Delete the Compute Resource Preference of a registered user resource profile.
     *
     * @param userId
     *   The identifier for the user resource profile to be deleted.
     *
     * @param gatewayID
     *   The identifier to link a gateway for the requested user resource profile.
     *
     * @param userComputeResourceId
     *   Preferences related to a particular compute resource
     *
     * @return status
     *   Returns a success/failure of the deletion.
     *
    */
    bool deleteUserComputeResourcePreference(1: required security_model.AuthzToken authzToken, 2: required string userId,
              3: required string gatewayID,
              4: required string userComputeResourceId)
    	throws (1: airavata_errors.InvalidRequestException ire,
              2: airavata_errors.AiravataClientException ace,
              3: airavata_errors.AiravataSystemException ase,
              4: airavata_errors.AuthorizationException ae)


    /**
     * Delete the Storage Resource Preference of a registered user resource profile.
     *
     * @param userId
     *   The identifier of the user profile to be deleted.
     *
     * @param gatewayID
     *   The identifier to link a gateway for the requested user resource profile.
     *
     * @param userStorageId
     *   ID of the storage preference you want to delete.
     *
     * @return status
     *   Returns a success/failure of the deletion.
     *
    */

    bool deleteUserStoragePreference(1: required security_model.AuthzToken authzToken, 2: required string userId,
                3: required string gatewayID,
                4: required string userStorageId)
      	throws (1: airavata_errors.InvalidRequestException ire,
                2: airavata_errors.AiravataClientException ace,
                3: airavata_errors.AiravataSystemException ase,
                4: airavata_errors.AuthorizationException ae)

  list<status_models.QueueStatusModel> getLatestQueueStatuses(1: required security_model.AuthzToken authzToken)
        throws (1: airavata_errors.InvalidRequestException ire,
                        2: airavata_errors.AiravataClientException ace,
                        3: airavata_errors.AiravataSystemException ase,
                        4: airavata_errors.AuthorizationException ae)

 /**
 * API Methods related to replica catalog
 **/
 string registerDataProduct(1: required security_model.AuthzToken authzToken, 2: required  replica_catalog_models.DataProductModel dataProductModel)
            throws (1: airavata_errors.InvalidRequestException ire,
                              2: airavata_errors.AiravataClientException ace,
                              3: airavata_errors.AiravataSystemException ase,
                              4: airavata_errors.AuthorizationException ae)

 replica_catalog_models.DataProductModel getDataProduct(1: required security_model.AuthzToken authzToken, 2: required  string dataProductUri)
             throws (1: airavata_errors.InvalidRequestException ire,
                               2: airavata_errors.AiravataClientException ace,
                               3: airavata_errors.AiravataSystemException ase,
                               4: airavata_errors.AuthorizationException ae)

 string registerReplicaLocation(1: required security_model.AuthzToken authzToken, 2: required  replica_catalog_models.DataReplicaLocationModel replicaLocationModel)
              throws (1: airavata_errors.InvalidRequestException ire,
                                2: airavata_errors.AiravataClientException ace,
                                3: airavata_errors.AiravataSystemException ase,
                                4: airavata_errors.AuthorizationException ae)

 replica_catalog_models.DataProductModel getParentDataProduct(1: required security_model.AuthzToken authzToken, 2: required  string productUri)
               throws (1: airavata_errors.InvalidRequestException ire,
                                 2: airavata_errors.AiravataClientException ace,
                                 3: airavata_errors.AiravataSystemException ase,
                                 4: airavata_errors.AuthorizationException ae)

 list<replica_catalog_models.DataProductModel> getChildDataProducts(1: required security_model.AuthzToken authzToken, 2: required  string productUri)
               throws (1: airavata_errors.InvalidRequestException ire,
                                 2: airavata_errors.AiravataClientException ace,
                                 3: airavata_errors.AiravataSystemException ase,
                                 4: airavata_errors.AuthorizationException ae)

 /**
  * Group Manager and Data Sharing Related API methods
  **/
  bool shareResourceWithUsers(1: required security_model.AuthzToken authzToken, 2: required string resourceId,
                                4: map<string, group_manager_model.ResourcePermissionType> userPermissionList)
               throws (1: airavata_errors.InvalidRequestException ire,
                                                2: airavata_errors.AiravataClientException ace,
                                                3: airavata_errors.AiravataSystemException ase,
                                                4: airavata_errors.AuthorizationException ae)

  bool shareResourceWithGroups(1: required security_model.AuthzToken authzToken, 2: required string resourceId,
                                4: map<string, group_manager_model.ResourcePermissionType> groupPermissionList)
               throws (1: airavata_errors.InvalidRequestException ire,
                                                2: airavata_errors.AiravataClientException ace,
                                                3: airavata_errors.AiravataSystemException ase,
                                                4: airavata_errors.AuthorizationException ae)

 bool revokeSharingOfResourceFromUsers(1: required security_model.AuthzToken authzToken, 2: required string resourceId,
                                 4: map<string, group_manager_model.ResourcePermissionType> userPermissionList)
                throws (1: airavata_errors.InvalidRequestException ire,
                                                 2: airavata_errors.AiravataClientException ace,
                                                 3: airavata_errors.AiravataSystemException ase,
                                                 4: airavata_errors.AuthorizationException ae)

 bool revokeSharingOfResourceFromGroups(1: required security_model.AuthzToken authzToken, 2: required string resourceId,
                                 4: map<string, group_manager_model.ResourcePermissionType> groupPermissionList)
                throws (1: airavata_errors.InvalidRequestException ire,
                                                 2: airavata_errors.AiravataClientException ace,
                                                 3: airavata_errors.AiravataSystemException ase,
                                                 4: airavata_errors.AuthorizationException ae)

 list<string> getAllAccessibleUsers(1: required security_model.AuthzToken authzToken, 2: required string resourceId,
                                  4: required group_manager_model.ResourcePermissionType permissionType)
                throws (1: airavata_errors.InvalidRequestException ire,
                                                 2: airavata_errors.AiravataClientException ace,
                                                 3: airavata_errors.AiravataSystemException ase,
                                                 4: airavata_errors.AuthorizationException ae)

 list<string> getAllAccessibleGroups(1: required security_model.AuthzToken authzToken, 2: required string resourceId,
                                  4: required group_manager_model.ResourcePermissionType permissionType)
                throws (1: airavata_errors.InvalidRequestException ire,
                                                 2: airavata_errors.AiravataClientException ace,
                                                 3: airavata_errors.AiravataSystemException ase,
                                                 4: airavata_errors.AuthorizationException ae)

 list<string> getAllDirectlyAccessibleUsers(1: required security_model.AuthzToken authzToken, 2: required string resourceId,
                                  4: required group_manager_model.ResourcePermissionType permissionType)
                throws (1: airavata_errors.InvalidRequestException ire,
                                                 2: airavata_errors.AiravataClientException ace,
                                                 3: airavata_errors.AiravataSystemException ase,
                                                 4: airavata_errors.AuthorizationException ae)

 list<string> getAllDirectlyAccessibleGroups(1: required security_model.AuthzToken authzToken, 2: required string resourceId,
                                  4: required group_manager_model.ResourcePermissionType permissionType)
                throws (1: airavata_errors.InvalidRequestException ire,
                                                 2: airavata_errors.AiravataClientException ace,
                                                 3: airavata_errors.AiravataSystemException ase,
                                                 4: airavata_errors.AuthorizationException ae)

 bool userHasAccess(1: required security_model.AuthzToken authzToken, 2: required string resourceId, 3: required group_manager_model.ResourcePermissionType permissionType)
                throws (1: airavata_errors.InvalidRequestException ire,
                                                 2: airavata_errors.AiravataClientException ace,
                                                 3: airavata_errors.AiravataSystemException ase,
                                                 4: airavata_errors.AuthorizationException ae)


 string createGroupResourceProfile(1: required security_model.AuthzToken authzToken, 2: required group_resource_profile_model.GroupResourceProfile groupResourceProfile)
                                                                         throws (1: airavata_errors.InvalidRequestException ire,
                                                                                 2: airavata_errors.AiravataClientException ace,
                                                                                 3: airavata_errors.AiravataSystemException ase,
                                                                                 4: airavata_errors.AuthorizationException ae)

 void updateGroupResourceProfile(1: required security_model.AuthzToken authzToken, 2: required group_resource_profile_model.GroupResourceProfile groupResourceProfile)
                                                                                           throws (1: airavata_errors.InvalidRequestException ire,
                                                                                                   2: airavata_errors.AiravataClientException ace,
                                                                                                   3: airavata_errors.AiravataSystemException ase,
                                                                                                   4: airavata_errors.AuthorizationException ae)

 group_resource_profile_model.GroupResourceProfile getGroupResourceProfile(1: required security_model.AuthzToken authzToken, 2: required string groupResourceProfileId)
                                                                         throws (1: airavata_errors.InvalidRequestException ire,
                                                                                 2: airavata_errors.AiravataClientException ace,
                                                                                 3: airavata_errors.AiravataSystemException ase,
                                                                                 4: airavata_errors.AuthorizationException ae)

 bool removeGroupResourceProfile(1: required security_model.AuthzToken authzToken, 2: required string groupResourceProfileId)
                                                                                    throws (1: airavata_errors.InvalidRequestException ire,
                                                                                             2: airavata_errors.AiravataClientException ace,
                                                                                             3: airavata_errors.AiravataSystemException ase,
                                                                                             4: airavata_errors.AuthorizationException ae)

 list<group_resource_profile_model.GroupResourceProfile> getGroupResourceList(1: required security_model.AuthzToken authzToken, 2: required string gatewayId)
                                                                                 throws (1: airavata_errors.InvalidRequestException ire,
                                                                                         2: airavata_errors.AiravataClientException ace,
                                                                                         3: airavata_errors.AiravataSystemException ase,
                                                                                         4: airavata_errors.AuthorizationException ae)

 bool removeGroupComputePrefs(1: required security_model.AuthzToken authzToken, 2: required string computeResourceId, 3: required string groupResourceProfileId)
                                                                                 throws (1: airavata_errors.InvalidRequestException ire,
                                                                                         2: airavata_errors.AiravataClientException ace,
                                                                                         3: airavata_errors.AiravataSystemException ase,
                                                                                         4: airavata_errors.AuthorizationException ae)

 bool removeGroupComputeResourcePolicy(1: required security_model.AuthzToken authzToken, 2: required string resourcePolicyId)
                                                                                 throws (1: airavata_errors.InvalidRequestException ire,
                                                                                         2: airavata_errors.AiravataClientException ace,
                                                                                         3: airavata_errors.AiravataSystemException ase,
                                                                                         4: airavata_errors.AuthorizationException ae)

 bool removeGroupBatchQueueResourcePolicy(1: required security_model.AuthzToken authzToken, 2: required string resourcePolicyId)
                                                                                 throws (1: airavata_errors.InvalidRequestException ire,
                                                                                         2: airavata_errors.AiravataClientException ace,
                                                                                         3: airavata_errors.AiravataSystemException ase,
                                                                                         4: airavata_errors.AuthorizationException ae)

 group_resource_profile_model.GroupComputeResourcePreference getGroupComputeResourcePreference(1: required security_model.AuthzToken authzToken, 2: required string computeResourceId, 3: required string groupResourceProfileId)
                                                                                 throws (1: airavata_errors.InvalidRequestException ire,
                                                                                         2: airavata_errors.AiravataClientException ace,
                                                                                         3: airavata_errors.AiravataSystemException ase,
                                                                                         4: airavata_errors.AuthorizationException ae)

 group_resource_profile_model.ComputeResourcePolicy getGroupComputeResourcePolicy(1: required security_model.AuthzToken authzToken, 2: required string resourcePolicyId)
                                                                                 throws (1: airavata_errors.InvalidRequestException ire,
                                                                                         2: airavata_errors.AiravataClientException ace,
                                                                                         3: airavata_errors.AiravataSystemException ase,
                                                                                         4: airavata_errors.AuthorizationException ae)

 group_resource_profile_model.BatchQueueResourcePolicy getBatchQueueResourcePolicy(1: required security_model.AuthzToken authzToken,2: required string resourcePolicyId)
                                                                                 throws (1: airavata_errors.InvalidRequestException ire,
                                                                                         2: airavata_errors.AiravataClientException ace,
                                                                                         3: airavata_errors.AiravataSystemException ase,
                                                                                         4: airavata_errors.AuthorizationException ae)

 list<group_resource_profile_model.GroupComputeResourcePreference> getGroupComputeResourcePrefList(1: required security_model.AuthzToken authzToken, 2: required string groupResourceProfileId)
                                                                                 throws (1: airavata_errors.InvalidRequestException ire,
                                                                                         2: airavata_errors.AiravataClientException ace,
                                                                                         3: airavata_errors.AiravataSystemException ase,
                                                                                         4: airavata_errors.AuthorizationException ae)

 list<group_resource_profile_model.BatchQueueResourcePolicy> getGroupBatchQueueResourcePolicyList(1: required security_model.AuthzToken authzToken, 2: required string groupResourceProfileId)
                                                                                 throws (1: airavata_errors.InvalidRequestException ire,
                                                                                         2: airavata_errors.AiravataClientException ace,
                                                                                         3: airavata_errors.AiravataSystemException ase,
                                                                                         4: airavata_errors.AuthorizationException ae)

 list<group_resource_profile_model.ComputeResourcePolicy> getGroupComputeResourcePolicyList(1: required security_model.AuthzToken authzToken, 2: required string groupResourceProfileId)
                                                                                 throws (1: airavata_errors.InvalidRequestException ire,
                                                                                         2: airavata_errors.AiravataClientException ace,
                                                                                         3: airavata_errors.AiravataSystemException ase,
                                                                                         4: airavata_errors.AuthorizationException ae)
  /**
   * GatewayGroups API methods
   */
 gateway_groups_model.GatewayGroups getGatewayGroups(1: required security_model.AuthzToken authzToken)
                                                                                 throws (1: airavata_errors.InvalidRequestException ire,
                                                                                         2: airavata_errors.AiravataClientException ace,
                                                                                         3: airavata_errors.AiravataSystemException ase,
                                                                                         4: airavata_errors.AuthorizationException ae)

 parser_model.Parser getParser(1: required security_model.AuthzToken authzToken, 2: required string parserId, 3: required string gatewayId)
                                                                                 throws (1: airavata_errors.InvalidRequestException ire,
                                                                                         2: airavata_errors.AiravataClientException ace,
                                                                                         3: airavata_errors.AiravataSystemException ase,
                                                                                         4: airavata_errors.AuthorizationException ae)

 string saveParser(1: required security_model.AuthzToken authzToken, 2: required parser_model.Parser parser)
                                                                                 throws (1: airavata_errors.InvalidRequestException ire,
                                                                                         2: airavata_errors.AiravataClientException ace,
                                                                                         3: airavata_errors.AiravataSystemException ase,
                                                                                         4: airavata_errors.AuthorizationException ae)

 list<parser_model.Parser> listAllParsers(1: required security_model.AuthzToken authzToken, 2: required string gatewayId)
                                                                                 throws (1: airavata_errors.InvalidRequestException ire,
                                                                                         2: airavata_errors.AiravataClientException ace,
                                                                                         3: airavata_errors.AiravataSystemException ase,
                                                                                         4: airavata_errors.AuthorizationException ae)

 bool removeParser(1: required security_model.AuthzToken authzToken, 2: required string parserId, 3: required string gatewayId) throws (1: airavata_errors.InvalidRequestException ire,
                                                                                          2: airavata_errors.AiravataClientException ace,
                                                                                          3: airavata_errors.AiravataSystemException ase,
                                                                                          4: airavata_errors.AuthorizationException ae)
 parser_model.ParsingTemplate getParsingTemplate(1: required security_model.AuthzToken authzToken, 2: required string templateId, 3: required string gatewayId)
                                                                                 throws (1: airavata_errors.InvalidRequestException ire,
                                                                                         2: airavata_errors.AiravataClientException ace,
                                                                                         3: airavata_errors.AiravataSystemException ase,
                                                                                         4: airavata_errors.AuthorizationException ae);

 list<parser_model.ParsingTemplate> getParsingTemplatesForExperiment(1: required security_model.AuthzToken authzToken, 2: required string experimentId, 3: required string gatewayId)
                                                                                 throws (1: airavata_errors.InvalidRequestException ire,
                                                                                         2: airavata_errors.AiravataClientException ace,
                                                                                         3: airavata_errors.AiravataSystemException ase,
                                                                                         4: airavata_errors.AuthorizationException ae);

 string saveParsingTemplate(1: required security_model.AuthzToken authzToken, 2: required parser_model.ParsingTemplate parsingTemplate)
                                                                                 throws (1: airavata_errors.InvalidRequestException ire,
                                                                                         2: airavata_errors.AiravataClientException ace,
                                                                                         3: airavata_errors.AiravataSystemException ase,
                                                                                         4: airavata_errors.AuthorizationException ae);

 bool removeParsingTemplate(1: required security_model.AuthzToken authzToken, 2: required string templateId, 3: required string gatewayId)
                                                                                  throws (1: airavata_errors.InvalidRequestException ire,
                                                                                          2: airavata_errors.AiravataClientException ace,
                                                                                          3: airavata_errors.AiravataSystemException ase,
                                                                                          4: airavata_errors.AuthorizationException ae);

  list<parser_model.ParsingTemplate> listAllParsingTemplates(1: required security_model.AuthzToken authzToken, 2: required string gatewayId)
                                                                                  throws (1: airavata_errors.InvalidRequestException ire,
                                                                                          2: airavata_errors.AiravataClientException ace,
                                                                                          3: airavata_errors.AiravataSystemException ase,
                                                                                          4: airavata_errors.AuthorizationException ae);
 //
 //End of API
 }