org.apache.camel.builder.endpoint.dsl

Interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, SoroushBotEndpointBuilderFactory.SoroushBotEndpointConsumerBuilder, SoroushBotEndpointBuilderFactory.SoroushBotEndpointProducerBuilder

Enclosing interface:

SoroushBotEndpointBuilderFactory

public static interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder
extends SoroushBotEndpointBuilderFactory.SoroushBotEndpointConsumerBuilder, SoroushBotEndpointBuilderFactory.SoroushBotEndpointProducerBuilder

Builder for endpoint for the Soroush component.

Method Summary

Modifier and Type	Method and Description
default SoroushBotEndpointBuilderFactory.AdvancedSoroushBotEndpointBuilder	advanced()
default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder	authorizationToken(String authorizationToken) The authorization token for using the bot.
default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder	backOffStrategy(String backOffStrategy) The strategy to backoff in case of connection failure.
default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder	connectionTimeout(int connectionTimeout) Connection timeout in ms when connecting to soroush API.
default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder	connectionTimeout(String connectionTimeout) Connection timeout in ms when connecting to soroush API.
default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder	maxConnectionRetry(int maxConnectionRetry) Maximum connection retry when fail to connect to soroush API, if the quota is reached, MaximumConnectionRetryReachedException is thrown for that message.
default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder	maxConnectionRetry(String maxConnectionRetry) Maximum connection retry when fail to connect to soroush API, if the quota is reached, MaximumConnectionRetryReachedException is thrown for that message.
default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder	maxRetryWaitingTime(long maxRetryWaitingTime) Maximum amount of time (in millisecond) a thread wait before retrying failed request.
default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder	maxRetryWaitingTime(String maxRetryWaitingTime) Maximum amount of time (in millisecond) a thread wait before retrying failed request.
default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder	reconnectIdleConnectionTimeout(long reconnectIdleConnectionTimeout) The timeout in millisecond to reconnect the existing getMessage connection to ensure that the connection is always live and does not dead without notifying the bot.
default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder	reconnectIdleConnectionTimeout(String reconnectIdleConnectionTimeout) The timeout in millisecond to reconnect the existing getMessage connection to ensure that the connection is always live and does not dead without notifying the bot.
default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder	retryExponentialCoefficient(long retryExponentialCoefficient) Coefficient to compute back off time when using Exponential Back Off strategy.
default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder	retryExponentialCoefficient(String retryExponentialCoefficient) Coefficient to compute back off time when using Exponential Back Off strategy.
default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder	retryLinearIncrement(long retryLinearIncrement) The amount of time (in millisecond) which adds to waiting time when using Linear back off strategy.
default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder	retryLinearIncrement(String retryLinearIncrement) The amount of time (in millisecond) which adds to waiting time when using Linear back off strategy.
default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder	retryWaitingTime(long retryWaitingTime) Waiting time before retry failed request (Millisecond).
default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder	retryWaitingTime(String retryWaitingTime) Waiting time before retry failed request (Millisecond).

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SoroushBotEndpointBuilderFactory.SoroushBotEndpointConsumerBuilder

bridgeErrorHandler, bridgeErrorHandler, concurrentConsumers, concurrentConsumers, queueCapacityPerThread, queueCapacityPerThread

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

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SoroushBotEndpointBuilderFactory.SoroushBotEndpointProducerBuilder

autoDownload, autoDownload, autoUploadFile, autoUploadFile, downloadThumbnail, downloadThumbnail, forceDownload, forceDownload, forceUpload, forceUpload, lazyStartProducer, lazyStartProducer

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default SoroushBotEndpointBuilderFactory.AdvancedSoroushBotEndpointBuilder advanced()

Specified by:

advanced in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointConsumerBuilder

Specified by:

advanced in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointProducerBuilder

connectionTimeout

default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder connectionTimeout(int connectionTimeout)

Connection timeout in ms when connecting to soroush API. The option is a: <code>int</code> type. Default: 30000 Group: common

Specified by:

connectionTimeout in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointConsumerBuilder

Specified by:

connectionTimeout in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointProducerBuilder

Parameters:

connectionTimeout - the value to set

Returns:

the dsl builder

connectionTimeout

default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder connectionTimeout(String connectionTimeout)

Connection timeout in ms when connecting to soroush API. The option will be converted to a <code>int</code> type. Default: 30000 Group: common

Specified by:

connectionTimeout in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointConsumerBuilder

Specified by:

connectionTimeout in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointProducerBuilder

Parameters:

connectionTimeout - the value to set

Returns:

the dsl builder

maxConnectionRetry

default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder maxConnectionRetry(int maxConnectionRetry)

Maximum connection retry when fail to connect to soroush API, if the quota is reached, MaximumConnectionRetryReachedException is thrown for that message. The option is a: <code>int</code> type. Default: 4 Group: common

Specified by:

maxConnectionRetry in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointConsumerBuilder

Specified by:

maxConnectionRetry in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointProducerBuilder

Parameters:

maxConnectionRetry - the value to set

Returns:

the dsl builder

maxConnectionRetry

default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder maxConnectionRetry(String maxConnectionRetry)

Maximum connection retry when fail to connect to soroush API, if the quota is reached, MaximumConnectionRetryReachedException is thrown for that message. The option will be converted to a <code>int</code> type. Default: 4 Group: common

Specified by:

maxConnectionRetry in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointConsumerBuilder

Specified by:

maxConnectionRetry in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointProducerBuilder

Parameters:

maxConnectionRetry - the value to set

Returns:

the dsl builder

backOffStrategy

default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder backOffStrategy(String backOffStrategy)

The strategy to backoff in case of connection failure. Currently 3 strategies are supported: 1. Exponential (default): It multiply retryWaitingTime by retryExponentialCoefficient after each connection failure. 2. Linear: It increase retryWaitingTime by retryLinearIncrement after each connection failure. 3. Fixed: Always use retryWaitingTime as the time between retries. The option is a: <code>java.lang.String</code> type. Default: Exponential Group: scheduling

Specified by:

backOffStrategy in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointConsumerBuilder

Specified by:

backOffStrategy in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointProducerBuilder

Parameters:

backOffStrategy - the value to set

Returns:

the dsl builder

maxRetryWaitingTime

default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder maxRetryWaitingTime(long maxRetryWaitingTime)

Maximum amount of time (in millisecond) a thread wait before retrying failed request. The option is a: <code>long</code> type. Default: 3600000 Group: scheduling

Specified by:

maxRetryWaitingTime in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointConsumerBuilder

Specified by:

maxRetryWaitingTime in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointProducerBuilder

Parameters:

maxRetryWaitingTime - the value to set

Returns:

the dsl builder

maxRetryWaitingTime

default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder maxRetryWaitingTime(String maxRetryWaitingTime)

Maximum amount of time (in millisecond) a thread wait before retrying failed request. The option will be converted to a <code>long</code> type. Default: 3600000 Group: scheduling

Specified by:

maxRetryWaitingTime in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointConsumerBuilder

Specified by:

maxRetryWaitingTime in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointProducerBuilder

Parameters:

maxRetryWaitingTime - the value to set

Returns:

the dsl builder

reconnectIdleConnectionTimeout

default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder reconnectIdleConnectionTimeout(long reconnectIdleConnectionTimeout)

The timeout in millisecond to reconnect the existing getMessage connection to ensure that the connection is always live and does not dead without notifying the bot. this value should not be changed. The option is a: <code>long</code> type. Default: 300000 Group: scheduling

Specified by:

reconnectIdleConnectionTimeout in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointConsumerBuilder

Specified by:

reconnectIdleConnectionTimeout in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointProducerBuilder

Parameters:

reconnectIdleConnectionTimeout - the value to set

Returns:

the dsl builder

reconnectIdleConnectionTimeout

default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder reconnectIdleConnectionTimeout(String reconnectIdleConnectionTimeout)

The timeout in millisecond to reconnect the existing getMessage connection to ensure that the connection is always live and does not dead without notifying the bot. this value should not be changed. The option will be converted to a <code>long</code> type. Default: 300000 Group: scheduling

Specified by:

reconnectIdleConnectionTimeout in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointConsumerBuilder

Specified by:

reconnectIdleConnectionTimeout in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointProducerBuilder

Parameters:

reconnectIdleConnectionTimeout - the value to set

Returns:

the dsl builder

retryExponentialCoefficient

default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder retryExponentialCoefficient(long retryExponentialCoefficient)

Coefficient to compute back off time when using Exponential Back Off strategy. The option is a: <code>long</code> type. Default: 2 Group: scheduling

Specified by:

retryExponentialCoefficient in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointConsumerBuilder

Specified by:

retryExponentialCoefficient in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointProducerBuilder

Parameters:

retryExponentialCoefficient - the value to set

Returns:

the dsl builder

retryExponentialCoefficient

default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder retryExponentialCoefficient(String retryExponentialCoefficient)

Coefficient to compute back off time when using Exponential Back Off strategy. The option will be converted to a <code>long</code> type. Default: 2 Group: scheduling

Specified by:

retryExponentialCoefficient in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointConsumerBuilder

Specified by:

retryExponentialCoefficient in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointProducerBuilder

Parameters:

retryExponentialCoefficient - the value to set

Returns:

the dsl builder

retryLinearIncrement

default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder retryLinearIncrement(long retryLinearIncrement)

The amount of time (in millisecond) which adds to waiting time when using Linear back off strategy. The option is a: <code>long</code> type. Default: 10000 Group: scheduling

Specified by:

retryLinearIncrement in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointConsumerBuilder

Specified by:

retryLinearIncrement in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointProducerBuilder

Parameters:

retryLinearIncrement - the value to set

Returns:

the dsl builder

retryLinearIncrement

default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder retryLinearIncrement(String retryLinearIncrement)

The amount of time (in millisecond) which adds to waiting time when using Linear back off strategy. The option will be converted to a <code>long</code> type. Default: 10000 Group: scheduling

Specified by:

retryLinearIncrement in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointConsumerBuilder

Specified by:

retryLinearIncrement in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointProducerBuilder

Parameters:

retryLinearIncrement - the value to set

Returns:

the dsl builder

retryWaitingTime

default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder retryWaitingTime(long retryWaitingTime)

Waiting time before retry failed request (Millisecond). If backOffStrategy is not Fixed this is the based value for computing back off waiting time. the first retry is always happen immediately after failure and retryWaitingTime do not apply to the first retry. The option is a: <code>long</code> type. Default: 1000 Group: scheduling

Specified by:

retryWaitingTime in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointConsumerBuilder

Specified by:

retryWaitingTime in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointProducerBuilder

Parameters:

retryWaitingTime - the value to set

Returns:

the dsl builder

retryWaitingTime

default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder retryWaitingTime(String retryWaitingTime)

Waiting time before retry failed request (Millisecond). If backOffStrategy is not Fixed this is the based value for computing back off waiting time. the first retry is always happen immediately after failure and retryWaitingTime do not apply to the first retry. The option will be converted to a <code>long</code> type. Default: 1000 Group: scheduling

Specified by:

retryWaitingTime in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointConsumerBuilder

Specified by:

retryWaitingTime in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointProducerBuilder

Parameters:

retryWaitingTime - the value to set

Returns:

the dsl builder

authorizationToken

default SoroushBotEndpointBuilderFactory.SoroushBotEndpointBuilder authorizationToken(String authorizationToken)

The authorization token for using the bot. if uri path does not contain authorization token, this token will be used. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

authorizationToken in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointConsumerBuilder

Specified by:

authorizationToken in interface SoroushBotEndpointBuilderFactory.SoroushBotEndpointProducerBuilder

Parameters:

authorizationToken - the value to set

Returns:

the dsl builder