org.apache.airavata.xbaya.workflow

Class WorkflowClient

java.lang.Object

org.apache.airavata.xbaya.messaging.event.EventProducer

org.apache.airavata.xbaya.workflow.WorkflowClient

public abstract class WorkflowClient
extends EventProducer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WorkflowClient.WorkflowType Either workflow template or workflow instance

Field Summary

Fields

Modifier and Type	Field and Description
protected URI	engineURL
protected static String	GRAPH_MIME_TYPE
protected static org.slf4j.Logger	logger
protected static String	PNG_MIME_TYPE
protected static String	PROCESS_GPEL_TITLE
protected static String	PROCESS_WSDL_TYTLE

Constructor Summary

Constructors

Constructor and Description
WorkflowClient()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	connect()
URI	createScriptAndDeploy(Workflow workflow, boolean redeploy) Deploys a workflow to the GPEL Engine.
abstract URI	deploy(Workflow workflow, boolean redeploy)
URI	getEngineURL()
abstract org.gpel.client.GcInstance	instantiate(Workflow workflow, Map<String,xsul5.wsdl.WsdlDefinitions> wsdlMap) Deprecated.
org.gpel.client.GcInstance	instantiate(Workflow workflow, URI dscURL)
abstract org.gpel.client.GcInstance	instantiate(Workflow workflow, URI dscURL, String name)
protected boolean	isConnected() Checks if the client is connected to the BPEL engine.
boolean	isSecure()
org.gpel.client.GcSearchList	list() Returns the List of GcSearchResult.
abstract org.gpel.client.GcSearchList	list(int maxNum, WorkflowClient.WorkflowType type) Returns the List of GcSearchResult.
Workflow	load(URI templateID) Loads a workflow with s specified workflow template ID.
abstract Workflow	load(URI id, WorkflowClient.WorkflowType workflowType)
void	setEngineURL(URI engineURL)
abstract void	setXBayaEngine(XBayaEngine xBayaEngine)
abstract xsul5.wsdl.WsdlDefinitions	start(org.gpel.client.GcInstance instance) Starts the workflow instance.

Methods inherited from class org.apache.airavata.xbaya.messaging.event.EventProducer

addEventListener, removeEventListener, sendEvent, sendSafeEvent

Methods inherited from class java.lang.Object

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

Field Detail

PROCESS_WSDL_TYTLE

protected static final String PROCESS_WSDL_TYTLE

See Also:

Constant Field Values

PROCESS_GPEL_TITLE

protected static final String PROCESS_GPEL_TITLE

See Also:

Constant Field Values

PNG_MIME_TYPE

protected static final String PNG_MIME_TYPE

See Also:

Constant Field Values

GRAPH_MIME_TYPE

protected static final String GRAPH_MIME_TYPE

See Also:

Constant Field Values

logger

protected static final org.slf4j.Logger logger

engineURL

protected URI engineURL

Constructor Detail

WorkflowClient

public WorkflowClient()

Method Detail

setEngineURL

public void setEngineURL(URI engineURL)
                  throws WorkflowEngineException

Parameters:

engineURL -

Throws:

WorkflowEngineException

getEngineURL

public URI getEngineURL()

Returns:

The URL of the GPEL Engine.

createScriptAndDeploy

public URI createScriptAndDeploy(Workflow workflow,
                        boolean redeploy)
                          throws GraphException,
                                 WorkflowEngineException

Deploys a workflow to the GPEL Engine.

Parameters:

workflow -

redeploy -

Returns:

The workflow template ID.

Throws:

GraphException

WorkflowEngineException

load

public Workflow load(URI templateID)
              throws GraphException,
                     WorkflowEngineException,
                     ComponentException

Loads a workflow with s specified workflow template ID.

Parameters:

templateID - The workflow template ID.

Returns:

The workflow loaded

Throws:

GraphException

WorkflowEngineException

ComponentException

list

public org.gpel.client.GcSearchList list()
                                  throws WorkflowEngineException

Returns the List of GcSearchResult.

This method returns the first 100 matches.

Returns:

The List of GcSearchResult.

Throws:

WorkflowEngineException

instantiate

public org.gpel.client.GcInstance instantiate(Workflow workflow,
                                     URI dscURL)
                                       throws WorkflowEngineException,
                                              ComponentException,
                                              GraphException

Parameters:

workflow -

dscURL -

Returns:

The instance of workflow

Throws:

WorkflowEngineException

ComponentException

GraphException

isSecure

public boolean isSecure()

Returns:

True if the connection is secure; false otherwise.

isConnected

protected boolean isConnected()

Checks if the client is connected to the BPEL engine.

Returns:

true if the client is connected to the BPEL engine; false otherwise.

deploy

public abstract URI deploy(Workflow workflow,
         boolean redeploy)
                    throws WorkflowEngineException

Parameters:

workflow -

redeploy -

Returns:

The workflow template ID.

Throws:

WorkflowEngineException

load

public abstract Workflow load(URI id,
            WorkflowClient.WorkflowType workflowType)
                       throws GraphException,
                              WorkflowEngineException,
                              ComponentException

Parameters:

id -

workflowType -

Returns:

The workflow loaded

Throws:

GraphException

WorkflowEngineException

ComponentException

list

public abstract org.gpel.client.GcSearchList list(int maxNum,
                                WorkflowClient.WorkflowType type)
                                           throws WorkflowEngineException

Returns the List of GcSearchResult.

Parameters:

maxNum - The maximum number of results

type -

Returns:

The List of GcSearchResult.

Throws:

WorkflowEngineException

instantiate

public abstract org.gpel.client.GcInstance instantiate(Workflow workflow,
                                     URI dscURL,
                                     String name)
                                                throws WorkflowEngineException,
                                                       ComponentException,
                                                       GraphException

Parameters:

workflow - The workflow to instantiate.

dscURL - The URL of the DSC.

name - The name that becomes a part of the workflow instance name.

Returns:

The instance of workflow

Throws:

WorkflowEngineException

ComponentException

GraphException

instantiate

@Deprecated
public abstract org.gpel.client.GcInstance instantiate(Workflow workflow,
                                                Map<String,xsul5.wsdl.WsdlDefinitions> wsdlMap)
                                                throws WorkflowEngineException

Deprecated.

Instantiate a specified workflow.

The workflow must have been dployed.

Parameters:

workflow -

wsdlMap - Map

Returns:

The workflow instance.

Throws:

WorkflowEngineException

start

public abstract xsul5.wsdl.WsdlDefinitions start(org.gpel.client.GcInstance instance)
                                          throws WorkflowEngineException

Starts the workflow instance.

The AWSDLs in workflow must have been modified to CWSDLs.

Parameters:

instance -

Returns:

The WSDL of the workflow.

Throws:

WorkflowEngineException

connect

public abstract void connect()
                      throws WorkflowEngineException

Throws:

WorkflowEngineException

setXBayaEngine

public abstract void setXBayaEngine(XBayaEngine xBayaEngine)