---
apiVersion: v1
kind: List
items:
- apiVersion: v1
  kind: ConfigMap
  metadata:
    labels:
      funktion.fabric8.io/kind: Connector
      provider: fabric8
      project: connector-scheduler
      version: 1.1.31
      group: io.fabric8.funktion.connector
    name: scheduler
  data:
    deployment.yml: |
      ---
      apiVersion: extensions/v1beta1
      kind: Deployment
      metadata:
        labels:
          funktion.fabric8.io/kind: Subscription
          connector: scheduler
      spec:
        replicas: 1
        template:
          metadata:
            labels:
              funktion.fabric8.io/kind: Subscription
              connector: scheduler
          spec:
            containers:
            - image: fabric8/connector-scheduler:1.1.31
              name: connector
    schema.yml: |
      ---
      component:
        kind: component
        scheme: scheduler
        syntax: scheduler:name
        title: Scheduler
        description: The scheduler component is used for generating message exchanges when a scheduler fires.
        label: core,scheduling
        deprecated: false
        async: false
        consumerOnly: true
        javaType: org.apache.camel.component.scheduler.SchedulerComponent
        groupId: org.apache.camel
        artifactId: camel-core
        version: 2.18.1
      componentProperties:
        concurrentTasks:
          kind: property
          type: integer
          javaType: int
          deprecated: false
          secret: false
          description: Number of threads used by the scheduling thread pool. Is by default using a single thread
      properties:
        name:
          kind: path
          group: consumer
          required: true
          type: string
          javaType: java.lang.String
          deprecated: false
          secret: false
          description: The name of the scheduler
        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.
        sendEmptyMessageWhenIdle:
          kind: parameter
          group: consumer
          label: consumer
          type: boolean
          javaType: boolean
          optionalPrefix: consumer.
          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
          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.
        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.
        pollStrategy:
          kind: parameter
          group: consumer (advanced)
          label: consumer,advanced
          type: object
          javaType: org.apache.camel.spi.PollingConsumerPollStrategy
          optionalPrefix: consumer.
          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 have been created and being routed in Camel. In other words the error occurred while the polling was gathering information for instance access to a file network failed so Camel cannot access it to scan for files. The default implementation will log the caused exception at WARN level and ignore it.
        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).
        backoffErrorThreshold:
          kind: parameter
          group: scheduler
          label: consumer,scheduler
          type: integer
          javaType: int
          optionalPrefix: consumer.
          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
          group: scheduler
          label: consumer,scheduler
          type: integer
          javaType: int
          optionalPrefix: consumer.
          deprecated: false
          secret: false
          description: The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
        backoffMultiplier:
          kind: parameter
          group: scheduler
          label: consumer,scheduler
          type: integer
          javaType: int
          optionalPrefix: consumer.
          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 is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
        concurrentTasks:
          kind: parameter
          group: scheduler
          label: scheduler
          type: integer
          javaType: int
          deprecated: false
          secret: false
          defaultValue: "1"
          description: Number of threads used by the scheduling thread pool. Is by default using a single thread
        delay:
          kind: parameter
          group: scheduler
          label: consumer,scheduler
          type: integer
          javaType: long
          optionalPrefix: consumer.
          deprecated: false
          secret: false
          defaultValue: "500"
          description: Milliseconds before the next poll. The default value is 500. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
        greedy:
          kind: parameter
          group: scheduler
          label: consumer,scheduler
          type: boolean
          javaType: boolean
          optionalPrefix: consumer.
          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
          group: scheduler
          label: consumer,scheduler
          type: integer
          javaType: long
          optionalPrefix: consumer.
          deprecated: false
          secret: false
          defaultValue: "1000"
          description: Milliseconds before the first poll starts. 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).
        runLoggingLevel:
          kind: parameter
          group: scheduler
          label: consumer,scheduler
          type: string
          javaType: org.apache.camel.LoggingLevel
          enum:
          - TRACE
          - DEBUG
          - INFO
          - WARN
          - ERROR
          - OFF
          optionalPrefix: consumer.
          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
          group: scheduler
          label: consumer,scheduler
          type: object
          javaType: java.util.concurrent.ScheduledExecutorService
          optionalPrefix: consumer.
          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. This option allows you to share a thread pool among multiple consumers.
        scheduler:
          kind: parameter
          group: scheduler
          label: consumer,scheduler
          type: string
          javaType: org.apache.camel.spi.ScheduledPollConsumerScheduler
          enum:
          - none
          - spring
          - quartz2
          optionalPrefix: consumer.
          deprecated: false
          secret: false
          defaultValue: none
          description: 'Allow to plugin a custom org.apache.camel.spi.ScheduledPollConsumerScheduler
            to use as the scheduler for firing when the polling consumer runs. The default
            implementation uses the ScheduledExecutorService and there is a Quartz2 and
            Spring based which supports CRON expressions. Notice: If using a custom scheduler
            then the options for initialDelay useFixedDelay timeUnit and scheduledExecutorService
            may not be in use. Use the text quartz2 to refer to use the Quartz2 scheduler;
            and use the text spring to use the Spring based; and use the text myScheduler
            to refer to a custom scheduler by its id in the Registry. See Quartz2 page for
            an example.'
        schedulerProperties:
          kind: parameter
          group: scheduler
          label: consumer,scheduler
          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 Quartz2 Spring based scheduler.
        startScheduler:
          kind: parameter
          group: scheduler
          label: consumer,scheduler
          type: boolean
          javaType: boolean
          optionalPrefix: consumer.
          deprecated: false
          secret: false
          defaultValue: true
          description: Whether the scheduler should be auto started.
        timeUnit:
          kind: parameter
          group: scheduler
          label: consumer,scheduler
          type: string
          javaType: java.util.concurrent.TimeUnit
          enum:
          - NANOSECONDS
          - MICROSECONDS
          - MILLISECONDS
          - SECONDS
          - MINUTES
          - HOURS
          - DAYS
          optionalPrefix: consumer.
          deprecated: false
          secret: false
          defaultValue: MILLISECONDS
          description: Time unit for initialDelay and delay options.
        useFixedDelay:
          kind: parameter
          group: scheduler
          label: consumer,scheduler
          type: boolean
          javaType: boolean
          optionalPrefix: consumer.
          deprecated: false
          secret: false
          defaultValue: true
          description: Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
    documentation.adoc: |+
      [[Scheduler-SchedulerComponent]]
      Scheduler Component
      ~~~~~~~~~~~~~~~~~~~

      *Available as of Camel 2.15*

      The *scheduler:* component is used to generate message exchanges when a
      scheduler fires. This component is similar to the
      ??link:timer.html[Timer]??component, but it offers more functionality in
      terms of scheduling. Also this component uses
      JDK??`ScheduledExecutorService`. Where as the timer uses a JDK??`Timer`.

      You can only consume events from this endpoint.

      [[Scheduler-URIformat]]
      URI format
      ^^^^^^^^^^

      [source,java]
      ------------------------
      scheduler:name[?options]
      ------------------------

      Where `name` is the name of the scheduler, which is created and shared
      across endpoints. So if you use the same name for all your timer
      endpoints, only one scheduler thread pool??and thread will be used - but
      you can configure the thread pool to allow more concurrent threads.

      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`.

      [[Scheduler-Options]]
      Options
      ^^^^^^^

      // component options: START
      The Scheduler component supports 1 options which are listed below.



      {% raw %}
      [width="100%",cols="2,1m,7",options="header"]
      |=======================================================================
      | Name | Java Type | Description
      | concurrentTasks | int | Number of threads used by the scheduling thread pool. Is by default using a single thread
      |=======================================================================
      {% endraw %}
      // component options: END


      // endpoint options: START
      The Scheduler component supports 21 endpoint options which are listed below:

      {% raw %}
      [width="100%",cols="2,1,1m,1m,5",options="header"]
      |=======================================================================
      | Name | Group | Default | Java Type | Description
      | name | consumer |  | String | *Required* The name of the scheduler
      | 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.
      | sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
      | 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.
      | pollStrategy | consumer (advanced) |  | PollingConsumerPollStrategy | 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. In other words the error occurred while the polling was gathering information for instance access to a file network failed so Camel cannot access it to scan for files. The default implementation will log the caused exception at WARN level and ignore it.
      | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
      | backoffErrorThreshold | scheduler |  | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
      | backoffIdleThreshold | scheduler |  | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
      | backoffMultiplier | scheduler |  | int | 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.
      | concurrentTasks | scheduler | 1 | int | Number of threads used by the scheduling thread pool. Is by default using a single thread
      | delay | scheduler | 500 | long | Milliseconds before the next poll. The default value is 500. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
      | greedy | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
      | initialDelay | scheduler | 1000 | long | Milliseconds before the first poll starts. 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).
      | runLoggingLevel | scheduler | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
      | scheduledExecutorService | scheduler |  | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. This option allows you to share a thread pool among multiple consumers.
      | scheduler | scheduler | none | ScheduledPollConsumerScheduler | Allow to plugin a custom org.apache.camel.spi.ScheduledPollConsumerScheduler to use as the scheduler for firing when the polling consumer runs. The default implementation uses the ScheduledExecutorService and there is a Quartz2 and Spring based which supports CRON expressions. Notice: If using a custom scheduler then the options for initialDelay useFixedDelay timeUnit and scheduledExecutorService may not be in use. Use the text quartz2 to refer to use the Quartz2 scheduler; and use the text spring to use the Spring based; and use the text myScheduler to refer to a custom scheduler by its id in the Registry. See Quartz2 page for an example.
      | schedulerProperties | scheduler |  | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
      | startScheduler | scheduler | true | boolean | Whether the scheduler should be auto started.
      | timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
      | useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
      |=======================================================================
      {% endraw %}
      // endpoint options: END


      [[Scheduler-Moreinformation]]
      More information
      ^^^^^^^^^^^^^^^^

      This component is a scheduler
      http://camel.apache.org/polling-consumer.html[Polling Consumer]??where
      you can find more information about the options above, and examples at
      the http://camel.apache.org/polling-consumer.html[Polling
      Consumer]??page.

      [[Scheduler-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_FIRED_TIME` |`Date` |The time when the consumer fired.
      |=======================================================================

      [[Scheduler-Sample]]
      Sample
      ^^^^^^

      To set up a route that generates an event every 60 seconds:

      [source,java]
      ------------------------------------------------------------------------------
         from("scheduler://foo?period=60s").to("bean:myBean?method=someMethodName");
      ------------------------------------------------------------------------------

      ??

      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="scheduler://foo?period=60s"/>
          <to uri="bean:myBean?method=someMethodName"/>
        </route>
      -------------------------------------------------

      ??

      [[Scheduler-Forcingtheschedulertotriggerimmediatelywhencompleted]]
      Forcing the scheduler to trigger immediately when completed
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

      To let the scheduler trigger as soon as the previous task is complete,
      you can set the option greedy=true. But beware then the scheduler will
      keep firing all the time. So use this with caution.

      [[Scheduler-Forcingtheschedulertobeidle]]
      Forcing the scheduler to be idle
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

      There can be use cases where you want the scheduler to trigger and be
      greedy. But sometimes you want "tell the scheduler" that there was no
      task to poll, so the scheduler can change into idle mode using the
      backoff options. To do this you would need to set a property on the
      exchange with the key??`Exchange.SCHEDULER_POLLED_MESSAGES` to a boolean
      value of false. This will cause the consumer to indicate that there was
      no messages polled.??

      The consumer will otherwise as by default return 1 message polled to the
      scheduler, every time the consumer has completed processing the
      exchange.

      ??

      [[Scheduler-SeeAlso]]
      See Also
      ^^^^^^^^

      * link:configuring-camel.html[Configuring Camel]
      * link:component.html[Component]
      * link:endpoint.html[Endpoint]
      * link:getting-started.html[Getting Started]

      * link:timer.html[Timer]
      * link:quartz.html[Quartz]

