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

Interface FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder, FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder

Enclosing interface:

FilesEndpointBuilderFactory

public static interface FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder
extends FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder, FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder

Advanced builder for endpoint for the Azure Files component.

Method Summary

Modifier and Type	Method	Description
default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder	autoCreate(boolean autoCreate)	Automatically create missing directories in the file's pathname.
default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder	autoCreate(String autoCreate)	Automatically create missing directories in the file's pathname.
default FilesEndpointBuilderFactory.FilesEndpointBuilder	basic()
default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder	connectTimeout(int connectTimeout)	Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH.
default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder	connectTimeout(String connectTimeout)	Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH.
default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder	maximumReconnectAttempts(int maximumReconnectAttempts)	Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server.
default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder	maximumReconnectAttempts(String maximumReconnectAttempts)	Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server.
default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder	reconnectDelay(long reconnectDelay)	Delay in millis Camel will wait before performing a reconnect attempt.
default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder	reconnectDelay(String reconnectDelay)	Delay in millis Camel will wait before performing a reconnect attempt.
default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder	throwExceptionOnConnectFailed(boolean throwExceptionOnConnectFailed)	Should an exception be thrown if connection failed (exhausted)By default exception is not thrown and a WARN is logged.
default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder	throwExceptionOnConnectFailed(String throwExceptionOnConnectFailed)	Should an exception be thrown if connection failed (exhausted)By default exception is not thrown and a WARN is logged.
default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder	timeout(int timeout)	Sets the data timeout for waiting for reply Used only by FTPClient.
default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder	timeout(String timeout)	Sets the data timeout for waiting for reply Used only by FTPClient.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder

bridgeErrorHandler, bridgeErrorHandler, download, download, exceptionHandler, exceptionHandler, exchangePattern, exchangePattern, inProgressRepository, inProgressRepository, localWorkDirectory, onCompletionExceptionHandler, onCompletionExceptionHandler, pollStrategy, pollStrategy, processStrategy, processStrategy

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder

allowNullBody, allowNullBody, disconnectOnBatchComplete, disconnectOnBatchComplete, eagerDeleteTargetFile, eagerDeleteTargetFile, keepLastModified, keepLastModified, lazyStartProducer, lazyStartProducer, moveExistingFileStrategy, moveExistingFileStrategy

Method Detail

basic

default FilesEndpointBuilderFactory.FilesEndpointBuilder basic()

Specified by:

basic in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder

Specified by:

basic in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder

autoCreate

default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder autoCreate(boolean autoCreate)

Automatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to. The option is a: <code>boolean</code> type. Default: true Group: advanced

Specified by:

autoCreate in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder

Specified by:

autoCreate in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder

Parameters:

autoCreate - the value to set

Returns:

the dsl builder

autoCreate

default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder autoCreate(String autoCreate)

Automatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to. The option will be converted to a <code>boolean</code> type. Default: true Group: advanced

Specified by:

autoCreate in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder

Specified by:

autoCreate in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder

Parameters:

autoCreate - the value to set

Returns:

the dsl builder

connectTimeout

default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder connectTimeout(int connectTimeout)

Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH. The option is a: <code>int</code> type. Default: 10000 Group: advanced

Specified by:

connectTimeout in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder

Specified by:

connectTimeout in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder

Parameters:

connectTimeout - the value to set

Returns:

the dsl builder

connectTimeout

default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder connectTimeout(String connectTimeout)

Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH. The option will be converted to a <code>int</code> type. Default: 10000 Group: advanced

Specified by:

connectTimeout in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder

Specified by:

connectTimeout in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder

Parameters:

connectTimeout - the value to set

Returns:

the dsl builder

maximumReconnectAttempts

default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder maximumReconnectAttempts(int maximumReconnectAttempts)

Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior. The option is a: <code>int</code> type. Group: advanced

Specified by:

maximumReconnectAttempts in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder

Specified by:

maximumReconnectAttempts in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder

Parameters:

maximumReconnectAttempts - the value to set

Returns:

the dsl builder

maximumReconnectAttempts

default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder maximumReconnectAttempts(String maximumReconnectAttempts)

Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior. The option will be converted to a <code>int</code> type. Group: advanced

Specified by:

maximumReconnectAttempts in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder

Specified by:

maximumReconnectAttempts in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder

Parameters:

maximumReconnectAttempts - the value to set

Returns:

the dsl builder

reconnectDelay

default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder reconnectDelay(long reconnectDelay)

Delay in millis Camel will wait before performing a reconnect attempt. The option is a: <code>long</code> type. Default: 1000 Group: advanced

Specified by:

reconnectDelay in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder

Specified by:

reconnectDelay in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder

Parameters:

reconnectDelay - the value to set

Returns:

the dsl builder

reconnectDelay

default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder reconnectDelay(String reconnectDelay)

Delay in millis Camel will wait before performing a reconnect attempt. The option will be converted to a <code>long</code> type. Default: 1000 Group: advanced

Specified by:

reconnectDelay in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder

Specified by:

reconnectDelay in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder

Parameters:

reconnectDelay - the value to set

Returns:

the dsl builder

throwExceptionOnConnectFailed

default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder throwExceptionOnConnectFailed(boolean throwExceptionOnConnectFailed)

Should an exception be thrown if connection failed (exhausted)By default exception is not thrown and a WARN is logged. You can use this to enable exception being thrown and handle the thrown exception from the org.apache.camel.spi.PollingConsumerPollStrategy rollback method. The option is a: <code>boolean</code> type. Default: false Group: advanced

Specified by:

throwExceptionOnConnectFailed in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder

Specified by:

throwExceptionOnConnectFailed in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder

Parameters:

throwExceptionOnConnectFailed - the value to set

Returns:

the dsl builder

throwExceptionOnConnectFailed

default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder throwExceptionOnConnectFailed(String throwExceptionOnConnectFailed)

Should an exception be thrown if connection failed (exhausted)By default exception is not thrown and a WARN is logged. You can use this to enable exception being thrown and handle the thrown exception from the org.apache.camel.spi.PollingConsumerPollStrategy rollback method. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Specified by:

throwExceptionOnConnectFailed in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder

Specified by:

throwExceptionOnConnectFailed in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder

Parameters:

throwExceptionOnConnectFailed - the value to set

Returns:

the dsl builder

timeout

default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder timeout(int timeout)

Sets the data timeout for waiting for reply Used only by FTPClient. The option is a: <code>int</code> type. Default: 30000 Group: advanced

Specified by:

timeout in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder

Specified by:

timeout in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder

Parameters:

timeout - the value to set

Returns:

the dsl builder

timeout

default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder timeout(String timeout)

Sets the data timeout for waiting for reply Used only by FTPClient. The option will be converted to a <code>int</code> type. Default: 30000 Group: advanced

Specified by:

timeout in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointConsumerBuilder

Specified by:

timeout in interface FilesEndpointBuilderFactory.AdvancedFilesEndpointProducerBuilder

Parameters:

timeout - the value to set

Returns:

the dsl builder