Interface ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
- Enclosing interface:
- ScpEndpointBuilderFactory
public static interface ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Advanced builder for endpoint for the SCP component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder
allowNullBody(boolean allowNullBody)
Used to specify if a null body is allowed during file writing.default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder
allowNullBody(String allowNullBody)
Used to specify if a null body is allowed during file writing.default ScpEndpointBuilderFactory.ScpEndpointBuilder
basic()
default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder
ciphers(String ciphers)
Set a comma separated list of ciphers that will be used in order of preference.default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder
connectTimeout(int connectTimeout)
Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH.default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder
connectTimeout(String connectTimeout)
Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH.default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder
disconnectOnBatchComplete(boolean disconnectOnBatchComplete)
Whether or not to disconnect from remote FTP server right after a Batch upload is complete.default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder
disconnectOnBatchComplete(String disconnectOnBatchComplete)
Whether or not to disconnect from remote FTP server right after a Batch upload is complete.default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder
lazyStartProducer(boolean lazyStartProducer)
Whether the producer should be started lazy (on the first message).default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder
lazyStartProducer(String lazyStartProducer)
Whether the producer should be started lazy (on the first message).default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder
moveExistingFileStrategy(String moveExistingFileStrategy)
Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured.default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder
moveExistingFileStrategy(org.apache.camel.component.file.strategy.FileMoveExistingStrategy moveExistingFileStrategy)
Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured.default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder
soTimeout(int soTimeout)
Sets the so timeout FTP and FTPS Is the SocketOptions.SO_TIMEOUT value in millis.default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder
soTimeout(String soTimeout)
Sets the so timeout FTP and FTPS Is the SocketOptions.SO_TIMEOUT value in millis.default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder
timeout(int timeout)
Sets the data timeout for waiting for reply Used only by FTPClient.default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder
timeout(String timeout)
Sets the data timeout for waiting for reply Used only by FTPClient.
-
-
-
Method Detail
-
basic
default ScpEndpointBuilderFactory.ScpEndpointBuilder basic()
-
allowNullBody
default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder allowNullBody(boolean allowNullBody)
Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file component, a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the fileExist option is set to 'Override', then the file will be truncated, and if set to append the file will remain unchanged. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)- Parameters:
allowNullBody
- the value to set- Returns:
- the dsl builder
-
allowNullBody
default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder allowNullBody(String allowNullBody)
Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file component, a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the fileExist option is set to 'Override', then the file will be truncated, and if set to append the file will remain unchanged. The option will be converted to a <code>boolean</code> type. Default: false Group: producer (advanced)- Parameters:
allowNullBody
- the value to set- Returns:
- the dsl builder
-
disconnectOnBatchComplete
default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder disconnectOnBatchComplete(boolean disconnectOnBatchComplete)
Whether or not to disconnect from remote FTP server right after a Batch upload is complete. disconnectOnBatchComplete will only disconnect the current connection to the FTP server. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)- Parameters:
disconnectOnBatchComplete
- the value to set- Returns:
- the dsl builder
-
disconnectOnBatchComplete
default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder disconnectOnBatchComplete(String disconnectOnBatchComplete)
Whether or not to disconnect from remote FTP server right after a Batch upload is complete. disconnectOnBatchComplete will only disconnect the current connection to the FTP server. The option will be converted to a <code>boolean</code> type. Default: false Group: producer (advanced)- Parameters:
disconnectOnBatchComplete
- the value to set- Returns:
- the dsl builder
-
lazyStartProducer
default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder lazyStartProducer(boolean lazyStartProducer)
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)- Parameters:
lazyStartProducer
- the value to set- Returns:
- the dsl builder
-
lazyStartProducer
default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder lazyStartProducer(String lazyStartProducer)
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option will be converted to a <code>boolean</code> type. Default: false Group: producer (advanced)- Parameters:
lazyStartProducer
- the value to set- Returns:
- the dsl builder
-
moveExistingFileStrategy
default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder moveExistingFileStrategy(org.apache.camel.component.file.strategy.FileMoveExistingStrategy moveExistingFileStrategy)
Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, there is an implementation used if no custom strategy is provided. The option is a: <code>org.apache.camel.component.file.strategy.FileMoveExistingStrategy</code> type. Group: producer (advanced)- Parameters:
moveExistingFileStrategy
- the value to set- Returns:
- the dsl builder
-
moveExistingFileStrategy
default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder moveExistingFileStrategy(String moveExistingFileStrategy)
Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, there is an implementation used if no custom strategy is provided. The option will be converted to a <code>org.apache.camel.component.file.strategy.FileMoveExistingStrategy</code> type. Group: producer (advanced)- Parameters:
moveExistingFileStrategy
- the value to set- Returns:
- the dsl builder
-
connectTimeout
default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder 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- Parameters:
connectTimeout
- the value to set- Returns:
- the dsl builder
-
connectTimeout
default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder 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- Parameters:
connectTimeout
- the value to set- Returns:
- the dsl builder
-
soTimeout
default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder soTimeout(int soTimeout)
Sets the so timeout FTP and FTPS Is the SocketOptions.SO_TIMEOUT value in millis. Recommended option is to set this to 300000 so as not have a hanged connection. On SFTP this option is set as timeout on the JSCH Session instance. The option is a: <code>int</code> type. Default: 300000 Group: advanced- Parameters:
soTimeout
- the value to set- Returns:
- the dsl builder
-
soTimeout
default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder soTimeout(String soTimeout)
Sets the so timeout FTP and FTPS Is the SocketOptions.SO_TIMEOUT value in millis. Recommended option is to set this to 300000 so as not have a hanged connection. On SFTP this option is set as timeout on the JSCH Session instance. The option will be converted to a <code>int</code> type. Default: 300000 Group: advanced- Parameters:
soTimeout
- the value to set- Returns:
- the dsl builder
-
timeout
default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder 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- Parameters:
timeout
- the value to set- Returns:
- the dsl builder
-
timeout
default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder 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- Parameters:
timeout
- the value to set- Returns:
- the dsl builder
-
ciphers
default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder ciphers(String ciphers)
Set a comma separated list of ciphers that will be used in order of preference. Possible cipher names are defined by JCraft JSCH. Some examples include: aes128-ctr,aes128-cbc,3des-ctr,3des-cbc,blowfish-cbc,aes192-cbc,aes256-cbc. If not specified the default list from JSCH will be used. The option is a: <code>java.lang.String</code> type. Group: security (advanced)- Parameters:
ciphers
- the value to set- Returns:
- the dsl builder
-
-