org.apache.airavata.persistance.registry.jpa.resources

Class GatewayResource

java.lang.Object

org.apache.airavata.persistance.registry.jpa.resources.AbstractResource

org.apache.airavata.persistance.registry.jpa.resources.GatewayResource

All Implemented Interfaces:

Resource

public class GatewayResource
extends AbstractResource

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.airavata.persistance.registry.jpa.resources.AbstractResource

AbstractResource.AdvancedInputDataHandlingConstants, AbstractResource.AdvancedOutputDataHandlingConstants, AbstractResource.ApplicationDescriptorConstants, AbstractResource.ApplicationInputConstants, AbstractResource.ApplicationOutputConstants, AbstractResource.ComputationalResourceSchedulingConstants, AbstractResource.ConfigurationConstants, AbstractResource.DataTransferDetailConstants, AbstractResource.ErrorDetailConstants, AbstractResource.ExperimentConfigurationDataConstants, AbstractResource.ExperimentConstants, AbstractResource.ExperimentInputConstants, AbstractResource.ExperimentOutputConstants, AbstractResource.GatewayConstants, AbstractResource.GatewayWorkerConstants, AbstractResource.HostDescriptorConstants, AbstractResource.JobDetailConstants, AbstractResource.NodeInputConstants, AbstractResource.NodeOutputConstants, AbstractResource.ProjectConstants, AbstractResource.ProjectUserConstants, AbstractResource.PublishedWorkflowConstants, AbstractResource.QosParamsConstants, AbstractResource.ServiceDescriptorConstants, AbstractResource.StatusConstants, AbstractResource.TaskDetailConstants, AbstractResource.UserConstants, AbstractResource.UserWorkflowConstants, AbstractResource.WorkflowNodeDetailsConstants

Field Summary

Fields inherited from class org.apache.airavata.persistance.registry.jpa.resources.AbstractResource

ADVANCE_INPUT_DATA_HANDLING, ADVANCE_OUTPUT_DATA_HANDLING, APPLICATION_DESCRIPTOR, APPLICATION_INPUT, APPLICATION_OUTPUT, COMPUTATIONAL_RESOURCE_SCHEDULING, CONFIG_DATA, CONFIGURATION, DATA_TRANSFER_DETAIL, ERROR_DETAIL, EXPERIMENT, EXPERIMENT_CONFIG_DATA, EXPERIMENT_INPUT, EXPERIMENT_OUTPUT, GATEWAY, GATEWAY_WORKER, HOST_DESCRIPTOR, JOB_DETAIL, NODE_INPUT, NODE_OUTPUT, PROJECT, PROJECT_USER, PUBLISHED_WORKFLOW, QOS_PARAMS, SERVICE_DESCRIPTOR, STATUS, TASK_DETAIL, USER_WORKFLOW, USERS, WORKFLOW_NODE_DETAIL

Constructor Summary

Constructors

Constructor and Description
GatewayResource()
GatewayResource(String gatewayName)

Method Summary

Methods

Modifier and Type	Method and Description
Resource	create(ResourceType type) Gateway is at the root level.
ApplicationDescriptorResource	createApplicationDescriptorResource(String descriptorName)
ExperimentResource	createExperiment(String experimentID)
HostDescriptorResource	createHostDescriptorResource(String hostDescriptorName)
PublishWorkflowResource	createPublishedWorkflow(String workflowTemplateName)
ServiceDescriptorResource	createServiceDescriptorResource(String descriptorName)
List<Resource>	get(ResourceType type) This method will list all the child resources for the given resource type
Resource	get(ResourceType type, Object name) Gateway can get information of his children
ApplicationDescriptorResource	getApplicationDescriptorResource(String descriptorName)
List<ApplicationDescriptorResource>	getApplicationDescriptorResources()
List<ApplicationDescriptorResource>	getApplicationDescriptorResources(String serviceName, String hostName)
ExperimentResource	getExperiment(String expId)
List<ExperimentResource>	getExperiments()
String	getGatewayName()
HostDescriptorResource	getHostDescriptorResource(String hostDescriptorName)
List<HostDescriptorResource>	getHostDescriptorResources()
String	getOwner()
PublishWorkflowResource	getPublishedWorkflow(String workflowTemplateName)
List<PublishWorkflowResource>	getPublishedWorkflows()
ServiceDescriptorResource	getServiceDescriptorResource(String descriptorName)
List<ServiceDescriptorResource>	getServiceDescriptorResources()
boolean	isApplicationDescriptorExists(String descriptorName)
boolean	isExists(ResourceType type, Object name) check whether child resource already exist in the database
boolean	isHostDescriptorExists(String descriptorName)
boolean	isPublishedWorkflowExists(String workflowTemplateName)
boolean	isServiceDescriptorExists(String descriptorName)
void	remove(ResourceType type, Object name) Child resources can be removed from a gateway
void	removeApplicationDescriptor(String descriptorName)
void	removeHostDescriptor(String descriptorName)
void	removePublishedWorkflow(String workflowTemplateName)
void	removeServiceDescriptor(String descriptorName)
void	save() save the gateway to the database
void	setGatewayName(String gatewayName)
void	setOwner(String owner)

Methods inherited from class org.apache.airavata.persistance.registry.jpa.resources.AbstractResource

getResourceList

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GatewayResource

public GatewayResource(String gatewayName)

Parameters:

gatewayName - gateway name

GatewayResource

public GatewayResource()

Method Detail

getGatewayName

public String getGatewayName()

Returns:

gateway name

setGatewayName

public void setGatewayName(String gatewayName)

Parameters:

gatewayName -

getOwner

public String getOwner()

Returns:

owner of the gateway

setOwner

public void setOwner(String owner)

Parameters:

owner - owner of the gateway

create

public Resource create(ResourceType type)
                throws RegistryException

Gateway is at the root level. So it can populate his child resources. Project, User, Published Workflows, User workflows, Host descriptors, Service Descriptors, Application descriptors and Experiments are all its children

Parameters:

type - resource type of the children

Returns:

specific child resource type

Throws:

RegistryException

remove

public void remove(ResourceType type,
          Object name)
            throws RegistryException

Child resources can be removed from a gateway

Parameters:

type - child resource type

name - child resource name

Throws:

RegistryException

get

public Resource get(ResourceType type,
           Object name)
             throws RegistryException

Gateway can get information of his children

Parameters:

type - child resource type

name - child resource name

Returns:

specific child resource type

Throws:

RegistryException

get

public List<Resource> get(ResourceType type)
                   throws RegistryException

Description copied from interface: Resource

This method will list all the child resources for the given resource type

Parameters:

type - child resource type

Returns:

list of child resources

Throws:

RegistryException

save

public void save()
          throws RegistryException

save the gateway to the database

Throws:

RegistryException

isExists

public boolean isExists(ResourceType type,
               Object name)
                 throws RegistryException

check whether child resource already exist in the database

Specified by:

isExists in interface Resource

Overrides:

isExists in class AbstractResource

Parameters:

type - child resource type

name - name of the child resource

Returns:

true or false

Throws:

RegistryException

isHostDescriptorExists

public boolean isHostDescriptorExists(String descriptorName)
                               throws RegistryException

Parameters:

descriptorName - host descriptor name

Returns:

whether host descriptor already available

Throws:

RegistryException

createHostDescriptorResource

public HostDescriptorResource createHostDescriptorResource(String hostDescriptorName)
                                                    throws RegistryException

Parameters:

hostDescriptorName - host descriptor name

Returns:

HostDescriptorResource

Throws:

RegistryException

getHostDescriptorResource

public HostDescriptorResource getHostDescriptorResource(String hostDescriptorName)
                                                 throws RegistryException

Parameters:

hostDescriptorName - host descriptor name

Returns:

HostDescriptorResource

Throws:

RegistryException

removeHostDescriptor

public void removeHostDescriptor(String descriptorName)
                          throws RegistryException

Parameters:

descriptorName - host descriptor name

Throws:

RegistryException

getHostDescriptorResources

public List<HostDescriptorResource> getHostDescriptorResources()
                                                        throws RegistryException

Returns:

list of host descriptors available for the gateway

Throws:

RegistryException

isServiceDescriptorExists

public boolean isServiceDescriptorExists(String descriptorName)
                                  throws RegistryException

Parameters:

descriptorName - service descriptor name

Returns:

whether service descriptor already available

Throws:

RegistryException

createServiceDescriptorResource

public ServiceDescriptorResource createServiceDescriptorResource(String descriptorName)
                                                          throws RegistryException

Parameters:

descriptorName - service descriptor name

Returns:

ServiceDescriptorResource

Throws:

RegistryException

getServiceDescriptorResource

public ServiceDescriptorResource getServiceDescriptorResource(String descriptorName)
                                                       throws RegistryException

Parameters:

descriptorName - service descriptor name

Returns:

ServiceDescriptorResource

Throws:

RegistryException

removeServiceDescriptor

public void removeServiceDescriptor(String descriptorName)
                             throws RegistryException

Parameters:

descriptorName - Service descriptor name

Throws:

RegistryException

getServiceDescriptorResources

public List<ServiceDescriptorResource> getServiceDescriptorResources()
                                                              throws RegistryException

Returns:

list of service descriptors for the gateway

Throws:

RegistryException

isApplicationDescriptorExists

public boolean isApplicationDescriptorExists(String descriptorName)
                                      throws RegistryException

Parameters:

descriptorName - application descriptor name

Returns:

whether application descriptor already available

Throws:

RegistryException

createApplicationDescriptorResource

public ApplicationDescriptorResource createApplicationDescriptorResource(String descriptorName)
                                                                  throws RegistryException

Parameters:

descriptorName - application descriptor name

Returns:

ApplicationDescriptorResource

Throws:

RegistryException

getApplicationDescriptorResource

public ApplicationDescriptorResource getApplicationDescriptorResource(String descriptorName)
                                                               throws RegistryException

Parameters:

descriptorName - application descriptor name

Returns:

ApplicationDescriptorResource

Throws:

RegistryException

removeApplicationDescriptor

public void removeApplicationDescriptor(String descriptorName)
                                 throws RegistryException

Parameters:

descriptorName - application descriptor name

Throws:

RegistryException

getApplicationDescriptorResources

public List<ApplicationDescriptorResource> getApplicationDescriptorResources()
                                                                      throws RegistryException

Returns:

list of application descriptors for the gateway

Throws:

RegistryException

getApplicationDescriptorResources

public List<ApplicationDescriptorResource> getApplicationDescriptorResources(String serviceName,
                                                                    String hostName)
                                                                      throws RegistryException

Parameters:

serviceName - service descriptor name

hostName - host descriptor name

Returns:

list of application descriptors for the gateway

Throws:

RegistryException

isPublishedWorkflowExists

public boolean isPublishedWorkflowExists(String workflowTemplateName)
                                  throws RegistryException

Parameters:

workflowTemplateName - published workflow template name

Returns:

boolean - whether workflow with the same name exists

Throws:

RegistryException

createPublishedWorkflow

public PublishWorkflowResource createPublishedWorkflow(String workflowTemplateName)
                                                throws RegistryException

Parameters:

workflowTemplateName - published workflow template name

Returns:

publish workflow resource

Throws:

RegistryException

getPublishedWorkflow

public PublishWorkflowResource getPublishedWorkflow(String workflowTemplateName)
                                             throws RegistryException

Parameters:

workflowTemplateName - published workflow template name

Returns:

publish workflow resource

Throws:

RegistryException

getPublishedWorkflows

public List<PublishWorkflowResource> getPublishedWorkflows()
                                                    throws RegistryException

Returns:

list of publish workflows for the gateway

Throws:

RegistryException

removePublishedWorkflow

public void removePublishedWorkflow(String workflowTemplateName)
                             throws RegistryException

Parameters:

workflowTemplateName - published workflow template name

Throws:

RegistryException

createExperiment

public ExperimentResource createExperiment(String experimentID)
                                    throws RegistryException

Throws:

RegistryException

getExperiment

public ExperimentResource getExperiment(String expId)
                                 throws RegistryException

Throws:

RegistryException

getExperiments

public List<ExperimentResource> getExperiments()
                                        throws RegistryException

Throws:

RegistryException