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

Class FtpsComponent

  • All Implemented Interfaces:
    AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.Component, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.SSLContextParametersAware, org.apache.camel.StatefulService, org.apache.camel.SuspendableService
    @Component("ftps")
public class FtpsComponent
extends FtpComponent
implements org.apache.camel.SSLContextParametersAware
    FTP Secure (FTP over SSL/TLS) Component.

    If desired, the JVM property -Djavax.net.debug=all can be used to see wire-level SSL details.

    • Field Summary

      • Fields inherited from class org.apache.camel.component.file.GenericFileComponent

        log

      • 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
      FtpsComponent()  
      FtpsComponent​(org.apache.camel.CamelContext context)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected org.apache.camel.component.file.GenericFileEndpoint<org.apache.commons.net.ftp.FTPFile> buildFileEndpoint​(String uri, String remaining, Map<String,​Object> parameters)  
      protected void extractAndSetFtpClientKeyStoreParameters​(Map<String,​Object> parameters, FtpsEndpoint endpoint)
      Extract additional ftp client key store options from the parameters map (parameters starting with 'ftpClient.keyStore.').
      protected void extractAndSetFtpClientTrustStoreParameters​(Map<String,​Object> parameters, FtpsEndpoint endpoint)
      Extract additional ftp client trust store options from the parameters map (parameters starting with 'ftpClient.trustStore.').
      boolean isUseGlobalSslContextParameters()  
      void setUseGlobalSslContextParameters​(boolean useGlobalSslContextParameters)
      Enable usage of global SSL context parameters.

      • Methods inherited from class org.apache.camel.component.file.GenericFileComponent

        createEndpoint

      • Methods inherited from class org.apache.camel.support.DefaultComponent

        afterConfiguration, createEndpoint, createEndpoint, doBuild, doInit, doStart, doStop, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, getComponentPropertyConfigurer, getDefaultName, getEndpointPropertyConfigurer, getExtension, getSupportedExtensions, ifStartsWithReturnRemainder, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, registerExtension, registerExtension, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, resolveRawParameterValues, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setLazyStartProducer, setProperties, setProperties, useIntrospectionOnEndpoint, useRawUri, validateParameters, validateURI

      • Methods inherited from class org.apache.camel.support.service.BaseService

        build, 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 interface org.apache.camel.CamelContextAware

        getCamelContext, setCamelContext

      • 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.SSLContextParametersAware

        retrieveGlobalSslContextParameters

      • 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

    • Constructor Detail

      • FtpsComponent

        public FtpsComponent()

      • FtpsComponent

        public FtpsComponent​(org.apache.camel.CamelContext context)

    • Method Detail

      • extractAndSetFtpClientKeyStoreParameters

        protected void extractAndSetFtpClientKeyStoreParameters​(Map<String,​Object> parameters,
                                                        FtpsEndpoint endpoint)
        Extract additional ftp client key store options from the parameters map (parameters starting with 'ftpClient.keyStore.'). To remember these parameters, we set them in the endpoint and we can use them when creating a client.

      • extractAndSetFtpClientTrustStoreParameters

        protected void extractAndSetFtpClientTrustStoreParameters​(Map<String,​Object> parameters,
                                                          FtpsEndpoint endpoint)
        Extract additional ftp client trust store options from the parameters map (parameters starting with 'ftpClient.trustStore.'). To remember these parameters, we set them in the endpoint and we can use them when creating a client.

      • isUseGlobalSslContextParameters

        public boolean isUseGlobalSslContextParameters()
        Specified by:
        isUseGlobalSslContextParameters in interface org.apache.camel.SSLContextParametersAware

      • setUseGlobalSslContextParameters

        public void setUseGlobalSslContextParameters​(boolean useGlobalSslContextParameters)
        Enable usage of global SSL context parameters.
        Specified by:
        setUseGlobalSslContextParameters in interface org.apache.camel.SSLContextParametersAware