org.apache.camel.component.file.remote
Class FtpEndpoint<T extends org.apache.commons.net.ftp.FTPFile>

java.lang.Object
  extended by org.apache.camel.impl.ServiceSupport
      extended by org.apache.camel.impl.DefaultEndpoint
          extended by org.apache.camel.impl.ScheduledPollEndpoint
              extended by org.apache.camel.component.file.GenericFileEndpoint<T>
                  extended by org.apache.camel.component.file.remote.RemoteFileEndpoint<org.apache.commons.net.ftp.FTPFile>
                      extended by org.apache.camel.component.file.remote.FtpEndpoint<T>
All Implemented Interfaces:
CamelContextAware, Endpoint, IsSingleton, Service, ShutdownableService, BrowsableEndpoint, HasId
Direct Known Subclasses:
FtpsEndpoint

public class FtpEndpoint<T extends org.apache.commons.net.ftp.FTPFile>
extends RemoteFileEndpoint<org.apache.commons.net.ftp.FTPFile>

FTP endpoint


Field Summary
protected  int dataTimeout
           
protected  org.apache.commons.net.ftp.FTPClient ftpClient
           
protected  org.apache.commons.net.ftp.FTPClientConfig ftpClientConfig
           
protected  Map<String,Object> ftpClientConfigParameters
           
protected  Map<String,Object> ftpClientParameters
           
protected  int soTimeout
           
 
Fields inherited from class org.apache.camel.component.file.GenericFileEndpoint
autoCreate, bufferSize, charset, configuration, DEFAULT_IDEMPOTENT_CACHE_SIZE, DEFAULT_STRATEGYFACTORY_CLASS, delete, directoryMustExist, doneFileName, eagerDeleteTargetFile, exclude, exclusiveReadLockStrategy, fileExist, fileName, filter, flatten, idempotent, idempotentRepository, include, inProgressRepository, keepLastModified, localWorkDirectory, log, maxDepth, maxMessagesPerPoll, minDepth, move, moveFailed, noop, preMove, processStrategy, readLock, readLockCheckInterval, readLockTimeout, recursive, sortBy, sorter, startingDirectoryMustExist, tempFileName, tempPrefix
 
Constructor Summary
FtpEndpoint()
           
FtpEndpoint(String uri, RemoteFileComponent<org.apache.commons.net.ftp.FTPFile> component, RemoteFileConfiguration configuration)
           
 
Method Summary
protected  RemoteFileConsumer<org.apache.commons.net.ftp.FTPFile> buildConsumer(Processor processor)
          Remote File Endpoints, impl this method to create a custom consumer specific to their "protocol" etc.
protected  GenericFileProducer<org.apache.commons.net.ftp.FTPFile> buildProducer()
          Remote File Endpoints, impl this method to create a custom producer specific to their "protocol" etc.
protected  org.apache.commons.net.ftp.FTPClient createFtpClient()
           
 RemoteFileOperations<org.apache.commons.net.ftp.FTPFile> createRemoteFileOperations()
          Creates the operations to be used by the consumer or producer.
 FtpConfiguration getConfiguration()
           
 org.apache.commons.net.ftp.FTPClient getFtpClient()
           
 org.apache.commons.net.ftp.FTPClientConfig getFtpClientConfig()
           
 String getScheme()
           
 int getSoTimeout()
           
 void setConfiguration(FtpConfiguration configuration)
           
 void setConfiguration(GenericFileConfiguration configuration)
           
 void setFtpClient(org.apache.commons.net.ftp.FTPClient ftpClient)
           
 void setFtpClientConfig(org.apache.commons.net.ftp.FTPClientConfig ftpClientConfig)
           
 void setSoTimeout(int soTimeout)
          Sets the soTimeout option.
 
Methods inherited from class org.apache.camel.component.file.remote.RemoteFileEndpoint
afterPropertiesSet, createConsumer, createExchange, createProducer, getFileSeparator, getMaximumReconnectAttempts, getReconnectDelay, isAbsolute, isDisconnect, remoteServerInformation, setDisconnect, setMaximumReconnectAttempts, setReconnectDelay
 
Methods inherited from class org.apache.camel.component.file.GenericFileEndpoint
configureExchange, configureMessage, configureMoveOrPreMoveExpression, createDoneFileName, createGenericFileStrategy, doStart, doStop, getBufferSize, getCharset, getDoneFileName, getExchanges, getExclude, getExclusiveReadLockStrategy, getFileExist, getFileName, getFilter, getGeneratedFileName, getGenericFileProcessStrategy, getIdempotentRepository, getInclude, getInProgressRepository, getLocalWorkDirectory, getMaxDepth, getMaxMessagesPerPoll, getMinDepth, getMove, getMoveFailed, getParamsAsMap, getPreMove, getProcessStrategy, getReadLock, getReadLockCheckInterval, getReadLockTimeout, getSortBy, getSorter, getTempFileName, getTempPrefix, isAutoCreate, isDelete, isDirectoryMustExist, isDoneFile, isEagerDeleteTargetFile, isFlatten, isIdempotent, isKeepLastModified, isNoop, isRecursive, isSingleton, isStartingDirectoryMustExist, setAutoCreate, setBufferSize, setCharset, setDelete, setDirectoryMustExist, setDoneFileName, setEagerDeleteTargetFile, setExclude, setExclusiveReadLockStrategy, setFileExist, setFileName, setFileName, setFilter, setFlatten, setIdempotent, setIdempotentRepository, setInclude, setInProgressRepository, setKeepLastModified, setLocalWorkDirectory, setMaxDepth, setMaxMessagesPerPoll, setMinDepth, setMove, setMove, setMoveFailed, setMoveFailed, setNoop, setPreMove, setPreMove, setProcessStrategy, setReadLock, setReadLockCheckInterval, setReadLockTimeout, setRecursive, setSortBy, setSortBy, setSortBy, setSorter, setStartingDirectoryMustExist, setTempFileName, setTempFileName, setTempPrefix
 
Methods inherited from class org.apache.camel.impl.ScheduledPollEndpoint
configureConsumer, configureProperties, getConsumerProperties, setConsumerProperties
 
Methods inherited from class org.apache.camel.impl.DefaultEndpoint
createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, equals, getCamelContext, getComponent, getEndpointKey, getEndpointUri, getExchangePattern, getExchangeType, getId, hashCode, isLenientProperties, isSynchronous, setCamelContext, setEndpointUri, setEndpointUriIfNotSpecified, setExchangePattern, setSynchronous, toString
 
Methods inherited from class org.apache.camel.impl.ServiceSupport
addChildService, doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspended, isSuspending, removeChildService, resume, shutdown, start, 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, getEndpointKey, getEndpointUri, isLenientProperties, setCamelContext
 
Methods inherited from interface org.apache.camel.Service
start, stop
 

Field Detail

ftpClient

protected org.apache.commons.net.ftp.FTPClient ftpClient

ftpClientConfig

protected org.apache.commons.net.ftp.FTPClientConfig ftpClientConfig

ftpClientParameters

protected Map<String,Object> ftpClientParameters

ftpClientConfigParameters

protected Map<String,Object> ftpClientConfigParameters

soTimeout

protected int soTimeout

dataTimeout

protected int dataTimeout
Constructor Detail

FtpEndpoint

public FtpEndpoint()

FtpEndpoint

public FtpEndpoint(String uri,
                   RemoteFileComponent<org.apache.commons.net.ftp.FTPFile> component,
                   RemoteFileConfiguration configuration)
Method Detail

getScheme

public String getScheme()
Specified by:
getScheme in class GenericFileEndpoint<org.apache.commons.net.ftp.FTPFile>

buildConsumer

protected RemoteFileConsumer<org.apache.commons.net.ftp.FTPFile> buildConsumer(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<org.apache.commons.net.ftp.FTPFile>
Parameters:
processor - the processor
Returns:
the created consumer

buildProducer

protected GenericFileProducer<org.apache.commons.net.ftp.FTPFile> 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<org.apache.commons.net.ftp.FTPFile>
Returns:
the created producer

createRemoteFileOperations

public RemoteFileOperations<org.apache.commons.net.ftp.FTPFile> createRemoteFileOperations()
                                                                                    throws Exception
Description copied from class: RemoteFileEndpoint
Creates the operations to be used by the consumer or producer.

Specified by:
createRemoteFileOperations in class RemoteFileEndpoint<org.apache.commons.net.ftp.FTPFile>
Returns:
a new created operations
Throws:
Exception - is thrown if error creating operations.

createFtpClient

protected org.apache.commons.net.ftp.FTPClient createFtpClient()
                                                        throws Exception
Throws:
Exception

getConfiguration

public FtpConfiguration getConfiguration()
Overrides:
getConfiguration in class RemoteFileEndpoint<org.apache.commons.net.ftp.FTPFile>

setConfiguration

public void setConfiguration(GenericFileConfiguration configuration)
Overrides:
setConfiguration in class GenericFileEndpoint<org.apache.commons.net.ftp.FTPFile>

setConfiguration

public void setConfiguration(FtpConfiguration configuration)

getFtpClient

public org.apache.commons.net.ftp.FTPClient getFtpClient()

setFtpClient

public void setFtpClient(org.apache.commons.net.ftp.FTPClient ftpClient)

getFtpClientConfig

public org.apache.commons.net.ftp.FTPClientConfig getFtpClientConfig()

setFtpClientConfig

public void setFtpClientConfig(org.apache.commons.net.ftp.FTPClientConfig ftpClientConfig)

getSoTimeout

public int getSoTimeout()

setSoTimeout

public void setSoTimeout(int soTimeout)
Sets the soTimeout option.

Used by FTPClient



Apache CAMEL