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

Interface SmbEndpointBuilderFactory.SmbEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, SmbEndpointBuilderFactory.SmbEndpointConsumerBuilder, SmbEndpointBuilderFactory.SmbEndpointProducerBuilder

Enclosing interface:

SmbEndpointBuilderFactory

public static interface SmbEndpointBuilderFactory.SmbEndpointBuilder
extends SmbEndpointBuilderFactory.SmbEndpointConsumerBuilder, SmbEndpointBuilderFactory.SmbEndpointProducerBuilder

Builder for endpoint for the SMB component.

Method Summary

Modifier and Type	Method	Description
default SmbEndpointBuilderFactory.AdvancedSmbEndpointBuilder	advanced()
default SmbEndpointBuilderFactory.SmbEndpointBuilder	charset(String charset)	This option is used to specify the encoding of the file.
default SmbEndpointBuilderFactory.SmbEndpointBuilder	disconnect(boolean disconnect)	Whether or not to disconnect from remote SMB share right after use.
default SmbEndpointBuilderFactory.SmbEndpointBuilder	disconnect(String disconnect)	Whether or not to disconnect from remote SMB share right after use.
default SmbEndpointBuilderFactory.SmbEndpointBuilder	domain(String domain)	The user domain.
default SmbEndpointBuilderFactory.SmbEndpointBuilder	doneFileName(String doneFileName)	Producer: If provided, then Camel will write a 2nd done file when the original file has been written.
default SmbEndpointBuilderFactory.SmbEndpointBuilder	fileName(String fileName)	Use Expression such as File Language to dynamically set the filename.
default SmbEndpointBuilderFactory.SmbEndpointBuilder	password(String password)	The password to access the share.
default SmbEndpointBuilderFactory.SmbEndpointBuilder	path(String path)	The base directory within the share.
default SmbEndpointBuilderFactory.SmbEndpointBuilder	username(String username)	The username required to access the share.

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.SmbEndpointBuilderFactory.SmbEndpointConsumerBuilder

antExclude, antFilterCaseSensitive, antFilterCaseSensitive, antInclude, backoffErrorThreshold, backoffErrorThreshold, backoffIdleThreshold, backoffIdleThreshold, backoffMultiplier, backoffMultiplier, delay, delay, delete, delete, eagerMaxMessagesPerPoll, eagerMaxMessagesPerPoll, exclude, excludeExt, exclusiveReadLockStrategy, exclusiveReadLockStrategy, filter, filter, filterDirectory, filterFile, greedy, greedy, idempotent, idempotent, idempotentEager, idempotentEager, idempotentKey, idempotentRepository, idempotentRepository, include, includeExt, initialDelay, initialDelay, maxDepth, maxDepth, maxMessagesPerPoll, maxMessagesPerPoll, minDepth, minDepth, move, moveFailed, noop, noop, preMove, preSort, preSort, readLock, readLockCheckInterval, readLockCheckInterval, readLockDeleteOrphanLockFiles, readLockDeleteOrphanLockFiles, readLockLoggingLevel, readLockLoggingLevel, readLockMarkerFile, readLockMarkerFile, readLockMinAge, readLockMinAge, readLockMinLength, readLockMinLength, readLockRemoveOnCommit, readLockRemoveOnCommit, readLockRemoveOnRollback, readLockRemoveOnRollback, readLockTimeout, readLockTimeout, recursive, recursive, repeatCount, repeatCount, runLoggingLevel, runLoggingLevel, scheduledExecutorService, scheduledExecutorService, scheduler, scheduler, schedulerProperties, schedulerProperties, searchPattern, sendEmptyMessageWhenIdle, sendEmptyMessageWhenIdle, shuffle, shuffle, sortBy, sorter, sorter, startScheduler, startScheduler, streamDownload, streamDownload, timeUnit, timeUnit, useFixedDelay, useFixedDelay

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SmbEndpointBuilderFactory.SmbEndpointProducerBuilder

checksumFileAlgorithm, fileExist, fileExist, flatten, flatten, jailStartingDirectory, jailStartingDirectory, moveExisting, tempFileName, tempPrefix

Method Details

advanced

default SmbEndpointBuilderFactory.AdvancedSmbEndpointBuilder advanced()

Specified by:

advanced in interface SmbEndpointBuilderFactory.SmbEndpointConsumerBuilder

Specified by:

advanced in interface SmbEndpointBuilderFactory.SmbEndpointProducerBuilder

charset

default SmbEndpointBuilderFactory.SmbEndpointBuilder charset(String charset)

This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset, so do not use this if you have big messages. The option is a: java.lang.String type. Group: common

Specified by:

charset in interface SmbEndpointBuilderFactory.SmbEndpointConsumerBuilder

Specified by:

charset in interface SmbEndpointBuilderFactory.SmbEndpointProducerBuilder

Parameters:

charset - the value to set

Returns:

the dsl builder

disconnect

default SmbEndpointBuilderFactory.SmbEndpointBuilder disconnect(boolean disconnect)

Whether or not to disconnect from remote SMB share right after use. Disconnect will only disconnect the current connection to the SMB share. If you have a consumer which you want to stop, then you need to stop the consumer/route instead. The option is a: boolean type. Default: false Group: common

Specified by:

disconnect in interface SmbEndpointBuilderFactory.SmbEndpointConsumerBuilder

Specified by:

disconnect in interface SmbEndpointBuilderFactory.SmbEndpointProducerBuilder

Parameters:

disconnect - the value to set

Returns:

the dsl builder

disconnect

default SmbEndpointBuilderFactory.SmbEndpointBuilder disconnect(String disconnect)

Whether or not to disconnect from remote SMB share right after use. Disconnect will only disconnect the current connection to the SMB share. 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 boolean type. Default: false Group: common

Specified by:

disconnect in interface SmbEndpointBuilderFactory.SmbEndpointConsumerBuilder

Specified by:

disconnect in interface SmbEndpointBuilderFactory.SmbEndpointProducerBuilder

Parameters:

disconnect - the value to set

Returns:

the dsl builder

doneFileName

default SmbEndpointBuilderFactory.SmbEndpointBuilder doneFileName(String doneFileName)

Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only ${file.name} and ${file.name.next} is supported as dynamic placeholders. The option is a: java.lang.String type. Group: common

Specified by:

doneFileName in interface SmbEndpointBuilderFactory.SmbEndpointConsumerBuilder

Specified by:

doneFileName in interface SmbEndpointBuilderFactory.SmbEndpointProducerBuilder

Parameters:

doneFileName - the value to set

Returns:

the dsl builder

fileName

default SmbEndpointBuilderFactory.SmbEndpointBuilder 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 is a: java.lang.String type. Group: common

Specified by:

fileName in interface SmbEndpointBuilderFactory.SmbEndpointConsumerBuilder

Specified by:

fileName in interface SmbEndpointBuilderFactory.SmbEndpointProducerBuilder

Parameters:

fileName - the value to set

Returns:

the dsl builder

path

default SmbEndpointBuilderFactory.SmbEndpointBuilder path(String path)

The base directory within the share. The option is a: java.lang.String type. Group: common

Specified by:

path in interface SmbEndpointBuilderFactory.SmbEndpointConsumerBuilder

Specified by:

path in interface SmbEndpointBuilderFactory.SmbEndpointProducerBuilder

Parameters:

path - the value to set

Returns:

the dsl builder

domain

default SmbEndpointBuilderFactory.SmbEndpointBuilder domain(String domain)

The user domain. The option is a: java.lang.String type. Group: security

Specified by:

domain in interface SmbEndpointBuilderFactory.SmbEndpointConsumerBuilder

Specified by:

domain in interface SmbEndpointBuilderFactory.SmbEndpointProducerBuilder

Parameters:

domain - the value to set

Returns:

the dsl builder

password

default SmbEndpointBuilderFactory.SmbEndpointBuilder password(String password)

The password to access the share. The option is a: java.lang.String type. Group: security

Specified by:

password in interface SmbEndpointBuilderFactory.SmbEndpointConsumerBuilder

Specified by:

password in interface SmbEndpointBuilderFactory.SmbEndpointProducerBuilder

Parameters:

password - the value to set

Returns:

the dsl builder

username

default SmbEndpointBuilderFactory.SmbEndpointBuilder username(String username)

The username required to access the share. The option is a: java.lang.String type. Group: security

Specified by:

username in interface SmbEndpointBuilderFactory.SmbEndpointConsumerBuilder

Specified by:

username in interface SmbEndpointBuilderFactory.SmbEndpointProducerBuilder

Parameters:

username - the value to set

Returns:

the dsl builder