This is an automated email from the ASF dual-hosted git repository. acosentino pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/camel.git
commit 1bb5e46b350513836da5a817c572ca307681254d Author: Andrea Cosentino <anco...@gmail.com> AuthorDate: Thu Feb 25 18:31:53 2021 +0100 CAMEL-16115 - Remove Camel-AWS-* components - AWS-SWF --- bom/camel-bom/pom.xml | 5 - .../org/apache/camel/catalog/components.properties | 1 - .../apache/camel/catalog/components/aws-swf.json | 90 ------- .../org/apache/camel/catalog/docs.properties | 1 - .../camel/catalog/docs/aws-swf-component.adoc | 288 -------------------- .../builder/endpoint/EndpointBuilderFactory.java | 3 +- docs/components/modules/ROOT/nav.adoc | 1 - .../modules/ROOT/pages/aws-swf-component.adoc | 290 --------------------- 8 files changed, 1 insertion(+), 678 deletions(-) diff --git a/bom/camel-bom/pom.xml b/bom/camel-bom/pom.xml index e27230c..c547ea6 100644 --- a/bom/camel-bom/pom.xml +++ b/bom/camel-bom/pom.xml @@ -138,11 +138,6 @@ </dependency> <dependency> <groupId>org.apache.camel</groupId> - <artifactId>camel-aws-swf</artifactId> - <version>${project.version}</version> - </dependency> - <dependency> - <groupId>org.apache.camel</groupId> <artifactId>camel-aws-xray</artifactId> <version>${project.version}</version> </dependency> diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components.properties b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components.properties index 507c780..7043ee2 100644 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components.properties +++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components.properties @@ -18,7 +18,6 @@ atomix-queue atomix-set atomix-value avro -aws-swf aws2-athena aws2-cw aws2-ddb diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws-swf.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws-swf.json deleted file mode 100644 index 80b077c..0000000 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/aws-swf.json +++ /dev/null @@ -1,90 +0,0 @@ -{ - "component": { - "kind": "component", - "name": "aws-swf", - "title": "AWS Simple Workflow (SWF)", - "description": "Manage workflows in the AWS Simple Workflow service.", - "deprecated": true, - "deprecatedSince": "3.8.0", - "firstVersion": "2.13.0", - "label": "cloud,workflow", - "javaType": "org.apache.camel.component.aws.swf.SWFComponent", - "supportLevel": "Stable", - "groupId": "org.apache.camel", - "artifactId": "camel-aws-swf", - "version": "3.9.0-SNAPSHOT", - "scheme": "aws-swf", - "extendsScheme": "", - "syntax": "aws-swf:type", - "async": false, - "api": false, - "consumerOnly": false, - "producerOnly": false, - "lenientProperties": false - }, - "componentProperties": { - "amazonSWClient": { "kind": "property", "displayName": "Amazon SWClient", "group": "common", "label": "", "required": false, "type": "object", "javaType": "com.amazonaws.services.simpleworkflow.AmazonSimpleWorkflow", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "To use the given AmazonSimpleWorkflowClient as client" }, - "configuration": { "kind": "property", "displayName": "Configuration", "group": "common", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.aws.swf.SWFConfiguration", "deprecated": false, "autowired": false, "secret": false, "description": "The component configuration" }, - "dataConverter": { "kind": "property", "displayName": "Data Converter", "group": "common", "label": "", "required": false, "type": "object", "javaType": "com.amazonaws.services.simpleworkflow.flow.DataConverter", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "An instance of com.amazonaws.services.simpleworkflow.flow.DataConverter to use for se [...] - "domainName": { "kind": "property", "displayName": "Domain Name", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "The workflow domain to use." }, - "eventName": { "kind": "property", "displayName": "Event Name", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "The workflow or activity event name to use." }, - "region": { "kind": "property", "displayName": "Region", "group": "common", "label": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "Amazon AWS Region. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1) [...] - "version": { "kind": "property", "displayName": "Version", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "The workflow or activity event version to use." }, - "bridgeErrorHandler": { "kind": "property", "displayName": "Bridge Error Handler", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 me [...] - "lazyStartProducer": { "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during star [...] - "activityList": { "kind": "property", "displayName": "Activity List", "group": "activity", "label": "consumer,activity", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "The list name to consume activities from." }, - "activitySchedulingOptions": { "kind": "property", "displayName": "Activity Scheduling Options", "group": "activity", "label": "producer,activity", "required": false, "type": "object", "javaType": "com.amazonaws.services.simpleworkflow.flow.ActivitySchedulingOptions", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "Activity scheduling options" }, - "activityThreadPoolSize": { "kind": "property", "displayName": "Activity Thread Pool Size", "group": "activity", "label": "consumer,activity", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 100, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "Maximum number of threads in work pool for activity." }, - "activityTypeExecutionOptions": { "kind": "property", "displayName": "Activity Type Execution Options", "group": "activity", "label": "consumer,activity", "required": false, "type": "object", "javaType": "com.amazonaws.services.simpleworkflow.flow.worker.ActivityTypeExecutionOptions", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "Activity exe [...] - "activityTypeRegistrationOptions": { "kind": "property", "displayName": "Activity Type Registration Options", "group": "activity", "label": "consumer,activity", "required": false, "type": "object", "javaType": "com.amazonaws.services.simpleworkflow.flow.worker.ActivityTypeRegistrationOptions", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "Act [...] - "autowiredEnabled": { "kind": "property", "displayName": "Autowired Enabled", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": true, "description": "Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which t [...] - "clientConfigurationParameters": { "kind": "property", "displayName": "Client Configuration Parameters", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>", "prefix": "clientConfiguration.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "descriptio [...] - "startWorkflowOptionsParameters": { "kind": "property", "displayName": "Start Workflow Options Parameters", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>", "prefix": "startWorkflowOptions.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "descri [...] - "sWClientParameters": { "kind": "property", "displayName": "SWClient Parameters", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>", "prefix": "sWClient.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "To configure the AmazonSimple [...] - "accessKey": { "kind": "property", "displayName": "Access Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "Amazon AWS Access Key." }, - "secretKey": { "kind": "property", "displayName": "Secret Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "Amazon AWS Secret Key." }, - "childPolicy": { "kind": "property", "displayName": "Child Policy", "group": "workflow", "label": "producer,workflow", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "The policy to use on child workflows when terminating a workflow." }, - "executionStartToCloseTimeout": { "kind": "property", "displayName": "Execution Start To Close Timeout", "group": "workflow", "label": "producer,workflow", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "3600", "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "Set the execution start to close timeout." }, - "operation": { "kind": "property", "displayName": "Operation", "group": "workflow", "label": "producer,workflow", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "SIGNAL", "CANCEL", "TERMINATE", "GET_STATE", "START", "DESCRIBE", "GET_HISTORY" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "START", "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description [...] - "signalName": { "kind": "property", "displayName": "Signal Name", "group": "workflow", "label": "producer,workflow", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "The name of the signal to send to the workflow." }, - "stateResultType": { "kind": "property", "displayName": "State Result Type", "group": "workflow", "label": "producer,workflow", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "The type of the result when a workflow state is queried." }, - "taskStartToCloseTimeout": { "kind": "property", "displayName": "Task Start To Close Timeout", "group": "workflow", "label": "producer,workflow", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "600", "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "Set the task start to close timeout." }, - "terminationDetails": { "kind": "property", "displayName": "Termination Details", "group": "workflow", "label": "producer,workflow", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "Details for terminating a workflow." }, - "terminationReason": { "kind": "property", "displayName": "Termination Reason", "group": "workflow", "label": "producer,workflow", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "The reason for terminating a workflow." }, - "workflowList": { "kind": "property", "displayName": "Workflow List", "group": "workflow", "label": "consumer,workflow", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "The list name to consume workflows from." }, - "workflowTypeRegistrationOptions": { "kind": "property", "displayName": "Workflow Type Registration Options", "group": "workflow", "label": "consumer,workflow", "required": false, "type": "object", "javaType": "com.amazonaws.services.simpleworkflow.flow.WorkflowTypeRegistrationOptions", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "Workflow r [...] - }, - "properties": { - "type": { "kind": "path", "displayName": "Type", "group": "common", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "enum": [ "activity", "workflow" ], "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "Activity or workflow" }, - "amazonSWClient": { "kind": "parameter", "displayName": "Amazon SWClient", "group": "common", "label": "", "required": false, "type": "object", "javaType": "com.amazonaws.services.simpleworkflow.AmazonSimpleWorkflow", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "To use the given AmazonSimpleWorkflowClient as client" }, - "dataConverter": { "kind": "parameter", "displayName": "Data Converter", "group": "common", "label": "", "required": false, "type": "object", "javaType": "com.amazonaws.services.simpleworkflow.flow.DataConverter", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "An instance of com.amazonaws.services.simpleworkflow.flow.DataConverter to use for s [...] - "domainName": { "kind": "parameter", "displayName": "Domain Name", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "The workflow domain to use." }, - "eventName": { "kind": "parameter", "displayName": "Event Name", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "The workflow or activity event name to use." }, - "region": { "kind": "parameter", "displayName": "Region", "group": "common", "label": "common", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "Amazon AWS Region. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1 [...] - "version": { "kind": "parameter", "displayName": "Version", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "The workflow or activity event version to use." }, - "bridgeErrorHandler": { "kind": "parameter", "displayName": "Bridge Error Handler", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "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 m [...] - "exceptionHandler": { "kind": "parameter", "displayName": "Exception Handler", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.", "deprecated": false, "autowired": false, "secret": false, "description": "To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the con [...] - "exchangePattern": { "kind": "parameter", "displayName": "Exchange Pattern", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut", "InOptionalOut" ], "deprecated": false, "autowired": false, "secret": false, "description": "Sets the exchange pattern when the consumer creates an exchange." }, - "lazyStartProducer": { "kind": "parameter", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during sta [...] - "activityList": { "kind": "parameter", "displayName": "Activity List", "group": "activity", "label": "consumer,activity", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "The list name to consume activities from." }, - "activitySchedulingOptions": { "kind": "parameter", "displayName": "Activity Scheduling Options", "group": "activity", "label": "producer,activity", "required": false, "type": "object", "javaType": "com.amazonaws.services.simpleworkflow.flow.ActivitySchedulingOptions", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "Activity scheduling options" }, - "activityThreadPoolSize": { "kind": "parameter", "displayName": "Activity Thread Pool Size", "group": "activity", "label": "consumer,activity", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 100, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "Maximum number of threads in work pool for activity." }, - "activityTypeExecutionOptions": { "kind": "parameter", "displayName": "Activity Type Execution Options", "group": "activity", "label": "consumer,activity", "required": false, "type": "object", "javaType": "com.amazonaws.services.simpleworkflow.flow.worker.ActivityTypeExecutionOptions", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "Activity ex [...] - "activityTypeRegistrationOptions": { "kind": "parameter", "displayName": "Activity Type Registration Options", "group": "activity", "label": "consumer,activity", "required": false, "type": "object", "javaType": "com.amazonaws.services.simpleworkflow.flow.worker.ActivityTypeRegistrationOptions", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "Ac [...] - "clientConfigurationParameters": { "kind": "parameter", "displayName": "Client Configuration Parameters", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>", "prefix": "clientConfiguration.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "descripti [...] - "startWorkflowOptionsParameters": { "kind": "parameter", "displayName": "Start Workflow Options Parameters", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>", "prefix": "startWorkflowOptions.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "descr [...] - "sWClientParameters": { "kind": "parameter", "displayName": "SWClient Parameters", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>", "prefix": "sWClient.", "multiValue": true, "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "To configure the AmazonSimpl [...] - "accessKey": { "kind": "parameter", "displayName": "Access Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "Amazon AWS Access Key." }, - "secretKey": { "kind": "parameter", "displayName": "Secret Key", "group": "security", "label": "security", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": true, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "Amazon AWS Secret Key." }, - "childPolicy": { "kind": "parameter", "displayName": "Child Policy", "group": "workflow", "label": "producer,workflow", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "The policy to use on child workflows when terminating a workflow." }, - "executionStartToCloseTimeout": { "kind": "parameter", "displayName": "Execution Start To Close Timeout", "group": "workflow", "label": "producer,workflow", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "3600", "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "Set the execution start to close timeout." }, - "operation": { "kind": "parameter", "displayName": "Operation", "group": "workflow", "label": "producer,workflow", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "SIGNAL", "CANCEL", "TERMINATE", "GET_STATE", "START", "DESCRIBE", "GET_HISTORY" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "START", "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "descriptio [...] - "signalName": { "kind": "parameter", "displayName": "Signal Name", "group": "workflow", "label": "producer,workflow", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "The name of the signal to send to the workflow." }, - "stateResultType": { "kind": "parameter", "displayName": "State Result Type", "group": "workflow", "label": "producer,workflow", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "The type of the result when a workflow state is queried." }, - "taskStartToCloseTimeout": { "kind": "parameter", "displayName": "Task Start To Close Timeout", "group": "workflow", "label": "producer,workflow", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "600", "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "Set the task start to close timeout." }, - "terminationDetails": { "kind": "parameter", "displayName": "Termination Details", "group": "workflow", "label": "producer,workflow", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "Details for terminating a workflow." }, - "terminationReason": { "kind": "parameter", "displayName": "Termination Reason", "group": "workflow", "label": "producer,workflow", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "The reason for terminating a workflow." }, - "workflowList": { "kind": "parameter", "displayName": "Workflow List", "group": "workflow", "label": "consumer,workflow", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "The list name to consume workflows from." }, - "workflowTypeRegistrationOptions": { "kind": "parameter", "displayName": "Workflow Type Registration Options", "group": "workflow", "label": "consumer,workflow", "required": false, "type": "object", "javaType": "com.amazonaws.services.simpleworkflow.flow.WorkflowTypeRegistrationOptions", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.aws.swf.SWFConfiguration", "configurationField": "configuration", "description": "Workflow [...] - } -} diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs.properties b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs.properties index a27ea4f..1792d85 100644 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs.properties +++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs.properties @@ -22,7 +22,6 @@ atomix-value-component attachments avro-component avro-dataformat -aws-swf-component aws-xray aws2-athena-component aws2-cw-component diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws-swf-component.adoc b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws-swf-component.adoc deleted file mode 100644 index 635f49c..0000000 --- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/aws-swf-component.adoc +++ /dev/null @@ -1,288 +0,0 @@ -[[aws-swf-component]] -= AWS Simple Workflow (SWF) Component (deprecated) -:docTitle: AWS Simple Workflow (SWF) -:artifactId: camel-aws-swf -:description: Manage workflows in the AWS Simple Workflow service. -:since: 2.13 -:supportLevel: Stable-deprecated -:deprecated: *deprecated* -:component-header: Both producer and consumer are supported -include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/aws-swf.adoc[opts=optional] -//Manually maintained attributes -:group: AWS - -*Since Camel {since}* - -*{component-header}* - -The Simple Workflow component supports managing workflows from -https://aws.amazon.com/swf/[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 https://aws.amazon.com/swf/[Amazon Simple Workflow]. - -== URI Format - -[source,java] ---------------------------------------- -aws-swf://<workflow|activity>[?options] ---------------------------------------- - -You can append query options to the URI in the following format, -?options=value&option2=value&... - -== URI Options - - -// component options: START -The AWS Simple Workflow (SWF) component supports 30 options, which are listed below. - - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *amazonSWClient* (common) | To use the given AmazonSimpleWorkflowClient as client | | AmazonSimpleWorkflow -| *configuration* (common) | The component configuration | | SWFConfiguration -| *dataConverter* (common) | An instance of com.amazonaws.services.simpleworkflow.flow.DataConverter to use for serializing/deserializing the data. | | DataConverter -| *domainName* (common) | The workflow domain to use. | | String -| *eventName* (common) | The workflow or activity event name to use. | | String -| *region* (common) | Amazon AWS Region. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1) You'll need to use the name Regions.EU_WEST_1.name() | | String -| *version* (common) | The workflow or activity event version to use. | | String -| *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 or ERROR level and ignored. | false | boolean -| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and [...] -| *activityList* (activity) | The list name to consume activities from. | | String -| *activitySchedulingOptions* (activity) | Activity scheduling options | | ActivitySchedulingOptions -| *activityThreadPoolSize* (activity) | Maximum number of threads in work pool for activity. | 100 | int -| *activityTypeExecutionOptions* (activity) | Activity execution options | | ActivityTypeExecutionOptions -| *activityTypeRegistration{zwsp}Options* (activity) | Activity registration options | | ActivityTypeRegistrationOptions -| *autowiredEnabled* (advanced) | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | boolean -| *clientConfigurationParameters* (advanced) | To configure the ClientConfiguration using the key/values from the Map. | | Map -| *startWorkflowOptionsParameters* (advanced) | To configure the StartWorkflowOptions using the key/values from the Map. | | Map -| *sWClientParameters* (advanced) | To configure the AmazonSimpleWorkflowClient using the key/values from the Map. | | Map -| *accessKey* (security) | Amazon AWS Access Key. | | String -| *secretKey* (security) | Amazon AWS Secret Key. | | String -| *childPolicy* (workflow) | The policy to use on child workflows when terminating a workflow. | | String -| *executionStartToCloseTimeout* (workflow) | Set the execution start to close timeout. | 3600 | String -| *operation* (workflow) | Workflow operation. There are 7 enums and the value can be one of: SIGNAL, CANCEL, TERMINATE, GET_STATE, START, DESCRIBE, GET_HISTORY | START | String -| *signalName* (workflow) | The name of the signal to send to the workflow. | | String -| *stateResultType* (workflow) | The type of the result when a workflow state is queried. | | String -| *taskStartToCloseTimeout* (workflow) | Set the task start to close timeout. | 600 | String -| *terminationDetails* (workflow) | Details for terminating a workflow. | | String -| *terminationReason* (workflow) | The reason for terminating a workflow. | | String -| *workflowList* (workflow) | The list name to consume workflows from. | | String -| *workflowTypeRegistration{zwsp}Options* (workflow) | Workflow registration options | | WorkflowTypeRegistrationOptions -|=== -// component options: END - - - - -// endpoint options: START -The AWS Simple Workflow (SWF) endpoint is configured using URI syntax: - ----- -aws-swf:type ----- - -with the following path and query parameters: - -=== Path Parameters (1 parameters): - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *type* | *Required* Activity or workflow. There are 2 enums and the value can be one of: activity, workflow | | String -|=== - - -=== Query Parameters (30 parameters): - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *amazonSWClient* (common) | To use the given AmazonSimpleWorkflowClient as client | | AmazonSimpleWorkflow -| *dataConverter* (common) | An instance of com.amazonaws.services.simpleworkflow.flow.DataConverter to use for serializing/deserializing the data. | | DataConverter -| *domainName* (common) | The workflow domain to use. | | String -| *eventName* (common) | The workflow or activity event name to use. | | String -| *region* (common) | Amazon AWS Region. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1) You'll need to use the name Regions.EU_WEST_1.name() | | String -| *version* (common) | The workflow or activity event version to use. | | String -| *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 or ERROR level and ignored. | false | boolean -| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. There are 3 enums and the value can be one of: InOnly, InOut, InOptionalOut | | ExchangePattern -| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and [...] -| *activityList* (activity) | The list name to consume activities from. | | String -| *activitySchedulingOptions* (activity) | Activity scheduling options | | ActivitySchedulingOptions -| *activityThreadPoolSize* (activity) | Maximum number of threads in work pool for activity. | 100 | int -| *activityTypeExecutionOptions* (activity) | Activity execution options | | ActivityTypeExecutionOptions -| *activityTypeRegistration{zwsp}Options* (activity) | Activity registration options | | ActivityTypeRegistrationOptions -| *clientConfigurationParameters* (advanced) | To configure the ClientConfiguration using the key/values from the Map. | | Map -| *startWorkflowOptionsParameters* (advanced) | To configure the StartWorkflowOptions using the key/values from the Map. | | Map -| *sWClientParameters* (advanced) | To configure the AmazonSimpleWorkflowClient using the key/values from the Map. | | Map -| *accessKey* (security) | Amazon AWS Access Key. | | String -| *secretKey* (security) | Amazon AWS Secret Key. | | String -| *childPolicy* (workflow) | The policy to use on child workflows when terminating a workflow. | | String -| *executionStartToCloseTimeout* (workflow) | Set the execution start to close timeout. | 3600 | String -| *operation* (workflow) | Workflow operation. There are 7 enums and the value can be one of: SIGNAL, CANCEL, TERMINATE, GET_STATE, START, DESCRIBE, GET_HISTORY | START | String -| *signalName* (workflow) | The name of the signal to send to the workflow. | | String -| *stateResultType* (workflow) | The type of the result when a workflow state is queried. | | String -| *taskStartToCloseTimeout* (workflow) | Set the task start to close timeout. | 600 | String -| *terminationDetails* (workflow) | Details for terminating a workflow. | | String -| *terminationReason* (workflow) | The reason for terminating a workflow. | | String -| *workflowList* (workflow) | The list name to consume workflows from. | | String -| *workflowTypeRegistration{zwsp}Options* (workflow) | Workflow registration options | | WorkflowTypeRegistrationOptions -|=== -// endpoint options: END - - - - -Required SWF component options - -You have to provide the amazonSWClient in the -Registry or your accessKey and secretKey to access -the https://aws.amazon.com/swf[Amazon SWF]. - -== Usage - -=== Message headers evaluated by the SWF Workflow Producer - -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. - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelSWFOperation` |`String` |The operation to perform on the workflow. Supported operations are: + - SIGNAL, CANCEL, TERMINATE, GET_STATE, START, DESCRIBE, GET_HISTORY. - -|`CamelSWFWorkflowId` |`String` |A workflow ID to use. - -|`CamelAwsDdbKeyCamelSWFRunId` |`String` |A worfklow run ID to use. - -|`CamelSWFStateResultType` |`String` |The type of the result when a workflow state is queried. - -|`CamelSWFEventName` |`String` |The workflow or activity event name to use. - -|`CamelSWFVersion` |`String` |The workflow or activity event version to use. - -|`CamelSWFReason` |`String` |The reason for terminating a workflow. - -|`CamelSWFDetails` |`String` |Details for terminating a workflow. - -|`CamelSWFChildPolicy` |`String` |The policy to use on child workflows when terminating a workflow. -|======================================================================= - -=== Message headers set by the SWF Workflow Producer - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelSWFWorkflowId` |`String` |The worfklow ID used or newly generated. - -|`CamelAwsDdbKeyCamelSWFRunId` |`String` |The worfklow run ID used or generated. -|======================================================================= - -=== Message headers set by the SWF Workflow Consumer - -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. - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelSWFAction` |`String` |Indicates what type is the current event: CamelSWFActionExecute, -CamelSWFSignalReceivedAction or CamelSWFGetStateAction. - -|`CamelSWFWorkflowReplaying` |`boolean` |Indicates whether the current decision task is a replay or not. - -|`CamelSWFWorkflowStartTime` |`long` |The time of the start event for this decision task. -|======================================================================= - -=== Message headers set by the SWF Activity Producer - -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. - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelSWFEventName` |`String` |The activity name to schedule. - -|`CamelSWFVersion` |`String` |The activity version to schedule. -|======================================================================= - -=== Message headers set by the SWF Activity Consumer - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelSWFTaskToken` |`String` |The task token that is required to report task completion for manually -completed tasks. -|======================================================================= - -=== Advanced amazonSWClient configuration - -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: - -[source,java] --------------------------------------------------------------------------------------------------------- -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); --------------------------------------------------------------------------------------------------------- - -== Automatic detection of AmazonSimpleWorkflow client in registry - -The component is capable of detecting the presence of an AmazonSimpleWorkflow bean into the registry. -If it's the only instance of that type it will be used as client and you won't have to define it as uri parameter. -This may be really useful for smarter configuration of the endpoint. - -== Dependencies - -Maven users will need to add the following dependency to their pom.xml. - -*pom.xml* - -[source,xml] ---------------------------------------- -<dependency> - <groupId>org.apache.camel</groupId> - <artifactId>camel-aws-swf</artifactId> - <version>${camel-version}</version> -</dependency> ---------------------------------------- - -where `$\{camel-version}` must be replaced by the actual version of Camel. - - -include::camel-spring-boot::page$aws-swf-starter.adoc[] diff --git a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilderFactory.java b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilderFactory.java index 789d80f..a2c3d4a 100644 --- a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilderFactory.java +++ b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/EndpointBuilderFactory.java @@ -281,7 +281,6 @@ public interface EndpointBuilderFactory org.apache.camel.builder.endpoint.dsl.RobotFrameworkEndpointBuilderFactory.RobotFrameworkBuilders, org.apache.camel.builder.endpoint.dsl.RssEndpointBuilderFactory.RssBuilders, org.apache.camel.builder.endpoint.dsl.STS2EndpointBuilderFactory.STS2Builders, - org.apache.camel.builder.endpoint.dsl.SWFEndpointBuilderFactory.SWFBuilders, org.apache.camel.builder.endpoint.dsl.SagaEndpointBuilderFactory.SagaBuilders, org.apache.camel.builder.endpoint.dsl.SalesforceEndpointBuilderFactory.SalesforceBuilders, org.apache.camel.builder.endpoint.dsl.SchedulerEndpointBuilderFactory.SchedulerBuilders, @@ -375,4 +374,4 @@ public interface EndpointBuilderFactory }; } } -//CHECKSTYLE:ON \ No newline at end of file +//CHECKSTYLE:ON diff --git a/docs/components/modules/ROOT/nav.adoc b/docs/components/modules/ROOT/nav.adoc index fd3c02f..f4b7717 100644 --- a/docs/components/modules/ROOT/nav.adoc +++ b/docs/components/modules/ROOT/nav.adoc @@ -21,7 +21,6 @@ ** xref:atomix-set-component.adoc[Atomix Set] ** xref:atomix-value-component.adoc[Atomix Value] ** xref:avro-component.adoc[Avro RPC] -*** xref:aws-swf-component.adoc[AWS Simple Workflow (SWF)] ** xref:aws2-summary.adoc[AWS 2] *** xref:aws2-athena-component.adoc[AWS 2 Athena] *** xref:aws2-cw-component.adoc[AWS 2 CloudWatch] diff --git a/docs/components/modules/ROOT/pages/aws-swf-component.adoc b/docs/components/modules/ROOT/pages/aws-swf-component.adoc deleted file mode 100644 index b4d6703..0000000 --- a/docs/components/modules/ROOT/pages/aws-swf-component.adoc +++ /dev/null @@ -1,290 +0,0 @@ -[[aws-swf-component]] -= AWS Simple Workflow (SWF) Component (deprecated) -//THIS FILE IS COPIED: EDIT THE SOURCE FILE: -:page-source: components/camel-aws-swf/src/main/docs/aws-swf-component.adoc -:docTitle: AWS Simple Workflow (SWF) -:artifactId: camel-aws-swf -:description: Manage workflows in the AWS Simple Workflow service. -:since: 2.13 -:supportLevel: Stable-deprecated -:deprecated: *deprecated* -:component-header: Both producer and consumer are supported -include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/aws-swf.adoc[opts=optional] -//Manually maintained attributes -:group: AWS - -*Since Camel {since}* - -*{component-header}* - -The Simple Workflow component supports managing workflows from -https://aws.amazon.com/swf/[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 https://aws.amazon.com/swf/[Amazon Simple Workflow]. - -== URI Format - -[source,java] ---------------------------------------- -aws-swf://<workflow|activity>[?options] ---------------------------------------- - -You can append query options to the URI in the following format, -?options=value&option2=value&... - -== URI Options - - -// component options: START -The AWS Simple Workflow (SWF) component supports 30 options, which are listed below. - - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *amazonSWClient* (common) | To use the given AmazonSimpleWorkflowClient as client | | AmazonSimpleWorkflow -| *configuration* (common) | The component configuration | | SWFConfiguration -| *dataConverter* (common) | An instance of com.amazonaws.services.simpleworkflow.flow.DataConverter to use for serializing/deserializing the data. | | DataConverter -| *domainName* (common) | The workflow domain to use. | | String -| *eventName* (common) | The workflow or activity event name to use. | | String -| *region* (common) | Amazon AWS Region. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1) You'll need to use the name Regions.EU_WEST_1.name() | | String -| *version* (common) | The workflow or activity event version to use. | | String -| *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 or ERROR level and ignored. | false | boolean -| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and [...] -| *activityList* (activity) | The list name to consume activities from. | | String -| *activitySchedulingOptions* (activity) | Activity scheduling options | | ActivitySchedulingOptions -| *activityThreadPoolSize* (activity) | Maximum number of threads in work pool for activity. | 100 | int -| *activityTypeExecutionOptions* (activity) | Activity execution options | | ActivityTypeExecutionOptions -| *activityTypeRegistration{zwsp}Options* (activity) | Activity registration options | | ActivityTypeRegistrationOptions -| *autowiredEnabled* (advanced) | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | boolean -| *clientConfigurationParameters* (advanced) | To configure the ClientConfiguration using the key/values from the Map. | | Map -| *startWorkflowOptionsParameters* (advanced) | To configure the StartWorkflowOptions using the key/values from the Map. | | Map -| *sWClientParameters* (advanced) | To configure the AmazonSimpleWorkflowClient using the key/values from the Map. | | Map -| *accessKey* (security) | Amazon AWS Access Key. | | String -| *secretKey* (security) | Amazon AWS Secret Key. | | String -| *childPolicy* (workflow) | The policy to use on child workflows when terminating a workflow. | | String -| *executionStartToCloseTimeout* (workflow) | Set the execution start to close timeout. | 3600 | String -| *operation* (workflow) | Workflow operation. There are 7 enums and the value can be one of: SIGNAL, CANCEL, TERMINATE, GET_STATE, START, DESCRIBE, GET_HISTORY | START | String -| *signalName* (workflow) | The name of the signal to send to the workflow. | | String -| *stateResultType* (workflow) | The type of the result when a workflow state is queried. | | String -| *taskStartToCloseTimeout* (workflow) | Set the task start to close timeout. | 600 | String -| *terminationDetails* (workflow) | Details for terminating a workflow. | | String -| *terminationReason* (workflow) | The reason for terminating a workflow. | | String -| *workflowList* (workflow) | The list name to consume workflows from. | | String -| *workflowTypeRegistration{zwsp}Options* (workflow) | Workflow registration options | | WorkflowTypeRegistrationOptions -|=== -// component options: END - - - - -// endpoint options: START -The AWS Simple Workflow (SWF) endpoint is configured using URI syntax: - ----- -aws-swf:type ----- - -with the following path and query parameters: - -=== Path Parameters (1 parameters): - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *type* | *Required* Activity or workflow. There are 2 enums and the value can be one of: activity, workflow | | String -|=== - - -=== Query Parameters (30 parameters): - - -[width="100%",cols="2,5,^1,2",options="header"] -|=== -| Name | Description | Default | Type -| *amazonSWClient* (common) | To use the given AmazonSimpleWorkflowClient as client | | AmazonSimpleWorkflow -| *dataConverter* (common) | An instance of com.amazonaws.services.simpleworkflow.flow.DataConverter to use for serializing/deserializing the data. | | DataConverter -| *domainName* (common) | The workflow domain to use. | | String -| *eventName* (common) | The workflow or activity event name to use. | | String -| *region* (common) | Amazon AWS Region. When using this parameter, the configuration will expect the capitalized name of the region (for example AP_EAST_1) You'll need to use the name Regions.EU_WEST_1.name() | | String -| *version* (common) | The workflow or activity event version to use. | | String -| *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 or ERROR level and ignored. | false | boolean -| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. There are 3 enums and the value can be one of: InOnly, InOut, InOptionalOut | | ExchangePattern -| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and [...] -| *activityList* (activity) | The list name to consume activities from. | | String -| *activitySchedulingOptions* (activity) | Activity scheduling options | | ActivitySchedulingOptions -| *activityThreadPoolSize* (activity) | Maximum number of threads in work pool for activity. | 100 | int -| *activityTypeExecutionOptions* (activity) | Activity execution options | | ActivityTypeExecutionOptions -| *activityTypeRegistration{zwsp}Options* (activity) | Activity registration options | | ActivityTypeRegistrationOptions -| *clientConfigurationParameters* (advanced) | To configure the ClientConfiguration using the key/values from the Map. | | Map -| *startWorkflowOptionsParameters* (advanced) | To configure the StartWorkflowOptions using the key/values from the Map. | | Map -| *sWClientParameters* (advanced) | To configure the AmazonSimpleWorkflowClient using the key/values from the Map. | | Map -| *accessKey* (security) | Amazon AWS Access Key. | | String -| *secretKey* (security) | Amazon AWS Secret Key. | | String -| *childPolicy* (workflow) | The policy to use on child workflows when terminating a workflow. | | String -| *executionStartToCloseTimeout* (workflow) | Set the execution start to close timeout. | 3600 | String -| *operation* (workflow) | Workflow operation. There are 7 enums and the value can be one of: SIGNAL, CANCEL, TERMINATE, GET_STATE, START, DESCRIBE, GET_HISTORY | START | String -| *signalName* (workflow) | The name of the signal to send to the workflow. | | String -| *stateResultType* (workflow) | The type of the result when a workflow state is queried. | | String -| *taskStartToCloseTimeout* (workflow) | Set the task start to close timeout. | 600 | String -| *terminationDetails* (workflow) | Details for terminating a workflow. | | String -| *terminationReason* (workflow) | The reason for terminating a workflow. | | String -| *workflowList* (workflow) | The list name to consume workflows from. | | String -| *workflowTypeRegistration{zwsp}Options* (workflow) | Workflow registration options | | WorkflowTypeRegistrationOptions -|=== -// endpoint options: END - - - - -Required SWF component options - -You have to provide the amazonSWClient in the -Registry or your accessKey and secretKey to access -the https://aws.amazon.com/swf[Amazon SWF]. - -== Usage - -=== Message headers evaluated by the SWF Workflow Producer - -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. - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelSWFOperation` |`String` |The operation to perform on the workflow. Supported operations are: + - SIGNAL, CANCEL, TERMINATE, GET_STATE, START, DESCRIBE, GET_HISTORY. - -|`CamelSWFWorkflowId` |`String` |A workflow ID to use. - -|`CamelAwsDdbKeyCamelSWFRunId` |`String` |A worfklow run ID to use. - -|`CamelSWFStateResultType` |`String` |The type of the result when a workflow state is queried. - -|`CamelSWFEventName` |`String` |The workflow or activity event name to use. - -|`CamelSWFVersion` |`String` |The workflow or activity event version to use. - -|`CamelSWFReason` |`String` |The reason for terminating a workflow. - -|`CamelSWFDetails` |`String` |Details for terminating a workflow. - -|`CamelSWFChildPolicy` |`String` |The policy to use on child workflows when terminating a workflow. -|======================================================================= - -=== Message headers set by the SWF Workflow Producer - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelSWFWorkflowId` |`String` |The worfklow ID used or newly generated. - -|`CamelAwsDdbKeyCamelSWFRunId` |`String` |The worfklow run ID used or generated. -|======================================================================= - -=== Message headers set by the SWF Workflow Consumer - -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. - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelSWFAction` |`String` |Indicates what type is the current event: CamelSWFActionExecute, -CamelSWFSignalReceivedAction or CamelSWFGetStateAction. - -|`CamelSWFWorkflowReplaying` |`boolean` |Indicates whether the current decision task is a replay or not. - -|`CamelSWFWorkflowStartTime` |`long` |The time of the start event for this decision task. -|======================================================================= - -=== Message headers set by the SWF Activity Producer - -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. - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelSWFEventName` |`String` |The activity name to schedule. - -|`CamelSWFVersion` |`String` |The activity version to schedule. -|======================================================================= - -=== Message headers set by the SWF Activity Consumer - -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Header |Type |Description - -|`CamelSWFTaskToken` |`String` |The task token that is required to report task completion for manually -completed tasks. -|======================================================================= - -=== Advanced amazonSWClient configuration - -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: - -[source,java] --------------------------------------------------------------------------------------------------------- -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); --------------------------------------------------------------------------------------------------------- - -== Automatic detection of AmazonSimpleWorkflow client in registry - -The component is capable of detecting the presence of an AmazonSimpleWorkflow bean into the registry. -If it's the only instance of that type it will be used as client and you won't have to define it as uri parameter. -This may be really useful for smarter configuration of the endpoint. - -== Dependencies - -Maven users will need to add the following dependency to their pom.xml. - -*pom.xml* - -[source,xml] ---------------------------------------- -<dependency> - <groupId>org.apache.camel</groupId> - <artifactId>camel-aws-swf</artifactId> - <version>${camel-version}</version> -</dependency> ---------------------------------------- - -where `$\{camel-version}` must be replaced by the actual version of Camel. - - -include::camel-spring-boot::page$aws-swf-starter.adoc[]