You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airavata.apache.org by ch...@apache.org on 2014/01/22 20:28:02 UTC
svn commit: r1560486 - in /airavata/trunk/modules/thrift-interfaces:
airavata-api.thrift airavata-errors.thrift airavataApi.thrift
airavataDatastructures.thrift airavataErrors.thrift
execution-datastructures.thrift orchestrator.thrift
Author: chathuri
Date: Wed Jan 22 19:28:01 2014
New Revision: 1560486
URL: http://svn.apache.org/r1560486
Log:
updating thrift interfaces
Added:
airavata/trunk/modules/thrift-interfaces/airavataApi.thrift
- copied, changed from r1560440, airavata/trunk/modules/thrift-interfaces/airavata-api.thrift
airavata/trunk/modules/thrift-interfaces/airavataDatastructures.thrift
- copied, changed from r1560440, airavata/trunk/modules/thrift-interfaces/execution-datastructures.thrift
airavata/trunk/modules/thrift-interfaces/airavataErrors.thrift
- copied, changed from r1560440, airavata/trunk/modules/thrift-interfaces/airavata-errors.thrift
airavata/trunk/modules/thrift-interfaces/orchestrator.thrift
Removed:
airavata/trunk/modules/thrift-interfaces/airavata-api.thrift
airavata/trunk/modules/thrift-interfaces/airavata-errors.thrift
airavata/trunk/modules/thrift-interfaces/execution-datastructures.thrift
Copied: airavata/trunk/modules/thrift-interfaces/airavataApi.thrift (from r1560440, airavata/trunk/modules/thrift-interfaces/airavata-api.thrift)
URL: http://svn.apache.org/viewvc/airavata/trunk/modules/thrift-interfaces/airavataApi.thrift?p2=airavata/trunk/modules/thrift-interfaces/airavataApi.thrift&p1=airavata/trunk/modules/thrift-interfaces/airavata-api.thrift&r1=1560440&r2=1560486&rev=1560486&view=diff
==============================================================================
--- airavata/trunk/modules/thrift-interfaces/airavata-api.thrift (original)
+++ airavata/trunk/modules/thrift-interfaces/airavataApi.thrift Wed Jan 22 19:28:01 2014
@@ -22,8 +22,8 @@
* Application Programming Interface definition for Apache Airavata Services.
*/
-include "execution-datastructures.thrift"
-include "airavata-errors.thrift"
+include "airavataDatastructures.thrift"
+include "airavataErrors.thrift"
namespace java org.apache.airavata.api
namespace php Airavata.API
@@ -91,10 +91,10 @@ service Airavata {
* rather an Airavata Administrator will be notified to take corrective action.
*
*/
- string createExperiment(1: required ExperimentMetadata experimentMetadata)
- throws (1:InvalidRequestException ire
- 2:AiravataClientException ace,
- 3:AiravataSystemException ase)
+ string createExperiment(1: required airavataDatastructures.ExperimentMetadata experimentMetadata)
+ throws (1:airavataErrors.InvalidRequestException ire
+ 2:airavataErrors.AiravataClientException ace,
+ 3:airavataErrors.AiravataSystemException ase)
/**
* Fetch previously created experiment metadata.
@@ -129,11 +129,11 @@ service Airavata {
* rather an Airavata Administrator will be notified to take corrective action.
*
*/
- ExperimentMetadata getExperimentMetadata(1:required string airavataExperimentId)
- throws (1:InvalidRequestException ire,
- 2:ExperimentNotFoundException enf,
- 3:AiravataClientException ace,
- 4:AiravataSystemException ase)
+ airavataDatastructures.ExperimentMetadata getExperimentMetadata(1:required string airavataExperimentId)
+ throws (1:airavataErrors.InvalidRequestException ire,
+ 2:airavataErrors.ExperimentNotFoundException enf,
+ 3:airavataErrors.AiravataClientException ace,
+ 4:airavataErrors.AiravataSystemException ase)
/**
* Configure a previously created experiment with required inputs, scheduling and other quality of service
@@ -179,12 +179,12 @@ service Airavata {
*
*/
void configureExperiment(1:required string airavataExperimentId,
- 2:required ExperimentConfigurationData experimentConfigurationData,
- 3:optional ExperimentMetadata experimentMetadata)
- throws (1:InvalidRequestException ire,
- 2:ExperimentNotFoundException enf,
- 3:AiravataClientException ace,
- 4:AiravataSystemException ase)
+ 2:required airavataDatastructures.ExperimentConfigurationData experimentConfigurationData,
+ 3:optional airavataDatastructures.ExperimentMetadata experimentMetadata)
+ throws (1:airavataErrors.InvalidRequestException ire,
+ 2:airavataErrors.ExperimentNotFoundException enf,
+ 3:airavataErrors.AiravataClientException ace,
+ 4:airavataErrors.AiravataSystemException ase)
/**
* Fetch the previously configured experiment configuration information.
@@ -219,11 +219,11 @@ service Airavata {
* rather an Airavata Administrator will be notified to take corrective action.
*
*/
- ExperimentConfigurationData getExperimentConfiguration(1:required string airavataExperimentId)
- throws (1:InvalidRequestException ire,
- 2:ExperimentNotFoundException enf,
- 3:AiravataClientException ace,
- 4:AiravataSystemException ase)
+ airavataDatastructures.ExperimentConfigurationData getExperimentConfiguration(1:required string airavataExperimentId)
+ throws (1:airavataErrors.InvalidRequestException ire,
+ 2:airavataErrors.ExperimentNotFoundException enf,
+ 3:airavataErrors.AiravataClientException ace,
+ 4:airavataErrors.AiravataSystemException ase)
/**
* Launch a previously created and configured experiment. Airavata Server will then start processing the request and appropriate
@@ -270,10 +270,10 @@ service Airavata {
*/
void launchConfiguredExperiment(1:required string airavataExperimentId
2:required string airavataCredStoreToken)
- throws (1:InvalidRequestException ire,
- 2:ExperimentNotFoundException enf,
- 3:AiravataClientException ace,
- 4:AiravataSystemException ase)
+ throws (1:airavataErrors.InvalidRequestException ire,
+ 2:airavataErrors.ExperimentNotFoundException enf,
+ 3:airavataErrors.AiravataClientException ace,
+ 4:airavataErrors.AiravataSystemException ase)
/**
* Configure and Launch a previously created experiment with required inputs, scheduling, security and other quality of service
@@ -324,13 +324,13 @@ service Airavata {
*
*/
string configureAndLaunchExperiment (1:required string airavataExperimentId
- 2:required ExperimentConfigurationData experimentConfigurationData,
+ 2:required airavataDatastructures.ExperimentConfigurationData experimentConfigurationData,
3:required string airavataCredStoreToken
- 4:optional ExperimentMetadata experimentMetadata)
- throws (1:InvalidRequestException ire,
- 2:ExperimentNotFoundException enf,
- 3:AiravataClientException ace,
- 4:AiravataSystemException ase)
+ 4:optional airavataDatastructures.ExperimentMetadata experimentMetadata)
+ throws (1:airavataErrors.InvalidRequestException ire,
+ 2:airavataErrors.ExperimentNotFoundException enf,
+ 3:airavataErrors.AiravataClientException ace,
+ 4:airavataErrors.AiravataSystemException ase)
/**
* Clone an specified experiment with a new name. A copy of the experiment configuration is made and is persisted with new metadata.
@@ -372,11 +372,11 @@ service Airavata {
*
*/
string cloneExperimentConfiguration(1:required string airavataExperimentIdToBeCloned,
- 2:required ExperimentMetadata experimentMetadata)
- throws (1:InvalidRequestException ire,
- 2:ExperimentNotFoundException enf,
- 3:AiravataClientException ace,
- 4:AiravataSystemException ase)
+ 2:required airavataDatastructures.ExperimentMetadata experimentMetadata)
+ throws (1:airavataErrors.InvalidRequestException ire,
+ 2:airavataErrors.ExperimentNotFoundException enf,
+ 3:airavataErrors.AiravataClientException ace,
+ 4:airavataErrors.AiravataSystemException ase)
/**
* Terminate a running experiment.
@@ -412,9 +412,9 @@ service Airavata {
*
*/
void terminateExperiment(1:required string airavataExperimentId)
- throws (1:InvalidRequestException ire,
- 2:ExperimentNotFoundException enf,
- 3:AiravataClientException ace,
- 4:AiravataSystemException ase)
+ throws (1:airavataErrors.InvalidRequestException ire,
+ 2:airavataErrors.ExperimentNotFoundException enf,
+ 3:airavataErrors.AiravataClientException ace,
+ 4:airavataErrors.AiravataSystemException ase)
}
Copied: airavata/trunk/modules/thrift-interfaces/airavataDatastructures.thrift (from r1560440, airavata/trunk/modules/thrift-interfaces/execution-datastructures.thrift)
URL: http://svn.apache.org/viewvc/airavata/trunk/modules/thrift-interfaces/airavataDatastructures.thrift?p2=airavata/trunk/modules/thrift-interfaces/airavataDatastructures.thrift&p1=airavata/trunk/modules/thrift-interfaces/execution-datastructures.thrift&r1=1560440&r2=1560486&rev=1560486&view=diff
==============================================================================
--- airavata/trunk/modules/thrift-interfaces/execution-datastructures.thrift (original)
+++ airavata/trunk/modules/thrift-interfaces/airavataDatastructures.thrift Wed Jan 22 19:28:01 2014
@@ -19,22 +19,22 @@
*/
/*
- * This file describes the definations of the Airavata Execution Data Structures. Each of the
- * lagunage specific Airavata Client SDK's will translate this neutral data model into an
+ * This file describes the definitions of the Airavata Execution Data Structures. Each of the
+ * language specific Airavata Client SDK's will translate this neutral data model into an
* appropriate form for passing to the Airavata Server Execution API Calls.
*/
/**
- * A structure holding the experimemt metadata.
+ * A structure holding the experiment metadata.
*
* userName:
- * The user name of the targetted gateway end user on whos behalf the experiment is being created.
- * the associated gateway identity can only be infered from the security hand-shake so as to avoid
- * authorized Airavata Clients mimicing an unauthorized request. If a gateway is not registered with
+ * The user name of the targeted gateway end user on whose behalf the experiment is being created.
+ * the associated gateway identity can only be inferred from the security hand-shake so as to avoid
+ * authorized Airavata Clients mimicking an unauthorized request. If a gateway is not registered with
* Airavata, an authorization exception is thrown.
*
* experimentName:
- * The name of the expeiment as defined by the user. The name need not be unique as uniqueness is enforced
+ * The name of the experiment as defined by the user. The name need not be unique as uniqueness is enforced
* by the generated experiment id.
*
* experimentDescription:
@@ -44,16 +44,16 @@ struct ExperimentMetadata {
1: required string userName,
2: required string experimentName,
3: optional string experimentDescription,
- 4: optional bool shareExperimentPublicly = "false"
+ 4: optional bool shareExperimentPublicly = 0
}
/**
- * A structure holding the required Security Information to execute expriements.
+ * A structure holding the required Security Information to execute experiments.
*
* airavataCredStoreToken:
- * A requirement to execute experiments within Airavata is to first register the targetted remote computational account
+ * A requirement to execute experiments within Airavata is to first register the targeted remote computational account
* credentials with Airavata Credential Store. The administrative API (related to credential store) will return a
- * generated token associated with the registered credentials. The client has to securily posses this token id and is
+ * generated token associated with the registered credentials. The client has to securely posses this token id and is
* required to pass it to Airavata Server for all execution requests.
*/
struct ExecutionSecurityParameters {
@@ -66,13 +66,13 @@ struct ExecutionSecurityParameters {
*
*/
struct ComputationalResourceScheduling {
- 1:required bool airavataAutoSchedule = "true"
- 2:required bool overrideManualScheduledParams = "false",
+ 1:required bool airavataAutoSchedule = 1
+ 2:required bool overrideManualScheduledParams = 0,
3:optional string resourceHostId,
4:optional i32 cpuCount,
- 4:optional i32 nodeCount,
- 5:optional string queueName,
- 6:optional i32 maxWalltime
+ 5:optional i32 nodeCount,
+ 6:optional string queueName,
+ 7:optional i32 maxWalltime
}
/**
@@ -80,7 +80,7 @@ struct ComputationalResourceScheduling {
*
*/
struct InputDataHandling {
- 1:optional bool stageInputFilesToWorkingDir = "false"
+ 1:optional bool stageInputFilesToWorkingDir = 0
}
/**
@@ -90,15 +90,15 @@ struct InputDataHandling {
struct OutputDataHandling {
2:optional string outputdataDir,
3:optional string dataRegistryURL,
- 4:optional bool persistOutputData = "true"
+ 4:optional bool persistOutputData = 1
}
/**
- * A structure holding the configuration data of an experimemt.
+ * A structure holding the configuration data of an experiment.
*
*/
struct ExperimentConfigurationData {
1: required ComputationalResourceScheduling computationalResourceScheduling,
2: optional InputDataHandling inputDataHandling,
- 2: optional OutputDataHandling OutputDataHandling
+ 3: optional OutputDataHandling OutputDataHandling
}
Copied: airavata/trunk/modules/thrift-interfaces/airavataErrors.thrift (from r1560440, airavata/trunk/modules/thrift-interfaces/airavata-errors.thrift)
URL: http://svn.apache.org/viewvc/airavata/trunk/modules/thrift-interfaces/airavataErrors.thrift?p2=airavata/trunk/modules/thrift-interfaces/airavataErrors.thrift&p1=airavata/trunk/modules/thrift-interfaces/airavata-errors.thrift&r1=1560440&r2=1560486&rev=1560486&view=diff
==============================================================================
--- airavata/trunk/modules/thrift-interfaces/airavata-errors.thrift (original)
+++ airavata/trunk/modules/thrift-interfaces/airavataErrors.thrift Wed Jan 22 19:28:01 2014
@@ -19,7 +19,7 @@
*/
/*
-* This file describes the definations of the Error Messages that can occur
+* This file describes the definitions of the Error Messages that can occur
* when invoking Apache Airavata Services through the API. In addition Thrift provides
* built in funcationality to raise TApplicationException for all internal server errors.
*/
Added: airavata/trunk/modules/thrift-interfaces/orchestrator.thrift
URL: http://svn.apache.org/viewvc/airavata/trunk/modules/thrift-interfaces/orchestrator.thrift?rev=1560486&view=auto
==============================================================================
--- airavata/trunk/modules/thrift-interfaces/orchestrator.thrift (added)
+++ airavata/trunk/modules/thrift-interfaces/orchestrator.thrift Wed Jan 22 19:28:01 2014
@@ -0,0 +1,39 @@
+/*
+ * 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.
+ *
+ */
+
+include "airavata-errors.thrift"
+
+service OrchestratorService {
+ string createExperiment (1: required string userName,
+ 2: required string experimentName,
+ 3: optional string experimentDescription) throws (1:InvalidRequestException ire
+ 2:AiravataClientException ace,
+ 3:AiravataSystemException ase);
+
+ boolean launchExperiment(1: required string experimentID) throws (1:InvalidRequestException ire,
+ 2:ExperimentNotFoundException enf,
+ 3:AiravataClientException ace,
+ 4:AiravataSystemException ase);
+ string terminateExperiment(1: required string experimentID) throws (1:InvalidRequestException ire,
+ 2:ExperimentNotFoundException enf,
+ 3:AiravataClientException ace,
+ 4:AiravataSystemException ase);
+
+}