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

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<org.apache.commons.net.ftp.FTPFile>
                      org.apache.camel.component.file.remote.FtpEndpoint<org.apache.commons.net.ftp.FTPFile>
                          org.apache.camel.component.file.remote.FtpsEndpoint

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="ftps",
             consumerClass=FtpConsumer.class)
public class FtpsEndpoint
extends FtpEndpoint<org.apache.commons.net.ftp.FTPFile>

FTP Secure (FTP over SSL/TLS) endpoint

Version:

Field Summary

protected Map<String,Object>	ftpClientKeyStoreParameters
protected Map<String,Object>	ftpClientTrustStoreParameters
protected org.apache.camel.util.jsse.SSLContextParameters	sslContextParameters

Fields inherited from class org.apache.camel.component.file.remote.FtpEndpoint

dataTimeout, ftpClient, ftpClientConfig, ftpClientConfigParameters, ftpClientParameters, soTimeout

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

FtpsEndpoint()

FtpsEndpoint(String uri, RemoteFileComponent<org.apache.commons.net.ftp.FTPFile> remoteFileComponent, RemoteFileConfiguration configuration)

Method Summary

protected org.apache.commons.net.ftp.FTPClient	createFtpClient() Create the FTPS client.
RemoteFileOperations<org.apache.commons.net.ftp.FTPFile>	createRemoteFileOperations() Creates the operations to be used by the consumer or producer.
org.apache.commons.net.ftp.FTPSClient	getFtpsClient() Returns the FTPSClient.
FtpsConfiguration	getFtpsConfiguration() Returns the FtpsConfiguration.
String	getScheme()
org.apache.camel.util.jsse.SSLContextParameters	getSslContextParameters() Gets the JSSE configuration that overrides any settings in ftpClientKeyStoreParameters, ftpClientTrustStoreParameters, and FtpsConfiguration.getSecurityProtocol().
void	setFtpClientKeyStoreParameters(Map<String,Object> param) Set the key store parameters
void	setFtpClientTrustStoreParameters(Map<String,Object> param) Set the trust store parameters
void	setSslContextParameters(org.apache.camel.util.jsse.SSLContextParameters sslContextParameters) Gets the JSSE configuration that overrides any settings in ftpClientKeyStoreParameters, ftpClientTrustStoreParameters, and FtpsConfiguration.getSecurityProtocol().

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

buildConsumer, buildProducer, getConfiguration, getFileSeparator, getFtpClient, getFtpClientConfig, getSoTimeout, setConfiguration, setConfiguration, setFtpClient, setFtpClientConfig, setSoTimeout

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

afterPropertiesSet, createConsumer, createExchange, createProducer, 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, 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

Field Detail

ftpClientKeyStoreParameters

protected Map<String,Object> ftpClientKeyStoreParameters

ftpClientTrustStoreParameters

protected Map<String,Object> ftpClientTrustStoreParameters

sslContextParameters

protected org.apache.camel.util.jsse.SSLContextParameters sslContextParameters

Constructor Detail

FtpsEndpoint

public FtpsEndpoint()

FtpsEndpoint

public FtpsEndpoint(String uri,
                    RemoteFileComponent<org.apache.commons.net.ftp.FTPFile> remoteFileComponent,
                    RemoteFileConfiguration configuration)

Method Detail

getScheme

public String getScheme()

Overrides:

getScheme in class FtpEndpoint<org.apache.commons.net.ftp.FTPFile>

createFtpClient

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

Create the FTPS client.

Overrides:

createFtpClient in class FtpEndpoint<org.apache.commons.net.ftp.FTPFile>

Throws:

Exception

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.

Overrides:

createRemoteFileOperations in class FtpEndpoint<org.apache.commons.net.ftp.FTPFile>

Returns:

a new created operations

Throws:

Exception - is thrown if error creating operations.

getFtpsClient

public org.apache.commons.net.ftp.FTPSClient getFtpsClient()

Returns the FTPSClient. This method exists only for convenient.

Returns:

ftpsClient

getFtpsConfiguration

public FtpsConfiguration getFtpsConfiguration()

Returns the FtpsConfiguration. This method exists only for convenient.

Returns:

ftpsConfiguration

setFtpClientKeyStoreParameters

public void setFtpClientKeyStoreParameters(Map<String,Object> param)

Set the key store parameters

setFtpClientTrustStoreParameters

public void setFtpClientTrustStoreParameters(Map<String,Object> param)

Set the trust store parameters

getSslContextParameters

public org.apache.camel.util.jsse.SSLContextParameters getSslContextParameters()

Gets the JSSE configuration that overrides any settings in ftpClientKeyStoreParameters, ftpClientTrustStoreParameters, and FtpsConfiguration.getSecurityProtocol().

setSslContextParameters

public void setSslContextParameters(org.apache.camel.util.jsse.SSLContextParameters sslContextParameters)

Gets the JSSE configuration that overrides any settings in ftpClientKeyStoreParameters, ftpClientTrustStoreParameters, and FtpsConfiguration.getSecurityProtocol().