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

Interface FilesEndpointBuilderFactory.FilesEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, FilesEndpointBuilderFactory.FilesEndpointConsumerBuilder, FilesEndpointBuilderFactory.FilesEndpointProducerBuilder

Enclosing interface:

FilesEndpointBuilderFactory

public static interface FilesEndpointBuilderFactory.FilesEndpointBuilder
extends FilesEndpointBuilderFactory.FilesEndpointConsumerBuilder, FilesEndpointBuilderFactory.FilesEndpointProducerBuilder

Builder for endpoint for the Azure Files component.

Method Summary

Modifier and Type	Method	Description
default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder	advanced()
default FilesEndpointBuilderFactory.FilesEndpointBuilder	credentialType(String credentialType)	Determines the credential strategy to adopt.
default FilesEndpointBuilderFactory.FilesEndpointBuilder	credentialType(org.apache.camel.component.file.azure.CredentialType credentialType)	Determines the credential strategy to adopt.
default FilesEndpointBuilderFactory.FilesEndpointBuilder	disconnect(boolean disconnect)	Whether or not to disconnect from remote FTP server right after use.
default FilesEndpointBuilderFactory.FilesEndpointBuilder	disconnect(String disconnect)	Whether or not to disconnect from remote FTP server right after use.
default FilesEndpointBuilderFactory.FilesEndpointBuilder	doneFileName(String doneFileName)	Producer: If provided, then Camel will write a 2nd done file when the original file has been written.
default FilesEndpointBuilderFactory.FilesEndpointBuilder	fileName(String fileName)	Use Expression such as File Language to dynamically set the filename.
default FilesEndpointBuilderFactory.FilesEndpointBuilder	sdd(String sdd)	part of service SAS token.
default FilesEndpointBuilderFactory.FilesEndpointBuilder	se(String se)	part of SAS token.
default FilesEndpointBuilderFactory.FilesEndpointBuilder	sharedKey(String sharedKey)	Shared key (storage account key).
default FilesEndpointBuilderFactory.FilesEndpointBuilder	si(String si)	part of service SAS token.
default FilesEndpointBuilderFactory.FilesEndpointBuilder	sig(String sig)	part of SAS token.
default FilesEndpointBuilderFactory.FilesEndpointBuilder	sip(String sip)	part of SAS token.
default FilesEndpointBuilderFactory.FilesEndpointBuilder	sp(String sp)	part of SAS token.
default FilesEndpointBuilderFactory.FilesEndpointBuilder	spr(String spr)	part of SAS token.
default FilesEndpointBuilderFactory.FilesEndpointBuilder	sr(String sr)	part of service SAS token.
default FilesEndpointBuilderFactory.FilesEndpointBuilder	srt(String srt)	part of SAS token.
default FilesEndpointBuilderFactory.FilesEndpointBuilder	ss(String ss)	part of account SAS token.
default FilesEndpointBuilderFactory.FilesEndpointBuilder	st(String st)	part of SAS token.
default FilesEndpointBuilderFactory.FilesEndpointBuilder	sv(String sv)	part of SAS token.

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.FilesEndpointConsumerBuilder

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, resumeDownload, resumeDownload, runLoggingLevel, runLoggingLevel, scheduledExecutorService, scheduledExecutorService, scheduler, scheduler, schedulerProperties, schedulerProperties, 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.FilesEndpointBuilderFactory.FilesEndpointProducerBuilder

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

Method Details

advanced

default FilesEndpointBuilderFactory.AdvancedFilesEndpointBuilder advanced()

Specified by:

advanced in interface FilesEndpointBuilderFactory.FilesEndpointConsumerBuilder

Specified by:

advanced in interface FilesEndpointBuilderFactory.FilesEndpointProducerBuilder

credentialType

default FilesEndpointBuilderFactory.FilesEndpointBuilder credentialType(org.apache.camel.component.file.azure.CredentialType credentialType)

Determines the credential strategy to adopt. The option is a: org.apache.camel.component.file.azure.CredentialType type. Default: SHARED_ACCOUNT_KEY Group: common

Specified by:

credentialType in interface FilesEndpointBuilderFactory.FilesEndpointConsumerBuilder

Specified by:

credentialType in interface FilesEndpointBuilderFactory.FilesEndpointProducerBuilder

Parameters:

credentialType - the value to set

Returns:

the dsl builder

credentialType

default FilesEndpointBuilderFactory.FilesEndpointBuilder credentialType(String credentialType)

Determines the credential strategy to adopt. The option will be converted to a org.apache.camel.component.file.azure.CredentialType type. Default: SHARED_ACCOUNT_KEY Group: common

Specified by:

credentialType in interface FilesEndpointBuilderFactory.FilesEndpointConsumerBuilder

Specified by:

credentialType in interface FilesEndpointBuilderFactory.FilesEndpointProducerBuilder

Parameters:

credentialType - the value to set

Returns:

the dsl builder

disconnect

default FilesEndpointBuilderFactory.FilesEndpointBuilder 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: boolean type. Default: false Group: common

Specified by:

disconnect in interface FilesEndpointBuilderFactory.FilesEndpointConsumerBuilder

Specified by:

disconnect in interface FilesEndpointBuilderFactory.FilesEndpointProducerBuilder

Parameters:

disconnect - the value to set

Returns:

the dsl builder

disconnect

default FilesEndpointBuilderFactory.FilesEndpointBuilder 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 boolean type. Default: false Group: common

Specified by:

disconnect in interface FilesEndpointBuilderFactory.FilesEndpointConsumerBuilder

Specified by:

disconnect in interface FilesEndpointBuilderFactory.FilesEndpointProducerBuilder

Parameters:

disconnect - the value to set

Returns:

the dsl builder

doneFileName

default FilesEndpointBuilderFactory.FilesEndpointBuilder 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 FilesEndpointBuilderFactory.FilesEndpointConsumerBuilder

Specified by:

doneFileName in interface FilesEndpointBuilderFactory.FilesEndpointProducerBuilder

Parameters:

doneFileName - the value to set

Returns:

the dsl builder

fileName

default FilesEndpointBuilderFactory.FilesEndpointBuilder 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 FilesEndpointBuilderFactory.FilesEndpointConsumerBuilder

Specified by:

fileName in interface FilesEndpointBuilderFactory.FilesEndpointProducerBuilder

Parameters:

fileName - the value to set

Returns:

the dsl builder

sharedKey

default FilesEndpointBuilderFactory.FilesEndpointBuilder sharedKey(String sharedKey)

Shared key (storage account key). The option is a: java.lang.String type. Group: common

Specified by:

sharedKey in interface FilesEndpointBuilderFactory.FilesEndpointConsumerBuilder

Specified by:

sharedKey in interface FilesEndpointBuilderFactory.FilesEndpointProducerBuilder

Parameters:

sharedKey - the value to set

Returns:

the dsl builder

sdd

default FilesEndpointBuilderFactory.FilesEndpointBuilder sdd(String sdd)

part of service SAS token. The option is a: java.lang.String type. Group: security

Specified by:

sdd in interface FilesEndpointBuilderFactory.FilesEndpointConsumerBuilder

Specified by:

sdd in interface FilesEndpointBuilderFactory.FilesEndpointProducerBuilder

Parameters:

sdd - the value to set

Returns:

the dsl builder

se

default FilesEndpointBuilderFactory.FilesEndpointBuilder se(String se)

part of SAS token. The option is a: java.lang.String type. Group: security

Specified by:

se in interface FilesEndpointBuilderFactory.FilesEndpointConsumerBuilder

Specified by:

se in interface FilesEndpointBuilderFactory.FilesEndpointProducerBuilder

Parameters:

se - the value to set

Returns:

the dsl builder

si

default FilesEndpointBuilderFactory.FilesEndpointBuilder si(String si)

part of service SAS token. The option is a: java.lang.String type. Group: security

Specified by:

si in interface FilesEndpointBuilderFactory.FilesEndpointConsumerBuilder

Specified by:

si in interface FilesEndpointBuilderFactory.FilesEndpointProducerBuilder

Parameters:

si - the value to set

Returns:

the dsl builder

sig

default FilesEndpointBuilderFactory.FilesEndpointBuilder sig(String sig)

part of SAS token. The option is a: java.lang.String type. Group: security

Specified by:

sig in interface FilesEndpointBuilderFactory.FilesEndpointConsumerBuilder

Specified by:

sig in interface FilesEndpointBuilderFactory.FilesEndpointProducerBuilder

Parameters:

sig - the value to set

Returns:

the dsl builder

sip

default FilesEndpointBuilderFactory.FilesEndpointBuilder sip(String sip)

part of SAS token. The option is a: java.lang.String type. Group: security

Specified by:

sip in interface FilesEndpointBuilderFactory.FilesEndpointConsumerBuilder

Specified by:

sip in interface FilesEndpointBuilderFactory.FilesEndpointProducerBuilder

Parameters:

sip - the value to set

Returns:

the dsl builder

sp

default FilesEndpointBuilderFactory.FilesEndpointBuilder sp(String sp)

part of SAS token. The option is a: java.lang.String type. Group: security

Specified by:

sp in interface FilesEndpointBuilderFactory.FilesEndpointConsumerBuilder

Specified by:

sp in interface FilesEndpointBuilderFactory.FilesEndpointProducerBuilder

Parameters:

sp - the value to set

Returns:

the dsl builder

spr

default FilesEndpointBuilderFactory.FilesEndpointBuilder spr(String spr)

part of SAS token. The option is a: java.lang.String type. Group: security

Specified by:

spr in interface FilesEndpointBuilderFactory.FilesEndpointConsumerBuilder

Specified by:

spr in interface FilesEndpointBuilderFactory.FilesEndpointProducerBuilder

Parameters:

spr - the value to set

Returns:

the dsl builder

sr

default FilesEndpointBuilderFactory.FilesEndpointBuilder sr(String sr)

part of service SAS token. The option is a: java.lang.String type. Group: security

Specified by:

sr in interface FilesEndpointBuilderFactory.FilesEndpointConsumerBuilder

Specified by:

sr in interface FilesEndpointBuilderFactory.FilesEndpointProducerBuilder

Parameters:

sr - the value to set

Returns:

the dsl builder

srt

default FilesEndpointBuilderFactory.FilesEndpointBuilder srt(String srt)

part of SAS token. The option is a: java.lang.String type. Group: security

Specified by:

srt in interface FilesEndpointBuilderFactory.FilesEndpointConsumerBuilder

Specified by:

srt in interface FilesEndpointBuilderFactory.FilesEndpointProducerBuilder

Parameters:

srt - the value to set

Returns:

the dsl builder

ss

default FilesEndpointBuilderFactory.FilesEndpointBuilder ss(String ss)

part of account SAS token. The option is a: java.lang.String type. Group: security

Specified by:

ss in interface FilesEndpointBuilderFactory.FilesEndpointConsumerBuilder

Specified by:

ss in interface FilesEndpointBuilderFactory.FilesEndpointProducerBuilder

Parameters:

ss - the value to set

Returns:

the dsl builder

st

default FilesEndpointBuilderFactory.FilesEndpointBuilder st(String st)

part of SAS token. The option is a: java.lang.String type. Group: security

Specified by:

st in interface FilesEndpointBuilderFactory.FilesEndpointConsumerBuilder

Specified by:

st in interface FilesEndpointBuilderFactory.FilesEndpointProducerBuilder

Parameters:

st - the value to set

Returns:

the dsl builder

sv

default FilesEndpointBuilderFactory.FilesEndpointBuilder sv(String sv)

part of SAS token. The option is a: java.lang.String type. Group: security

Specified by:

sv in interface FilesEndpointBuilderFactory.FilesEndpointConsumerBuilder

Specified by:

sv in interface FilesEndpointBuilderFactory.FilesEndpointProducerBuilder

Parameters:

sv - the value to set

Returns:

the dsl builder