org.apache.camel.builder.endpoint.dsl

Interface HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder

All Superinterfaces:

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

All Known Subinterfaces:

HdfsEndpointBuilderFactory.HdfsEndpointBuilder

Enclosing interface:

HdfsEndpointBuilderFactory

public static interface HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint producers for the HDFS component.

Method Summary

Modifier and Type	Method and Description
default HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder	advanced()
default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder	append(boolean append) Append to existing file.
default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder	append(String append) Append to existing file.
default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder	connectOnStartup(boolean connectOnStartup) Whether to connect to the HDFS file system on starting the producer/consumer.
default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder	connectOnStartup(String connectOnStartup) Whether to connect to the HDFS file system on starting the producer/consumer.
default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder	fileSystemType(HdfsEndpointBuilderFactory.HdfsFileSystemType fileSystemType) Set to LOCAL to not use HDFS but local java.io.File instead.
default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder	fileSystemType(String fileSystemType) Set to LOCAL to not use HDFS but local java.io.File instead.
default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder	fileType(HdfsEndpointBuilderFactory.HdfsFileType fileType) The file type to use.
default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder	fileType(String fileType) The file type to use.
default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder	kerberosConfigFileLocation(String kerberosConfigFileLocation) The location of the kerb5.conf file (https://web.mit.edu/kerberos/krb5-1.12/doc/admin/conf_files/krb5_conf.html).
default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder	kerberosKeytabLocation(String kerberosKeytabLocation) The location of the keytab file used to authenticate with the kerberos nodes (contains pairs of kerberos principals and encrypted keys (which are derived from the Kerberos password)).
default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder	kerberosUsername(String kerberosUsername) The username used to authenticate with the kerberos nodes.
default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder	keyType(HdfsEndpointBuilderFactory.WritableType keyType) The type for the key in case of sequence or map files.
default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder	keyType(String keyType) The type for the key in case of sequence or map files.
default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder	namedNodes(String namedNodes) A comma separated list of named nodes (e.g.
default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder	overwrite(boolean overwrite) Whether to overwrite existing files with the same name.
default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder	overwrite(String overwrite) Whether to overwrite existing files with the same name.
default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder	owner(String owner) The file owner must match this owner for the consumer to pickup the file.
default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder	valueType(HdfsEndpointBuilderFactory.WritableType valueType) The type for the key in case of sequence or map files.
default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder	valueType(String valueType) The type for the key in case of sequence or map files.

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 HdfsEndpointBuilderFactory.AdvancedHdfsEndpointProducerBuilder advanced()

connectOnStartup

default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder connectOnStartup(boolean connectOnStartup)

Whether to connect to the HDFS file system on starting the producer/consumer. If false then the connection is created on-demand. Notice that HDFS may take up till 15 minutes to establish a connection, as it has hardcoded 45 x 20 sec redelivery. By setting this option to false allows your application to startup, and not block for up till 15 minutes. The option is a: <code>boolean</code> type. Default: true Group: common

Parameters:

connectOnStartup - the value to set

Returns:

the dsl builder

connectOnStartup

default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder connectOnStartup(String connectOnStartup)

Whether to connect to the HDFS file system on starting the producer/consumer. If false then the connection is created on-demand. Notice that HDFS may take up till 15 minutes to establish a connection, as it has hardcoded 45 x 20 sec redelivery. By setting this option to false allows your application to startup, and not block for up till 15 minutes. The option will be converted to a <code>boolean</code> type. Default: true Group: common

Parameters:

connectOnStartup - the value to set

Returns:

the dsl builder

fileSystemType

default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder fileSystemType(HdfsEndpointBuilderFactory.HdfsFileSystemType fileSystemType)

Set to LOCAL to not use HDFS but local java.io.File instead. The option is a: <code>org.apache.camel.component.hdfs.HdfsFileSystemType</code> type. Default: HDFS Group: common

Parameters:

fileSystemType - the value to set

Returns:

the dsl builder

fileSystemType

default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder fileSystemType(String fileSystemType)

Set to LOCAL to not use HDFS but local java.io.File instead. The option will be converted to a <code>org.apache.camel.component.hdfs.HdfsFileSystemType</code> type. Default: HDFS Group: common

Parameters:

fileSystemType - the value to set

Returns:

the dsl builder

fileType

default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder fileType(HdfsEndpointBuilderFactory.HdfsFileType fileType)

The file type to use. For more details see Hadoop HDFS documentation about the various files types. The option is a: <code>org.apache.camel.component.hdfs.HdfsFileType</code> type. Default: NORMAL_FILE Group: common

Parameters:

fileType - the value to set

Returns:

the dsl builder

fileType

default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder fileType(String fileType)

The file type to use. For more details see Hadoop HDFS documentation about the various files types. The option will be converted to a <code>org.apache.camel.component.hdfs.HdfsFileType</code> type. Default: NORMAL_FILE Group: common

Parameters:

fileType - the value to set

Returns:

the dsl builder

keyType

default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder keyType(HdfsEndpointBuilderFactory.WritableType keyType)

The type for the key in case of sequence or map files. The option is a: <code>org.apache.camel.component.hdfs.WritableType</code> type. Default: NULL Group: common

Parameters:

keyType - the value to set

Returns:

the dsl builder

keyType

default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder keyType(String keyType)

The type for the key in case of sequence or map files. The option will be converted to a <code>org.apache.camel.component.hdfs.WritableType</code> type. Default: NULL Group: common

Parameters:

keyType - the value to set

Returns:

the dsl builder

namedNodes

default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder namedNodes(String namedNodes)

A comma separated list of named nodes (e.g. srv11.example.com:8020,srv12.example.com:8020). The option is a: <code>java.lang.String</code> type. Group: common

Parameters:

namedNodes - the value to set

Returns:

the dsl builder

owner

default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder owner(String owner)

The file owner must match this owner for the consumer to pickup the file. Otherwise the file is skipped. The option is a: <code>java.lang.String</code> type. Group: common

Parameters:

owner - the value to set

Returns:

the dsl builder

valueType

default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder valueType(HdfsEndpointBuilderFactory.WritableType valueType)

The type for the key in case of sequence or map files. The option is a: <code>org.apache.camel.component.hdfs.WritableType</code> type. Default: BYTES Group: common

Parameters:

valueType - the value to set

Returns:

the dsl builder

valueType

default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder valueType(String valueType)

The type for the key in case of sequence or map files. The option will be converted to a <code>org.apache.camel.component.hdfs.WritableType</code> type. Default: BYTES Group: common

Parameters:

valueType - the value to set

Returns:

the dsl builder

append

default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder append(boolean append)

Append to existing file. Notice that not all HDFS file systems support the append option. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

append - the value to set

Returns:

the dsl builder

append

default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder append(String append)

Append to existing file. Notice that not all HDFS file systems support the append option. The option will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

append - the value to set

Returns:

the dsl builder

lazyStartProducer

default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder 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 HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder 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

overwrite

default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder overwrite(boolean overwrite)

Whether to overwrite existing files with the same name. The option is a: <code>boolean</code> type. Default: true Group: producer

Parameters:

overwrite - the value to set

Returns:

the dsl builder

overwrite

default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder overwrite(String overwrite)

Whether to overwrite existing files with the same name. The option will be converted to a <code>boolean</code> type. Default: true Group: producer

Parameters:

overwrite - the value to set

Returns:

the dsl builder

kerberosConfigFileLocation

default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder kerberosConfigFileLocation(String kerberosConfigFileLocation)

The location of the kerb5.conf file (https://web.mit.edu/kerberos/krb5-1.12/doc/admin/conf_files/krb5_conf.html). The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

kerberosConfigFileLocation - the value to set

Returns:

the dsl builder

kerberosKeytabLocation

default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder kerberosKeytabLocation(String kerberosKeytabLocation)

The location of the keytab file used to authenticate with the kerberos nodes (contains pairs of kerberos principals and encrypted keys (which are derived from the Kerberos password)). The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

kerberosKeytabLocation - the value to set

Returns:

the dsl builder

kerberosUsername

default HdfsEndpointBuilderFactory.HdfsEndpointProducerBuilder kerberosUsername(String kerberosUsername)

The username used to authenticate with the kerberos nodes. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

kerberosUsername - the value to set

Returns:

the dsl builder