org.apache.camel.builder.endpoint.dsl

Interface TimerEndpointBuilderFactory.TimerEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

Enclosing interface:

TimerEndpointBuilderFactory

public static interface TimerEndpointBuilderFactory.TimerEndpointBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Builder for endpoint for the Timer component.

Method Summary

Modifier and Type	Method and Description
default TimerEndpointBuilderFactory.AdvancedTimerEndpointBuilder	advanced()
default TimerEndpointBuilderFactory.TimerEndpointBuilder	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 TimerEndpointBuilderFactory.TimerEndpointBuilder	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 TimerEndpointBuilderFactory.TimerEndpointBuilder	delay(long delay) Delay before first event is triggered.
default TimerEndpointBuilderFactory.TimerEndpointBuilder	delay(String delay) Delay before first event is triggered.
default TimerEndpointBuilderFactory.TimerEndpointBuilder	fixedRate(boolean fixedRate) Events take place at approximately regular intervals, separated by the specified period.
default TimerEndpointBuilderFactory.TimerEndpointBuilder	fixedRate(String fixedRate) Events take place at approximately regular intervals, separated by the specified period.
default TimerEndpointBuilderFactory.TimerEndpointBuilder	includeMetadata(boolean includeMetadata) Whether to include metadata in the exchange such as fired time, timer name, timer count etc.
default TimerEndpointBuilderFactory.TimerEndpointBuilder	includeMetadata(String includeMetadata) Whether to include metadata in the exchange such as fired time, timer name, timer count etc.
default TimerEndpointBuilderFactory.TimerEndpointBuilder	period(long period) If greater than 0, generate periodic events every period.
default TimerEndpointBuilderFactory.TimerEndpointBuilder	period(String period) If greater than 0, generate periodic events every period.
default TimerEndpointBuilderFactory.TimerEndpointBuilder	repeatCount(long repeatCount) Specifies a maximum limit of number of fires.
default TimerEndpointBuilderFactory.TimerEndpointBuilder	repeatCount(String repeatCount) Specifies a maximum limit of number of fires.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Detail

advanced

default TimerEndpointBuilderFactory.AdvancedTimerEndpointBuilder advanced()

bridgeErrorHandler

default TimerEndpointBuilderFactory.TimerEndpointBuilder 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

bridgeErrorHandler

default TimerEndpointBuilderFactory.TimerEndpointBuilder 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 <code>boolean</code> type. Default: false Group: consumer

Parameters:

bridgeErrorHandler - the value to set

Returns:

the dsl builder

delay

default TimerEndpointBuilderFactory.TimerEndpointBuilder delay(long delay)

Delay before first event is triggered. The option is a: <code>long</code> type. Default: 1s Group: consumer

Parameters:

delay - the value to set

Returns:

the dsl builder

delay

default TimerEndpointBuilderFactory.TimerEndpointBuilder delay(String delay)

Delay before first event is triggered. The option will be converted to a <code>long</code> type. Default: 1s Group: consumer

Parameters:

delay - the value to set

Returns:

the dsl builder

fixedRate

default TimerEndpointBuilderFactory.TimerEndpointBuilder fixedRate(boolean fixedRate)

Events take place at approximately regular intervals, separated by the specified period. The option is a: <code>boolean</code> type. Default: false Group: consumer

Parameters:

fixedRate - the value to set

Returns:

the dsl builder

fixedRate

default TimerEndpointBuilderFactory.TimerEndpointBuilder fixedRate(String fixedRate)

Events take place at approximately regular intervals, separated by the specified period. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer

Parameters:

fixedRate - the value to set

Returns:

the dsl builder

includeMetadata

default TimerEndpointBuilderFactory.TimerEndpointBuilder includeMetadata(boolean includeMetadata)

Whether to include metadata in the exchange such as fired time, timer name, timer count etc. This information is default included. The option is a: <code>boolean</code> type. Default: true Group: consumer

Parameters:

includeMetadata - the value to set

Returns:

the dsl builder

includeMetadata

default TimerEndpointBuilderFactory.TimerEndpointBuilder includeMetadata(String includeMetadata)

Whether to include metadata in the exchange such as fired time, timer name, timer count etc. This information is default included. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer

Parameters:

includeMetadata - the value to set

Returns:

the dsl builder

period

default TimerEndpointBuilderFactory.TimerEndpointBuilder period(long period)

If greater than 0, generate periodic events every period. The option is a: <code>long</code> type. Default: 1s Group: consumer

Parameters:

period - the value to set

Returns:

the dsl builder

period

default TimerEndpointBuilderFactory.TimerEndpointBuilder period(String period)

If greater than 0, generate periodic events every period. The option will be converted to a <code>long</code> type. Default: 1s Group: consumer

Parameters:

period - the value to set

Returns:

the dsl builder

repeatCount

default TimerEndpointBuilderFactory.TimerEndpointBuilder repeatCount(long repeatCount)

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. The option is a: <code>long</code> type. Default: 0 Group: consumer

Parameters:

repeatCount - the value to set

Returns:

the dsl builder

repeatCount

default TimerEndpointBuilderFactory.TimerEndpointBuilder repeatCount(String repeatCount)

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. The option will be converted to a <code>long</code> type. Default: 0 Group: consumer

Parameters:

repeatCount - the value to set

Returns:

the dsl builder