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 Summary

Modifier and Type	Method and Description
default XQueryEndpointBuilderFactory.AdvancedXQueryEndpointConsumerBuilder	advanced()
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	allowStAX(boolean allowStAX) Whether to allow using StAX mode.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	allowStAX(String allowStAX) Whether to allow using StAX mode.
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.
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.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	backoffIdleThreshold(int backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	backoffIdleThreshold(String backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
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.
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.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	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.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	bridgeErrorHandler(String 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.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	delay(long delay) Milliseconds before the next poll.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	delay(String delay) Milliseconds before the next poll.
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.
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.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	headerName(String headerName) To use a Camel Message header as the input source instead of Message body.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	initialDelay(long initialDelay) Milliseconds before the first poll starts.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	initialDelay(String initialDelay) Milliseconds before the first poll starts.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	namespacePrefixes(Map<String,String> namespacePrefixes) Allows to control which namespace prefixes to use for a set of namespace mappings.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	namespacePrefixes(String namespacePrefixes) Allows to control which namespace prefixes to use for a set of namespace mappings.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	repeatCount(long repeatCount) Specifies a maximum limit of number of fires.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	repeatCount(String repeatCount) Specifies a maximum limit of number of fires.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	resultsFormat(String resultsFormat) What output result to use.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	resultsFormat(XQueryEndpointBuilderFactory.ResultFormat resultsFormat) What output result to use.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	resultType(Class<Object> resultType) What output result to use defined as a class.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	resultType(String resultType) What output result to use defined as a class.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	runLoggingLevel(String runLoggingLevel) The consumer logs a start/complete log line when it polls.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	scheduledExecutorService(ScheduledExecutorService scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	scheduledExecutorService(String scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	scheduler(Object scheduler) To use a cron scheduler from either camel-spring or camel-quartz component.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	scheduler(String scheduler) To use a cron scheduler from either camel-spring or camel-quartz component.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	schedulerProperties(Map values) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
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.
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.
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.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	startScheduler(boolean startScheduler) Whether the scheduler should be auto started.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	startScheduler(String startScheduler) Whether the scheduler should be auto started.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	stripsAllWhiteSpace(boolean stripsAllWhiteSpace) Whether to strip all whitespaces.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	stripsAllWhiteSpace(String stripsAllWhiteSpace) Whether to strip all whitespaces.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	timeUnit(String timeUnit) Time unit for initialDelay and delay options.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	timeUnit(TimeUnit timeUnit) Time unit for initialDelay and delay options.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	useFixedDelay(boolean useFixedDelay) Controls if fixed delay or fixed rate is used.
default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder	useFixedDelay(String useFixedDelay) Controls if fixed delay or fixed rate is used.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Detail

advanced

default XQueryEndpointBuilderFactory.AdvancedXQueryEndpointConsumerBuilder advanced()

allowStAX

default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder allowStAX(boolean allowStAX)

Whether to allow using StAX mode. The option is a: boolean type. Default: false Group: common

allowStAX

default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder allowStAX(String allowStAX)

Whether to allow using StAX mode. The option will be converted to a boolean type. Default: false Group: common

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: java.lang.String type. Group: common

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: java.util.Map<java.lang.String, java.lang.String> type. Group: common

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 java.util.Map<java.lang.String, java.lang.String> type. Group: common

resultsFormat

default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder resultsFormat(XQueryEndpointBuilderFactory.ResultFormat resultsFormat)

What output result to use. The option is a: org.apache.camel.component.xquery.ResultFormat type. Default: DOM Group: common

resultsFormat

default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder resultsFormat(String resultsFormat)

What output result to use. The option will be converted to a org.apache.camel.component.xquery.ResultFormat type. Default: DOM Group: common

resultType

default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder resultType(Class<Object> resultType)

What output result to use defined as a class. The option is a: java.lang.Class<java.lang.Object> type. Group: common

resultType

default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder resultType(String resultType)

What output result to use defined as a class. The option will be converted to a java.lang.Class<java.lang.Object> type. Group: common

stripsAllWhiteSpace

default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder stripsAllWhiteSpace(boolean stripsAllWhiteSpace)

Whether to strip all whitespaces. The option is a: boolean type. Default: true Group: common

stripsAllWhiteSpace

default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder stripsAllWhiteSpace(String stripsAllWhiteSpace)

Whether to strip all whitespaces. The option will be converted to a boolean type. Default: true Group: common

bridgeErrorHandler

default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder 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: boolean type. Default: false Group: consumer

bridgeErrorHandler

default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder bridgeErrorHandler(String 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 will be converted to a boolean type. Default: false Group: consumer

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: boolean type. Default: false Group: consumer

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 boolean type. Default: false Group: consumer

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: int type. Group: scheduler

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 int type. Group: scheduler

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: int type. Group: scheduler

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 int type. Group: scheduler

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: int type. Group: scheduler

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 int type. Group: scheduler

delay

default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder delay(long delay)

Milliseconds before the next poll. The option is a: long type. Default: 500 Group: scheduler

delay

default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder delay(String delay)

Milliseconds before the next poll. The option will be converted to a long type. Default: 500 Group: scheduler

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: boolean type. Default: false Group: scheduler

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 boolean type. Default: false Group: scheduler

initialDelay

default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder initialDelay(long initialDelay)

Milliseconds before the first poll starts. The option is a: long type. Default: 1000 Group: scheduler

initialDelay

default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder initialDelay(String initialDelay)

Milliseconds before the first poll starts. The option will be converted to a long type. Default: 1000 Group: scheduler

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: long type. Default: 0 Group: scheduler

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 long type. Default: 0 Group: scheduler

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: org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler

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 org.apache.camel.LoggingLevel type. Default: TRACE Group: scheduler

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: java.util.concurrent.ScheduledExecutorService type. Group: scheduler

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 java.util.concurrent.ScheduledExecutorService type. Group: scheduler

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: java.lang.Object type. Default: none Group: scheduler

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 java.lang.Object type. Default: none Group: scheduler

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: java.util.Map<java.lang.String, java.lang.Object> 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

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: java.util.Map<java.lang.String, java.lang.Object> 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

startScheduler

default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder startScheduler(boolean startScheduler)

Whether the scheduler should be auto started. The option is a: boolean type. Default: true Group: scheduler

startScheduler

default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder startScheduler(String startScheduler)

Whether the scheduler should be auto started. The option will be converted to a boolean type. Default: true Group: scheduler

timeUnit

default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder timeUnit(TimeUnit timeUnit)

Time unit for initialDelay and delay options. The option is a: java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler

timeUnit

default XQueryEndpointBuilderFactory.XQueryEndpointConsumerBuilder timeUnit(String timeUnit)

Time unit for initialDelay and delay options. The option will be converted to a java.util.concurrent.TimeUnit type. Default: MILLISECONDS Group: scheduler

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: boolean type. Default: true Group: scheduler

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 boolean type. Default: true Group: scheduler