org.apache.camel.component.file.remote
Class SftpEndpoint

java.lang.Object
  org.apache.camel.support.ServiceSupport
      org.apache.camel.impl.DefaultEndpoint
          org.apache.camel.impl.ScheduledPollEndpoint
              org.apache.camel.component.file.GenericFileEndpoint<T>
                  org.apache.camel.component.file.remote.RemoteFileEndpoint<com.jcraft.jsch.ChannelSftp.LsEntry>
                      org.apache.camel.component.file.remote.SftpEndpoint

All Implemented Interfaces:

org.apache.camel.CamelContextAware, 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.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@UriEndpoint(scheme="sftp",
             consumerClass=SftpConsumer.class)
public class SftpEndpoint
extends RemoteFileEndpoint<com.jcraft.jsch.ChannelSftp.LsEntry>

Secure FTP endpoint

Field Summary

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

allowNullBody, antFilter, autoCreate, bufferSize, charset, configuration, DEFAULT_IDEMPOTENT_CACHE_SIZE, DEFAULT_STRATEGYFACTORY_CLASS, delete, directoryMustExist, doneFileName, eagerDeleteTargetFile, eagerMaxMessagesPerPoll, exclude, exclusiveReadLockStrategy, fileExist, fileName, filter, flatten, idempotent, idempotentKey, idempotentRepository, include, inProgressRepository, keepLastModified, localWorkDirectory, log, maxDepth, maxMessagesPerPoll, minDepth, move, moveExisting, moveFailed, noop, preMove, processStrategy, readLock, readLockCheckInterval, readLockLoggingLevel, readLockMinLength, readLockTimeout, recursive, sortBy, sorter, startingDirectoryMustExist, tempFileName, tempPrefix

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

SftpEndpoint()

SftpEndpoint(String uri, SftpComponent component, RemoteFileConfiguration configuration)

Method Summary

protected RemoteFileConsumer<com.jcraft.jsch.ChannelSftp.LsEntry>	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<com.jcraft.jsch.ChannelSftp.LsEntry>	buildProducer() Remote File Endpoints, impl this method to create a custom producer specific to their "protocol" etc.
RemoteFileOperations<com.jcraft.jsch.ChannelSftp.LsEntry>	createRemoteFileOperations() Creates the operations to be used by the consumer or producer.
SftpConfiguration	getConfiguration()
String	getScheme()
void	setProxy(com.jcraft.jsch.Proxy proxy)

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

afterPropertiesSet, createConsumer, createExchange, createProducer, getFileSeparator, getMaximumReconnectAttempts, getParamsAsMap, getReconnectDelay, isAbsolute, isDisconnect, isDownload, isFastExistsCheck, remoteServerInformation, setDisconnect, setDownload, setFastExistsCheck, setMaximumReconnectAttempts, setReconnectDelay

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

configureExchange, configureMessage, configureMoveOrPreMoveExpression, createDoneFileName, createGenericFileStrategy, doStart, doStop, getAntFilter, getBufferSize, getCharset, getDoneFileName, getExchanges, getExclude, getExclusiveReadLockStrategy, getFileExist, getFileName, getFilter, getGeneratedFileName, getGenericFileProcessStrategy, getIdempotentKey, getIdempotentRepository, getInclude, getInProgressRepository, getLocalWorkDirectory, getMaxDepth, getMaxMessagesPerPoll, getMinDepth, getMove, getMoveExisting, getMoveFailed, getPreMove, getProcessStrategy, getReadLock, getReadLockCheckInterval, getReadLockLoggingLevel, getReadLockMinLength, getReadLockTimeout, getSortBy, getSorter, getTempFileName, getTempPrefix, isAllowNullBody, isAutoCreate, isDelete, isDirectoryMustExist, isDoneFile, isEagerDeleteTargetFile, isEagerMaxMessagesPerPoll, isFlatten, isIdempotent, isIdempotentSet, isKeepLastModified, isNoop, isRecursive, isSingleton, isStartingDirectoryMustExist, setAllowNullBody, setAntExclude, setAntFilterCaseSensitive, setAntInclude, setAutoCreate, setBufferSize, setCharset, setConfiguration, setDelete, setDirectoryMustExist, setDoneFileName, setEagerDeleteTargetFile, setEagerMaxMessagesPerPoll, setExclude, setExclusiveReadLockStrategy, setFileExist, setFileName, setFileName, setFilter, setFlatten, setIdempotent, setIdempotentKey, setIdempotentKey, setIdempotentRepository, setInclude, setInProgressRepository, setKeepLastModified, setLocalWorkDirectory, setMaxDepth, setMaxMessagesPerPoll, setMinDepth, setMove, setMove, setMoveExisting, setMoveExisting, setMoveFailed, setMoveFailed, setNoop, setPreMove, setPreMove, setProcessStrategy, setReadLock, setReadLockCheckInterval, setReadLockLoggingLevel, setReadLockMinLength, setReadLockTimeout, setRecursive, setSortBy, setSortBy, setSortBy, setSorter, setStartingDirectoryMustExist, setTempFileName, setTempFileName, setTempPrefix

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

configurePollingConsumer, configureProperties, configureScheduledPollConsumerProperties

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

configureConsumer, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExchangePattern, getId, hashCode, isLenientProperties, isSynchronous, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExchangePattern, setProperties, setSynchronous, toString

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

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, 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.Endpoint

configureProperties, createExchange, createExchange, createExchange, createPollingConsumer, getCamelContext, getEndpointConfiguration, getEndpointKey, getEndpointUri, isLenientProperties, setCamelContext

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

SftpEndpoint

public SftpEndpoint()

SftpEndpoint

public SftpEndpoint(String uri,
                    SftpComponent component,
                    RemoteFileConfiguration configuration)

Method Detail

getConfiguration

public SftpConfiguration getConfiguration()

Overrides:

getConfiguration in class RemoteFileEndpoint<com.jcraft.jsch.ChannelSftp.LsEntry>

buildConsumer

protected RemoteFileConsumer<com.jcraft.jsch.ChannelSftp.LsEntry> 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<com.jcraft.jsch.ChannelSftp.LsEntry>

Parameters:

processor - the processor

Returns:

the created consumer

buildProducer

protected org.apache.camel.component.file.GenericFileProducer<com.jcraft.jsch.ChannelSftp.LsEntry> 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<com.jcraft.jsch.ChannelSftp.LsEntry>

Returns:

the created producer

createRemoteFileOperations

public RemoteFileOperations<com.jcraft.jsch.ChannelSftp.LsEntry> createRemoteFileOperations()

Description copied from class: RemoteFileEndpoint

Creates the operations to be used by the consumer or producer.

Specified by:

createRemoteFileOperations in class RemoteFileEndpoint<com.jcraft.jsch.ChannelSftp.LsEntry>

Returns:

a new created operations

getScheme

public String getScheme()

Specified by:

getScheme in class org.apache.camel.component.file.GenericFileEndpoint<com.jcraft.jsch.ChannelSftp.LsEntry>

setProxy

public void setProxy(com.jcraft.jsch.Proxy proxy)