Class FtpsEndpoint
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<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:
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.HasCamelContext
,org.apache.camel.spi.HasId
,org.apache.camel.StatefulService
,org.apache.camel.SuspendableService
@UriEndpoint(firstVersion="2.2.0",
scheme="ftps",
extendsScheme="file",
title="FTPS",
syntax="ftps:host:port/directoryName",
alternativeSyntax="ftps:username:password@host:port/directoryName",
category=FILE,
headersClass=FtpConstants.class)
@Metadata(excludeProperties="appendChars,readLockIdempotentReleaseAsync,readLockIdempotentReleaseAsyncPoolSize,readLockIdempotentReleaseDelay,readLockIdempotentReleaseExecutorService,directoryMustExist,extendedAttributes,probeContentType,startingDirectoryMustExist,startingDirectoryMustHaveAccess,chmodDirectory,forceWrites,copyAndDeleteOnRenameFail,renameUsingCopy,synchronous")
@ManagedResource(description="Managed FtpsEndpoint")
public class FtpsEndpoint
extends FtpEndpoint<org.apache.commons.net.ftp.FTPFile>
Upload and download files to/from FTP servers supporting the FTPS protocol.
-
Field Summary
Modifier and TypeFieldDescriptionprotected FtpsConfiguration
protected org.apache.camel.support.jsse.SSLContextParameters
Fields inherited from class org.apache.camel.component.file.remote.FtpEndpoint
dataTimeout, ftpClient, ftpClientConfig, ftpClientConfigParameters, ftpClientParameters, resumeDownload, soTimeout, transferLoggingIntervalSeconds, transferLoggingLevel, transferLoggingVerbose
Fields inherited from class org.apache.camel.component.file.GenericFileEndpoint
allowNullBody, antExclude, antFilter, antFilterCaseSensitive, antInclude, appendChars, autoCreate, bufferSize, charset, 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
ConstructorDescriptionFtpsEndpoint
(String uri, RemoteFileComponent<org.apache.commons.net.ftp.FTPFile> remoteFileComponent, FtpsConfiguration configuration) -
Method Summary
Modifier and TypeMethodDescriptionprotected org.apache.commons.net.ftp.FTPClient
Create the FTP clientRemoteFileOperations<org.apache.commons.net.ftp.FTPFile>
Creates the operations to be used by the consumer or producer.org.apache.commons.net.ftp.FTPSClient
Returns the FTPSClient.Returns the FtpsConfiguration.org.apache.camel.support.jsse.SSLContextParameters
Gets the JSSE configuration that overrides any settings inftpClientKeyStoreParameters
,ftpClientTrustStoreParameters
, andFtpsConfiguration.getSecurityProtocol()
.void
Set the key store parametersvoid
Set the trust store parametersvoid
setSslContextParameters
(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters) Gets the JSSE configuration that overrides any settings inftpClientKeyStoreParameters
,ftpClientTrustStoreParameters
, andFtpsConfiguration.getSecurityProtocol()
.Methods inherited from class org.apache.camel.component.file.remote.FtpEndpoint
buildConsumer, buildProducer, createConsumer, createGenericFileStrategy, getDataTimeout, getFileSeparator, getFtpClient, getFtpClientConfig, getFtpClientConfigParameters, getFtpClientParameters, getSoTimeout, getTransferLoggingIntervalSeconds, getTransferLoggingLevel, getTransferLoggingLevelName, isResumeDownload, isTransferLoggingVerbose, setConfiguration, setDataTimeout, setFtpClient, setFtpClientConfig, setResumeDownload, setSoTimeout, setTransferLoggingIntervalSeconds, setTransferLoggingLevel, setTransferLoggingLevelName, setTransferLoggingVerbose
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, getCharset, getDoneFileName, getExchanges, getExclude, getExcludeExt, getExcludePattern, getExclusiveReadLockStrategy, getFileExist, getFileName, getFilter, getFilterDirectory, getFilterFile, getGeneratedFileName, getIdempotent, 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, isIdempotentSet, isJailStartingDirectory, isKeepLastModified, isNoop, isPreSort, isReadLockDeleteOrphanLockFiles, isReadLockIdempotentReleaseAsync, isReadLockMarkerFile, isReadLockRemoveOnCommit, isReadLockRemoveOnRollback, isRecursive, isShuffle, isSynchronous, setAllowNullBody, setAntExclude, setAntFilterCaseSensitive, setAntInclude, setAppendChars, setAutoCreate, setBufferSize, setCharset, setDelete, setDoneFileName, setEagerDeleteTargetFile, setEagerMaxMessagesPerPoll, setExclude, setExcludeExt, setExclusiveReadLockStrategy, setFileExist, setFileName, setFileName, setFilter, setFilterDirectory, setFilterDirectory, setFilterFile, setFilterFile, setFlatten, setIdempotent, 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, 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, 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
-
sslContextParameters
@UriParam(label="security") protected org.apache.camel.support.jsse.SSLContextParameters sslContextParameters -
ftpClientKeyStoreParameters
-
ftpClientTrustStoreParameters
-
-
Constructor Details
-
FtpsEndpoint
public FtpsEndpoint() -
FtpsEndpoint
public FtpsEndpoint(String uri, RemoteFileComponent<org.apache.commons.net.ftp.FTPFile> remoteFileComponent, FtpsConfiguration configuration)
-
-
Method Details
-
getConfiguration
- Overrides:
getConfiguration
in classFtpEndpoint<org.apache.commons.net.ftp.FTPFile>
-
getScheme
- Overrides:
getScheme
in classFtpEndpoint<org.apache.commons.net.ftp.FTPFile>
-
createFtpClient
Description copied from class:FtpEndpoint
Create the FTP client- Overrides:
createFtpClient
in classFtpEndpoint<org.apache.commons.net.ftp.FTPFile>
- Throws:
Exception
- may throw client-specific exceptions if the client cannot be created
-
createRemoteFileOperations
public RemoteFileOperations<org.apache.commons.net.ftp.FTPFile> createRemoteFileOperations() throws ExceptionDescription copied from class:RemoteFileEndpoint
Creates the operations to be used by the consumer or producer.- Overrides:
createRemoteFileOperations
in classFtpEndpoint<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. -
getFtpsConfiguration
Returns the FtpsConfiguration. This method exists only for convenient. -
getFtpClientKeyStoreParameters
-
setFtpClientKeyStoreParameters
Set the key store parameters -
getFtpClientTrustStoreParameters
-
setFtpClientTrustStoreParameters
Set the trust store parameters -
getSslContextParameters
public org.apache.camel.support.jsse.SSLContextParameters getSslContextParameters()Gets the JSSE configuration that overrides any settings inftpClientKeyStoreParameters
,ftpClientTrustStoreParameters
, andFtpsConfiguration.getSecurityProtocol()
. -
setSslContextParameters
public void setSslContextParameters(org.apache.camel.support.jsse.SSLContextParameters sslContextParameters) Gets the JSSE configuration that overrides any settings inftpClientKeyStoreParameters
,ftpClientTrustStoreParameters
, andFtpsConfiguration.getSecurityProtocol()
.
-