Table of Contents
Available as of Camel 2.13
The Simple Workflow component supports managing workflows from Amazon’s Simple Workflow service.
Prerequisites
You must have a valid Amazon Web Services developer account, and be signed up to use Amazon Simple Workflow. More information are available at Amazon Simple Workflow.
aws-swf://<workflow|activity>[?options]
You can append query options to the URI in the following format, ?options=value&option2=value&…
The AWS Simple Workflow component has no options.
The AWS Simple Workflow component supports 30 endpoint options which are listed below:
{% raw %}
| Name | Group | Default | Java Type | Description |
|---|---|---|---|---|
type | common |
| Required Activity or workflow | |
accessKey | common |
| Amazon AWS Access Key. | |
amazonSWClient | common |
| To use the given AmazonSimpleWorkflowClient as client | |
dataConverter | common |
| An instance of com.amazonaws.services.simpleworkflow.flow.DataConverter to use for serializing/deserializing the data. | |
domainName | common |
| The workflow domain to use. | |
eventName | common |
| The workflow or activity event name to use. | |
secretKey | common |
| Amazon AWS Secret Key. | |
version | common |
| The workflow or activity event version to use. | |
bridgeErrorHandler | consumer |
|
| Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. |
exceptionHandler | consumer (advanced) |
| To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | |
exchangePattern | consumer (advanced) |
| Sets the exchange pattern when the consumer creates an exchange. | |
clientConfigurationParameters | advanced |
| To configure the ClientConfiguration using the key/values from the Map. | |
startWorkflowOptionsParameters | advanced |
| To configure the StartWorkflowOptions using the key/values from the Map. | |
sWClientParameters | advanced |
| To configure the AmazonSimpleWorkflowClient using the key/values from the Map. | |
synchronous | advanced |
|
| Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |
activityList | activity |
| The list name to consume activities from. | |
activitySchedulingOptions | activity |
| Activity scheduling options | |
activityThreadPoolSize | activity |
|
| Maximum number of threads in work pool for activity. |
activityTypeExecutionOptions | activity |
| Activity execution options | |
activityTypeRegistrationOptions | activity |
| Activity registration options | |
childPolicy | workflow |
| The policy to use on child workflows when terminating a workflow. | |
executionStartToCloseTimeout | workflow |
|
| Set the execution start to close timeout. |
operation | workflow |
|
| Workflow operation |
signalName | workflow |
| The name of the signal to send to the workflow. | |
stateResultType | workflow |
| The type of the result when a workflow state is queried. | |
taskStartToCloseTimeout | workflow |
|
| Set the task start to close timeout. |
terminationDetails | workflow |
| Details for terminating a workflow. | |
terminationReason | workflow |
| The reason for terminating a workflow. | |
workflowList | workflow |
| The list name to consume workflows from. | |
workflowTypeRegistrationOptions | workflow |
| Workflow registration options |
{% endraw %}
Required SWF component options
You have to provide the amazonSWClient in the Registry or your accessKey and secretKey to access the Amazon’s Simple Workflow Service.
Table of Contents
A workflow producer allows interacting with a workflow. It can start a new workflow execution, query its state, send signals to a running workflow, or terminate and cancel it.
| Header | Type | Description |
|---|---|---|
|
| The operation to perform on the workflow. Supported operations are: SIGNAL, CANCEL, TERMINATE, GET_STATE, START, DESCRIBE, GET_HISTORY. |
|
| A workflow ID to use. |
|
| A worfklow run ID to use. |
|
| The type of the result when a workflow state is queried. |
|
| The workflow or activity event name to use. |
|
| The workflow or activity event version to use. |
|
| The reason for terminating a workflow. |
|
| Details for terminating a workflow. |
|
| The policy to use on child workflows when terminating a workflow. |
| Header | Type | Description |
|---|---|---|
|
| The worfklow ID used or newly generated. |
|
| The worfklow run ID used or generated. |
A workflow consumer represents the workflow logic. When it is started, it will start polling workflow decision tasks and process them. In addition to processing decision tasks, a workflow consumer route, will also receive signals (send from a workflow producer) or state queries. The primary purpose of a workflow consumer is to schedule activity tasks for execution using activity producers. Actually activity tasks can be scheduled only from a thread started by a workflow consumer.
| Header | Type | Description |
|---|---|---|
|
| Indicates what type is the current event: CamelSWFActionExecute, CamelSWFSignalReceivedAction or CamelSWFGetStateAction. |
|
| Indicates whether the current decision task is a replay or not. |
|
| The time of the start event for this decision task. |
An activity producer allows scheduling activity tasks. An activity producer can be used only from a thread started by a workflow consumer ie, it can process synchronous exchanges started by a workflow consumer.
| Header | Type | Description |
|---|---|---|
|
| The activity name to schedule. |
|
| The activity version to schedule. |
| Header | Type | Description |
|---|---|---|
|
| The task token that is required to report task completion for manually completed tasks. |
If you need more control over the AmazonSimpleWorkflowClient instance configuration you can create your own instance and refer to it from the URI:
The #client refers to a AmazonSimpleWorkflowClient in the
Registry.
For example if your Camel Application is running behind a firewall:
AWSCredentials awsCredentials = new BasicAWSCredentials("myAccessKey", "mySecretKey");
ClientConfiguration clientConfiguration = new ClientConfiguration();
clientConfiguration.setProxyHost("http://myProxyHost");
clientConfiguration.setProxyPort(8080);
AmazonSimpleWorkflowClient client = new AmazonSimpleWorkflowClient(awsCredentials, clientConfiguration);
registry.bind("client", client);Maven users will need to add the following dependency to their pom.xml.
pom.xml
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-aws</artifactId>
<version>${camel-version}</version>
</dependency>where ${camel-version} must be replaced by the actual version of Camel
(2.13 or higher).