You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ja...@apache.org on 2020/11/09 11:38:09 UTC
[camel] branch master updated: CAMEL-15825: Enable scheduler
configuration to be set on camel-github consumers
This is an automated email from the ASF dual-hosted git repository.
jamesnetherton pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/master by this push:
new f9ad7bf CAMEL-15825: Enable scheduler configuration to be set on camel-github consumers
f9ad7bf is described below
commit f9ad7bf07b6c3e7a8110e40810ff9e54422722fc
Author: James Netherton <ja...@gmail.com>
AuthorDate: Mon Nov 9 11:20:07 2020 +0000
CAMEL-15825: Enable scheduler configuration to be set on camel-github consumers
---
.../camel/catalog/docs/github-component.adoc | 18 +-
.../component/github/GitHubEndpointConfigurer.java | 87 ++++
.../component/github/GitHubEndpointUriFactory.java | 28 +-
.../org/apache/camel/component/github/github.json | 18 +-
.../src/main/docs/github-component.adoc | 18 +-
.../camel/component/github/GitHubEndpoint.java | 21 +-
.../SchedulerConfigurationConsumerTest.java | 48 +++
.../endpoint/dsl/GitHubEndpointBuilderFactory.java | 450 +++++++++++++++++++++
.../modules/ROOT/pages/github-component.adoc | 18 +-
9 files changed, 689 insertions(+), 17 deletions(-)
diff --git a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/github-component.adoc b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/github-component.adoc
index 1234b19..f262f4e 100644
--- a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/github-component.adoc
+++ b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/github-component.adoc
@@ -90,7 +90,7 @@ with the following path and query parameters:
|===
-=== Query Parameters (14 parameters):
+=== Query Parameters (30 parameters):
[width="100%",cols="2,5,^1,2",options="header"]
@@ -102,14 +102,30 @@ with the following path and query parameters:
| *repoOwner* (common) | *Required* GitHub repository owner (organization) | | String
| *username* (common) | GitHub username, required unless oauthToken is provided | | 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
+| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. | 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
+| *pollStrategy* (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPollStrategy
| *encoding* (producer) | To use the given encoding when getting a git commit file | | String
| *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 [...]
| *state* (producer) | To set git commit status state. There are 4 enums and the value can be one of: error, failure, pending, success | | String
| *targetUrl* (producer) | To set git commit status target url | | String
| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| *delay* (scheduler) | Milliseconds before the next poll. | 500 | long
+| *greedy* (scheduler) | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. | false | boolean
+| *initialDelay* (scheduler) | Milliseconds before the first poll starts. | 1000 | long
+| *repeatCount* (scheduler) | Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. | 0 | long
+| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. There are 6 enums and the value can be one of: TRACE, DEBUG, INFO, WARN, ERROR, OFF | TRACE | LoggingLevel
+| *scheduledExecutorService* (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutorService
+| *scheduler* (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler | none | Object
+| *schedulerProperties* (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. | | Map
+| *startScheduler* (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. There are 7 enums and the value can be one of: NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS | MILLISECONDS | TimeUnit
+| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
|===
// endpoint options: END
diff --git a/components/camel-github/src/generated/java/org/apache/camel/component/github/GitHubEndpointConfigurer.java b/components/camel-github/src/generated/java/org/apache/camel/component/github/GitHubEndpointConfigurer.java
index 86c9248..b721cd1 100644
--- a/components/camel-github/src/generated/java/org/apache/camel/component/github/GitHubEndpointConfigurer.java
+++ b/components/camel-github/src/generated/java/org/apache/camel/component/github/GitHubEndpointConfigurer.java
@@ -21,28 +21,57 @@ public class GitHubEndpointConfigurer extends PropertyConfigurerSupport implemen
public boolean configure(CamelContext camelContext, Object obj, String name, Object value, boolean ignoreCase) {
GitHubEndpoint target = (GitHubEndpoint) obj;
switch (ignoreCase ? name.toLowerCase() : name) {
+ case "backofferrorthreshold":
+ case "backoffErrorThreshold": target.setBackoffErrorThreshold(property(camelContext, int.class, value)); return true;
+ case "backoffidlethreshold":
+ case "backoffIdleThreshold": target.setBackoffIdleThreshold(property(camelContext, int.class, value)); return true;
+ case "backoffmultiplier":
+ case "backoffMultiplier": target.setBackoffMultiplier(property(camelContext, int.class, value)); return true;
case "basicpropertybinding":
case "basicPropertyBinding": target.setBasicPropertyBinding(property(camelContext, boolean.class, value)); return true;
case "bridgeerrorhandler":
case "bridgeErrorHandler": target.setBridgeErrorHandler(property(camelContext, boolean.class, value)); return true;
+ case "delay": target.setDelay(property(camelContext, long.class, value)); return true;
case "encoding": target.setEncoding(property(camelContext, java.lang.String.class, value)); return true;
case "exceptionhandler":
case "exceptionHandler": target.setExceptionHandler(property(camelContext, org.apache.camel.spi.ExceptionHandler.class, value)); return true;
case "exchangepattern":
case "exchangePattern": target.setExchangePattern(property(camelContext, org.apache.camel.ExchangePattern.class, value)); return true;
+ case "greedy": target.setGreedy(property(camelContext, boolean.class, value)); return true;
+ case "initialdelay":
+ case "initialDelay": target.setInitialDelay(property(camelContext, long.class, value)); return true;
case "lazystartproducer":
case "lazyStartProducer": target.setLazyStartProducer(property(camelContext, boolean.class, value)); return true;
case "oauthtoken":
case "oauthToken": target.setOauthToken(property(camelContext, java.lang.String.class, value)); return true;
case "password": target.setPassword(property(camelContext, java.lang.String.class, value)); return true;
+ case "pollstrategy":
+ case "pollStrategy": target.setPollStrategy(property(camelContext, org.apache.camel.spi.PollingConsumerPollStrategy.class, value)); return true;
+ case "repeatcount":
+ case "repeatCount": target.setRepeatCount(property(camelContext, long.class, value)); return true;
case "reponame":
case "repoName": target.setRepoName(property(camelContext, java.lang.String.class, value)); return true;
case "repoowner":
case "repoOwner": target.setRepoOwner(property(camelContext, java.lang.String.class, value)); return true;
+ case "runlogginglevel":
+ case "runLoggingLevel": target.setRunLoggingLevel(property(camelContext, org.apache.camel.LoggingLevel.class, value)); return true;
+ case "scheduledexecutorservice":
+ case "scheduledExecutorService": target.setScheduledExecutorService(property(camelContext, java.util.concurrent.ScheduledExecutorService.class, value)); return true;
+ case "scheduler": target.setScheduler(property(camelContext, java.lang.Object.class, value)); return true;
+ case "schedulerproperties":
+ case "schedulerProperties": target.setSchedulerProperties(property(camelContext, java.util.Map.class, value)); return true;
+ case "sendemptymessagewhenidle":
+ case "sendEmptyMessageWhenIdle": target.setSendEmptyMessageWhenIdle(property(camelContext, boolean.class, value)); return true;
+ case "startscheduler":
+ case "startScheduler": target.setStartScheduler(property(camelContext, boolean.class, value)); return true;
case "state": target.setState(property(camelContext, java.lang.String.class, value)); return true;
case "synchronous": target.setSynchronous(property(camelContext, boolean.class, value)); return true;
case "targeturl":
case "targetUrl": target.setTargetUrl(property(camelContext, java.lang.String.class, value)); return true;
+ case "timeunit":
+ case "timeUnit": target.setTimeUnit(property(camelContext, java.util.concurrent.TimeUnit.class, value)); return true;
+ case "usefixeddelay":
+ case "useFixedDelay": target.setUseFixedDelay(property(camelContext, boolean.class, value)); return true;
case "username": target.setUsername(property(camelContext, java.lang.String.class, value)); return true;
default: return false;
}
@@ -51,28 +80,57 @@ public class GitHubEndpointConfigurer extends PropertyConfigurerSupport implemen
@Override
public Class<?> getOptionType(String name, boolean ignoreCase) {
switch (ignoreCase ? name.toLowerCase() : name) {
+ case "backofferrorthreshold":
+ case "backoffErrorThreshold": return int.class;
+ case "backoffidlethreshold":
+ case "backoffIdleThreshold": return int.class;
+ case "backoffmultiplier":
+ case "backoffMultiplier": return int.class;
case "basicpropertybinding":
case "basicPropertyBinding": return boolean.class;
case "bridgeerrorhandler":
case "bridgeErrorHandler": return boolean.class;
+ case "delay": return long.class;
case "encoding": return java.lang.String.class;
case "exceptionhandler":
case "exceptionHandler": return org.apache.camel.spi.ExceptionHandler.class;
case "exchangepattern":
case "exchangePattern": return org.apache.camel.ExchangePattern.class;
+ case "greedy": return boolean.class;
+ case "initialdelay":
+ case "initialDelay": return long.class;
case "lazystartproducer":
case "lazyStartProducer": return boolean.class;
case "oauthtoken":
case "oauthToken": return java.lang.String.class;
case "password": return java.lang.String.class;
+ case "pollstrategy":
+ case "pollStrategy": return org.apache.camel.spi.PollingConsumerPollStrategy.class;
+ case "repeatcount":
+ case "repeatCount": return long.class;
case "reponame":
case "repoName": return java.lang.String.class;
case "repoowner":
case "repoOwner": return java.lang.String.class;
+ case "runlogginglevel":
+ case "runLoggingLevel": return org.apache.camel.LoggingLevel.class;
+ case "scheduledexecutorservice":
+ case "scheduledExecutorService": return java.util.concurrent.ScheduledExecutorService.class;
+ case "scheduler": return java.lang.Object.class;
+ case "schedulerproperties":
+ case "schedulerProperties": return java.util.Map.class;
+ case "sendemptymessagewhenidle":
+ case "sendEmptyMessageWhenIdle": return boolean.class;
+ case "startscheduler":
+ case "startScheduler": return boolean.class;
case "state": return java.lang.String.class;
case "synchronous": return boolean.class;
case "targeturl":
case "targetUrl": return java.lang.String.class;
+ case "timeunit":
+ case "timeUnit": return java.util.concurrent.TimeUnit.class;
+ case "usefixeddelay":
+ case "useFixedDelay": return boolean.class;
case "username": return java.lang.String.class;
default: return null;
}
@@ -82,28 +140,57 @@ public class GitHubEndpointConfigurer extends PropertyConfigurerSupport implemen
public Object getOptionValue(Object obj, String name, boolean ignoreCase) {
GitHubEndpoint target = (GitHubEndpoint) obj;
switch (ignoreCase ? name.toLowerCase() : name) {
+ case "backofferrorthreshold":
+ case "backoffErrorThreshold": return target.getBackoffErrorThreshold();
+ case "backoffidlethreshold":
+ case "backoffIdleThreshold": return target.getBackoffIdleThreshold();
+ case "backoffmultiplier":
+ case "backoffMultiplier": return target.getBackoffMultiplier();
case "basicpropertybinding":
case "basicPropertyBinding": return target.isBasicPropertyBinding();
case "bridgeerrorhandler":
case "bridgeErrorHandler": return target.isBridgeErrorHandler();
+ case "delay": return target.getDelay();
case "encoding": return target.getEncoding();
case "exceptionhandler":
case "exceptionHandler": return target.getExceptionHandler();
case "exchangepattern":
case "exchangePattern": return target.getExchangePattern();
+ case "greedy": return target.isGreedy();
+ case "initialdelay":
+ case "initialDelay": return target.getInitialDelay();
case "lazystartproducer":
case "lazyStartProducer": return target.isLazyStartProducer();
case "oauthtoken":
case "oauthToken": return target.getOauthToken();
case "password": return target.getPassword();
+ case "pollstrategy":
+ case "pollStrategy": return target.getPollStrategy();
+ case "repeatcount":
+ case "repeatCount": return target.getRepeatCount();
case "reponame":
case "repoName": return target.getRepoName();
case "repoowner":
case "repoOwner": return target.getRepoOwner();
+ case "runlogginglevel":
+ case "runLoggingLevel": return target.getRunLoggingLevel();
+ case "scheduledexecutorservice":
+ case "scheduledExecutorService": return target.getScheduledExecutorService();
+ case "scheduler": return target.getScheduler();
+ case "schedulerproperties":
+ case "schedulerProperties": return target.getSchedulerProperties();
+ case "sendemptymessagewhenidle":
+ case "sendEmptyMessageWhenIdle": return target.isSendEmptyMessageWhenIdle();
+ case "startscheduler":
+ case "startScheduler": return target.isStartScheduler();
case "state": return target.getState();
case "synchronous": return target.isSynchronous();
case "targeturl":
case "targetUrl": return target.getTargetUrl();
+ case "timeunit":
+ case "timeUnit": return target.getTimeUnit();
+ case "usefixeddelay":
+ case "useFixedDelay": return target.isUseFixedDelay();
case "username": return target.getUsername();
default: return null;
}
diff --git a/components/camel-github/src/generated/java/org/apache/camel/component/github/GitHubEndpointUriFactory.java b/components/camel-github/src/generated/java/org/apache/camel/component/github/GitHubEndpointUriFactory.java
index 98bb601..e067cd0 100644
--- a/components/camel-github/src/generated/java/org/apache/camel/component/github/GitHubEndpointUriFactory.java
+++ b/components/camel-github/src/generated/java/org/apache/camel/component/github/GitHubEndpointUriFactory.java
@@ -20,20 +20,36 @@ public class GitHubEndpointUriFactory extends org.apache.camel.support.component
private static final Set<String> PROPERTY_NAMES;
private static final Set<String> SECRET_PROPERTY_NAMES;
static {
- Set<String> props = new HashSet<>(16);
+ Set<String> props = new HashSet<>(32);
props.add("basicPropertyBinding");
+ props.add("backoffMultiplier");
+ props.add("synchronous");
+ props.add("initialDelay");
+ props.add("type");
+ props.add("scheduler");
+ props.add("password");
+ props.add("bridgeErrorHandler");
+ props.add("useFixedDelay");
+ props.add("runLoggingLevel");
+ props.add("backoffErrorThreshold");
+ props.add("greedy");
+ props.add("state");
+ props.add("scheduledExecutorService");
+ props.add("repeatCount");
+ props.add("timeUnit");
props.add("repoOwner");
props.add("repoName");
- props.add("synchronous");
+ props.add("sendEmptyMessageWhenIdle");
+ props.add("schedulerProperties");
props.add("exchangePattern");
props.add("branchName");
- props.add("type");
props.add("oauthToken");
props.add("encoding");
- props.add("password");
+ props.add("backoffIdleThreshold");
props.add("lazyStartProducer");
- props.add("bridgeErrorHandler");
- props.add("state");
+ props.add("delay");
+ props.add("pollStrategy");
+ props.add("startScheduler");
props.add("exceptionHandler");
props.add("targetUrl");
props.add("username");
diff --git a/components/camel-github/src/generated/resources/org/apache/camel/component/github/github.json b/components/camel-github/src/generated/resources/org/apache/camel/component/github/github.json
index 38dc743..ec31a44 100644
--- a/components/camel-github/src/generated/resources/org/apache/camel/component/github/github.json
+++ b/components/camel-github/src/generated/resources/org/apache/camel/component/github/github.json
@@ -35,13 +35,29 @@
"repoOwner": { "kind": "parameter", "displayName": "Repo Owner", "group": "common", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "secret": false, "description": "GitHub repository owner (organization)" },
"username": { "kind": "parameter", "displayName": "Username", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "GitHub username, required unless oauthToken is provided" },
"bridgeErrorHandler": { "kind": "parameter", "displayName": "Bridge Error Handler", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": 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 message and handled b [...]
+ "sendEmptyMessageWhenIdle": { "kind": "parameter", "displayName": "Send Empty Message When Idle", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead." },
"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, "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 consumer will deal with [...]
"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, "secret": false, "description": "Sets the exchange pattern when the consumer creates an exchange." },
+ "pollStrategy": { "kind": "parameter", "displayName": "Poll Strategy", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.PollingConsumerPollStrategy", "deprecated": false, "secret": false, "description": "A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange h [...]
"encoding": { "kind": "parameter", "displayName": "Encoding", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "To use the given encoding when getting a git commit file" },
"lazyStartProducer": { "kind": "parameter", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": 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 starting and cause the [...]
"state": { "kind": "parameter", "displayName": "State", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "enum": [ "error", "failure", "pending", "success" ], "deprecated": false, "secret": false, "description": "To set git commit status state" },
"targetUrl": { "kind": "parameter", "displayName": "Target Url", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "To set git commit status target url" },
"basicPropertyBinding": { "kind": "parameter", "displayName": "Basic Property Binding", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities" },
- "synchronous": { "kind": "parameter", "displayName": "Synchronous", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported)." }
+ "synchronous": { "kind": "parameter", "displayName": "Synchronous", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported)." },
+ "backoffErrorThreshold": { "kind": "parameter", "displayName": "Backoff Error Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "secret": false, "description": "The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in." },
+ "backoffIdleThreshold": { "kind": "parameter", "displayName": "Backoff Idle Threshold", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "secret": false, "description": "The number of subsequent idle polls that should happen before the backoffMultipler should kick-in." },
+ "backoffMultiplier": { "kind": "parameter", "displayName": "Backoff Multiplier", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "secret": false, "description": "To let the scheduled polling consumer backoff if there has been a number of subsequent idles\/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option [...]
+ "delay": { "kind": "parameter", "displayName": "Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "secret": false, "defaultValue": 500, "description": "Milliseconds before the next poll." },
+ "greedy": { "kind": "parameter", "displayName": "Greedy", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages." },
+ "initialDelay": { "kind": "parameter", "displayName": "Initial Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "secret": false, "defaultValue": 1000, "description": "Milliseconds before the first poll starts." },
+ "repeatCount": { "kind": "parameter", "displayName": "Repeat Count", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "integer", "javaType": "long", "deprecated": false, "secret": false, "defaultValue": 0, "description": "Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever." },
+ "runLoggingLevel": { "kind": "parameter", "displayName": "Run Logging Level", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "org.apache.camel.LoggingLevel", "enum": [ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF" ], "deprecated": false, "secret": false, "defaultValue": "TRACE", "description": "The consumer logs a start\/complete log line when it polls. This option allows you to configure the logging level for that." },
+ "scheduledExecutorService": { "kind": "parameter", "displayName": "Scheduled Executor Service", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.concurrent.ScheduledExecutorService", "deprecated": false, "secret": false, "description": "Allows for configuring a custom\/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool." },
+ "scheduler": { "kind": "parameter", "displayName": "Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.lang.Object", "deprecated": false, "secret": false, "defaultValue": "none", "description": "To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler" },
+ "schedulerProperties": { "kind": "parameter", "displayName": "Scheduler Properties", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.Map<java.lang.String, java.lang.Object>", "prefix": "scheduler.", "multiValue": true, "deprecated": false, "secret": false, "description": "To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler." },
+ "startScheduler": { "kind": "parameter", "displayName": "Start Scheduler", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": true, "description": "Whether the scheduler should be auto started." },
+ "timeUnit": { "kind": "parameter", "displayName": "Time Unit", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "object", "javaType": "java.util.concurrent.TimeUnit", "enum": [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ], "deprecated": false, "secret": false, "defaultValue": "MILLISECONDS", "description": "Time unit for initialDelay and delay options." },
+ "useFixedDelay": { "kind": "parameter", "displayName": "Use Fixed Delay", "group": "scheduler", "label": "consumer,scheduler", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": true, "description": "Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details." }
}
}
diff --git a/components/camel-github/src/main/docs/github-component.adoc b/components/camel-github/src/main/docs/github-component.adoc
index 1234b19..f262f4e 100644
--- a/components/camel-github/src/main/docs/github-component.adoc
+++ b/components/camel-github/src/main/docs/github-component.adoc
@@ -90,7 +90,7 @@ with the following path and query parameters:
|===
-=== Query Parameters (14 parameters):
+=== Query Parameters (30 parameters):
[width="100%",cols="2,5,^1,2",options="header"]
@@ -102,14 +102,30 @@ with the following path and query parameters:
| *repoOwner* (common) | *Required* GitHub repository owner (organization) | | String
| *username* (common) | GitHub username, required unless oauthToken is provided | | 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
+| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. | 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
+| *pollStrategy* (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPollStrategy
| *encoding* (producer) | To use the given encoding when getting a git commit file | | String
| *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 [...]
| *state* (producer) | To set git commit status state. There are 4 enums and the value can be one of: error, failure, pending, success | | String
| *targetUrl* (producer) | To set git commit status target url | | String
| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| *delay* (scheduler) | Milliseconds before the next poll. | 500 | long
+| *greedy* (scheduler) | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. | false | boolean
+| *initialDelay* (scheduler) | Milliseconds before the first poll starts. | 1000 | long
+| *repeatCount* (scheduler) | Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. | 0 | long
+| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. There are 6 enums and the value can be one of: TRACE, DEBUG, INFO, WARN, ERROR, OFF | TRACE | LoggingLevel
+| *scheduledExecutorService* (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutorService
+| *scheduler* (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler | none | Object
+| *schedulerProperties* (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. | | Map
+| *startScheduler* (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. There are 7 enums and the value can be one of: NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS | MILLISECONDS | TimeUnit
+| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
|===
// endpoint options: END
diff --git a/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubEndpoint.java b/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubEndpoint.java
index ca4c3b8..51c0a22 100644
--- a/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubEndpoint.java
+++ b/components/camel-github/src/main/java/org/apache/camel/component/github/GitHubEndpoint.java
@@ -34,7 +34,7 @@ import org.apache.camel.spi.Metadata;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
-import org.apache.camel.support.DefaultEndpoint;
+import org.apache.camel.support.ScheduledPollEndpoint;
import org.apache.camel.util.StringHelper;
/**
@@ -59,7 +59,7 @@ import org.apache.camel.util.StringHelper;
*/
@UriEndpoint(firstVersion = "2.15.0", scheme = "github", title = "GitHub", syntax = "github:type/branchName",
category = { Category.FILE, Category.CLOUD, Category.API })
-public class GitHubEndpoint extends DefaultEndpoint {
+public class GitHubEndpoint extends ScheduledPollEndpoint {
@UriPath
@Metadata(required = true)
@@ -109,17 +109,24 @@ public class GitHubEndpoint extends DefaultEndpoint {
@Override
public Consumer createConsumer(Processor processor) throws Exception {
+ Consumer consumer = null;
if (type == GitHubType.COMMIT) {
StringHelper.notEmpty(branchName, "branchName", this);
- return new CommitConsumer(this, processor, branchName);
+ consumer = new CommitConsumer(this, processor, branchName);
} else if (type == GitHubType.PULLREQUEST) {
- return new PullRequestConsumer(this, processor);
+ consumer = new PullRequestConsumer(this, processor);
} else if (type == GitHubType.PULLREQUESTCOMMENT) {
- return new PullRequestCommentConsumer(this, processor);
+ consumer = new PullRequestCommentConsumer(this, processor);
} else if (type == GitHubType.TAG) {
- return new TagConsumer(this, processor);
+ consumer = new TagConsumer(this, processor);
}
- throw new IllegalArgumentException("Cannot create consumer with type " + type);
+
+ if (consumer == null) {
+ throw new IllegalArgumentException("Cannot create consumer with type " + type);
+ }
+
+ configureConsumer(consumer);
+ return consumer;
}
public GitHubType getType() {
diff --git a/components/camel-github/src/test/java/org/apache/camel/component/github/consumer/SchedulerConfigurationConsumerTest.java b/components/camel-github/src/test/java/org/apache/camel/component/github/consumer/SchedulerConfigurationConsumerTest.java
new file mode 100644
index 0000000..56d47ef
--- /dev/null
+++ b/components/camel-github/src/test/java/org/apache/camel/component/github/consumer/SchedulerConfigurationConsumerTest.java
@@ -0,0 +1,48 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.camel.component.github.consumer;
+
+import org.apache.camel.EndpointInject;
+import org.apache.camel.builder.RouteBuilder;
+import org.apache.camel.component.github.GitHubComponent;
+import org.apache.camel.component.github.GitHubComponentTestBase;
+import org.apache.camel.component.mock.MockEndpoint;
+import org.junit.jupiter.api.Test;
+
+public class SchedulerConfigurationConsumerTest extends GitHubComponentTestBase {
+
+ @EndpointInject("mock:commits")
+ protected MockEndpoint mockCommitsEndpoint;
+
+ @Test
+ public void testSimpleSchedulerConsumerConfiguration() throws InterruptedException {
+ mockCommitsEndpoint.expectedMessageCount(5);
+ mockCommitsEndpoint.assertIsSatisfied(10000);
+ }
+
+ @Override
+ protected RouteBuilder createRouteBuilder() throws Exception {
+ return new RouteBuilder() {
+ @Override
+ public void configure() throws Exception {
+ context.addComponent("github", new GitHubComponent());
+ from("github://commit/master?username=someguy&password=apassword&repoOwner=anotherguy&repoName=somerepo&repeatCount=5&sendEmptyMessageWhenIdle=true&delay=1")
+ .to(mockCommitsEndpoint);
+ }
+ };
+ }
+}
diff --git a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/GitHubEndpointBuilderFactory.java b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/GitHubEndpointBuilderFactory.java
index b91a216..6a77aea 100644
--- a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/GitHubEndpointBuilderFactory.java
+++ b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/GitHubEndpointBuilderFactory.java
@@ -16,12 +16,17 @@
*/
package org.apache.camel.builder.endpoint.dsl;
+import java.util.Map;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
import org.apache.camel.ExchangePattern;
+import org.apache.camel.LoggingLevel;
import org.apache.camel.builder.EndpointConsumerBuilder;
import org.apache.camel.builder.EndpointProducerBuilder;
import org.apache.camel.builder.endpoint.AbstractEndpointBuilder;
import org.apache.camel.spi.ExceptionHandler;
+import org.apache.camel.spi.PollingConsumerPollStrategy;
/**
* Interact with the GitHub API.
@@ -136,6 +141,419 @@ public interface GitHubEndpointBuilderFactory {
doSetProperty("bridgeErrorHandler", bridgeErrorHandler);
return this;
}
+ /**
+ * If the polling consumer did not poll any files, you can enable this
+ * option to send an empty message (no body) instead.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: consumer
+ */
+ default GitHubEndpointConsumerBuilder sendEmptyMessageWhenIdle(
+ boolean sendEmptyMessageWhenIdle) {
+ doSetProperty("sendEmptyMessageWhenIdle", sendEmptyMessageWhenIdle);
+ return this;
+ }
+ /**
+ * If the polling consumer did not poll any files, you can enable this
+ * option to send an empty message (no body) instead.
+ *
+ * The option will be converted to a <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: consumer
+ */
+ default GitHubEndpointConsumerBuilder sendEmptyMessageWhenIdle(
+ String sendEmptyMessageWhenIdle) {
+ doSetProperty("sendEmptyMessageWhenIdle", sendEmptyMessageWhenIdle);
+ return this;
+ }
+ /**
+ * The number of subsequent error polls (failed due some error) that
+ * should happen before the backoffMultipler should kick-in.
+ *
+ * The option is a: <code>int</code> type.
+ *
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder backoffErrorThreshold(
+ int backoffErrorThreshold) {
+ doSetProperty("backoffErrorThreshold", backoffErrorThreshold);
+ return this;
+ }
+ /**
+ * The number of subsequent error polls (failed due some error) that
+ * should happen before the backoffMultipler should kick-in.
+ *
+ * The option will be converted to a <code>int</code> type.
+ *
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder backoffErrorThreshold(
+ String backoffErrorThreshold) {
+ doSetProperty("backoffErrorThreshold", backoffErrorThreshold);
+ return this;
+ }
+ /**
+ * The number of subsequent idle polls that should happen before the
+ * backoffMultipler should kick-in.
+ *
+ * The option is a: <code>int</code> type.
+ *
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder backoffIdleThreshold(
+ int backoffIdleThreshold) {
+ doSetProperty("backoffIdleThreshold", backoffIdleThreshold);
+ return this;
+ }
+ /**
+ * The number of subsequent idle polls that should happen before the
+ * backoffMultipler should kick-in.
+ *
+ * The option will be converted to a <code>int</code> type.
+ *
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder backoffIdleThreshold(
+ String backoffIdleThreshold) {
+ doSetProperty("backoffIdleThreshold", backoffIdleThreshold);
+ return this;
+ }
+ /**
+ * To let the scheduled polling consumer backoff if there has been a
+ * number of subsequent idles/errors in a row. The multiplier is then
+ * the number of polls that will be skipped before the next actual
+ * attempt is happening again. When this option is in use then
+ * backoffIdleThreshold and/or backoffErrorThreshold must also be
+ * configured.
+ *
+ * The option is a: <code>int</code> type.
+ *
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder backoffMultiplier(
+ int backoffMultiplier) {
+ doSetProperty("backoffMultiplier", backoffMultiplier);
+ return this;
+ }
+ /**
+ * To let the scheduled polling consumer backoff if there has been a
+ * number of subsequent idles/errors in a row. The multiplier is then
+ * the number of polls that will be skipped before the next actual
+ * attempt is happening again. When this option is in use then
+ * backoffIdleThreshold and/or backoffErrorThreshold must also be
+ * configured.
+ *
+ * The option will be converted to a <code>int</code> type.
+ *
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder backoffMultiplier(
+ String backoffMultiplier) {
+ doSetProperty("backoffMultiplier", backoffMultiplier);
+ return this;
+ }
+ /**
+ * Milliseconds before the next poll.
+ *
+ * The option is a: <code>long</code> type.
+ *
+ * Default: 500
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder delay(long delay) {
+ doSetProperty("delay", delay);
+ return this;
+ }
+ /**
+ * Milliseconds before the next poll.
+ *
+ * The option will be converted to a <code>long</code> type.
+ *
+ * Default: 500
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder delay(String delay) {
+ doSetProperty("delay", delay);
+ return this;
+ }
+ /**
+ * If greedy is enabled, then the ScheduledPollConsumer will run
+ * immediately again, if the previous run polled 1 or more messages.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder greedy(boolean greedy) {
+ doSetProperty("greedy", greedy);
+ return this;
+ }
+ /**
+ * If greedy is enabled, then the ScheduledPollConsumer will run
+ * immediately again, if the previous run polled 1 or more messages.
+ *
+ * The option will be converted to a <code>boolean</code> type.
+ *
+ * Default: false
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder greedy(String greedy) {
+ doSetProperty("greedy", greedy);
+ return this;
+ }
+ /**
+ * Milliseconds before the first poll starts.
+ *
+ * The option is a: <code>long</code> type.
+ *
+ * Default: 1000
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder initialDelay(long initialDelay) {
+ doSetProperty("initialDelay", initialDelay);
+ return this;
+ }
+ /**
+ * Milliseconds before the first poll starts.
+ *
+ * The option will be converted to a <code>long</code> type.
+ *
+ * Default: 1000
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder initialDelay(String initialDelay) {
+ doSetProperty("initialDelay", initialDelay);
+ return this;
+ }
+ /**
+ * Specifies a maximum limit of number of fires. So if you set it to 1,
+ * the scheduler will only fire once. If you set it to 5, it will only
+ * fire five times. A value of zero or negative means fire forever.
+ *
+ * The option is a: <code>long</code> type.
+ *
+ * Default: 0
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder repeatCount(long repeatCount) {
+ doSetProperty("repeatCount", repeatCount);
+ return this;
+ }
+ /**
+ * Specifies a maximum limit of number of fires. So if you set it to 1,
+ * the scheduler will only fire once. If you set it to 5, it will only
+ * fire five times. A value of zero or negative means fire forever.
+ *
+ * The option will be converted to a <code>long</code> type.
+ *
+ * Default: 0
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder repeatCount(String repeatCount) {
+ doSetProperty("repeatCount", repeatCount);
+ return this;
+ }
+ /**
+ * The consumer logs a start/complete log line when it polls. This
+ * option allows you to configure the logging level for that.
+ *
+ * The option is a: <code>org.apache.camel.LoggingLevel</code> type.
+ *
+ * Default: TRACE
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder runLoggingLevel(
+ LoggingLevel runLoggingLevel) {
+ doSetProperty("runLoggingLevel", runLoggingLevel);
+ return this;
+ }
+ /**
+ * The consumer logs a start/complete log line when it polls. This
+ * option allows you to configure the logging level for that.
+ *
+ * The option will be converted to a
+ * <code>org.apache.camel.LoggingLevel</code> type.
+ *
+ * Default: TRACE
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder runLoggingLevel(
+ String runLoggingLevel) {
+ doSetProperty("runLoggingLevel", runLoggingLevel);
+ return this;
+ }
+ /**
+ * Allows for configuring a custom/shared thread pool to use for the
+ * consumer. By default each consumer has its own single threaded thread
+ * pool.
+ *
+ * The option is a:
+ * <code>java.util.concurrent.ScheduledExecutorService</code> type.
+ *
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder scheduledExecutorService(
+ ScheduledExecutorService scheduledExecutorService) {
+ doSetProperty("scheduledExecutorService", scheduledExecutorService);
+ return this;
+ }
+ /**
+ * Allows for configuring a custom/shared thread pool to use for the
+ * consumer. By default each consumer has its own single threaded thread
+ * pool.
+ *
+ * The option will be converted to a
+ * <code>java.util.concurrent.ScheduledExecutorService</code> type.
+ *
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder scheduledExecutorService(
+ String scheduledExecutorService) {
+ doSetProperty("scheduledExecutorService", scheduledExecutorService);
+ return this;
+ }
+ /**
+ * To use a cron scheduler from either camel-spring or camel-quartz
+ * component. Use value spring or quartz for built in scheduler.
+ *
+ * The option is a: <code>java.lang.Object</code> type.
+ *
+ * Default: none
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder scheduler(Object scheduler) {
+ doSetProperty("scheduler", scheduler);
+ return this;
+ }
+ /**
+ * To use a cron scheduler from either camel-spring or camel-quartz
+ * component. Use value spring or quartz for built in scheduler.
+ *
+ * The option will be converted to a <code>java.lang.Object</code> type.
+ *
+ * Default: none
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder scheduler(String scheduler) {
+ doSetProperty("scheduler", scheduler);
+ return this;
+ }
+ /**
+ * To configure additional properties when using a custom scheduler or
+ * any of the Quartz, Spring based scheduler.
+ *
+ * The option is a: <code>java.util.Map<java.lang.String,
+ * java.lang.Object></code> type.
+ * The option is multivalued, and you can use the
+ * schedulerProperties(String, Object) method to add a value (call the
+ * method multiple times to set more values).
+ *
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder schedulerProperties(
+ String key,
+ Object value) {
+ doSetMultiValueProperty("schedulerProperties", "scheduler." + key, value);
+ return this;
+ }
+ /**
+ * To configure additional properties when using a custom scheduler or
+ * any of the Quartz, Spring based scheduler.
+ *
+ * The option is a: <code>java.util.Map<java.lang.String,
+ * java.lang.Object></code> type.
+ * The option is multivalued, and you can use the
+ * schedulerProperties(String, Object) method to add a value (call the
+ * method multiple times to set more values).
+ *
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder schedulerProperties(Map values) {
+ doSetMultiValueProperties("schedulerProperties", "scheduler.", values);
+ return this;
+ }
+ /**
+ * Whether the scheduler should be auto started.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: true
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder startScheduler(
+ boolean startScheduler) {
+ doSetProperty("startScheduler", startScheduler);
+ return this;
+ }
+ /**
+ * Whether the scheduler should be auto started.
+ *
+ * The option will be converted to a <code>boolean</code> type.
+ *
+ * Default: true
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder startScheduler(
+ String startScheduler) {
+ doSetProperty("startScheduler", startScheduler);
+ return this;
+ }
+ /**
+ * Time unit for initialDelay and delay options.
+ *
+ * The option is a: <code>java.util.concurrent.TimeUnit</code> type.
+ *
+ * Default: MILLISECONDS
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder timeUnit(TimeUnit timeUnit) {
+ doSetProperty("timeUnit", timeUnit);
+ return this;
+ }
+ /**
+ * Time unit for initialDelay and delay options.
+ *
+ * The option will be converted to a
+ * <code>java.util.concurrent.TimeUnit</code> type.
+ *
+ * Default: MILLISECONDS
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder timeUnit(String timeUnit) {
+ doSetProperty("timeUnit", timeUnit);
+ return this;
+ }
+ /**
+ * Controls if fixed delay or fixed rate is used. See
+ * ScheduledExecutorService in JDK for details.
+ *
+ * The option is a: <code>boolean</code> type.
+ *
+ * Default: true
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder useFixedDelay(
+ boolean useFixedDelay) {
+ doSetProperty("useFixedDelay", useFixedDelay);
+ return this;
+ }
+ /**
+ * Controls if fixed delay or fixed rate is used. See
+ * ScheduledExecutorService in JDK for details.
+ *
+ * The option will be converted to a <code>boolean</code> type.
+ *
+ * Default: true
+ * Group: scheduler
+ */
+ default GitHubEndpointConsumerBuilder useFixedDelay(String useFixedDelay) {
+ doSetProperty("useFixedDelay", useFixedDelay);
+ return this;
+ }
}
/**
@@ -205,6 +623,38 @@ public interface GitHubEndpointBuilderFactory {
return this;
}
/**
+ * A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing
+ * you to provide your custom implementation to control error handling
+ * usually occurred during the poll operation before an Exchange have
+ * been created and being routed in Camel.
+ *
+ * The option is a:
+ * <code>org.apache.camel.spi.PollingConsumerPollStrategy</code> type.
+ *
+ * Group: consumer (advanced)
+ */
+ default AdvancedGitHubEndpointConsumerBuilder pollStrategy(
+ PollingConsumerPollStrategy pollStrategy) {
+ doSetProperty("pollStrategy", pollStrategy);
+ return this;
+ }
+ /**
+ * A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing
+ * you to provide your custom implementation to control error handling
+ * usually occurred during the poll operation before an Exchange have
+ * been created and being routed in Camel.
+ *
+ * The option will be converted to a
+ * <code>org.apache.camel.spi.PollingConsumerPollStrategy</code> type.
+ *
+ * Group: consumer (advanced)
+ */
+ default AdvancedGitHubEndpointConsumerBuilder pollStrategy(
+ String pollStrategy) {
+ doSetProperty("pollStrategy", pollStrategy);
+ return this;
+ }
+ /**
* Whether the endpoint should use basic property binding (Camel 2.x) or
* the newer property binding with additional capabilities.
*
diff --git a/docs/components/modules/ROOT/pages/github-component.adoc b/docs/components/modules/ROOT/pages/github-component.adoc
index 039f98d..38f5383 100644
--- a/docs/components/modules/ROOT/pages/github-component.adoc
+++ b/docs/components/modules/ROOT/pages/github-component.adoc
@@ -92,7 +92,7 @@ with the following path and query parameters:
|===
-=== Query Parameters (14 parameters):
+=== Query Parameters (30 parameters):
[width="100%",cols="2,5,^1,2",options="header"]
@@ -104,14 +104,30 @@ with the following path and query parameters:
| *repoOwner* (common) | *Required* GitHub repository owner (organization) | | String
| *username* (common) | GitHub username, required unless oauthToken is provided | | 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
+| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. | 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
+| *pollStrategy* (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | | PollingConsumerPollStrategy
| *encoding* (producer) | To use the given encoding when getting a git commit file | | String
| *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 [...]
| *state* (producer) | To set git commit status state. There are 4 enums and the value can be one of: error, failure, pending, success | | String
| *targetUrl* (producer) | To set git commit status target url | | String
| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean
+| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int
+| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int
+| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | | int
+| *delay* (scheduler) | Milliseconds before the next poll. | 500 | long
+| *greedy* (scheduler) | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. | false | boolean
+| *initialDelay* (scheduler) | Milliseconds before the first poll starts. | 1000 | long
+| *repeatCount* (scheduler) | Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. | 0 | long
+| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. There are 6 enums and the value can be one of: TRACE, DEBUG, INFO, WARN, ERROR, OFF | TRACE | LoggingLevel
+| *scheduledExecutorService* (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutorService
+| *scheduler* (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler | none | Object
+| *schedulerProperties* (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. | | Map
+| *startScheduler* (scheduler) | Whether the scheduler should be auto started. | true | boolean
+| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. There are 7 enums and the value can be one of: NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS | MILLISECONDS | TimeUnit
+| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
|===
// endpoint options: END