Permalink
Switch branches/tags
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
367 lines (321 sloc) 14 KB
---
apiVersion: v1
kind: ConfigMap
metadata:
labels:
funktion.fabric8.io/kind: Connector
name: timer
data:
deployment.yml: |
---
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
labels:
funktion.fabric8.io/kind: Subscription
connector: timer
spec:
replicas: 1
template:
metadata:
labels:
funktion.fabric8.io/kind: Subscription
connector: timer
spec:
containers:
- image: funktion/connector-timer:${project.version}
name: connector
schema.yml: |
---
component:
kind: component
scheme: timer
syntax: timer:timerName
title: Timer
description: The timer component is used for generating message exchanges when a timer fires.
label: core,scheduling
deprecated: false
async: false
consumerOnly: true
javaType: org.apache.camel.component.timer.TimerComponent
groupId: org.apache.camel
artifactId: camel-core
version: 2.18.3
componentProperties: {}
properties:
timerName:
kind: path
group: consumer
required: true
type: string
javaType: java.lang.String
deprecated: false
secret: false
description: The name of the timer
order: 0
bridgeErrorHandler:
kind: parameter
group: consumer
label: consumer
type: boolean
javaType: boolean
optionalPrefix: consumer.
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 by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
order: 1
delay:
kind: parameter
group: consumer
type: integer
javaType: long
deprecated: false
secret: false
defaultValue: "1000"
description: The number of milliseconds to wait before the first event is generated. Should not be used in conjunction with the time option. The default value is 1000. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
order: 2
fixedRate:
kind: parameter
group: consumer
type: boolean
javaType: boolean
deprecated: false
secret: false
defaultValue: false
description: Events take place at approximately regular intervals separated by the specified period.
order: 3
period:
kind: parameter
group: consumer
type: integer
javaType: long
deprecated: false
secret: false
defaultValue: "1000"
description: If greater than 0 generate periodic events every period milliseconds. The default value is 1000. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
order: 4
repeatCount:
kind: parameter
group: consumer
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 timer 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.
order: 5
exceptionHandler:
kind: parameter
group: consumer (advanced)
label: consumer,advanced
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 options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
order: 6
exchangePattern:
kind: parameter
group: consumer (advanced)
label: consumer,advanced
type: string
javaType: org.apache.camel.ExchangePattern
enum:
- InOnly
- RobustInOnly
- InOut
- InOptionalOut
- OutOnly
- RobustOutOnly
- OutIn
- OutOptionalIn
deprecated: false
secret: false
description: Sets the default exchange pattern when creating an exchange.
order: 7
daemon:
kind: parameter
group: advanced
label: advanced
type: boolean
javaType: boolean
deprecated: false
secret: false
defaultValue: true
description: Specifies whether or not the thread associated with the timer endpoint runs as a daemon. The default value is true.
order: 8
pattern:
kind: parameter
group: advanced
label: advanced
type: string
javaType: java.lang.String
deprecated: false
secret: false
description: Allows you to specify a custom Date pattern to use for setting the time option using URI syntax.
order: 9
synchronous:
kind: parameter
group: advanced
label: advanced
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).
order: 10
time:
kind: parameter
group: advanced
label: advanced
type: string
javaType: java.util.Date
deprecated: false
secret: false
description: 'A java.util.Date the first event should be generated. If using the
URI the pattern expected is: yyyy-MM-dd HH:mm:ss or yyyy-MM-dd''T''HH:mm:ss.'
order: 11
timer:
kind: parameter
group: advanced
label: advanced
type: object
javaType: java.util.Timer
deprecated: false
secret: false
description: To use a custom Timer
order: 12
documentation.adoc: |+
[[Timer-TimerComponent]]
Timer Component
~~~~~~~~~~~~~~~
The *timer:* component is used to generate message exchanges when a
timer fires You can only consume events from this endpoint.
[[Timer-URIformat]]
URI format
^^^^^^^^^^
[source,java]
--------------------
timer:name[?options]
--------------------
Where `name` is the name of the `Timer` object, which is created and
shared across endpoints. So if you use the same name for all your timer
endpoints, only one `Timer` object and thread will be used.
You can append query options to the URI in the following format,
`?option=value&option=value&...`
*Note:* The IN body of the generated exchange is `null`. So
`exchange.getIn().getBody()` returns `null`.
TIP:*Advanced Scheduler*
See also the link:quartz.html[Quartz] component that supports much more
advanced scheduling.
TIP:*Specify time in human friendly format*
In *Camel 2.3* onwards you can specify the time in
link:how-do-i-specify-time-period-in-a-human-friendly-syntax.html[human
friendly syntax].
[[Timer-Options]]
Options
^^^^^^^
// component options: START
The Timer component has no options.
// component options: END
// endpoint options: START
The Timer component supports 13 endpoint options which are listed below:
{% raw %}
[width="100%",cols="2,1,1m,1m,5",options="header"]
|=======================================================================
| Name | Group | Default | Java Type | Description
| timerName | consumer | | String | *Required* The name of the timer
| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
| delay | consumer | 1000 | long | The number of milliseconds to wait before the first event is generated. Should not be used in conjunction with the time option. The default value is 1000. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
| fixedRate | consumer | false | boolean | Events take place at approximately regular intervals separated by the specified period.
| period | consumer | 1000 | long | If greater than 0 generate periodic events every period milliseconds. The default value is 1000. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
| repeatCount | consumer | 0 | long | Specifies a maximum limit of number of fires. So if you set it to 1 the timer 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.
| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the default exchange pattern when creating an exchange.
| daemon | advanced | true | boolean | Specifies whether or not the thread associated with the timer endpoint runs as a daemon. The default value is true.
| pattern | advanced | | String | Allows you to specify a custom Date pattern to use for setting the time option using URI syntax.
| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
| time | advanced | | Date | A java.util.Date the first event should be generated. If using the URI the pattern expected is: yyyy-MM-dd HH:mm:ss or yyyy-MM-dd'T'HH:mm:ss.
| timer | advanced | | Timer | To use a custom Timer
|=======================================================================
{% endraw %}
// endpoint options: END
[[Timer-ExchangeProperties]]
Exchange Properties
^^^^^^^^^^^^^^^^^^^
When the timer is fired, it adds the following information as properties
to the `Exchange`:
[width="100%",cols="10%,10%,80%",options="header",]
|=======================================================================
|Name |Type |Description
|`Exchange.TIMER_NAME` |`String` |The value of the `name` option.
|`Exchange.TIMER_TIME` |`Date` |The value of the `time` option.
|`Exchange.TIMER_PERIOD` |`long` |The value of the `period` option.
|`Exchange.TIMER_FIRED_TIME` |`Date` |The time when the consumer fired.
|`Exchange.TIMER_COUNTER` |`Long` |*Camel 2.8:* The current fire counter. Starts from 1.
|=======================================================================
[[Timer-Sample]]
Sample
^^^^^^
To set up a route that generates an event every 60 seconds:
[source,java]
-------------------------------------------------------------------------------------------
from("timer://foo?fixedRate=true&period=60000").to("bean:myBean?method=someMethodName");
-------------------------------------------------------------------------------------------
TIP:Instead of 60000 you can use period=60s which is more friendly to read.
The above route will generate an event and then invoke the
`someMethodName` method on the bean called `myBean` in the
link:registry.html[Registry] such as JNDI or link:spring.html[Spring].
And the route in Spring DSL:
[source,xml]
-------------------------------------------------------------
<route>
<from uri="timer://foo?fixedRate=true&amp;period=60000"/>
<to uri="bean:myBean?method=someMethodName"/>
</route>
-------------------------------------------------------------
[[Timer-Firingassoonaspossible]]
Firing as soon as possible
++++++++++++++++++++++++++
[[Timer-AvailableasofCamel2.17]]
Available as of Camel 2.17
++++++++++++++++++++++++++
You may want to fire messages in a Camel route as soon as possible you
can use a negative delay:
[source,xml]
-------------------------------------------------
<route>
<from uri="timer://foo?delay=-1"/>
<to uri="bean:myBean?method=someMethodName"/>
</route>
-------------------------------------------------
In this way the timer will fire messages immediately.
You can also specify a repeatCount parameter in conjunction with a
negative delay to stop firing messages after a fixed number has been
reached.
If you don't specify a repeatCount then the timer will continue firing
messages until the route will be stopped. 
[[Timer-Firingonlyonce]]
Firing only once
++++++++++++++++
*Available as of Camel 2.8*
You may want to fire a message in a Camel route only once, such as when
starting the route. To do that you use the repeatCount option as shown:
[source,xml]
-------------------------------------------------
<route>
<from uri="timer://foo?repeatCount=1"/>
<to uri="bean:myBean?method=someMethodName"/>
</route>
-------------------------------------------------
[[Timer-SeeAlso]]
See Also
^^^^^^^^
* link:configuring-camel.html[Configuring Camel]
* link:component.html[Component]
* link:endpoint.html[Endpoint]
* link:getting-started.html[Getting Started]
* link:quartz.html[Quartz]