SMILA 1.0 API documentation

org.eclipse.smila.processing.bpel
Interface BpelEngine

All Known Implementing Classes:
OdeBpelEngine

public interface BpelEngine

interface of BpelEngine service.


Method Summary
 java.util.Collection<java.lang.String> deployPredefinedWorkflows(java.lang.String pipelineDirName)
          prepare a deployment unit dirrectory from a configuration directory with predefined workflows and deploy it to the server.
 void deployWorkflow(java.lang.String workflowName, AnyMap workflowDefinition)
          deploy a single workflow to the server.
 javax.xml.namespace.QName deployWorkflowDir(java.lang.String workflowName, java.io.File deploymentDirectory)
          deploy a deployment unit dir with one workflow to the server.
 AnyMap getWorkflow(java.lang.String workflowName)
          get current workflow definition from ODE server.
 org.w3c.dom.Element invoke(java.lang.String workflowName, org.w3c.dom.Element message)
          invoke a pipeline.
 boolean isCustomWorkflow(java.lang.String workflowName)
          check if a workflow is custom defined.
 boolean isPredefinedWorkflow(java.lang.String workflowName)
          check if a workflow is predefined.
 void undeployWorkflow(java.lang.String workflowName)
          undeploy a workflow from the server.
 java.io.File validateWorkflow(java.lang.String workflowName, AnyMap workflowDefinition)
          create deployment unit for given workflow definition and validate it.
 

Method Detail

invoke

org.w3c.dom.Element invoke(java.lang.String workflowName,
                           org.w3c.dom.Element message)
                           throws ODEServerException
invoke a pipeline.

Throws:
ODEServerException

isPredefinedWorkflow

boolean isPredefinedWorkflow(java.lang.String workflowName)
check if a workflow is predefined.


isCustomWorkflow

boolean isCustomWorkflow(java.lang.String workflowName)
check if a workflow is custom defined.


getWorkflow

AnyMap getWorkflow(java.lang.String workflowName)
                   throws java.io.IOException
get current workflow definition from ODE server.

Throws:
java.io.IOException

validateWorkflow

java.io.File validateWorkflow(java.lang.String workflowName,
                              AnyMap workflowDefinition)
                              throws ProcessingException
create deployment unit for given workflow definition and validate it.

Returns:
directory ready to deploy.
Throws:
ProcessingException - validation error.

deployWorkflowDir

javax.xml.namespace.QName deployWorkflowDir(java.lang.String workflowName,
                                            java.io.File deploymentDirectory)
                                            throws ProcessingException
deploy a deployment unit dir with one workflow to the server.

Throws:
ProcessingException

undeployWorkflow

void undeployWorkflow(java.lang.String workflowName)
                      throws ProcessingException
undeploy a workflow from the server.

Throws:
ProcessingException

deployWorkflow

void deployWorkflow(java.lang.String workflowName,
                    AnyMap workflowDefinition)
                    throws ProcessingException
deploy a single workflow to the server.

Throws:
ProcessingException

deployPredefinedWorkflows

java.util.Collection<java.lang.String> deployPredefinedWorkflows(java.lang.String pipelineDirName)
                                                                 throws ProcessingException,
                                                                        java.io.IOException
prepare a deployment unit dirrectory from a configuration directory with predefined workflows and deploy it to the server.

Throws:
ProcessingException
java.io.IOException

SMILA 1.0 API documentation