http://git-wip-us.apache.org/repos/asf/airavata/blob/32fff944/modules/airavata-client/src/main/java/org/apache/airavata/client/api/AiravataManager.java ---------------------------------------------------------------------- diff --git a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/AiravataManager.java b/modules/airavata-client/src/main/java/org/apache/airavata/client/api/AiravataManager.java deleted file mode 100644 index 6805dd2..0000000 --- a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/AiravataManager.java +++ /dev/null @@ -1,137 +0,0 @@ -/* - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - */ - -package org.apache.airavata.client.api; - -import org.apache.airavata.client.api.exception.AiravataAPIInvocationException; - -import java.net.URI; -import java.util.Date; -import java.util.List; - -/** - * This interface contains set of methods to access the basic configurations of AiravataClient required to connect to - * Airvata services running at the backend - */ -public interface AiravataManager { - - /** - * Return a list of Workflow Interpreter service urls registered in the system - * @return 0 or more urls - * @throws AiravataAPIInvocationException - */ - public List<URI> getWorkflowInterpreterServiceURLs() throws AiravataAPIInvocationException; - - /** - * Return a the first Workflow interpreter service url registered in the system - * @return url or null if a url is not registered - * @throws AiravataAPIInvocationException - */ - public URI getWorkflowInterpreterServiceURL() throws AiravataAPIInvocationException; - - /** - * Return a the first GFaC service url registered in the system orelse return the <code>defaultURL</code> - * @param defaultURL - * @return url - * @throws AiravataAPIInvocationException - */ - public URI getWorkflowInterpreterServiceURL(URI defaultURL) throws AiravataAPIInvocationException; - - /** - * Return a list of Workflow Interpreter service urls registered in the system - * @return 0 or more urls - * @throws AiravataAPIInvocationException - */ - public List<URI> getMessageBoxServiceURLs() throws AiravataAPIInvocationException; - - /** - * Return a the first Workflow interpreter service url registered in the system - * @return url or null if a url is not registered - * @throws AiravataAPIInvocationException - */ - public URI getMessageBoxServiceURL() throws AiravataAPIInvocationException; - - /** - * Return a the first GFaC service url registered in the system orelse return the <code>defaultURL</code> - * @param defaultURL - * @return url - * @throws AiravataAPIInvocationException - */ - public URI getMessageBoxServiceURL(URI defaultURL) throws AiravataAPIInvocationException; - - /** - * Return a list of Workflow Interpreter service urls registered in the system - * @return 0 or more urls - * @throws AiravataAPIInvocationException - */ - public List<URI> getEventingServiceURLs() throws AiravataAPIInvocationException; - - /** - * Return a the first Workflow interpreter service url registered in the system - * @return url or null if a url is not registered - * @throws AiravataAPIInvocationException - */ - public URI getEventingServiceURL() throws AiravataAPIInvocationException; - - /** - * Return a the first GFaC service url registered in the system orelse return the <code>defaultURL</code> - * @param defaultURL - * @return url - * @throws AiravataAPIInvocationException - */ - public URI getEventingServiceURL(URI defaultURL) throws AiravataAPIInvocationException; - - public Object getConfiguration(String key) throws AiravataAPIInvocationException; - - public List<Object> getConfigurationList(String key) throws AiravataAPIInvocationException; - - public void setConfiguration(String key, String value, Date expire) throws AiravataAPIInvocationException; - - public void addConfiguration(String key, String value, Date expire) throws AiravataAPIInvocationException; - - public void removeAllConfiguration(String key) throws AiravataAPIInvocationException; - - public void removeConfiguration(String key, String value) throws AiravataAPIInvocationException; - - public void addWorkflowInterpreterURI(URI uri) throws AiravataAPIInvocationException; - - public void setEventingURI(URI uri) throws AiravataAPIInvocationException; - - public void setMessageBoxURI(URI uri) throws AiravataAPIInvocationException; - - public void addWorkflowInterpreterURI(URI uri, Date expire) throws AiravataAPIInvocationException; - - public void setEventingURI(URI uri, Date expire) throws AiravataAPIInvocationException; - - public void setMessageBoxURI(URI uri, Date expire) throws AiravataAPIInvocationException; - - public void removeWorkflowInterpreterURI(URI uri) throws AiravataAPIInvocationException; - - public void removeAllWorkflowInterpreterURI() throws AiravataAPIInvocationException; - - public void unsetEventingURI() throws AiravataAPIInvocationException; - - public void unsetMessageBoxURI() throws AiravataAPIInvocationException; - -// public Gateway getGateway () throws AiravataAPIInvocationException; - -// public AiravataUser getUser() throws AiravataAPIInvocationException; -}
http://git-wip-us.apache.org/repos/asf/airavata/blob/32fff944/modules/airavata-client/src/main/java/org/apache/airavata/client/api/AmazonWebServicesSettings.java ---------------------------------------------------------------------- diff --git a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/AmazonWebServicesSettings.java b/modules/airavata-client/src/main/java/org/apache/airavata/client/api/AmazonWebServicesSettings.java deleted file mode 100644 index eaa924e..0000000 --- a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/AmazonWebServicesSettings.java +++ /dev/null @@ -1,38 +0,0 @@ -/* - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - */ - -package org.apache.airavata.client.api; - -public interface AmazonWebServicesSettings { - public String getAccessKeyId(); - public String getAMIId(); - public String getInstanceId(); - public String getInstanceType(); - public String getSecretAccessKey(); - public String getUsername(); - - public void setAccessKeyId(String accessKeyId); - public void setAMIId(String amiId); - public void setInstanceId(String instanceId); - public void setInstanceType(String instanceType); - public void setSecretAccessKey(String secretAccessKey); - public void setUsername(String username); -} http://git-wip-us.apache.org/repos/asf/airavata/blob/32fff944/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ApplicationManager.java ---------------------------------------------------------------------- diff --git a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ApplicationManager.java b/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ApplicationManager.java deleted file mode 100644 index fe00afd..0000000 --- a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ApplicationManager.java +++ /dev/null @@ -1,284 +0,0 @@ -/* - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - */ - -package org.apache.airavata.client.api; - -import java.util.List; -import java.util.Map; - -import org.apache.airavata.client.api.exception.AiravataAPIInvocationException; -import org.apache.airavata.client.api.exception.DescriptorAlreadyExistsException; -//import org.apache.airavata.commons.gfac.type.ApplicationDescription; -//import org.apache.airavata.commons.gfac.type.HostDescription; -//import org.apache.airavata.commons.gfac.type.ServiceDescription; - -public interface ApplicationManager { - //Service descriptors - -// /** -// * Retrieve registered service description of the given service name -// * @param serviceName -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public ServiceDescription getServiceDescription(String serviceName) throws AiravataAPIInvocationException; -// -// /** -// * Retrieve all registered service descriptions -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public List<ServiceDescription> getAllServiceDescriptions() throws AiravataAPIInvocationException; -// -// /** -// * Save service description on registry -// * @param service Service description information to update. -// * @return The service descriptor name. -// * @deprecated Deprecated since 0.6 release. User {@see #addServiceDescription} and {@see #updateServiceDescription} -// * methods instead. -// * @throws AiravataAPIInvocationException If an error occurred while updating service descriptor. -// */ -// @Deprecated -// public String saveServiceDescription(ServiceDescription service)throws AiravataAPIInvocationException; -// -// /** -// * Adds a new Service descriptor to the system. If service descriptor already exists in the system -// * this will throw {@see DescriptorRecordAlreadyExistsException}. If you want to update an existing -// * service descriptor use {@see #updateServiceDescription}. -// * @param serviceDescription The service descriptor. -// * @throws AiravataAPIInvocationException If an error occurred while adding service description. -// * @throws DescriptorAlreadyExistsException If service descriptor already exists in the system. -// */ -// public void addServiceDescription(ServiceDescription serviceDescription)throws AiravataAPIInvocationException, -// DescriptorAlreadyExistsException; -// -// /** -// * Updates the service descriptor. -// * @param serviceDescription Service description information to update. -// * @throws AiravataAPIInvocationException If an error occurred while updating service description. -// */ -// public void updateServiceDescription(ServiceDescription serviceDescription)throws AiravataAPIInvocationException; -// -// -// -// /** -// * Delete service description from the registry -// * @param serviceName -// * @throws AiravataAPIInvocationException -// */ -// public void deleteServiceDescription(String serviceName) throws AiravataAPIInvocationException; -// -// /** -// * Retrieve a list of registered service descriptions of the given regex service name -// * @param nameRegEx -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public List<ServiceDescription> searchServiceDescription(String nameRegEx) throws AiravataAPIInvocationException; -// -// //Application descriptors -// -// /** -// * Retrieve registered application description of the given service name & hostName -// * @param serviceName -// * @param hostName -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public ApplicationDescription getApplicationDescription(String serviceName, String hostName)throws AiravataAPIInvocationException; -// -// /** -// * Save deployment description on registry for a given service for a host -// * @param serviceId The service descriptor id. -// * @param hostId The host descriptor id. -// * @param app The application deployment descriptor. -// * @return The application deployment descriptor name. -// * @deprecated Deprecated since 0.6 release. Please use {@see #addApplicationDescription} and -// * {@see #updateApplicationDescription}. -// * @throws AiravataAPIInvocationException If an error occurred while adding application deployment descriptor. -// */ -// @Deprecated -// public String saveApplicationDescription(String serviceId, String hostId, ApplicationDescription app)throws AiravataAPIInvocationException; -// -// -// /** -// * Adds a new deployment description associating with given service description and given host description. If -// * an association already exists this will throw {@see DescriptorRecordAlreadyExistsException} exception. If you -// * want to update an existing deployment descriptor use {@see #updateApplicationDescription}. -// * @param serviceDescription The service description to associate. Should be saved before passing to this method. -// * @param hostDescription The host description to associate, should have been saved before calling this method. -// * @param applicationDeploymentDescription The application descriptor to save. -// * @throws AiravataAPIInvocationException If an error occurred while saving application descriptor. -// * @throws DescriptorAlreadyExistsException If deployment descriptor already exists in the system. -// */ -// public void addApplicationDescription(ServiceDescription serviceDescription, HostDescription hostDescription, -// ApplicationDescription applicationDeploymentDescription) -// throws AiravataAPIInvocationException, DescriptorAlreadyExistsException; -// -// /** -// * Adds a new deployment description associating with given service description and given host description. If -// * an association already exists this will throw {@see DescriptorRecordAlreadyExistsException} exception. -// * @param serviceDescription The service description to associate. Should be saved before passing to this method. -// * @param hostDescription The host description to associate, should have been saved before calling this method. -// * @param applicationDeploymentDescription The application descriptor to save. -// * @throws AiravataAPIInvocationException If an error occurred while saving application descriptor. -// */ -// public void updateApplicationDescription(ServiceDescription serviceDescription, HostDescription hostDescription, -// ApplicationDescription applicationDeploymentDescription) -// throws AiravataAPIInvocationException; -// -// /** -// * Retrieve list of registered deployment descriptions of the given regex service name & regex host name -// * @param serviceName -// * @param hostName -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public List<ApplicationDescription> searchApplicationDescription(String serviceName, String hostName)throws AiravataAPIInvocationException; -// -// /** -// * Retrieve all registered deployment descriptions, The key represents the service name & host name in string array -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public Map<String[], ApplicationDescription> getAllApplicationDescriptions() throws AiravataAPIInvocationException; -// -// /** -// * Retrieve list of registered deployment descriptions of the given regex service name, regex host name & regex application name -// * @param serviceName -// * @param hostName -// * @param applicationName -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public List<ApplicationDescription> searchApplicationDescription(String serviceName, String hostName, String applicationName) throws AiravataAPIInvocationException; -// -// /** -// * Retrieve registered map of deployment descriptions for their host description of the given service name -// * @param serviceName -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public Map<HostDescription, List<ApplicationDescription>> searchApplicationDescription(String serviceName)throws AiravataAPIInvocationException; -// -// /** -// * Delete deployment description from the registry which is exposed as the service name in the host name -// * @param serviceName -// * @param hostName -// * @param applicationName -// * @throws AiravataAPIInvocationException -// */ -// public void deleteApplicationDescription(String serviceName, String hostName, String applicationName)throws AiravataAPIInvocationException; -// -// //Host descriptors -// -// /** -// * Retrieve registered host description of the given host name -// * @param hostName -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public HostDescription getHostDescription(String hostName) throws AiravataAPIInvocationException; -// -// /** -// * Retrieve all registered host descriptions -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public List<HostDescription> getAllHostDescriptions() throws AiravataAPIInvocationException; -// -// /** -// * Save host description on registry -// * @param host The host descriptor object to update in the database. -// * @deprecated Deprecated since 0.6 release. Please use {@see #addHostDescription} and {@see #updateHostDescription} -// * @throws AiravataAPIInvocationException If an error occurred while saving the host description. -// */ -// @Deprecated -// public String saveHostDescription(HostDescription host)throws AiravataAPIInvocationException; -// -// -// /** -// * Adds a new host descriptor object. If adding host descriptor already exists in the system this will throw -// * DescriptorRecordAlreadyExistsException. If user wants to update an existing host descriptor use -// * {@see #updateHostDescription(HostDescription host)} method. -// * @param host The host descriptor object to save in the database. -// * @throws AiravataAPIInvocationException If an error occurred while saving the host description. -// * @throws DescriptorAlreadyExistsException If host descriptor object already exists in the system. -// */ -// public void addHostDescription (HostDescription host) throws DescriptorAlreadyExistsException, -// AiravataAPIInvocationException; -// -// -// /** -// * Updates an existing host descriptor. If you are not sure whether descriptor already exists try using -// * {@see #addHostDescription} and catch {@see DescriptorRecordAlreadyExistsException}. If caught use this method -// * to update the record. -// * @param host The host descriptor object to update in the database. -// * @throws AiravataAPIInvocationException If an error occurred while saving the host description. -// */ -// public void updateHostDescription(HostDescription host)throws AiravataAPIInvocationException; -// -// /** -// * Retrieve a list of registered hsot descriptions of the given regex host name -// * @param regExName -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public List<HostDescription> searchHostDescription(String regExName) throws AiravataAPIInvocationException; -// -// /** -// * Delete host description from the registry -// * @param hostId -// * @throws AiravataAPIInvocationException -// */ -// public void deleteHostDescription(String hostId) throws AiravataAPIInvocationException; -// -// /** -// * Map services to possible hosts -// * @param serviceName -// * @param hostName -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public boolean deployServiceOnHost(String serviceName, String hostName)throws AiravataAPIInvocationException; -// -// public Map<String,ApplicationDescription> getApplicationDescriptors (String serviceName) throws AiravataAPIInvocationException; -// -// public boolean isHostDescriptorExists(String descriptorName) throws AiravataAPIInvocationException; -// -// public void removeHostDescriptor(String hostName) throws AiravataAPIInvocationException; -// -// public boolean isServiceDescriptorExists(String descriptorName) throws AiravataAPIInvocationException; -// -// public boolean isApplicationDescriptorExists(String serviceName, String hostName, String descriptorName)throws AiravataAPIInvocationException; -// -// public void removeServiceDescriptor(String serviceName) throws AiravataAPIInvocationException; -// -// public void removeApplicationDescriptor(String serviceName, String hostName, String applicationName) throws AiravataAPIInvocationException; -// -// public void updateHostDescriptor(HostDescription descriptor) throws AiravataAPIInvocationException; -// -// public void updateServiceDescriptor(ServiceDescription descriptor) throws AiravataAPIInvocationException; -// -// public void updateApplicationDescriptor(String serviceName, String hostName, ApplicationDescription descriptor) throws AiravataAPIInvocationException; -// -// public ApplicationDescription getApplicationDescriptor(String serviceName, String hostname, String applicationName) throws AiravataAPIInvocationException; -} http://git-wip-us.apache.org/repos/asf/airavata/blob/32fff944/modules/airavata-client/src/main/java/org/apache/airavata/client/api/BaseAPI.java ---------------------------------------------------------------------- diff --git a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/BaseAPI.java b/modules/airavata-client/src/main/java/org/apache/airavata/client/api/BaseAPI.java deleted file mode 100644 index 05b7bb2..0000000 --- a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/BaseAPI.java +++ /dev/null @@ -1,46 +0,0 @@ -/* - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - */ - -package org.apache.airavata.client.api; - -import java.net.URI; - -import org.apache.airavata.client.api.exception.AiravataAPIInvocationException; -import org.apache.airavata.common.utils.Version; - -public interface BaseAPI { - - /** - * Retrieve the version associated with the Experiment Execution API - * @return - * @throws AiravataAPIInvocationException - */ - public Version getVersion() throws AiravataAPIInvocationException; - - public String getUser(); - - public String getGateway(); - - public void initialize() throws AiravataAPIInvocationException; - - public URI getServiceURL() throws AiravataAPIInvocationException; -// public PasswordCallback getPasswordCallback() throws AiravataAPIInvocationException; -} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/airavata/blob/32fff944/modules/airavata-client/src/main/java/org/apache/airavata/client/api/CredentialStoreManager.java ---------------------------------------------------------------------- diff --git a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/CredentialStoreManager.java b/modules/airavata-client/src/main/java/org/apache/airavata/client/api/CredentialStoreManager.java deleted file mode 100644 index f79b8d4..0000000 --- a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/CredentialStoreManager.java +++ /dev/null @@ -1,62 +0,0 @@ -/* - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - */ - -package org.apache.airavata.client.api; - -import org.apache.airavata.client.api.exception.AiravataAPIInvocationException; - -public interface CredentialStoreManager { - - /** - * Checks whether a credential exists in the credential store for given gateway and token - * @param gatewayId - * @param tokenId - * @return a boolean (true is credential exists, false if not) - */ - public boolean isCredentialExist(String gatewayId, String tokenId) throws AiravataAPIInvocationException; - - /** - * Get the public key for a credential in the credential store for given gateway and token - * @param gatewayId - * @param tokenId - * @return String The public key of the credential - */ - public String getCredentialPublicKey(String gatewayId, String tokenId) throws AiravataAPIInvocationException; - - /** - * Creates a new SSH credential for given gateway and token, encrypts it with the given password - * and stores it in the credential store - * @param gatewayId - * @param tokenId - * @return String The public key of the credential - */ - public String createCredential(String gatewayId, String tokenId) throws AiravataAPIInvocationException; - - /** - * Creates a new SSH credential for given gateway and token, encrypts it with the given password - * and stores it in the credential store - * @param gatewayId - * @param tokenId - * @param username - * @return String The public key of the credential - */ - public String createCredential(String gatewayId, String tokenId, String username) throws AiravataAPIInvocationException; -} http://git-wip-us.apache.org/repos/asf/airavata/blob/32fff944/modules/airavata-client/src/main/java/org/apache/airavata/client/api/CredentialStoreSecuritySettings.java ---------------------------------------------------------------------- diff --git a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/CredentialStoreSecuritySettings.java b/modules/airavata-client/src/main/java/org/apache/airavata/client/api/CredentialStoreSecuritySettings.java deleted file mode 100644 index e8a1d3d..0000000 --- a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/CredentialStoreSecuritySettings.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - */ - -package org.apache.airavata.client.api; - -/** - * Encapsulates security information related to credential-store. - * Mainly we need information about the token id and and user id of the portal user - * who is invoking the workflow. - */ -public interface CredentialStoreSecuritySettings { - - /** - * Returns the token id to get the credentials. - * @return The token id. - */ - String getTokenId(); - - /** - * Sets the token to be used when accessing the credential store. - * @param token The token. - */ - void setTokenId(String token); - - /** - * Sets the portal user name. - * @param portalUserName The name of the portal user. - */ - void setPortalUser(String portalUserName); - - /** - * Gets the portal user name. - * @return portal user name. - */ - String getPortalUser(); - - /** - * Sets the gateway id. - * @param gatewayId The gateway id. - */ - void setGatewayId(String gatewayId); - - /** - * Gets the gateway id. - * @return name of the gateway. - */ - String getGatewayId(); - - - -} http://git-wip-us.apache.org/repos/asf/airavata/blob/32fff944/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ExecutionManager.java ---------------------------------------------------------------------- diff --git a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ExecutionManager.java b/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ExecutionManager.java deleted file mode 100644 index fe7832f..0000000 --- a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ExecutionManager.java +++ /dev/null @@ -1,207 +0,0 @@ -/* - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - */ - -package org.apache.airavata.client.api; - -import java.util.List; - -import org.apache.airavata.client.api.exception.AiravataAPIInvocationException; -import org.apache.airavata.workflow.model.wf.Workflow; -import org.apache.airavata.workflow.model.wf.WorkflowInput; -import org.apache.airavata.ws.monitor.EventDataListener; -import org.apache.airavata.ws.monitor.Monitor; - -public interface ExecutionManager { - /** - * Run an experiment containing single workflow - * @param workflow - Workflow template Id or Workflow Graph XML - * @param inputs - * @return - * @throws AiravataAPIInvocationException - */ - public String runExperiment(String workflow,List<WorkflowInput> inputs) throws AiravataAPIInvocationException; - - /** - * Run an experiment containing single workflow with custom settings for the experiment - * @param workflow - Workflow template Id or Workflow Graph XML - * @param inputs - * @param options - * @return - * @throws AiravataAPIInvocationException - */ - public String runExperiment(String workflow,List<WorkflowInput> inputs, ExperimentAdvanceOptions options) throws AiravataAPIInvocationException; - - /** - * Run an experiment containing single workflow with custom settings for the experiment & listen - * for notification events - * @param workflow - Workflow template Id or Workflow Graph XML - * @param inputs - * @param options - * @return - * @throws AiravataAPIInvocationException - */ - public String runExperiment(String workflow,List<WorkflowInput> inputs, ExperimentAdvanceOptions options, EventDataListener listener) throws AiravataAPIInvocationException; - - /** - * Run an experiment containing single workflow - * @param workflow - * @param inputs - * @return - * @throws AiravataAPIInvocationException - */ - public String runExperiment(Workflow workflow,List<WorkflowInput> inputs, ExperimentAdvanceOptions options) throws AiravataAPIInvocationException; - - /** - * Get a monitor for a running experiment - * @param experimentId - * @return - * @throws AiravataAPIInvocationException - */ - public Monitor getExperimentMonitor(String experimentId)throws AiravataAPIInvocationException; - - /** - * Get a monitor for a running experiment - * @param experimentId - * @param listener - * @return - * @throws AiravataAPIInvocationException - */ - public Monitor getExperimentMonitor(String experimentId, EventDataListener listener) throws AiravataAPIInvocationException; - - /** - * Create a new experiment advance options - * @return - * @throws AiravataAPIInvocationException - */ - public ExperimentAdvanceOptions createExperimentAdvanceOptions() throws AiravataAPIInvocationException; - - /** - * Create a new experiment advance options - * @param experimentName - Name of the running experiment - * @param experimentUser - Experiment submission user - * @param experimentMetadata - Experiment metadata - * @return - * @throws AiravataAPIInvocationException - */ - public ExperimentAdvanceOptions createExperimentAdvanceOptions(String experimentName, String experimentUser, String experimentMetadata) throws AiravataAPIInvocationException; - - /** - * Returns when the given experiment has completed - * @param experimentId - * @throws AiravataAPIInvocationException - */ - public void waitForExperimentTermination(String experimentId) throws AiravataAPIInvocationException; - - /* - * Errors in experiment executions - */ - - /** - * Return errors defined at the experiment level - * @param experimentId - * @return - * @throws AiravataAPIInvocationException - */ -// public List<ExperimentExecutionError> getExperimentExecutionErrors(String experimentId) throws AiravataAPIInvocationException; -// -// /** -// * Return errors defined at the workflow level -// * @param experimentId -// * @param workflowInstanceId -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public List<WorkflowExecutionError> getWorkflowExecutionErrors(String experimentId, String workflowInstanceId) throws AiravataAPIInvocationException; -// -// /** -// * Return errors defined at the node level -// * @param experimentId -// * @param workflowInstanceId -// * @param nodeId -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public List<NodeExecutionError> getNodeExecutionErrors(String experimentId, String workflowInstanceId, String nodeId) throws AiravataAPIInvocationException; -// -// /** -// * Return errors defined for a Application job -// * @param experimentId -// * @param workflowInstanceId -// * @param nodeId -// * @param jobId -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public List<ApplicationJobExecutionError> getApplicationJobErrors(String experimentId, String workflowInstanceId, String nodeId, String jobId) throws AiravataAPIInvocationException; -// -// /** -// * Return errors defined for a Application job -// * @param jobId -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public List<ApplicationJobExecutionError> getApplicationJobErrors(String jobId) throws AiravataAPIInvocationException; -// -// /** -// * Return errors filtered by the parameters -// * @param experimentId -// * @param workflowInstanceId -// * @param nodeId -// * @param jobId -// * @param filterBy - what type of source types the results should contain -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public List<ExecutionError> getExecutionErrors(String experimentId, String workflowInstanceId, String nodeId, String jobId, ExecutionErrors.Source...filterBy) throws AiravataAPIInvocationException; -// -// /** -// * Adds an experiment execution error -// * @param error -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public int addExperimentError(ExperimentExecutionError error) throws AiravataAPIInvocationException; -// -// /** -// * Adds an workflow execution error -// * @param error -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public int addWorkflowExecutionError(WorkflowExecutionError error) throws AiravataAPIInvocationException; -// -// /** -// * Adds an node execution error -// * @param error -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public int addNodeExecutionError(NodeExecutionError error) throws AiravataAPIInvocationException; -// -// /** -// * Adds an Application job execution error -// * @param error -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public int addApplicationJobExecutionError(ApplicationJobExecutionError error) throws AiravataAPIInvocationException; - -} http://git-wip-us.apache.org/repos/asf/airavata/blob/32fff944/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ExperimentAdvanceOptions.java ---------------------------------------------------------------------- diff --git a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ExperimentAdvanceOptions.java b/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ExperimentAdvanceOptions.java deleted file mode 100644 index 458ec8c..0000000 --- a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ExperimentAdvanceOptions.java +++ /dev/null @@ -1,160 +0,0 @@ -/* - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - */ - -package org.apache.airavata.client.api; - -import org.apache.airavata.client.api.exception.AiravataAPIInvocationException; -import org.apache.airavata.client.impl.SecuritySettingsImpl; -import org.apache.airavata.client.impl.WorkflowOutputDataSettingsImpl; -import org.apache.airavata.client.impl.WorkflowSchedulingSettingsImpl; - -import java.util.UUID; - -public class ExperimentAdvanceOptions { - private String executionUser; - private String metadata; - private String experimentName; - private String customExperimentId; - private WorkflowSchedulingSettings schedulingSettings; - private WorkflowOutputDataSettings outputDataSettings; - private SecuritySettings securitySettings; -// private AiravataAPI api; -// -// public ExperimentAdvanceOptions(AiravataAPI api) { -// this.api=api; -// } - - /** - * Get the user who will be running the experiment if different from the experiment - * submitting user. - * @return String representing the execution user - */ - public String getExperimentExecutionUser(){ - return executionUser; - } - - /** - * Get the metadata for the experiment. - * @return String representing the custom metadata. - */ - public String getExperimentMetadata(){ - return metadata; - } - - /** - * Get the name of the experiment - * @return String representing the experiment name. - */ - public String getExperimentName(){ - return experimentName; - } - - /** - * Get the custom Id that will be used as the experiment Id. - * @return String representing the custom experiment Id. - */ - public String getCustomExperimentId(){ - return customExperimentId; - } - - /** - * Set a 3rd party user identity as the user who performed this experiment. If not specified - * the experiment submission user will be used as the execution user. - * @param experimentExecutionUser - String representing the user. - */ - public void setExperimentExecutionUser(String experimentExecutionUser){ - this.executionUser=experimentExecutionUser; - } - - /** - * Set custom metadata for the experiment.<br /> - * <i><b>Note:</b> Users can store custom data related to experiment along with the experiment and - * retrieve them later on.</i> - * @param experimentMetadata - String representing the metadata. - */ - public void setExperimentCustomMetadata(String experimentMetadata){ - this.metadata=experimentMetadata; - } - - /** - * Set the name of the experiment. Must be unique. If not defined the name will be - * auto-generated using the worklfow template Id & & time of experiment submission . - * @param experimentName - String representing experiment name. - */ - public void setExperimentName(String experimentName){ - this.experimentName=experimentName; - } - - /** - * Set a custom id as an experiment Id. If not specified the system will autogenerate an - * experiment id. - * @param customExperimentId - String representing the experiment Id. - */ - public void setCustomExperimentId(String customExperimentId){ - this.customExperimentId=customExperimentId; - } - - /** - * Create a unique experiment Id.<br /> - * <i><b>Note:</b> This will not be set as the experiment Id for the experiment. Users should use the - * function </i><code><b>setCustomExperimentId(...)</b></code><i> to do so. - * @return A string representing a unique id. - */ - public String generatExperimentId(){ - return UUID.randomUUID().toString(); - } - - /** - * Get custom workflow scheduling settings - * @return - * @throws AiravataAPIInvocationException - */ - public WorkflowSchedulingSettings getCustomWorkflowSchedulingSettings() throws AiravataAPIInvocationException{ - if (schedulingSettings==null){ - schedulingSettings=new WorkflowSchedulingSettingsImpl(); - } - return schedulingSettings; - } - - /** - * Get workflow intermediate output data settings for application executions - * @return - * @throws AiravataAPIInvocationException - */ - public WorkflowOutputDataSettings getCustomWorkflowOutputDataSettings() throws AiravataAPIInvocationException{ - if (outputDataSettings==null){ - outputDataSettings=new WorkflowOutputDataSettingsImpl(); - } - return outputDataSettings; - } - - /** - * Get the custom security settings for running the experiment - * @return - * @throws AiravataAPIInvocationException - */ - public SecuritySettings getCustomSecuritySettings() throws AiravataAPIInvocationException{ - if (securitySettings==null){ - securitySettings= new SecuritySettingsImpl(); - } - return securitySettings; - } -} http://git-wip-us.apache.org/repos/asf/airavata/blob/32fff944/modules/airavata-client/src/main/java/org/apache/airavata/client/api/GridMyProxyRepositorySettings.java ---------------------------------------------------------------------- diff --git a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/GridMyProxyRepositorySettings.java b/modules/airavata-client/src/main/java/org/apache/airavata/client/api/GridMyProxyRepositorySettings.java deleted file mode 100644 index e0a7091..0000000 --- a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/GridMyProxyRepositorySettings.java +++ /dev/null @@ -1,39 +0,0 @@ -/* - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - */ - -package org.apache.airavata.client.api; - -public interface GridMyProxyRepositorySettings { - public String getUsername(); - public String getPassword(); - public String getMyProxyServer(); - public int getLifeTime(); - - public void setUsername(String username); - public void setPassword(String password); - public void setMyProxyServer(String myproxyServer); - public void setLifeTime(int lifeTime); - - public void resetUsername(); - public void resetPassword(); - public void resetMyProxyServer(); - public void resetLifeTime(); -} http://git-wip-us.apache.org/repos/asf/airavata/blob/32fff944/modules/airavata-client/src/main/java/org/apache/airavata/client/api/HPCSettings.java ---------------------------------------------------------------------- diff --git a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/HPCSettings.java b/modules/airavata-client/src/main/java/org/apache/airavata/client/api/HPCSettings.java deleted file mode 100644 index 7fe2c32..0000000 --- a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/HPCSettings.java +++ /dev/null @@ -1,111 +0,0 @@ -/* - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - */ - -package org.apache.airavata.client.api; - -public interface HPCSettings { - - /** - * Get the job manager to use for this job submission - * @return - */ - public String getJobManager(); - - /** - * Get the no of CPU cores to allocate for this job - * @return - */ - public Integer getCPUCount(); - - /** - * Get the no of nodes to allocate for this job - * @return - */ - public Integer getNodeCount(); - - /** - * Get the job queue name - * @return - */ - public String getQueueName(); - - /** - * Get the maximum time the job should be allocated for execution - * @return - */ - public Integer getMaxWallTime(); - - /** - * Set the job manager to use for this job submission - * @param jobManager - */ - public void setJobManager(String jobManager); - - /** - * Set the no of CPU cores to allocate for this job - * @param cpuCount - */ - public void setCPUCount(Integer cpuCount); - - /** - * Set the no of nodes to allocate for this job - * @param nodeCount - */ - public void setNodeCount(Integer nodeCount); - - /** - * Set the job queue name - * @param queueName - */ - public void setQueueName(String queueName); - - /** - * Set the maximum time the job should be allocated for execution - * @param maxWallTime - */ - public void setMaxWallTime(Integer maxWallTime); - - /** - * Reset the job manager values - */ - public void resetJobManager(); - - /** - * Reset the CPU count - */ - public void resetCPUCount(); - - /** - * Reset the Node count - */ - public void resetNodeCount(); - - /** - * Reset the queue name for the job - */ - public void resetQueueName(); - - /** - * Reset the maximum time allocated for the job - */ - public void resetMaxWallTime(); - -} http://git-wip-us.apache.org/repos/asf/airavata/blob/32fff944/modules/airavata-client/src/main/java/org/apache/airavata/client/api/HostSchedulingSettings.java ---------------------------------------------------------------------- diff --git a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/HostSchedulingSettings.java b/modules/airavata-client/src/main/java/org/apache/airavata/client/api/HostSchedulingSettings.java deleted file mode 100644 index 2d7f919..0000000 --- a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/HostSchedulingSettings.java +++ /dev/null @@ -1,71 +0,0 @@ -/* - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - */ - -package org.apache.airavata.client.api; - -public interface HostSchedulingSettings { - - /** - * Get the id of the host descriptor - * @return - */ - public String getHostId(); - - /** - * Using WS-Gram or not (Pre WS-GRAM) - * @return - */ - public Boolean isWSGRAMPreffered(); - - /** - * Get the gatekeeper endpoint reference - * @return - */ - public String getGatekeeperEPR(); - - /** - * Set the id of the host descriptor use - * @param hostId - */ - public void setHostId(String hostId); - - /** - * Set whether to use WS-GRAM or Pre WS-GRAM - * @param wsgramPreffered - */ - public void setWSGramPreffered(Boolean wsgramPreffered); - - /** - * Set the gatekeeper endpoint reference - * @param gatekeeperEPR - */ - public void setGatekeeperEPR(String gatekeeperEPR); - - /** - * reset the values for the WS-GRAM preference - */ - public void resetWSGramPreffered(); - - /** - * Reset the values for gatekeeper endpoint reference - */ - public void resetGatekeeperEPR(); -} http://git-wip-us.apache.org/repos/asf/airavata/blob/32fff944/modules/airavata-client/src/main/java/org/apache/airavata/client/api/NodeSettings.java ---------------------------------------------------------------------- diff --git a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/NodeSettings.java b/modules/airavata-client/src/main/java/org/apache/airavata/client/api/NodeSettings.java deleted file mode 100644 index 9b33cf8..0000000 --- a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/NodeSettings.java +++ /dev/null @@ -1,90 +0,0 @@ -/* - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - */ - -package org.apache.airavata.client.api; - -import java.util.List; - -import org.apache.airavata.client.tools.NameValuePairType; - -public interface NodeSettings { - - /** - * Get the id of the node in the workflow - * @return - */ - public String getNodeId(); - - /** - * Get the id of the service descriptor which the node binds to - * @return - */ - public String getServiceId(); - - /** - * host settings for the service descriptor - * @return - */ - public HostSchedulingSettings getHostSettings(); - - /** - * HPC settings for the grid application exposed by the service descriptor - * @return - */ - public HPCSettings getHPCSettings(); - - /** - * get the list of name-value pair settings - * @return - */ - public List<NameValuePairType> getNameValuePair(); - - /** - * Set the node Id of the workflow - * @param nodeId - */ - public void setNodeId(String nodeId); - - /** - * Set the id of the service descriptor which the node should binds to - * @param serviceId - */ - public void setServiceId(String serviceId); - - /** - * set host settings for the application - * @param hostSchedulingSettings - */ - public void setHostSettings(HostSchedulingSettings hostSchedulingSettings); - - /** - * Set HPC settings for the grid application - * @param hpcSettings - */ - public void setHPCSettings(HPCSettings hpcSettings); - - /** - * - * @param nameValuePair - */ - public void setNameValuePair(List<NameValuePairType> nameValuePair); - -} http://git-wip-us.apache.org/repos/asf/airavata/blob/32fff944/modules/airavata-client/src/main/java/org/apache/airavata/client/api/OutputDataSettings.java ---------------------------------------------------------------------- diff --git a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/OutputDataSettings.java b/modules/airavata-client/src/main/java/org/apache/airavata/client/api/OutputDataSettings.java deleted file mode 100644 index e1a8189..0000000 --- a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/OutputDataSettings.java +++ /dev/null @@ -1,90 +0,0 @@ -/* - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - */ - -package org.apache.airavata.client.api; - -public interface OutputDataSettings { - - /** - * Retrieve the id of the node which these output data settings are relevant - * @return - */ - public String getNodeId(); - - /** - * Retrieve the pre-specified staging location for output data - * @return - */ - public String getOutputDataDirectory(); - - /** - * Retrieve the associated data registry location for cataloging data separately - * @return - */ - public String getDataRegistryUrl(); - - /** - * Should the intermediate workflow output data should be kept or discarded - * @return - */ - public Boolean isDataPersistent(); - - /** - * Setup the id of the node which these output data settings are relevant - */ - public void setNodeId(String nodeId); - - /** - * Setup a custom pre-specified staging location for output data - * @param outputDataDirectory - Path for output data directory - */ - public void setOutputDataDirectory(String outputDataDirectory); - - /** - * Setup a URL for pre-specified data registry (instead of the default) which will - * catalog data - * @param dataRegistryUrl - */ - public void setDataRegistryUrl(String dataRegistryUrl); - - /** - * Retain or discard intermediate output data - * @param isDataPersistance - if true (default value) the intermediate output data is - * kept, else discarded. - */ - public void setDataPersistent(Boolean isDataPersistance); - - /** - * Default output data directory will be used. - */ - public void resetOutputDataDirectory(); - - /** - * Default data registry location will be used. - */ - public void resetDataRegistryUrl(); - - /** - * Default data persistent settings will be used. - */ - public void resetDataPersistent(); - -} http://git-wip-us.apache.org/repos/asf/airavata/blob/32fff944/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ProvenanceManager.java ---------------------------------------------------------------------- diff --git a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ProvenanceManager.java b/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ProvenanceManager.java deleted file mode 100644 index 5c248ae..0000000 --- a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/ProvenanceManager.java +++ /dev/null @@ -1,461 +0,0 @@ -///* -// * -// * Licensed to the Apache Software Foundation (ASF) under one -// * or more contributor license agreements. See the NOTICE file -// * distributed with this work for additional information -// * regarding copyright ownership. The ASF licenses this file -// * to you under the Apache License, Version 2.0 (the -// * "License"); you may not use this file except in compliance -// * with the License. You may obtain a copy of the License at -// * -// * http://www.apache.org/licenses/LICENSE-2.0 -// * -// * Unless required by applicable law or agreed to in writing, -// * software distributed under the License is distributed on an -// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -// * KIND, either express or implied. See the License for the -// * specific language governing permissions and limitations -// * under the License. -// * -// */ -// -//package org.apache.airavata.client.api; -//import java.util.Date; -//import java.util.List; -//import java.util.Map; -// -//import org.apache.airavata.client.api.exception.AiravataAPIInvocationException; -// -///** -// * This interface provide and API to manage all the provenance related methods, get Workflow inputs outputs -// */ -//public interface ProvenanceManager { -// -// /** -// * Add input port data for a node in a running instance of a Workflow -// * @param data -// * @throws AiravataAPIInvocationException -// */ -// public void setWorkflowInstanceNodeInput(WorkflowInstanceNode node, String data) throws AiravataAPIInvocationException; -// -// /** -// * Add input port data for a node in a running instance of a Workflow -// * @param experimentId -// * @param workflowInstanceId -// * @param nodeId -// * @param data -// * @throws AiravataAPIInvocationException -// */ -// public void setWorkflowInstanceNodeInput(String experimentId, String workflowInstanceId, String nodeId, String data) throws AiravataAPIInvocationException; -// -// /** -// * Add output port data for a node in a running instance of a Workflow -// * @param data -// * @throws AiravataAPIInvocationException -// */ -// public void setWorkflowInstanceNodeOutput(WorkflowInstanceNode node, String data) throws AiravataAPIInvocationException; -// -// /** -// * Add output port data for a node in a running instance of a Workflow -// * @param experimentId -// * @param workflowInstanceId -// * @param nodeId -// * @param data -// * @throws AiravataAPIInvocationException -// */ -// public void setWorkflowInstanceNodeOutput(String experimentId, String workflowInstanceId, String nodeId, String data) throws AiravataAPIInvocationException; -// -// /** -// * Get data of input ports of a node in a running instance of a Workflow -// * @param node -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public String getWorkflowInstanceNodeInput(WorkflowInstanceNode node) throws AiravataAPIInvocationException; -// -// /** -// * Get data of input ports of a node in a running instance of a Workflow -// * @param experimentId -// * @param workflowInstanceId -// * @param nodeId -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public String getWorkflowInstanceNodeInput(String experimentId, String workflowInstanceId, String nodeId) throws AiravataAPIInvocationException; -// -// /** -// * Get data of input ports of a node in all the running instance of a particular Workflow template -// * @param workflowTemplateId -// * @param nodeId -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public Map<WorkflowInstanceNode,String> getWorkflowInstanceNodeInput(String workflowTemplateId, String nodeId) throws AiravataAPIInvocationException; -// -// /** -// * Get data of output ports of a node in a running instance of a Workflow -// * @param node -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public String getWorkflowInstanceNodeOutput(WorkflowInstanceNode node) throws AiravataAPIInvocationException; -// -// /** -// * Get data of output ports of a node in a running instance of a Workflow -// * @param experimentId -// * @param workflowInstanceId -// * @param nodeId -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public String getWorkflowInstanceNodeOutput(String experimentId, String workflowInstanceId, String nodeId) throws AiravataAPIInvocationException; -// -// /** -// * Get data of output ports of a node in all the running instance of a particular Workflow template -// * @param workflowName -// * @param nodeId -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public Map<WorkflowInstanceNode,String> getWorkflowInstanceNodeOutput(String workflowName, String nodeId) throws AiravataAPIInvocationException; -// -// /** -// * Update the status of the Workflow instance -// * @param experimentId -// * @param workflowInstanceId -// * @param status -// * @throws AiravataAPIInvocationException -// */ -// public void setWorkflowInstanceStatus(String experimentId, String workflowInstanceId, State status) throws AiravataAPIInvocationException; -// -// /** -// * Update the status of the Workflow instance -// * @param status -// * @throws AiravataAPIInvocationException -// */ -// public void setWorkflowInstanceStatus(WorkflowExecutionStatus status) throws AiravataAPIInvocationException; -// -// /** -// * Retrieve the status of the Workflow instance -// * @param experimentId -// * @param workflowInstanceId -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public WorkflowExecutionStatus getWorkflowInstanceStatus(String experimentId, String workflowInstanceId) throws AiravataAPIInvocationException; -// -// /** -// * Retrieve the status of the Workflow instance -// * @param workflowInstance -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public WorkflowExecutionStatus getWorkflowInstanceStatus(WorkflowExecution workflowInstance) throws AiravataAPIInvocationException; -// -// /** -// * Update the User of the Workflow instance -// * @param experimentId -// * @param user -// * @throws AiravataAPIInvocationException -// */ -// public void setExperimentUser(String experimentId, String user) throws AiravataAPIInvocationException; -// -// /** -// * Update the User of the Workflow instance -// * @param user -// * @throws AiravataAPIInvocationException -// */ -// public void setExperimentUser(ExperimentUser user) throws AiravataAPIInvocationException; -// -// /** -// * Retrieve the User of the Workflow instance -// * @param experimentId -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public ExperimentUser getExperimentUser(String experimentId) throws AiravataAPIInvocationException; -// -// /** -// * Update the metadata of the Workflow instance -// * @param experimentId -// * @param metadata -// * @throws AiravataAPIInvocationException -// */ -// public void setExperimentMetadata(String experimentId, String metadata) throws AiravataAPIInvocationException; -// -// /** -// * Update the metadata of the Workflow instance -// * @param experimentMetadata -// * @throws AiravataAPIInvocationException -// */ -// public void setExperimentMetadata(ExperimentMetadata experimentMetadata) throws AiravataAPIInvocationException; -// -// /** -// * Retrieve the metadata of the Workflow instance -// * @param experimentId -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public ExperimentMetadata getExperimentMetadata(String experimentId) throws AiravataAPIInvocationException; -// -// /** -// * check whether the experiment exists -// * @param experimentName -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public boolean isExperimentNameExist(String experimentName) throws AiravataAPIInvocationException; -// -// /** -// * Update the instance name of the Workflow -// * @param experimentId -// * @param instanceName -// * @throws AiravataAPIInvocationException -// */ -// public void setExperimentName(String experimentId, String instanceName) throws AiravataAPIInvocationException; -// -// /** -// * Update the instance name of the Workflow -// * @param experimentName -// * @throws AiravataAPIInvocationException -// */ -// public void setExperimentName(ExperimentName experimentName) throws AiravataAPIInvocationException; -// -// /** -// * Retrieve the metadata of the Workflow instance -// * @param experimentId -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public ExperimentName getExperimentName(String experimentId) throws AiravataAPIInvocationException; -// -// /** -// * Retrieve the id's of all the experiments run by the given owner -// * @param owner -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public List<String> getExperimentIdList(String owner) throws AiravataAPIInvocationException; -// -// public ExperimentData getExperimentMetaInformation(String experimentId)throws AiravataAPIInvocationException; -// -// public List<ExperimentData> getAllExperimentMetaInformation(String user)throws AiravataAPIInvocationException; -// -// /** -// * Retrieve the id's of all the experiments run by the current user -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public List<String> getExperimentIdList() throws AiravataAPIInvocationException; -// -// /** -// * Retrieve all the experiments run by the current user -// * @deprecated -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public List<ExperimentData> getWorkflowExperimentDataList() throws AiravataAPIInvocationException; -// -// public List<ExperimentData> getExperimentDataList() throws AiravataAPIInvocationException; -// -// /** -// * Retrieve all the experiments run by the given owner -// * @deprecated -// * @param user -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public List<ExperimentData> getWorkflowExperimentDataList(String user) throws AiravataAPIInvocationException; -// -// public List<ExperimentData> getExperimentDataList(String user) throws AiravataAPIInvocationException; -// -// /** -// * Retrieve all the experiment data run by the given owner with paging -// * @deprecated -// * @param user -// * @param pageSize -// * @param pageNo -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public List<ExperimentData> getWorkflowExperimentData(String user, int pageSize, int pageNo) throws AiravataAPIInvocationException; -// -// public List<ExperimentData> getExperimentData(String user, int pageSize, int pageNo) throws AiravataAPIInvocationException; -// -// /** -// * Retrieve all the experiment data run by the given owner with paging -// * @deprecated -// * @param experimentId -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public ExperimentData getWorkflowExperimentData(String experimentId) throws AiravataAPIInvocationException; -// -// public ExperimentData getExperimentData(String experimentId) throws AiravataAPIInvocationException; -// -// /** -// * Retrieve experiment data for a given workflow instance -// * @param experimentId -// * @param workflowInstanceId -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public WorkflowExecutionData getWorkflowInstanceData(String experimentId, String workflowInstanceId) throws AiravataAPIInvocationException; -// -// /** -// * Retrieve experiment data for a given workflow instance -// * @param workflowInstance -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public WorkflowExecutionData getWorkflowInstanceData(WorkflowExecution workflowInstance) throws AiravataAPIInvocationException; -// -// /** -// * Retrieve output node names of a experiment -// * @param experimentId -// * @deprecated -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public String[] getWorkflowExecutionOutputNames(String experimentId) throws AiravataAPIInvocationException; -// -// public void setWorkflowInstanceNodeStatus(String experimentId, String workflowInstaceId, String nodeId, State status) throws AiravataAPIInvocationException; -// -// public void setWorkflowInstanceNodeStatus(NodeExecutionStatus status) throws AiravataAPIInvocationException; -// -// public NodeExecutionStatus getWorkflowInstanceNodeStatus(String experimentId, String workflowInstaceId, String nodeId) throws AiravataAPIInvocationException; -// -// public NodeExecutionStatus getWorkflowInstanceNodeStatus(WorkflowInstanceNode node) throws AiravataAPIInvocationException; -// -// public void addExperiment(String projectName, String experimentId, String experimentName) throws AiravataAPIInvocationException; -// -// public void addWorkflowInstance(String experimentId, WorkflowExecution workflowInstance) throws AiravataAPIInvocationException; -// -// //TODO setup node type for the node & gram data for the node -// -// public List<WorkflowExecution> getExperimentWorkflowInstances(String experimentId) throws AiravataAPIInvocationException; -// -// public void setWorkflowNodeType(WorkflowInstanceNode node, WorkflowNodeType type) throws AiravataAPIInvocationException; -// -// public void setWorkflowInstanceTemplateName(String workflowInstanceId,String templateName) throws AiravataAPIInvocationException; -// -// public void saveWorkflowExecutionOutput(String experimentId, String outputNodeName, String output) throws AiravataAPIInvocationException; -// -// /** -// * @deprecated - Will be removed from 0.9 release onwards. Use {@see #addApplicationJob #updateApplicationJob(ApplucationJob) etc.} functions instead. -// * This will store the gram specific data in to repository, this can be called before submitting the workflow in to Grid -// * @param data -// * @throws AiravataAPIInvocationException -// */ -// public void updateWorkflowNodeGramData(WorkflowNodeGramData data) throws AiravataAPIInvocationException; -// -// /*--------------------------------------- Managing Data for Application Jobs ------------------------------------------*/ -// -// /** -// * Returns <code>true</code> if a Application job data is existing in Airavata -// * @param jobId -// * @return -// * @throws org.apache.airavata.registry.api.exception.RegException -// */ -// public boolean isApplicationJobExists(String jobId) throws AiravataAPIInvocationException; -// -// /** -// * Adding data related to a new Application job submission -// * @param job - the <code>jobId</code> cannot be <code>null</code>. -// * @throws AiravataAPIInvocationException -// */ -// public void addApplicationJob(ApplicationJob job) throws AiravataAPIInvocationException; -// -// /** -// * Update data related to a existing Application job record in Airavata -// * @param job - the <code>jobId</code> cannot be <code>null</code> and should already exist in Airavata -// * @throws AiravataAPIInvocationException -// */ -// public void updateApplicationJob(ApplicationJob job) throws AiravataAPIInvocationException; -// -// /** -// * Update the status of the job -// * @param jobId -// * @param status -// * @param statusUpdateTime -// * @throws AiravataAPIInvocationException -// */ -// public void updateApplicationJobStatus(String jobId, ApplicationJobStatus status, Date statusUpdateTime) throws AiravataAPIInvocationException; -// -// /** -// * Update the status of the job for the current server time -// * @param jobId -// * @param status -// * @throws org.apache.airavata.registry.api.exception.RegException -// */ -// public void updateApplicationJobStatus(String jobId, ApplicationJobStatus status) throws AiravataAPIInvocationException; -// -// /** -// * Update the job data. GFacProvider implementation should decide the job data. Typically it'll -// * be a serialization of the submitted job query (eg: rsl for a GRAM job) -// * @param jobId -// * @param jobdata -// * @throws AiravataAPIInvocationException -// */ -// public void updateApplicationJobData(String jobId, String jobdata) throws AiravataAPIInvocationException; -// -// /** -// * Update the time of job submission or job started executing -// * @param jobId -// * @param submitted -// * @throws AiravataAPIInvocationException -// */ -// public void updateApplicationJobSubmittedTime(String jobId, Date submitted) throws AiravataAPIInvocationException; -// -// /** -// * Update the time of current job status is valid. -// * @param jobId -// * @param statusUpdateTime -// * @throws AiravataAPIInvocationException -// */ -// public void updateApplicationJobStatusUpdateTime(String jobId, Date statusUpdateTime) throws AiravataAPIInvocationException; -// -// /** -// * Custom data field for users -// * @param jobId -// * @param metadata -// * @throws AiravataAPIInvocationException -// */ -// public void updateApplicationJobMetadata(String jobId, String metadata) throws AiravataAPIInvocationException; -// -// /** -// * Retrieve the Application Job for the given job id -// * @param jobId -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public ApplicationJob getApplicationJob(String jobId) throws AiravataAPIInvocationException; -// -// /** -// * Retrieve a list of Application jobs executed for the given descriptors -// * @param serviceDescriptionId - should be <code>null</code> if user does not care what service description the job corresponds to -// * @param hostDescriptionId - should be <code>null</code> if user does not care what host description the job corresponds to -// * @param applicationDescriptionId - should be <code>null</code> if user does not care what application description the job corresponds to -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public List<ApplicationJob> getApplicationJobsForDescriptors(String serviceDescriptionId, String hostDescriptionId, String applicationDescriptionId) throws AiravataAPIInvocationException; -// -// /** -// * Retrieve a list of Application jobs executed for the given experiment credentials -// * @param experimentId - should be <code>null</code> if user does not care what experiment the job corresponds to -// * @param workflowExecutionId - - should be <code>null</code> if user does not care what workflow execution the job corresponds to -// * @param nodeId - should be <code>null</code> if user does not care what node id the job corresponds to -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public List<ApplicationJob> getApplicationJobs(String experimentId, String workflowExecutionId, String nodeId) throws AiravataAPIInvocationException; -// -// /** -// * Retrieve the list all the status updates for an application job. -// * @param jobId - Application job id -// * @return -// * @throws AiravataAPIInvocationException -// */ -// public List<ApplicationJobStatusData> getApplicationJobStatusHistory(String jobId) throws AiravataAPIInvocationException; -//} http://git-wip-us.apache.org/repos/asf/airavata/blob/32fff944/modules/airavata-client/src/main/java/org/apache/airavata/client/api/SSHAuthenticationSettings.java ---------------------------------------------------------------------- diff --git a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/SSHAuthenticationSettings.java b/modules/airavata-client/src/main/java/org/apache/airavata/client/api/SSHAuthenticationSettings.java deleted file mode 100644 index 2b8fa18..0000000 --- a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/SSHAuthenticationSettings.java +++ /dev/null @@ -1,30 +0,0 @@ -/* - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - */ - -package org.apache.airavata.client.api; - -public interface SSHAuthenticationSettings { - public String getAccessKeyId(); - public String getSecretAccessKey(); - - public void setAccessKeyId(String accessKeyId); - public void setSecretAccessKey(String secretAccessKey); -} http://git-wip-us.apache.org/repos/asf/airavata/blob/32fff944/modules/airavata-client/src/main/java/org/apache/airavata/client/api/SecuritySettings.java ---------------------------------------------------------------------- diff --git a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/SecuritySettings.java b/modules/airavata-client/src/main/java/org/apache/airavata/client/api/SecuritySettings.java deleted file mode 100644 index 06cf8c6..0000000 --- a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/SecuritySettings.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - */ - -package org.apache.airavata.client.api; - -import org.apache.airavata.client.api.exception.AiravataAPIInvocationException; - -public interface SecuritySettings { - public AmazonWebServicesSettings getAmazonWSSettings() throws AiravataAPIInvocationException; - public CredentialStoreSecuritySettings getCredentialStoreSecuritySettings() throws AiravataAPIInvocationException; - public GridMyProxyRepositorySettings getGridMyProxyRepositorySettings() throws AiravataAPIInvocationException; - public SSHAuthenticationSettings getSSHAuthenticationSettings() throws AiravataAPIInvocationException; -} http://git-wip-us.apache.org/repos/asf/airavata/blob/32fff944/modules/airavata-client/src/main/java/org/apache/airavata/client/api/UserManager.java ---------------------------------------------------------------------- diff --git a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/UserManager.java b/modules/airavata-client/src/main/java/org/apache/airavata/client/api/UserManager.java deleted file mode 100644 index 7487f7a..0000000 --- a/modules/airavata-client/src/main/java/org/apache/airavata/client/api/UserManager.java +++ /dev/null @@ -1,31 +0,0 @@ -/* - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - */ - -package org.apache.airavata.client.api; - -public interface UserManager { - /** - * Get the current user - * @return - */ - public String getAiravataUser(); - -}
