Author: lahiru
Date: Wed Jun 27 19:43:51 2012
New Revision: 1354690
URL: http://svn.apache.org/viewvc?rev=1354690&view=rev
Log:
fixing build error and adding api documentation.
Modified:
incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/airavata/AiravataClient.java
incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ApplicationManager.java
incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ExecutionManager.java
incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/UserManager.java
incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/WorkflowManager.java
Modified: incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/airavata/AiravataClient.java
URL: http://svn.apache.org/viewvc/incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/airavata/AiravataClient.java?rev=1354690&r1=1354689&r2=1354690&view=diff
==============================================================================
--- incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/airavata/AiravataClient.java
(original)
+++ incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/airavata/AiravataClient.java
Wed Jun 27 19:43:51 2012
@@ -828,22 +828,22 @@ public class AiravataClient implements A
}
- public List<String> getWorkflowServiceNodeIDs(String templateID){
- Property workflowAsString = null;
- try {
- workflowAsString = this.getWorkflowAsString(templateID);
- Workflow workflow = new Workflow(workflowAsString.getString());
- return workflow.getWorkflowServiceNodeIDs();
- } catch (RegistryException e) {
- e.printStackTrace(); //To change body of catch statement use File | Settings
| File Templates.
- } catch (RepositoryException e) {
- e.printStackTrace(); //To change body of catch statement use File | Settings
| File Templates.
- } catch (GraphException e) {
- e.printStackTrace(); //To change body of catch statement use File | Settings
| File Templates.
- } catch (ComponentException e) {
- e.printStackTrace(); //To change body of catch statement use File | Settings
| File Templates.
- }
- return null;
+ public List<String> getWorkflowServiceNodeIDs(String templateID) {
+ Property workflowAsString = null;
+ try {
+ workflowAsString = this.getWorkflowAsString(templateID);
+ Workflow workflow = new Workflow(workflowAsString.getString());
+ return workflow.getWorkflowServiceNodeIDs();
+ } catch (RegistryException e) {
+ e.printStackTrace();
+ } catch (RepositoryException e) {
+ e.printStackTrace();
+ } catch (GraphException e) {
+ e.printStackTrace();
+ } catch (ComponentException e) {
+ e.printStackTrace();
}
+ return null;
+ }
}
Modified: incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ApplicationManager.java
URL: http://svn.apache.org/viewvc/incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ApplicationManager.java?rev=1354690&r1=1354689&r2=1354690&view=diff
==============================================================================
--- incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ApplicationManager.java
(original)
+++ incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ApplicationManager.java
Wed Jun 27 19:43:51 2012
@@ -30,28 +30,156 @@ import org.apache.airavata.commons.gfac.
public interface ApplicationManager {
//Service descriptors
+
+ /**
+ *
+ * @param serviceId
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public ServiceDescription getServiceDescription(String serviceId) throws AiravataAPIInvocationException;
+
+ /**
+ *
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public List<ServiceDescription> getAllServiceDescriptions() throws AiravataAPIInvocationException;
+
+ /**
+ *
+ * @param service
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public String saveServiceDescription(ServiceDescription service)throws AiravataAPIInvocationException;
+
+ /**
+ *
+ * @param serviceId
+ * @throws AiravataAPIInvocationException
+ */
public void deleteServiceDescription(String serviceId) throws AiravataAPIInvocationException;
+
+ /**
+ *
+ * @param nameRegEx
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public List<ServiceDescription> searchServiceDescription(String nameRegEx) throws
AiravataAPIInvocationException;
//Application descriptors
+
+ /**
+ *
+ * @param serviceId
+ * @param hostId
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public ApplicationDeploymentDescription getDeploymentDescription(String serviceId, String
hostId)throws AiravataAPIInvocationException;
+
+ /**
+ *
+ * @param serviceId
+ * @param hostId
+ * @param app
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public String saveDeploymentDescription(String serviceId, String hostId, ApplicationDeploymentDescription
app)throws AiravataAPIInvocationException;
+
+ /**
+ *
+ * @param serviceName
+ * @param hostName
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public List<ApplicationDeploymentDescription> searchDeploymentDescription(String
serviceName, String hostName)throws AiravataAPIInvocationException;
+
+ /**
+ *
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public Map<ApplicationDeploymentDescription, String> getAllDeploymentDescriptions()
throws AiravataAPIInvocationException;
+
+ /**
+ *
+ * @param serviceName
+ * @param hostName
+ * @param applicationName
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public List<ApplicationDeploymentDescription> searchDeploymentDescription(String
serviceName, String hostName,String applicationName) throws AiravataAPIInvocationException;
+
+ /**
+ *
+ * @param serviceName
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public Map<HostDescription, List<ApplicationDeploymentDescription>> searchDeploymentDescription(String
serviceName)throws AiravataAPIInvocationException;
+
+ /**
+ *
+ * @param serviceName
+ * @param hostName
+ * @param applicationName
+ * @throws AiravataAPIInvocationException
+ */
public void deleteDeploymentDescription(String serviceName, String hostName, String applicationName)throws
AiravataAPIInvocationException;
//Host descriptors
+
+ /**
+ *
+ * @param hostId
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public HostDescription getHostDescription(String hostId) throws AiravataAPIInvocationException;
+
+ /**
+ *
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public List<HostDescription> getAllHostDescriptions() throws AiravataAPIInvocationException;
+
+ /**
+ *
+ * @param host
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public String saveHostDescription(HostDescription host)throws AiravataAPIInvocationException;
+
+ /**
+ *
+ * @param regExName
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public List<HostDescription> searchHostDescription(String regExName) throws AiravataAPIInvocationException;
+
+ /**
+ *
+ * @param hostId
+ * @throws AiravataAPIInvocationException
+ */
public void deleteHostDescription(String hostId) throws AiravataAPIInvocationException;
-
+
+ /**
+ *
+ * @param serviceName
+ * @param hostName
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public boolean deployServiceOnHost(String serviceName, String hostName)throws AiravataAPIInvocationException;
}
Modified: incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ExecutionManager.java
URL: http://svn.apache.org/viewvc/incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ExecutionManager.java?rev=1354690&r1=1354689&r2=1354690&view=diff
==============================================================================
--- incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ExecutionManager.java
(original)
+++ incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ExecutionManager.java
Wed Jun 27 19:43:51 2012
@@ -29,17 +29,61 @@ import org.apache.airavata.xbaya.monitor
import org.apache.airavata.xbaya.monitor.MonitorEventListener;
public interface ExecutionManager {
-
+ /**
+ *
+ * @param workflowTemplateId
+ * @param inputs
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public abstract String runWorkflow(String workflowTemplateId,List<WorkflowInput> inputs)
throws AiravataAPIInvocationException;
+ /**
+ *
+ * @param workflow
+ * @param inputs
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public abstract String runWorkflow(Workflow workflow,List<WorkflowInput> inputs) throws
AiravataAPIInvocationException;
-
+
+ /**
+ *
+ * @param workflowTemplateId
+ * @param inputs
+ * @param user
+ * @param metadata
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public abstract String runWorkflow(String workflowTemplateId,List<WorkflowInput> inputs,
String user, String metadata)throws AiravataAPIInvocationException;
-
+
+ /**
+ *
+ * @param workflow
+ * @param inputs
+ * @param user
+ * @param metadata
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public abstract String runWorkflow(Workflow workflow,List<WorkflowInput> inputs, String
user, String metadata)throws AiravataAPIInvocationException;
-
+
+ /**
+ *
+ * @param topic
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public Monitor getWorkflowIntanceMonitor(String topic)throws AiravataAPIInvocationException;
+ /**
+ *
+ * @param topic
+ * @param listener
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public Monitor getWorkflowInstanceMonitor(String topic, MonitorEventListener listener) throws
AiravataAPIInvocationException;
}
Modified: incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/UserManager.java
URL: http://svn.apache.org/viewvc/incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/UserManager.java?rev=1354690&r1=1354689&r2=1354690&view=diff
==============================================================================
--- incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/UserManager.java
(original)
+++ incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/UserManager.java
Wed Jun 27 19:43:51 2012
@@ -22,7 +22,10 @@
package org.apache.airavata.client.api;
public interface UserManager {
-
- public String getAiravataUser();
+ /**
+ *
+ * @return
+ */
+ public String getAiravataUser();
}
Modified: incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/WorkflowManager.java
URL: http://svn.apache.org/viewvc/incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/WorkflowManager.java?rev=1354690&r1=1354689&r2=1354690&view=diff
==============================================================================
--- incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/WorkflowManager.java
(original)
+++ incubator/airavata/trunk/modules/airavata-client/src/main/java/org/apache/airavata/client/api/WorkflowManager.java
Wed Jun 27 19:43:51 2012
@@ -28,41 +28,154 @@ import org.apache.airavata.workflow.mode
public interface WorkflowManager {
//privilledged API
+
+ /**
+ *
+ * @param workflowAsString
+ * @param owner
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public boolean saveWorkflow(String workflowAsString, String owner) throws AiravataAPIInvocationException;
-
+
+ /**
+ *
+ * @param workflow
+ * @param owner
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public boolean saveWorkflow(Workflow workflow, String owner) throws AiravataAPIInvocationException;
+ /**
+ *
+ * @param owner
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public List<Workflow> getWorkflows(String owner) throws AiravataAPIInvocationException;
-
+
+ /**
+ *
+ * @param owner
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public List<String> getWorkflowTemplateIds(String owner) throws AiravataAPIInvocationException;
+ /**
+ *
+ * @param workflowName
+ * @param owner
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public Workflow getWorkflow(String workflowName, String owner) throws AiravataAPIInvocationException;
+ /**
+ *
+ * @param workflowName
+ * @param owner
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public String getWorkflowAsString(String workflowName, String owner) throws AiravataAPIInvocationException;
+ /**
+ *
+ * @param workflowName
+ * @param owner
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public boolean deleteWorkflow(String workflowName, String owner) throws AiravataAPIInvocationException;
//user api
+
+ /**
+ *
+ * @param workflowAsString
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public boolean saveWorkflow(String workflowAsString) throws AiravataAPIInvocationException;
+ /**
+ *
+ * @param workflowAsString
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public boolean saveWorkflowAsPublic(String workflowAsString) throws AiravataAPIInvocationException;
-
+
+ /**
+ *
+ * @param workflow
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public boolean saveWorkflow(Workflow workflow) throws AiravataAPIInvocationException;
-
+
+ /**
+ *
+ * @param workflow
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public boolean saveWorkflowAsPublic(Workflow workflow) throws AiravataAPIInvocationException;
+ /**
+ *
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public List<Workflow> getWorkflows() throws AiravataAPIInvocationException;
-
+
+ /**
+ *
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public List<String> getWorkflowTemplateIds() throws AiravataAPIInvocationException;
+ /**
+ *
+ * @param workflowName
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public Workflow getWorkflow(String workflowName) throws AiravataAPIInvocationException;
+ /**
+ *
+ * @param workflowName
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public String getWorkflowAsString(String workflowName) throws AiravataAPIInvocationException;
+ /**
+ *
+ * @param workflowName
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public boolean deleteWorkflow(String workflowName) throws AiravataAPIInvocationException;
-
+
+ /**
+ *
+ * @param workflowAsString
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public Workflow getWorkflowFromString(String workflowAsString) throws AiravataAPIInvocationException;
-
+
+ /**
+ *
+ * @param workflow
+ * @return
+ * @throws AiravataAPIInvocationException
+ */
public String getWorkflowAsString(Workflow workflow) throws AiravataAPIInvocationException;
}
|