You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2022/03/02 10:17:11 UTC
[camel] branch main updated: Add resumable EIP to model
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 99e072a Add resumable EIP to model
99e072a is described below
commit 99e072afa886d3e9f5547ae087fd6c4b1d65dca6
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Wed Mar 2 11:13:31 2022 +0100
Add resumable EIP to model
---
.../camel/catalog/components/controlbus.json | 2 +-
.../org/apache/camel/catalog/models.properties | 1 +
.../org/apache/camel/catalog/models/resumable.json | 19 ++++++++
.../org/apache/camel/catalog/others.properties | 1 +
.../org/apache/camel/catalog/others/console.json | 15 ++++++
.../apache/camel/catalog/schemas/camel-spring.xsd | 42 ++++++++++++++++-
.../docs/modules/eips/pages/resume-strategies.adoc | 55 ++++++++++++----------
.../services/org/apache/camel/model.properties | 1 +
.../resources/org/apache/camel/model/jaxb.index | 1 +
.../org/apache/camel/model/resumable.json | 19 ++++++++
.../apache/camel/model/ResumableDefinition.java | 44 ++++++++++++-----
.../camel/processor/resume/ResumableProcessor.java | 10 ++--
.../org/apache/camel/reifier/ResumableReifier.java | 16 +++----
.../java/org/apache/camel/xml/in/ModelParser.java | 10 ++++
.../dsl/yaml/deserializers/ModelDeserializers.java | 54 +++++++++++++++++++++
.../deserializers/ModelDeserializersResolver.java | 2 +
.../src/generated/resources/camel-yaml-dsl.json | 21 +++++++++
.../src/generated/resources/camelYamlDsl.json | 21 +++++++++
18 files changed, 283 insertions(+), 51 deletions(-)
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/controlbus.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/controlbus.json
index 64d8185..75b407b 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/controlbus.json
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/controlbus.json
@@ -28,7 +28,7 @@
"properties": {
"command": { "kind": "path", "displayName": "Command", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "enum": [ "route", "language" ], "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "Command can be either route or language" },
"language": { "kind": "path", "displayName": "Language", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.spi.Language", "enum": [ "bean", "constant", "el", "exchangeProperty", "file", "groovy", "header", "jsonpath", "mvel", "ognl", "ref", "simple", "spel", "sql", "terser", "tokenize", "xpath", "xquery", "xtokenize" ], "deprecated": false, "autowired": false, "secret": false, "description": "Allows you to specify the name of a Langu [...]
- "action": { "kind": "parameter", "displayName": "Action", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "start", "stop", "suspend", "resume", "restart", "status", "stats" ], "deprecated": false, "autowired": false, "secret": false, "description": "To denote an action that can be either: start, stop, or status. To either start or stop a route, or to get the status of the route as output in the message body. You can use [...]
+ "action": { "kind": "parameter", "displayName": "Action", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "start", "stop", "fail", "suspend", "resume", "restart", "status", "stats" ], "deprecated": false, "autowired": false, "secret": false, "description": "To denote an action that can be either: start, stop, or status. To either start or stop a route, or to get the status of the route as output in the message body. You [...]
"async": { "kind": "parameter", "displayName": "Async", "group": "producer", "label": "", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "autowired": false, "secret": false, "defaultValue": false, "description": "Whether to execute the control bus task asynchronously. Important: If this option is enabled, then any result from the task is not set on the Exchange. This is only possible if executing tasks synchronously." },
"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 [...]
"loggingLevel": { "kind": "parameter", "displayName": "Logging Level", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.LoggingLevel", "enum": [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF" ], "deprecated": false, "autowired": false, "secret": false, "defaultValue": "INFO", "description": "Logging level used for logging when task is done, or if any exceptions occurred during processing the task." },
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models.properties b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models.properties
index 79538ac..9ba8efe 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models.properties
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models.properties
@@ -142,6 +142,7 @@ restContext
restContextRef
restProperty
rests
+resumable
ribbonLoadBalancer
rollback
roundRobin
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/resumable.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/resumable.json
new file mode 100644
index 0000000..acbea22
--- /dev/null
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/resumable.json
@@ -0,0 +1,19 @@
+{
+ "model": {
+ "kind": "model",
+ "name": "resumable",
+ "title": "Resumable",
+ "description": "Resume EIP to support resuming processing from last known offset.",
+ "deprecated": false,
+ "label": "eip,routing",
+ "javaType": "org.apache.camel.model.ResumableDefinition",
+ "abstract": false,
+ "input": true,
+ "output": false
+ },
+ "properties": {
+ "resumeStrategy": { "kind": "attribute", "displayName": "Resume Strategy", "required": true, "type": "object", "javaType": "org.apache.camel.ResumeStrategy", "deprecated": false, "autowired": false, "secret": false, "description": "Sets the resume strategy to use" },
+ "id": { "kind": "attribute", "displayName": "Id", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Sets the id of this node" },
+ "description": { "kind": "element", "displayName": "Description", "required": false, "type": "object", "javaType": "org.apache.camel.model.DescriptionDefinition", "deprecated": false, "autowired": false, "secret": false, "description": "Sets the description of this node" }
+ }
+}
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/others.properties b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/others.properties
index 2ecc8b0..5f99325 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/others.properties
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/others.properties
@@ -8,6 +8,7 @@ cloud
cloudevents
cluster
componentdsl
+console
csimple-joor
cxf-transport
debug
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/others/console.json b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/others/console.json
new file mode 100644
index 0000000..b1048bd
--- /dev/null
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/others/console.json
@@ -0,0 +1,15 @@
+{
+ "other": {
+ "kind": "other",
+ "name": "console",
+ "title": "Console",
+ "description": "Camel Developer Console",
+ "deprecated": false,
+ "firstVersion": "3.15.0",
+ "label": "core",
+ "supportLevel": "Preview",
+ "groupId": "org.apache.camel",
+ "artifactId": "camel-console",
+ "version": "3.16.0-SNAPSHOT"
+ }
+}
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
index 74fb0ef..2e09f09 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
@@ -1215,6 +1215,14 @@ A series of rest services defined using the rest-dsl
</xs:annotation>
</xs:element>
+ <xs:element name="resumable" type="tns:resumableDefinition">
+ <xs:annotation>
+ <xs:documentation xml:lang="en"><![CDATA[
+Resume EIP to support resuming processing from last known offset.
+ ]]></xs:documentation>
+ </xs:annotation>
+ </xs:element>
+
<xs:element name="ribbonLoadBalancer" type="tns:ribbonServiceCallServiceLoadBalancerConfiguration">
<xs:annotation>
<xs:documentation xml:lang="en"><![CDATA[
@@ -3038,6 +3046,7 @@ will fallback to use the fixed value if the Expression result was null or 0.
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
@@ -3542,6 +3551,7 @@ should be intercepted by this exception type or not.
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
@@ -3642,6 +3652,7 @@ should be intercepted by this exception type or not.
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
@@ -3730,6 +3741,7 @@ should be intercepted by this exception type or not.
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
@@ -3810,6 +3822,7 @@ should be intercepted by this exception type or not.
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
@@ -4856,6 +4869,7 @@ org.apache.camel.spi.SendDynamicAware . Default value: true
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
@@ -4941,6 +4955,7 @@ Setting this allows to know if the filter predicate evaluated as true or false.
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
@@ -5080,6 +5095,7 @@ Global option value.
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
@@ -5259,6 +5275,7 @@ Whether if validation is required for this input type. Default value: false
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
@@ -5352,6 +5369,7 @@ configured, then all incoming messages is intercepted.
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
@@ -5452,6 +5470,7 @@ process its result.
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
@@ -5546,6 +5565,7 @@ specified using uri syntax, eg mynamecount=4&type=gold.
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
@@ -5840,6 +5860,7 @@ To refer to a custom logger instance to lookup from the registry.
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
@@ -8874,6 +8895,7 @@ decompressed size. Default value: 1073741824
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
@@ -9075,6 +9097,7 @@ should be invoked or not.
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
@@ -9243,6 +9266,7 @@ failure. If this option is enabled then its considered handled as well.
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
@@ -9605,6 +9629,7 @@ generate the log message from exchange.
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
@@ -9742,6 +9767,7 @@ Include finding route builder from these java package names.
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
@@ -9819,6 +9845,7 @@ Include finding route builder from these java package names.
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
@@ -10363,6 +10390,7 @@ Name of property to remove.
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
@@ -10514,7 +10542,13 @@ Reference to the rest-dsl.
<xs:complexContent>
<xs:extension base="tns:noOutputDefinition">
<xs:sequence/>
- <xs:attribute name="resumeStrategy" type="xs:string" use="required"/>
+ <xs:attribute name="resumeStrategy" type="xs:string" use="required">
+ <xs:annotation>
+ <xs:documentation xml:lang="en"><![CDATA[
+Sets the resume strategy to use.
+ ]]></xs:documentation>
+ </xs:annotation>
+ </xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
@@ -10654,6 +10688,7 @@ Reference to the routes in the xml dsl.
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
@@ -11011,6 +11046,7 @@ compensation/completion exchange.
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
@@ -11362,6 +11398,7 @@ Sets the comparator to use for sorting.
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
@@ -11571,6 +11608,7 @@ individual unit of work. Default value: false
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
@@ -12072,6 +12110,7 @@ Whether to auto startup components when toD is starting up. Default value: true
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
@@ -12186,6 +12225,7 @@ Sets a reference to use for lookup the policy in the registry.
<xs:element ref="tns:removeProperties"/>
<xs:element ref="tns:removeProperty"/>
<xs:element ref="tns:resequence"/>
+ <xs:element ref="tns:resumable"/>
<xs:element ref="tns:rollback"/>
<xs:element ref="tns:route"/>
<xs:element ref="tns:routingSlip"/>
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/resume-strategies.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/resume-strategies.adoc
index b284b4c..e608045 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/resume-strategies.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/resume-strategies.adoc
@@ -15,53 +15,61 @@ The resume strategies comes in 3 parts:
* A set of core infrastructure that allow integrations to implement different types of strategies
* Basic strategies implementations that can be extended to implement the specific resume strategies required by the integrations
-=== The DSL method
+== The DSL method
-The route needs to use the `resumable()` method followed by a `resumableStrategyRef` to point to an instance of the resume strategy in use. This instance needs to be bound in the Context registry.
+The route needs to use the `resumable()` method followed by a `resumableStrategy` to point to an instance of the resume strategy in use.
+
+This instance can be bound in the Context registry as follows:
[source,java]
----
-getCamelContext().getRegistry().bind("testResumeStrategy", testResumeStrategy);
+getCamelContext().getRegistry().bind("testResumeStrategy", new MyTestResumeStrategy());
from("some:component")
.process(this::process)
- .resumable().resumableStrategyRef("testResumeStrategy");
+ .resumable().resumableStrategy("testResumeStrategy");
----
+Or the instance can be constructed as follows:
+
+[source,java]
+----
+from("some:component")
+ .process(this::process)
+ .resumable().resumableStrategy(new MyTestResumeStrategy());
+----
-=== The Core Interfaces
+== The Resume API Interfaces
These are the *core interfaces*:
-* org.apache.camel.ResumeStrategy: the basic resume strategy
-* org.apache.camel.UpdatableConsumerResumeStrategy: an extension to the resume strategy to allow updatable strategies
-* org.apache.camel.ResumeCache: an interface for local cache for resumable information
+* `org.apache.camel.ResumeStrategy` - the basic resume strategy
+* `org.apache.camel.UpdatableConsumerResumeStrategy` - an extension to the resume strategy to allow updatable strategies
+* `org.apache.camel.ResumeCache` - an interface for local cache for resumable information
These are the *core classes* supporting the strategies:
-* org.apache.camel.Resumable: an interface to allow users to work with abstract resumable entities (files, offsets, etc)
-* org.apache.camel.ResumableSet: an interface for resumables with a 1-to-many relationship
-* org.apache.camel.Offset: a generic offset without a concrete type (it may represent a long, a file name, etc)
-
+* `org.apache.camel.Resumable` - an interface to allow users to work with abstract resumable entities (files, offsets, etc)
+* `org.apache.camel.ResumableSet` - an interface for resumables with a 1-to-many relationship
+* `org.apache.camel.Offset` - a generic offset without a concrete type (it may represent a long, a file name, etc)
These are the *supporting classes*:
-* org.apache.camel.support.Resumables: resumables handling support
-* org.apache.camel.support.Offsets: offset handling support
+* `org.apache.camel.support.Resumables` - resumables handling support
+* `org.apache.camel.support.Offsets` - offset handling support
-
-=== Basic Strategies
+== Basic Strategies
The basic strategies offer a component-specific skeleton that can be used to implement strategies.
-* AbstractKafkaResumeStrategy: a resume strategy from the `camel-kafka` component that uses Kafka as the store for the offsets.
-
+* `AbstractKafkaResumeStrategy` - a resume strategy from the `camel-kafka` component that uses Kafka as the store for the offsets.
[source,java]
----
public class KafkaResumeStrategy<K> extends AbstractKafkaResumeStrategy<K, Long> implements GenericFileResumeStrategy<File> {
-private static final Logger LOG = LoggerFactory.getLogger(KafkaResumeStrategy.class);
-public static final int CACHE_SIZE = 100;
+
+ private static final Logger LOG = LoggerFactory.getLogger(KafkaResumeStrategy.class);
+ public static final int CACHE_SIZE = 100;
private final String topic;
private final ResumeCache<K, Long> cache;
@@ -111,7 +119,7 @@ public static final int CACHE_SIZE = 100;
----
-=== Local Cache Support
+== Local Cache Support
A sample local cache implemented using https://github.com/ben-manes/caffeine[Caffeine].
@@ -151,10 +159,9 @@ public class SingleItemCache<K> implements ResumeCache<K, Long> {
----
+== Known Limitations
-=== Known Limitations, Bugs and Other Notes
-
-* When using the converters with the file component, beware of the differences in the behavior from `Reader` and `InputStream`:
+When using the converters with the file component, beware of the differences in the behavior from `Reader` and `InputStream`:
For instance, the behavior of:
diff --git a/core/camel-core-model/src/generated/resources/META-INF/services/org/apache/camel/model.properties b/core/camel-core-model/src/generated/resources/META-INF/services/org/apache/camel/model.properties
index cdf082b..acf74d0 100644
--- a/core/camel-core-model/src/generated/resources/META-INF/services/org/apache/camel/model.properties
+++ b/core/camel-core-model/src/generated/resources/META-INF/services/org/apache/camel/model.properties
@@ -134,6 +134,7 @@ restConfiguration
restContextRef
restProperty
rests
+resumable
ribbonLoadBalancer
rollback
roundRobin
diff --git a/core/camel-core-model/src/generated/resources/org/apache/camel/model/jaxb.index b/core/camel-core-model/src/generated/resources/org/apache/camel/model/jaxb.index
index 94d29fe..6b088ff 100644
--- a/core/camel-core-model/src/generated/resources/org/apache/camel/model/jaxb.index
+++ b/core/camel-core-model/src/generated/resources/org/apache/camel/model/jaxb.index
@@ -61,6 +61,7 @@ RemovePropertyDefinition
ResequenceDefinition
Resilience4jConfigurationDefinition
RestContextRefDefinition
+ResumableDefinition
RollbackDefinition
RouteBuilderDefinition
RouteConfigurationContextRefDefinition
diff --git a/core/camel-core-model/src/generated/resources/org/apache/camel/model/resumable.json b/core/camel-core-model/src/generated/resources/org/apache/camel/model/resumable.json
new file mode 100644
index 0000000..acbea22
--- /dev/null
+++ b/core/camel-core-model/src/generated/resources/org/apache/camel/model/resumable.json
@@ -0,0 +1,19 @@
+{
+ "model": {
+ "kind": "model",
+ "name": "resumable",
+ "title": "Resumable",
+ "description": "Resume EIP to support resuming processing from last known offset.",
+ "deprecated": false,
+ "label": "eip,routing",
+ "javaType": "org.apache.camel.model.ResumableDefinition",
+ "abstract": false,
+ "input": true,
+ "output": false
+ },
+ "properties": {
+ "resumeStrategy": { "kind": "attribute", "displayName": "Resume Strategy", "required": true, "type": "object", "javaType": "org.apache.camel.ResumeStrategy", "deprecated": false, "autowired": false, "secret": false, "description": "Sets the resume strategy to use" },
+ "id": { "kind": "attribute", "displayName": "Id", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "description": "Sets the id of this node" },
+ "description": { "kind": "element", "displayName": "Description", "required": false, "type": "object", "javaType": "org.apache.camel.model.DescriptionDefinition", "deprecated": false, "autowired": false, "secret": false, "description": "Sets the description of this node" }
+ }
+}
diff --git a/core/camel-core-model/src/main/java/org/apache/camel/model/ResumableDefinition.java b/core/camel-core-model/src/main/java/org/apache/camel/model/ResumableDefinition.java
index a2f4611..c0c5f26 100644
--- a/core/camel-core-model/src/main/java/org/apache/camel/model/ResumableDefinition.java
+++ b/core/camel-core-model/src/main/java/org/apache/camel/model/ResumableDefinition.java
@@ -14,53 +14,71 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
package org.apache.camel.model;
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
+import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlTransient;
import org.apache.camel.ResumeStrategy;
+import org.apache.camel.spi.Metadata;
+/**
+ * Resume EIP to support resuming processing from last known offset.
+ */
+@Metadata(label = "eip,routing")
+@XmlRootElement(name = "resumable")
+@XmlAccessorType(XmlAccessType.FIELD)
public class ResumableDefinition extends NoOutputDefinition<ResumableDefinition> {
- @XmlAttribute(required = true, name = "resumeStrategy")
- private String resumeStrategyRef;
@XmlTransient
- private ResumeStrategy resumeStrategy;
+ private ResumeStrategy resumeStrategyBean;
+
+ @XmlAttribute(required = true)
+ @Metadata(required = true, javaType = "org.apache.camel.ResumeStrategy")
+ private String resumeStrategy;
@Override
public String getShortName() {
return "resumable";
}
- public String getResumeStrategyRef() {
- return resumeStrategyRef;
+ @Override
+ public String getLabel() {
+ return "resumable";
}
- public void setResumeStrategyRef(String resumeStrategyRef) {
- this.resumeStrategyRef = resumeStrategyRef;
+ public ResumeStrategy getResumeStrategyBean() {
+ return resumeStrategyBean;
}
- public ResumeStrategy getResumeStrategy() {
+ public String getResumeStrategy() {
return resumeStrategy;
}
- public void setResumeStrategy(ResumeStrategy resumeStrategy) {
+ public void setResumeStrategy(String resumeStrategy) {
this.resumeStrategy = resumeStrategy;
}
+ public void setResumeStrategy(ResumeStrategy resumeStrategyBean) {
+ this.resumeStrategyBean = resumeStrategyBean;
+ }
+
// Fluent API
// -------------------------------------------------------------------------
- public ResumableDefinition resumeStrategy(String resumeStrategyRef) {
- setResumeStrategyRef(resumeStrategyRef);
+ /**
+ * Sets the resume strategy to use
+ */
+ public ResumableDefinition resumeStrategy(String resumeStrategyRef) {
+ setResumeStrategy(resumeStrategyRef);
return this;
}
public ResumableDefinition resumeStrategy(ResumeStrategy resumeStrategy) {
setResumeStrategy(resumeStrategy);
-
return this;
}
}
diff --git a/core/camel-core-processor/src/main/java/org/apache/camel/processor/resume/ResumableProcessor.java b/core/camel-core-processor/src/main/java/org/apache/camel/processor/resume/ResumableProcessor.java
index a31196c..467f124 100644
--- a/core/camel-core-processor/src/main/java/org/apache/camel/processor/resume/ResumableProcessor.java
+++ b/core/camel-core-processor/src/main/java/org/apache/camel/processor/resume/ResumableProcessor.java
@@ -14,7 +14,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
package org.apache.camel.processor.resume;
import java.util.ArrayList;
@@ -38,12 +37,17 @@ import org.apache.camel.support.AsyncProcessorSupport;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * Resume EIP
+ */
public class ResumableProcessor extends AsyncProcessorSupport
implements Navigate<Processor>, CamelContextAware, IdAware, RouteIdAware {
+
private static final Logger LOG = LoggerFactory.getLogger(ResumableProcessor.class);
+
private CamelContext camelContext;
- private ResumeStrategy resumeStrategy;
- private AsyncProcessor processor;
+ private final ResumeStrategy resumeStrategy;
+ private final AsyncProcessor processor;
private String id;
private String routeId;
diff --git a/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/ResumableReifier.java b/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/ResumableReifier.java
index 1d19634..08c3c79 100644
--- a/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/ResumableReifier.java
+++ b/core/camel-core-reifier/src/main/java/org/apache/camel/reifier/ResumableReifier.java
@@ -14,7 +14,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
package org.apache.camel.reifier;
import org.apache.camel.Processor;
@@ -26,9 +25,9 @@ import org.apache.camel.processor.resume.ResumableProcessor;
import org.apache.camel.util.ObjectHelper;
public class ResumableReifier extends ProcessorReifier<ResumableDefinition> {
+
protected ResumableReifier(Route route, ProcessorDefinition<?> definition) {
super(route, ResumableDefinition.class.cast(definition));
-
}
@Override
@@ -37,18 +36,17 @@ public class ResumableReifier extends ProcessorReifier<ResumableDefinition> {
ResumeStrategy resumeStrategy = resolveResumeStrategy();
ObjectHelper.notNull(resumeStrategy, "resumeStrategy", definition);
- route.setResumeStrategy(resumeStrategy);
+ route.setResumeStrategy(resumeStrategy);
return new ResumableProcessor(resumeStrategy, childProcessor);
}
protected ResumeStrategy resolveResumeStrategy() {
- String ref = parseString(definition.getResumeStrategyRef());
-
- if (ref != null) {
- definition.setResumeStrategy(mandatoryLookup(ref, ResumeStrategy.class));
+ ResumeStrategy strategy = definition.getResumeStrategyBean();
+ if (strategy == null) {
+ String ref = parseString(definition.getResumeStrategy());
+ strategy = mandatoryLookup(ref, ResumeStrategy.class);
}
-
- return definition.getResumeStrategy();
+ return strategy;
}
}
diff --git a/core/camel-xml-io/src/generated/java/org/apache/camel/xml/in/ModelParser.java b/core/camel-xml-io/src/generated/java/org/apache/camel/xml/in/ModelParser.java
index 56d3407..b8f457b 100644
--- a/core/camel-xml-io/src/generated/java/org/apache/camel/xml/in/ModelParser.java
+++ b/core/camel-xml-io/src/generated/java/org/apache/camel/xml/in/ModelParser.java
@@ -945,6 +945,15 @@ public class ModelParser extends BaseParser {
return false;
}, noElementHandler(), noValueHandler());
}
+ protected ResumableDefinition doParseResumableDefinition() throws IOException, XmlPullParserException {
+ return doParse(new ResumableDefinition(), (def, key, val) -> {
+ if ("resumeStrategy".equals(key)) {
+ def.setResumeStrategy(val);
+ return true;
+ }
+ return processorDefinitionAttributeHandler().accept(def, key, val);
+ }, optionalIdentifiedDefinitionElementHandler(), noValueHandler());
+ }
protected RollbackDefinition doParseRollbackDefinition() throws IOException, XmlPullParserException {
return doParse(new RollbackDefinition(), (def, key, val) -> {
switch (key) {
@@ -3241,6 +3250,7 @@ public class ModelParser extends BaseParser {
case "removeProperties": return doParseRemovePropertiesDefinition();
case "removeProperty": return doParseRemovePropertyDefinition();
case "resequence": return doParseResequenceDefinition();
+ case "resumable": return doParseResumableDefinition();
case "rollback": return doParseRollbackDefinition();
case "route": return doParseRouteDefinition();
case "routingSlip": return doParseRoutingSlipDefinition();
diff --git a/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializers.java b/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializers.java
index 0f092a9..47930c5 100644
--- a/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializers.java
+++ b/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializers.java
@@ -67,6 +67,7 @@ import org.apache.camel.model.RemovePropertyDefinition;
import org.apache.camel.model.ResequenceDefinition;
import org.apache.camel.model.Resilience4jConfigurationDefinition;
import org.apache.camel.model.RestContextRefDefinition;
+import org.apache.camel.model.ResumableDefinition;
import org.apache.camel.model.RollbackDefinition;
import org.apache.camel.model.RouteBuilderDefinition;
import org.apache.camel.model.RouteConfigurationContextRefDefinition;
@@ -12511,6 +12512,59 @@ public final class ModelDeserializers extends YamlDeserializerSupport {
}
@YamlType(
+ types = org.apache.camel.model.ResumableDefinition.class,
+ order = org.apache.camel.dsl.yaml.common.YamlDeserializerResolver.ORDER_LOWEST - 1,
+ nodes = "resumable",
+ properties = {
+ @YamlProperty(name = "description", type = "string"),
+ @YamlProperty(name = "id", type = "string"),
+ @YamlProperty(name = "inherit-error-handler", type = "boolean"),
+ @YamlProperty(name = "resume-strategy", type = "string", required = true)
+ }
+ )
+ public static class ResumableDefinitionDeserializer extends YamlDeserializerBase<ResumableDefinition> {
+ public ResumableDefinitionDeserializer() {
+ super(ResumableDefinition.class);
+ }
+
+ @Override
+ protected ResumableDefinition newInstance() {
+ return new ResumableDefinition();
+ }
+
+ @Override
+ protected boolean setProperty(ResumableDefinition target, String propertyKey,
+ String propertyName, Node node) {
+ switch(propertyKey) {
+ case "inherit-error-handler": {
+ String val = asText(node);
+ target.setInheritErrorHandler(java.lang.Boolean.valueOf(val));
+ break;
+ }
+ case "resume-strategy": {
+ String val = asText(node);
+ target.setResumeStrategy(val);
+ break;
+ }
+ case "id": {
+ String val = asText(node);
+ target.setId(val);
+ break;
+ }
+ case "description": {
+ org.apache.camel.model.DescriptionDefinition val = asType(node, org.apache.camel.model.DescriptionDefinition.class);
+ target.setDescription(val);
+ break;
+ }
+ default: {
+ return false;
+ }
+ }
+ return true;
+ }
+ }
+
+ @YamlType(
types = org.apache.camel.model.cloud.RibbonServiceCallServiceLoadBalancerConfiguration.class,
order = org.apache.camel.dsl.yaml.common.YamlDeserializerResolver.ORDER_LOWEST - 1,
nodes = {
diff --git a/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializersResolver.java b/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializersResolver.java
index 1614865..bbd2dea 100644
--- a/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializersResolver.java
+++ b/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializersResolver.java
@@ -353,6 +353,8 @@ public final class ModelDeserializersResolver implements YamlDeserializerResolve
case "org.apache.camel.model.rest.RestSecuritiesDefinition": return new ModelDeserializers.RestSecuritiesDefinitionDeserializer();
case "rests": return new ModelDeserializers.RestsDefinitionDeserializer();
case "org.apache.camel.model.rest.RestsDefinition": return new ModelDeserializers.RestsDefinitionDeserializer();
+ case "resumable": return new ModelDeserializers.ResumableDefinitionDeserializer();
+ case "org.apache.camel.model.ResumableDefinition": return new ModelDeserializers.ResumableDefinitionDeserializer();
case "ribbon-load-balancer": return new ModelDeserializers.RibbonServiceCallServiceLoadBalancerConfigurationDeserializer();
case "ribbonLoadBalancer": return new ModelDeserializers.RibbonServiceCallServiceLoadBalancerConfigurationDeserializer();
case "org.apache.camel.model.cloud.RibbonServiceCallServiceLoadBalancerConfiguration": return new ModelDeserializers.RibbonServiceCallServiceLoadBalancerConfigurationDeserializer();
diff --git a/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/camel-yaml-dsl.json b/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/camel-yaml-dsl.json
index 84fc726..bfa5e8b 100644
--- a/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/camel-yaml-dsl.json
+++ b/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/camel-yaml-dsl.json
@@ -179,6 +179,9 @@
"resequence" : {
"$ref" : "#/items/definitions/org.apache.camel.model.ResequenceDefinition"
},
+ "resumable" : {
+ "$ref" : "#/items/definitions/org.apache.camel.model.ResumableDefinition"
+ },
"rollback" : {
"$ref" : "#/items/definitions/org.apache.camel.model.RollbackDefinition"
},
@@ -2367,6 +2370,24 @@
} ],
"required" : [ "ref" ]
},
+ "org.apache.camel.model.ResumableDefinition" : {
+ "type" : "object",
+ "properties" : {
+ "description" : {
+ "type" : "string"
+ },
+ "id" : {
+ "type" : "string"
+ },
+ "inherit-error-handler" : {
+ "type" : "boolean"
+ },
+ "resume-strategy" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "resume-strategy" ]
+ },
"org.apache.camel.model.RollbackDefinition" : {
"oneOf" : [ {
"type" : "string"
diff --git a/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/camelYamlDsl.json b/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/camelYamlDsl.json
index 417f99a..5a4dac2 100644
--- a/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/camelYamlDsl.json
+++ b/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/camelYamlDsl.json
@@ -119,6 +119,9 @@
"resequence" : {
"$ref" : "#/items/definitions/org.apache.camel.model.ResequenceDefinition"
},
+ "resumable" : {
+ "$ref" : "#/items/definitions/org.apache.camel.model.ResumableDefinition"
+ },
"rollback" : {
"$ref" : "#/items/definitions/org.apache.camel.model.RollbackDefinition"
},
@@ -2268,6 +2271,24 @@
} ],
"required" : [ "ref" ]
},
+ "org.apache.camel.model.ResumableDefinition" : {
+ "type" : "object",
+ "properties" : {
+ "description" : {
+ "type" : "string"
+ },
+ "id" : {
+ "type" : "string"
+ },
+ "inheritErrorHandler" : {
+ "type" : "boolean"
+ },
+ "resumeStrategy" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "resumeStrategy" ]
+ },
"org.apache.camel.model.RollbackDefinition" : {
"oneOf" : [ {
"type" : "string"