Package org.apache.camel.builder.endpoint.dsl

Interface XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
XQueryEndpointBuilderFactory.XQueryEndpointBuilder
Enclosing interface:
XQueryEndpointBuilderFactory
public static interface XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the XQuery component.

  • Method Details

    • advanced

      default XQueryEndpointBuilderFactory.AdvancedXQueryEndpointConsumerBuilder advanced()

    • allowStAX

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder allowStAX(boolean allowStAX)
      Whether to allow using StAX mode. The option is a: <code>boolean</code> type. Default: false Group: common
      Parameters:
      allowStAX - the value to set
      Returns:
      the dsl builder

    • allowStAX

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder allowStAX(String allowStAX)
      Whether to allow using StAX mode. The option will be converted to a <code>boolean</code> type. Default: false Group: common
      Parameters:
      allowStAX - the value to set
      Returns:
      the dsl builder

    • headerName

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder headerName(String headerName)
      To use a Camel Message header as the input source instead of Message body. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      headerName - the value to set
      Returns:
      the dsl builder

    • namespacePrefixes

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder namespacePrefixes(Map<String,String> namespacePrefixes)
      Allows to control which namespace prefixes to use for a set of namespace mappings. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.String&gt;</code> type. Group: common
      Parameters:
      namespacePrefixes - the value to set
      Returns:
      the dsl builder

    • namespacePrefixes

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder namespacePrefixes(String namespacePrefixes)
      Allows to control which namespace prefixes to use for a set of namespace mappings. The option will be converted to a <code>java.util.Map&lt;java.lang.String, java.lang.String&gt;</code> type. Group: common
      Parameters:
      namespacePrefixes - the value to set
      Returns:
      the dsl builder

    • propertyName

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder propertyName(String propertyName)
      To use a Camel Exchange property as the input source instead of Message body. It has a lower precedent than the name of header if both are set. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      propertyName - the value to set
      Returns:
      the dsl builder

    • resultsFormat

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder resultsFormat(org.apache.camel.component.xquery.ResultFormat resultsFormat)
      What output result to use. The option is a: <code>org.apache.camel.component.xquery.ResultFormat</code> type. Default: DOM Group: common
      Parameters:
      resultsFormat - the value to set
      Returns:
      the dsl builder

    • resultsFormat

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder resultsFormat(String resultsFormat)
      What output result to use. The option will be converted to a <code>org.apache.camel.component.xquery.ResultFormat</code> type. Default: DOM Group: common
      Parameters:
      resultsFormat - the value to set
      Returns:
      the dsl builder

    • resultType

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder resultType(Class<Object> resultType)
      What output result to use defined as a class. The option is a: <code>java.lang.Class&lt;java.lang.Object&gt;</code> type. Group: common
      Parameters:
      resultType - the value to set
      Returns:
      the dsl builder

    • resultType

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder resultType(String resultType)
      What output result to use defined as a class. The option will be converted to a <code>java.lang.Class&lt;java.lang.Object&gt;</code> type. Group: common
      Parameters:
      resultType - the value to set
      Returns:
      the dsl builder

    • stripsAllWhiteSpace

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder stripsAllWhiteSpace(boolean stripsAllWhiteSpace)
      Whether to strip all whitespaces. The option is a: <code>boolean</code> type. Default: true Group: common
      Parameters:
      stripsAllWhiteSpace - the value to set
      Returns:
      the dsl builder

    • stripsAllWhiteSpace

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder stripsAllWhiteSpace(String stripsAllWhiteSpace)
      Whether to strip all whitespaces. The option will be converted to a <code>boolean</code> type. Default: true Group: common
      Parameters:
      stripsAllWhiteSpace - the value to set
      Returns:
      the dsl builder

    • sendEmptyMessageWhenIdle

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle)
      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
      Parameters:
      sendEmptyMessageWhenIdle - the value to set
      Returns:
      the dsl builder

    • sendEmptyMessageWhenIdle

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle)
      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
      Parameters:
      sendEmptyMessageWhenIdle - the value to set
      Returns:
      the dsl builder

    • backoffErrorThreshold

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder backoffErrorThreshold(int backoffErrorThreshold)
      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
      Parameters:
      backoffErrorThreshold - the value to set
      Returns:
      the dsl builder

    • backoffErrorThreshold

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder backoffErrorThreshold(String backoffErrorThreshold)
      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
      Parameters:
      backoffErrorThreshold - the value to set
      Returns:
      the dsl builder

    • backoffIdleThreshold

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder backoffIdleThreshold(int backoffIdleThreshold)
      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
      Parameters:
      backoffIdleThreshold - the value to set
      Returns:
      the dsl builder

    • backoffIdleThreshold

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder backoffIdleThreshold(String backoffIdleThreshold)
      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
      Parameters:
      backoffIdleThreshold - the value to set
      Returns:
      the dsl builder

    • backoffMultiplier

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder backoffMultiplier(int backoffMultiplier)
      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
      Parameters:
      backoffMultiplier - the value to set
      Returns:
      the dsl builder

    • backoffMultiplier

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder backoffMultiplier(String backoffMultiplier)
      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
      Parameters:
      backoffMultiplier - the value to set
      Returns:
      the dsl builder

    • delay

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder delay(long delay)
      Milliseconds before the next poll. The option is a: <code>long</code> type. Default: 500 Group: scheduler
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder

    • delay

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder delay(String delay)
      Milliseconds before the next poll. The option will be converted to a <code>long</code> type. Default: 500 Group: scheduler
      Parameters:
      delay - the value to set
      Returns:
      the dsl builder

    • greedy

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder greedy(boolean greedy)
      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
      Parameters:
      greedy - the value to set
      Returns:
      the dsl builder

    • greedy

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder greedy(String greedy)
      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
      Parameters:
      greedy - the value to set
      Returns:
      the dsl builder

    • initialDelay

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder initialDelay(long initialDelay)
      Milliseconds before the first poll starts. The option is a: <code>long</code> type. Default: 1000 Group: scheduler
      Parameters:
      initialDelay - the value to set
      Returns:
      the dsl builder

    • initialDelay

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder initialDelay(String initialDelay)
      Milliseconds before the first poll starts. The option will be converted to a <code>long</code> type. Default: 1000 Group: scheduler
      Parameters:
      initialDelay - the value to set
      Returns:
      the dsl builder

    • repeatCount

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder repeatCount(long repeatCount)
      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
      Parameters:
      repeatCount - the value to set
      Returns:
      the dsl builder

    • repeatCount

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder repeatCount(String repeatCount)
      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
      Parameters:
      repeatCount - the value to set
      Returns:
      the dsl builder

    • runLoggingLevel

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)
      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
      Parameters:
      runLoggingLevel - the value to set
      Returns:
      the dsl builder

    • runLoggingLevel

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder runLoggingLevel(String runLoggingLevel)
      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
      Parameters:
      runLoggingLevel - the value to set
      Returns:
      the dsl builder

    • scheduledExecutorService

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder scheduledExecutorService(ScheduledExecutorService 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. The option is a: <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler
      Parameters:
      scheduledExecutorService - the value to set
      Returns:
      the dsl builder

    • scheduledExecutorService

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder scheduledExecutorService(String 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. The option will be converted to a <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler
      Parameters:
      scheduledExecutorService - the value to set
      Returns:
      the dsl builder

    • scheduler

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder scheduler(Object scheduler)
      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
      Parameters:
      scheduler - the value to set
      Returns:
      the dsl builder

    • scheduler

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder scheduler(String scheduler)
      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
      Parameters:
      scheduler - the value to set
      Returns:
      the dsl builder

    • schedulerProperties

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder schedulerProperties(String key, Object value)
      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&lt;java.lang.String, java.lang.Object&gt;</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
      Parameters:
      key - the option key
      value - the option value
      Returns:
      the dsl builder

    • schedulerProperties

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder schedulerProperties(Map values)
      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&lt;java.lang.String, java.lang.Object&gt;</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
      Parameters:
      values - the values
      Returns:
      the dsl builder

    • startScheduler

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

    • startScheduler

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder startScheduler(String startScheduler)
      Whether the scheduler should be auto started. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler
      Parameters:
      startScheduler - the value to set
      Returns:
      the dsl builder

    • timeUnit

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder timeUnit(TimeUnit timeUnit)
      Time unit for initialDelay and delay options. The option is a: <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler
      Parameters:
      timeUnit - the value to set
      Returns:
      the dsl builder

    • timeUnit

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder timeUnit(String timeUnit)
      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
      Parameters:
      timeUnit - the value to set
      Returns:
      the dsl builder

    • useFixedDelay

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder useFixedDelay(boolean useFixedDelay)
      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
      Parameters:
      useFixedDelay - the value to set
      Returns:
      the dsl builder

    • useFixedDelay

      default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder useFixedDelay(String useFixedDelay)
      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
      Parameters:
      useFixedDelay - the value to set
      Returns:
      the dsl builder