Package org.apache.camel.builder.component.dsl

Interface QuartzComponentBuilderFactory.QuartzComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.quartz.QuartzComponent>
All Known Implementing Classes:
QuartzComponentBuilderFactory.QuartzComponentBuilderImpl
Enclosing interface:
QuartzComponentBuilderFactory
public static interface QuartzComponentBuilderFactory.QuartzComponentBuilder extends ComponentBuilder<org.apache.camel.component.quartz.QuartzComponent>
Builder for the Quartz component.

  • Method Details

    • bridgeErrorHandler

      default QuartzComponentBuilderFactory.QuartzComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      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. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • enableJmx

      default QuartzComponentBuilderFactory.QuartzComponentBuilder enableJmx(boolean enableJmx)
      Whether to enable Quartz JMX which allows to manage the Quartz scheduler from JMX. This options is default true. The option is a: <code>boolean</code> type. Default: true Group: consumer
      Parameters:
      enableJmx - the value to set
      Returns:
      the dsl builder

    • prefixInstanceName

      default QuartzComponentBuilderFactory.QuartzComponentBuilder prefixInstanceName(boolean prefixInstanceName)
      Whether to prefix the Quartz Scheduler instance name with the CamelContext name. This is enabled by default, to let each CamelContext use its own Quartz scheduler instance by default. You can set this option to false to reuse Quartz scheduler instances between multiple CamelContext's. The option is a: <code>boolean</code> type. Default: true Group: consumer
      Parameters:
      prefixInstanceName - the value to set
      Returns:
      the dsl builder

    • prefixJobNameWithEndpointId

      default QuartzComponentBuilderFactory.QuartzComponentBuilder prefixJobNameWithEndpointId(boolean prefixJobNameWithEndpointId)
      Whether to prefix the quartz job with the endpoint id. This option is default false. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      prefixJobNameWithEndpointId - the value to set
      Returns:
      the dsl builder

    • properties

      default QuartzComponentBuilderFactory.QuartzComponentBuilder properties(Map properties)
      Properties to configure the Quartz scheduler. The option is a: <code>java.util.Map</code> type. Group: consumer
      Parameters:
      properties - the value to set
      Returns:
      the dsl builder

    • propertiesFile

      default QuartzComponentBuilderFactory.QuartzComponentBuilder propertiesFile(String propertiesFile)
      File name of the properties to load from the classpath. This option can also be loaded from an existing file, by prefixing with file: or classpath: followed by the location of the file. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      propertiesFile - the value to set
      Returns:
      the dsl builder

    • propertiesRef

      default QuartzComponentBuilderFactory.QuartzComponentBuilder propertiesRef(String propertiesRef)
      References to an existing Properties or Map to lookup in the registry to use for configuring quartz. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      propertiesRef - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default QuartzComponentBuilderFactory.QuartzComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • scheduler

      default QuartzComponentBuilderFactory.QuartzComponentBuilder scheduler(org.quartz.Scheduler scheduler)
      To use the custom configured Quartz scheduler, instead of creating a new Scheduler. The option is a: <code>org.quartz.Scheduler</code> type. Group: advanced
      Parameters:
      scheduler - the value to set
      Returns:
      the dsl builder

    • schedulerFactory

      default QuartzComponentBuilderFactory.QuartzComponentBuilder schedulerFactory(org.quartz.SchedulerFactory schedulerFactory)
      To use the custom SchedulerFactory which is used to create the Scheduler. The option is a: <code>org.quartz.SchedulerFactory</code> type. Group: advanced
      Parameters:
      schedulerFactory - the value to set
      Returns:
      the dsl builder

    • autoStartScheduler

      default QuartzComponentBuilderFactory.QuartzComponentBuilder autoStartScheduler(boolean autoStartScheduler)
      Whether the scheduler should be auto started. This option is default true. The option is a: <code>boolean</code> type. Default: true Group: scheduler
      Parameters:
      autoStartScheduler - the value to set
      Returns:
      the dsl builder

    • interruptJobsOnShutdown

      default QuartzComponentBuilderFactory.QuartzComponentBuilder interruptJobsOnShutdown(boolean interruptJobsOnShutdown)
      Whether to interrupt jobs on shutdown which forces the scheduler to shutdown quicker and attempt to interrupt any running jobs. If this is enabled then any running jobs can fail due to being interrupted. When a job is interrupted then Camel will mark the exchange to stop continue routing and set java.util.concurrent.RejectedExecutionException as caused exception. Therefore use this with care, as its often better to allow Camel jobs to complete and shutdown gracefully. The option is a: <code>boolean</code> type. Default: false Group: scheduler
      Parameters:
      interruptJobsOnShutdown - the value to set
      Returns:
      the dsl builder