ScpEndpointBuilderFactory.ScpEndpointBuilder (Camel

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

ScpEndpointBuilderFactory
```
public static interface ScpEndpointBuilderFactory.ScpEndpointBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
```
Builder for endpoint for the SCP component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder`	`advanced()`
`default ScpEndpointBuilderFactory.ScpEndpointBuilder`	`chmod(String chmod)` Allows you to set chmod on the stored file.
`default ScpEndpointBuilderFactory.ScpEndpointBuilder`	`disconnect(boolean disconnect)` Whether or not to disconnect from remote FTP server right after use.
`default ScpEndpointBuilderFactory.ScpEndpointBuilder`	`disconnect(String disconnect)` Whether or not to disconnect from remote FTP server right after use.
`default ScpEndpointBuilderFactory.ScpEndpointBuilder`	`fileName(org.apache.camel.Expression fileName)` Use Expression such as File Language to dynamically set the filename.
`default ScpEndpointBuilderFactory.ScpEndpointBuilder`	`fileName(String fileName)` Use Expression such as File Language to dynamically set the filename.
`default ScpEndpointBuilderFactory.ScpEndpointBuilder`	`flatten(boolean flatten)` Flatten is used to flatten the file name path to strip any leading paths, so it's just the file name.
`default ScpEndpointBuilderFactory.ScpEndpointBuilder`	`flatten(String flatten)` Flatten is used to flatten the file name path to strip any leading paths, so it's just the file name.
`default ScpEndpointBuilderFactory.ScpEndpointBuilder`	`jailStartingDirectory(boolean jailStartingDirectory)` Used for jailing (restricting) writing files to the starting directory (and sub) only.
`default ScpEndpointBuilderFactory.ScpEndpointBuilder`	`jailStartingDirectory(String jailStartingDirectory)` Used for jailing (restricting) writing files to the starting directory (and sub) only.
`default ScpEndpointBuilderFactory.ScpEndpointBuilder`	`knownHostsFile(String knownHostsFile)` Sets the known_hosts file, so that the jsch endpoint can do host key verification.
`default ScpEndpointBuilderFactory.ScpEndpointBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default ScpEndpointBuilderFactory.ScpEndpointBuilder`	`lazyStartProducer(String lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default ScpEndpointBuilderFactory.ScpEndpointBuilder`	`password(String password)` Password to use for login.
`default ScpEndpointBuilderFactory.ScpEndpointBuilder`	`preferredAuthentications(String preferredAuthentications)` Set a comma separated list of authentications that will be used in order of preference.
`default ScpEndpointBuilderFactory.ScpEndpointBuilder`	`privateKeyBytes(Byte[] privateKeyBytes)` Set the private key bytes to that the endpoint can do private key verification.
`default ScpEndpointBuilderFactory.ScpEndpointBuilder`	`privateKeyBytes(String privateKeyBytes)` Set the private key bytes to that the endpoint can do private key verification.
`default ScpEndpointBuilderFactory.ScpEndpointBuilder`	`privateKeyFile(String privateKeyFile)` Set the private key file to that the endpoint can do private key verification.
`default ScpEndpointBuilderFactory.ScpEndpointBuilder`	`privateKeyFilePassphrase(String privateKeyFilePassphrase)` Set the private key file passphrase to that the endpoint can do private key verification.
`default ScpEndpointBuilderFactory.ScpEndpointBuilder`	`strictHostKeyChecking(String strictHostKeyChecking)` Sets whether to use strict host key checking.
`default ScpEndpointBuilderFactory.ScpEndpointBuilder`	`username(String username)` Username to use for login.
`default ScpEndpointBuilderFactory.ScpEndpointBuilder`	`useUserKnownHostsFile(boolean useUserKnownHostsFile)` If knownHostFile has not been explicit configured, then use the host file from System.getProperty(user.home) /.ssh/known_hosts.
`default ScpEndpointBuilderFactory.ScpEndpointBuilder`	`useUserKnownHostsFile(String useUserKnownHostsFile)` If knownHostFile has not been explicit configured, then use the host file from System.getProperty(user.home) /.ssh/known_hosts.

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver
resolve, resolve

- Method Detail
  - advanced
```
default ScpEndpointBuilderFactory.AdvancedScpEndpointBuilder advanced()
```
  - chmod
```
default ScpEndpointBuilderFactory.ScpEndpointBuilder chmod(String chmod)
```
    Allows you to set chmod on the stored file. For example chmod=664. The option is a: <code>java.lang.String</code> type. Default: 664 Group: producer
    
    Parameters:
    
    chmod - the value to set
    
    Returns:
    
    the dsl builder
  - disconnect
```
default ScpEndpointBuilderFactory.ScpEndpointBuilder disconnect(boolean disconnect)
```
    Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead. The option is a: <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    disconnect - the value to set
    
    Returns:
    
    the dsl builder
  - disconnect
```
default ScpEndpointBuilderFactory.ScpEndpointBuilder disconnect(String disconnect)
```
    Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead. The option will be converted to a <code>boolean</code> type. Default: false Group: common
    
    Parameters:
    
    disconnect - the value to set
    
    Returns:
    
    the dsl builder
  - fileName
```
default ScpEndpointBuilderFactory.ScpEndpointBuilder fileName(org.apache.camel.Expression fileName)
```
    Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today's file using the File Language syntax: mydata-${date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards. The option is a: <code>org.apache.camel.Expression</code> type. Group: producer
    
    Parameters:
    
    fileName - the value to set
    
    Returns:
    
    the dsl builder
  - fileName
```
default ScpEndpointBuilderFactory.ScpEndpointBuilder fileName(String fileName)
```
    Use Expression such as File Language to dynamically set the filename. For consumers, it's used as a filename filter. For producers, it's used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today's file using the File Language syntax: mydata-${date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards. The option will be converted to a <code>org.apache.camel.Expression</code> type. Group: producer
    
    Parameters:
    
    fileName - the value to set
    
    Returns:
    
    the dsl builder
  - flatten
```
default ScpEndpointBuilderFactory.ScpEndpointBuilder flatten(boolean flatten)
```
    Flatten is used to flatten the file name path to strip any leading paths, so it's just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths. The option is a: <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    flatten - the value to set
    
    Returns:
    
    the dsl builder
  - flatten
```
default ScpEndpointBuilderFactory.ScpEndpointBuilder flatten(String flatten)
```
    Flatten is used to flatten the file name path to strip any leading paths, so it's just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
    
    Parameters:
    
    flatten - the value to set
    
    Returns:
    
    the dsl builder
  - jailStartingDirectory
```
default ScpEndpointBuilderFactory.ScpEndpointBuilder jailStartingDirectory(boolean jailStartingDirectory)
```
    Used for jailing (restricting) writing files to the starting directory (and sub) only. This is enabled by default to not allow Camel to write files to outside directories (to be more secured out of the box). You can turn this off to allow writing files to directories outside the starting directory, such as parent or root folders. The option is a: <code>boolean</code> type. Default: true Group: producer
    
    Parameters:
    
    jailStartingDirectory - the value to set
    
    Returns:
    
    the dsl builder
  - jailStartingDirectory
```
default ScpEndpointBuilderFactory.ScpEndpointBuilder jailStartingDirectory(String jailStartingDirectory)
```
    Used for jailing (restricting) writing files to the starting directory (and sub) only. This is enabled by default to not allow Camel to write files to outside directories (to be more secured out of the box). You can turn this off to allow writing files to directories outside the starting directory, such as parent or root folders. The option will be converted to a <code>boolean</code> type. Default: true Group: producer
    
    Parameters:
    
    jailStartingDirectory - the value to set
    
    Returns:
    
    the dsl builder
  - lazyStartProducer
```
default ScpEndpointBuilderFactory.ScpEndpointBuilder 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
    
    Parameters:
    
    lazyStartProducer - the value to set
    
    Returns:
    
    the dsl builder
  - lazyStartProducer
```
default ScpEndpointBuilderFactory.ScpEndpointBuilder 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
    
    Parameters:
    
    lazyStartProducer - the value to set
    
    Returns:
    
    the dsl builder
  - strictHostKeyChecking
```
default ScpEndpointBuilderFactory.ScpEndpointBuilder strictHostKeyChecking(String strictHostKeyChecking)
```
    Sets whether to use strict host key checking. Possible values are: no, yes. The option is a: <code>java.lang.String</code> type. Default: no Group: producer
    
    Parameters:
    
    strictHostKeyChecking - the value to set
    
    Returns:
    
    the dsl builder
  - knownHostsFile
```
default ScpEndpointBuilderFactory.ScpEndpointBuilder knownHostsFile(String knownHostsFile)
```
    Sets the known_hosts file, so that the jsch endpoint can do host key verification. You can prefix with classpath: to load the file from classpath instead of file system. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    knownHostsFile - the value to set
    
    Returns:
    
    the dsl builder
  - password
```
default ScpEndpointBuilderFactory.ScpEndpointBuilder password(String password)
```
    Password to use for login. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    password - the value to set
    
    Returns:
    
    the dsl builder
  - preferredAuthentications
```
default ScpEndpointBuilderFactory.ScpEndpointBuilder preferredAuthentications(String preferredAuthentications)
```
    Set a comma separated list of authentications that will be used in order of preference. Possible authentication methods are defined by JCraft JSCH. Some examples include: gssapi-with-mic,publickey,keyboard-interactive,password If not specified the JSCH and/or system defaults will be used. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    preferredAuthentications - the value to set
    
    Returns:
    
    the dsl builder
  - privateKeyBytes
```
default ScpEndpointBuilderFactory.ScpEndpointBuilder privateKeyBytes(Byte[] privateKeyBytes)
```
    Set the private key bytes to that the endpoint can do private key verification. This must be used only if privateKeyFile wasn't set. Otherwise the file will have the priority. The option is a: <code>byte[]</code> type. Group: security
    
    Parameters:
    
    privateKeyBytes - the value to set
    
    Returns:
    
    the dsl builder
  - privateKeyBytes
```
default ScpEndpointBuilderFactory.ScpEndpointBuilder privateKeyBytes(String privateKeyBytes)
```
    Set the private key bytes to that the endpoint can do private key verification. This must be used only if privateKeyFile wasn't set. Otherwise the file will have the priority. The option will be converted to a <code>byte[]</code> type. Group: security
    
    Parameters:
    
    privateKeyBytes - the value to set
    
    Returns:
    
    the dsl builder
  - privateKeyFile
```
default ScpEndpointBuilderFactory.ScpEndpointBuilder privateKeyFile(String privateKeyFile)
```
    Set the private key file to that the endpoint can do private key verification. You can prefix with classpath: to load the file from classpath instead of file system. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    privateKeyFile - the value to set
    
    Returns:
    
    the dsl builder
  - privateKeyFilePassphrase
```
default ScpEndpointBuilderFactory.ScpEndpointBuilder privateKeyFilePassphrase(String privateKeyFilePassphrase)
```
    Set the private key file passphrase to that the endpoint can do private key verification. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    privateKeyFilePassphrase - the value to set
    
    Returns:
    
    the dsl builder
  - username
```
default ScpEndpointBuilderFactory.ScpEndpointBuilder username(String username)
```
    Username to use for login. The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    username - the value to set
    
    Returns:
    
    the dsl builder
  - useUserKnownHostsFile
```
default ScpEndpointBuilderFactory.ScpEndpointBuilder useUserKnownHostsFile(boolean useUserKnownHostsFile)
```
    If knownHostFile has not been explicit configured, then use the host file from System.getProperty(user.home) /.ssh/known_hosts. The option is a: <code>boolean</code> type. Default: true Group: security
    
    Parameters:
    
    useUserKnownHostsFile - the value to set
    
    Returns:
    
    the dsl builder
  - useUserKnownHostsFile
```
default ScpEndpointBuilderFactory.ScpEndpointBuilder useUserKnownHostsFile(String useUserKnownHostsFile)
```
    If knownHostFile has not been explicit configured, then use the host file from System.getProperty(user.home) /.ssh/known_hosts. The option will be converted to a <code>boolean</code> type. Default: true Group: security
    
    Parameters:
    
    useUserKnownHostsFile - the value to set
    
    Returns:
    
    the dsl builder

Interface ScpEndpointBuilderFactory.ScpEndpointBuilder

Method Summary

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

Methods inherited from interface org.apache.camel.EndpointProducerResolver

Method Detail

advanced

chmod

disconnect

disconnect

fileName

fileName

flatten

flatten

jailStartingDirectory

jailStartingDirectory

lazyStartProducer

lazyStartProducer

strictHostKeyChecking

knownHostsFile

password

preferredAuthentications

privateKeyBytes

privateKeyBytes

privateKeyFile

privateKeyFilePassphrase

username

useUserKnownHostsFile

useUserKnownHostsFile