Package org.apache.camel.component.file.remote

Class SftpEndpoint

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<SftpRemoteFile>
org.apache.camel.component.file.remote.RemoteFileEndpoint<SftpRemoteFile>
org.apache.camel.component.file.remote.SftpEndpoint
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="1.1.0", scheme="sftp", extendsScheme="file", title="SFTP", syntax="sftp:host:port/directoryName", category=FILE, headersClass=FtpConstants.class) @Metadata(excludeProperties="appendChars,bufferSize,siteCommand,directoryMustExist,extendedAttributes,probeContentType,startingDirectoryMustExist,startingDirectoryMustHaveAccess,forceWrites,copyAndDeleteOnRenameFail,renameUsingCopy,synchronous") public class SftpEndpoint extends RemoteFileEndpoint<SftpRemoteFile>
Upload and download files to/from SFTP servers.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.apache.camel.spi.BrowsableEndpoint

    org.apache.camel.spi.BrowsableEndpoint.BrowseStatus

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected SftpConfiguration
    configuration
     
    protected com.jcraft.jsch.Proxy
    proxy
     

    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
    SftpEndpoint()
     
    SftpEndpoint(String uri, SftpComponent component, SftpConfiguration configuration)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected RemoteFileConsumer<SftpRemoteFile>
    buildConsumer(org.apache.camel.Processor processor)
    Remote File Endpoints, impl this method to create a custom consumer specific to their "protocol" etc.
    protected org.apache.camel.component.file.GenericFileProducer<SftpRemoteFile>
    buildProducer()
    Remote File Endpoints, impl this method to create a custom producer specific to their "protocol" etc.
    protected org.apache.camel.component.file.GenericFileProcessStrategy<SftpRemoteFile>
    createGenericFileStrategy()
     
    RemoteFileOperations<SftpRemoteFile>
    createRemoteFileOperations()
    Creates the operations to be used by the consumer or producer.
    SftpConfiguration
    getConfiguration()
     
    com.jcraft.jsch.Proxy
    getProxy()
     
    String
    getScheme()
     
    void
    setConfiguration(org.apache.camel.component.file.GenericFileConfiguration configuration)
     
    void
    setProxy(com.jcraft.jsch.Proxy proxy)
    To use a custom configured com.jcraft.jsch.Proxy.

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

    afterPropertiesSet, createConsumer, createExchange, createPollingConsumer, createProducer, getFileSeparator, getMaximumReconnectAttempts, getParamsAsMap, getReconnectDelay, getServiceMetadata, getServiceProtocol, getServiceUrl, 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, getBrowseLimit, getBrowseStatus, getBufferSize, getCharset, getChecksumFileAlgorithm, getDoneFileName, getExchanges, 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, setBrowseLimit, 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 SftpConfiguration configuration

    • proxy

      @UriParam(label="advanced") protected com.jcraft.jsch.Proxy proxy

  • Constructor Details

  • Method Details

    • getConfiguration

      public SftpConfiguration getConfiguration()
      Overrides:
      getConfiguration in class RemoteFileEndpoint<SftpRemoteFile>

    • setConfiguration

      public void setConfiguration(org.apache.camel.component.file.GenericFileConfiguration configuration)
      Overrides:
      setConfiguration in class org.apache.camel.component.file.GenericFileEndpoint<SftpRemoteFile>

    • buildConsumer

      protected RemoteFileConsumer<SftpRemoteFile> buildConsumer(org.apache.camel.Processor processor)
      Description copied from class: RemoteFileEndpoint
      Remote File Endpoints, impl this method to create a custom consumer specific to their "protocol" etc.
      Specified by:
      buildConsumer in class RemoteFileEndpoint<SftpRemoteFile>
      Parameters:
      processor - the processor
      Returns:
      the created consumer

    • buildProducer

      protected org.apache.camel.component.file.GenericFileProducer<SftpRemoteFile> buildProducer()
      Description copied from class: RemoteFileEndpoint
      Remote File Endpoints, impl this method to create a custom producer specific to their "protocol" etc.
      Specified by:
      buildProducer in class RemoteFileEndpoint<SftpRemoteFile>
      Returns:
      the created producer

    • createGenericFileStrategy

      protected org.apache.camel.component.file.GenericFileProcessStrategy<SftpRemoteFile> createGenericFileStrategy()
      Specified by:
      createGenericFileStrategy in class org.apache.camel.component.file.GenericFileEndpoint<SftpRemoteFile>

    • createRemoteFileOperations

      public RemoteFileOperations<SftpRemoteFile> createRemoteFileOperations()
      Description copied from class: RemoteFileEndpoint
      Creates the operations to be used by the consumer or producer.
      Specified by:
      createRemoteFileOperations in class RemoteFileEndpoint<SftpRemoteFile>
      Returns:
      a new created operations

    • getProxy

      public com.jcraft.jsch.Proxy getProxy()

    • setProxy

      public void setProxy(com.jcraft.jsch.Proxy proxy)
      To use a custom configured com.jcraft.jsch.Proxy. This proxy is used to consume/send messages from the target SFTP host.

    • getScheme

      public String getScheme()
      Specified by:
      getScheme in class org.apache.camel.component.file.GenericFileEndpoint<SftpRemoteFile>