Package org.apache.camel.component.file.azure

Class FilesEndpoint

java.lang.Object
org.apache.camel.support.service.BaseService
org.apache.camel.support.service.ServiceSupport
org.apache.camel.support.DefaultEndpoint
org.apache.camel.support.ScheduledPollEndpoint
org.apache.camel.component.file.GenericFileEndpoint<com.azure.storage.file.share.models.ShareFileItem>
org.apache.camel.component.file.remote.RemoteFileEndpoint<com.azure.storage.file.share.models.ShareFileItem>
org.apache.camel.component.file.azure.FilesEndpoint
All Implemented Interfaces:
AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.ComponentAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.BrowsableEndpoint, org.apache.camel.spi.EndpointServiceLocation, org.apache.camel.spi.HasCamelContext, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService
@UriEndpoint(firstVersion="3.22.0", scheme="azure-files", extendsScheme="file", title="Azure Files", syntax="azure-files:account/share", category={CLOUD,FILE}, headersClass=FilesHeaders.class) @Metadata(excludeProperties="appendChars,readLockIdempotentReleaseAsync,readLockIdempotentReleaseAsyncPoolSize,readLockIdempotentReleaseDelay,readLockIdempotentReleaseExecutorService,directoryMustExist,extendedAttributes,probeContentType,startingDirectoryMustExist,startingDirectoryMustHaveAccess,chmodDirectory,forceWrites,copyAndDeleteOnRenameFail,renameUsingCopy,synchronous,passive,passiveMode,stepwise,useList,binary,charset,password,siteCommand,fastExistsCheck,soTimeout,separator,sendNoop,ignoreFileNotFoundOrPermissionError,bufferSize,moveExisting,username,host") @ManagedResource(description="Camel Azure Files endpoint") public class FilesEndpoint extends org.apache.camel.component.file.remote.RemoteFileEndpoint<com.azure.storage.file.share.models.ShareFileItem> implements org.apache.camel.spi.EndpointServiceLocation
Send and receive files to Azure storage file share

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected FilesConfiguration
    configuration
     
    protected boolean
    resumeDownload
     
    protected org.apache.camel.component.file.azure.FilesToken
    token
     

    Fields inherited from class org.apache.camel.component.file.GenericFileEndpoint

    allowNullBody, antExclude, antFilter, antFilterCaseSensitive, antInclude, appendChars, autoCreate, bufferSize, charset, checksumFileAlgorithm, DEFAULT_IDEMPOTENT_CACHE_SIZE, DEFAULT_IN_PROGRESS_CACHE_SIZE, delete, doneFileName, eagerDeleteTargetFile, eagerMaxMessagesPerPoll, exclude, excludeExt, exclusiveReadLockStrategy, fileExist, fileName, filter, filterDirectory, filterFile, flatten, idempotent, idempotentKey, idempotentRepository, include, includeExt, inProgressRepository, jailStartingDirectory, keepLastModified, localWorkDirectory, maxDepth, maxMessagesPerPoll, minDepth, move, moveExisting, moveExistingFileStrategy, moveFailed, noop, onCompletionExceptionHandler, preMove, preSort, processStrategy, readLock, readLockCheckInterval, readLockDeleteOrphanLockFiles, readLockIdempotentReleaseAsync, readLockIdempotentReleaseAsyncPoolSize, readLockIdempotentReleaseDelay, readLockIdempotentReleaseExecutorService, readLockLoggingLevel, readLockMarkerFile, readLockMinAge, readLockMinLength, readLockRemoveOnCommit, readLockRemoveOnRollback, readLockTimeout, recursive, shuffle, sortBy, sorter, tempFileName, tempPrefix

    Fields inherited from class org.apache.camel.support.service.BaseService

    BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

  • Constructor Summary

    Constructors
    Constructor
    Description
    FilesEndpoint()
     
    FilesEndpoint(String uri, FilesComponent component, FilesConfiguration configuration)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected FilesConsumer
    buildConsumer(org.apache.camel.Processor processor)
     
    protected FilesProducer
    buildProducer()
     
    org.apache.camel.component.file.remote.RemoteFileConsumer<com.azure.storage.file.share.models.ShareFileItem>
    createConsumer(org.apache.camel.Processor processor)
     
    protected org.apache.camel.component.file.GenericFileProcessStrategy<com.azure.storage.file.share.models.ShareFileItem>
    createGenericFileStrategy()
     
    FilesOperations
    createRemoteFileOperations()
     
    String
    getCharset()
     
    FilesConfiguration
    getConfiguration()
     
    char
    getFileSeparator()
     
    String
    getScheme()
     
    Map<String,String>
    getServiceMetadata()
     
    String
    getServiceProtocol()
     
    String
    getServiceUrl()
     
    org.apache.camel.component.file.azure.FilesToken
    getToken()
     
    boolean
    isResumeDownload()
     
    void
    setConfiguration(org.apache.camel.component.file.GenericFileConfiguration configuration)
     
    void
    setResumeDownload(boolean resumeDownload)
    Configures whether resume download is enabled.
    void
    setToken(org.apache.camel.component.file.azure.FilesToken token)
     

    Methods inherited from class org.apache.camel.component.file.remote.RemoteFileEndpoint

    afterPropertiesSet, createExchange, createPollingConsumer, createProducer, getMaximumReconnectAttempts, getParamsAsMap, getReconnectDelay, isAbsolute, isDisconnect, isDisconnectOnBatchComplete, isDownload, isFastExistsCheck, isSingletonProducer, remoteServerInformation, setDisconnect, setDisconnectOnBatchComplete, setDownload, setFastExistsCheck, setMaximumReconnectAttempts, setReconnectDelay

    Methods inherited from class org.apache.camel.component.file.GenericFileEndpoint

    configureExchange, configureMessage, configureMoveOrPreMoveExpression, createDoneFileName, doInit, doStart, doStop, getAntExclude, getAntFilter, getAntInclude, getAppendChars, getBufferSize, getChecksumFileAlgorithm, getDoneFileName, getExchanges, getExclude, getExcludeExt, getExcludePattern, getExclusiveReadLockStrategy, getFileExist, getFileName, getFilter, getFilterDirectory, getFilterFile, getGeneratedFileName, getIdempotent, getIdempotentEager, getIdempotentKey, getIdempotentRepository, getInclude, getIncludeExt, getIncludePattern, getInProgressRepository, getLocalWorkDirectory, getMaxDepth, getMaxMessagesPerPoll, getMinDepth, getMove, getMoveExisting, getMoveExistingFileStrategy, getMoveFailed, getOnCompletionExceptionHandler, getPreMove, getProcessStrategy, getReadLock, getReadLockCheckInterval, getReadLockIdempotentReleaseAsyncPoolSize, getReadLockIdempotentReleaseDelay, getReadLockIdempotentReleaseExecutorService, getReadLockLoggingLevel, getReadLockMinAge, getReadLockMinLength, getReadLockTimeout, getSortBy, getSorter, getTempFileName, getTempPrefix, isAllowNullBody, isAntFilterCaseSensitive, isAutoCreate, isDelete, isDoneFile, isEagerDeleteTargetFile, isEagerMaxMessagesPerPoll, isFlatten, isHiddenFilesEnabled, isIdempotent, isIdempotentEager, isIdempotentSet, isJailStartingDirectory, isKeepLastModified, isNoop, isPreSort, isReadLockDeleteOrphanLockFiles, isReadLockIdempotentReleaseAsync, isReadLockMarkerFile, isReadLockRemoveOnCommit, isReadLockRemoveOnRollback, isRecursive, isShuffle, isSynchronous, setAllowNullBody, setAntExclude, setAntFilterCaseSensitive, setAntInclude, setAppendChars, setAutoCreate, setBufferSize, setCharset, setChecksumFileAlgorithm, setDelete, setDoneFileName, setEagerDeleteTargetFile, setEagerMaxMessagesPerPoll, setExclude, setExcludeExt, setExclusiveReadLockStrategy, setFileExist, setFileName, setFileName, setFilter, setFilterDirectory, setFilterDirectory, setFilterFile, setFilterFile, setFlatten, setIdempotent, setIdempotentEager, setIdempotentKey, setIdempotentKey, setIdempotentRepository, setInclude, setIncludeExt, setInProgressRepository, setJailStartingDirectory, setKeepLastModified, setLocalWorkDirectory, setMaxDepth, setMaxMessagesPerPoll, setMinDepth, setMove, setMove, setMoveExisting, setMoveExisting, setMoveExistingFileStrategy, setMoveFailed, setMoveFailed, setNoop, setOnCompletionExceptionHandler, setPreMove, setPreMove, setPreSort, setProcessStrategy, setReadLock, setReadLockCheckInterval, setReadLockDeleteOrphanLockFiles, setReadLockIdempotentReleaseAsync, setReadLockIdempotentReleaseAsyncPoolSize, setReadLockIdempotentReleaseDelay, setReadLockIdempotentReleaseExecutorService, setReadLockLoggingLevel, setReadLockMarkerFile, setReadLockMinAge, setReadLockMinLength, setReadLockRemoveOnCommit, setReadLockRemoveOnRollback, setReadLockTimeout, setRecursive, setShuffle, setSortBy, setSortBy, setSortBy, setSorter, setSynchronous, setTempFileName, setTempFileName, setTempPrefix

    Methods inherited from class org.apache.camel.support.ScheduledPollEndpoint

    configureConsumer, configureProperties, configureScheduledPollConsumerProperties, doConfigureConsumer, getBackoffErrorThreshold, getBackoffIdleThreshold, getBackoffMultiplier, getDefaultDelay, getDelay, getInitialDelay, getPollStrategy, getRepeatCount, getRunLoggingLevel, getScheduledExecutorService, getScheduler, getSchedulerProperties, getTimeUnit, isGreedy, isSendEmptyMessageWhenIdle, isStartScheduler, isUseFixedDelay, setBackoffErrorThreshold, setBackoffIdleThreshold, setBackoffMultiplier, setDelay, setGreedy, setInitialDelay, setPollStrategy, setRepeatCount, setRunLoggingLevel, setScheduledExecutorService, setScheduler, setSchedulerProperties, setSendEmptyMessageWhenIdle, setStartScheduler, setTimeUnit, setUseFixedDelay

    Methods inherited from class org.apache.camel.support.DefaultEndpoint

    configurePollingConsumer, createAsyncProducer, createEndpointUri, createExchange, createExchange, equals, getCamelContext, getComponent, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, isLenientProperties, isPollingConsumerBlockWhenFull, isPollingConsumerCopy, isSingleton, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setComponent, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerCopy, setPollingConsumerQueueSize, setProperties, toString

    Methods inherited from class org.apache.camel.support.service.BaseService

    build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, doSuspend, fail, getInternalLock, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.apache.camel.ComponentAware

    getComponent, getComponent, setComponent

    Methods inherited from interface org.apache.camel.Endpoint

    configureProperties, createAsyncProducer, createExchange, createExchange, getCamelContext, getEndpointBaseUri, getEndpointKey, getEndpointUri, getExchangePattern, isLenientProperties, isRemote, setCamelContext

    Methods inherited from interface org.apache.camel.IsSingleton

    isSingleton

    Methods inherited from interface org.apache.camel.Service

    build, close, init, start, stop

    Methods inherited from interface org.apache.camel.ShutdownableService

    shutdown

    Methods inherited from interface org.apache.camel.StatefulService

    getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

    Methods inherited from interface org.apache.camel.SuspendableService

    isSuspended, resume, suspend

  • Field Details

    • configuration

      @UriParam protected FilesConfiguration configuration

    • token

      @UriParam protected org.apache.camel.component.file.azure.FilesToken token

    • resumeDownload

      @UriParam(label="consumer") protected boolean resumeDownload

  • Constructor Details

  • Method Details

    • getScheme

      public String getScheme()
      Specified by:
      getScheme in class org.apache.camel.component.file.GenericFileEndpoint<com.azure.storage.file.share.models.ShareFileItem>

    • createConsumer

      public org.apache.camel.component.file.remote.RemoteFileConsumer<com.azure.storage.file.share.models.ShareFileItem> createConsumer(org.apache.camel.Processor processor) throws Exception
      Specified by:
      createConsumer in interface org.apache.camel.Endpoint
      Overrides:
      createConsumer in class org.apache.camel.component.file.remote.RemoteFileEndpoint<com.azure.storage.file.share.models.ShareFileItem>
      Throws:
      Exception

    • buildConsumer

      protected FilesConsumer buildConsumer(org.apache.camel.Processor processor)
      Specified by:
      buildConsumer in class org.apache.camel.component.file.remote.RemoteFileEndpoint<com.azure.storage.file.share.models.ShareFileItem>

    • buildProducer

      protected FilesProducer buildProducer()
      Specified by:
      buildProducer in class org.apache.camel.component.file.remote.RemoteFileEndpoint<com.azure.storage.file.share.models.ShareFileItem>

    • createGenericFileStrategy

      protected org.apache.camel.component.file.GenericFileProcessStrategy<com.azure.storage.file.share.models.ShareFileItem> createGenericFileStrategy()
      Specified by:
      createGenericFileStrategy in class org.apache.camel.component.file.GenericFileEndpoint<com.azure.storage.file.share.models.ShareFileItem>

    • createRemoteFileOperations

      public FilesOperations createRemoteFileOperations()
      Specified by:
      createRemoteFileOperations in class org.apache.camel.component.file.remote.RemoteFileEndpoint<com.azure.storage.file.share.models.ShareFileItem>

    • getToken

      public org.apache.camel.component.file.azure.FilesToken getToken()

    • setToken

      public void setToken(org.apache.camel.component.file.azure.FilesToken token)

    • getConfiguration

      public FilesConfiguration getConfiguration()
      Overrides:
      getConfiguration in class org.apache.camel.component.file.remote.RemoteFileEndpoint<com.azure.storage.file.share.models.ShareFileItem>

    • setConfiguration

      public void setConfiguration(org.apache.camel.component.file.GenericFileConfiguration configuration)
      Overrides:
      setConfiguration in class org.apache.camel.component.file.GenericFileEndpoint<com.azure.storage.file.share.models.ShareFileItem>

    • isResumeDownload

      public boolean isResumeDownload()

    • setResumeDownload

      public void setResumeDownload(boolean resumeDownload)
      Configures whether resume download is enabled. In addition the options localWorkDirectory must be configured so downloaded files are stored in a local directory, which is required to support resuming of downloads.

    • getFileSeparator

      public char getFileSeparator()
      Overrides:
      getFileSeparator in class org.apache.camel.component.file.remote.RemoteFileEndpoint<com.azure.storage.file.share.models.ShareFileItem>

    • getCharset

      public String getCharset()
      Overrides:
      getCharset in class org.apache.camel.component.file.GenericFileEndpoint<com.azure.storage.file.share.models.ShareFileItem>

    • getServiceUrl

      public String getServiceUrl()
      Specified by:
      getServiceUrl in interface org.apache.camel.spi.EndpointServiceLocation
      Overrides:
      getServiceUrl in class org.apache.camel.component.file.remote.RemoteFileEndpoint<com.azure.storage.file.share.models.ShareFileItem>

    • getServiceProtocol

      public String getServiceProtocol()
      Specified by:
      getServiceProtocol in interface org.apache.camel.spi.EndpointServiceLocation
      Overrides:
      getServiceProtocol in class org.apache.camel.component.file.remote.RemoteFileEndpoint<com.azure.storage.file.share.models.ShareFileItem>

    • getServiceMetadata

      public Map<String,String> getServiceMetadata()
      Specified by:
      getServiceMetadata in interface org.apache.camel.spi.EndpointServiceLocation
      Overrides:
      getServiceMetadata in class org.apache.camel.component.file.remote.RemoteFileEndpoint<com.azure.storage.file.share.models.ShareFileItem>