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

Class FtpComponent

  • All Implemented Interfaces:
    AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.Component, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.StatefulService, org.apache.camel.SuspendableService
    Direct Known Subclasses:
    FtpsComponent
    @Component("ftp")
public class FtpComponent
extends RemoteFileComponent<org.apache.commons.net.ftp.FTPFile>
    FTP Component

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void afterPropertiesSet​(org.apache.camel.component.file.GenericFileEndpoint<org.apache.commons.net.ftp.FTPFile> endpoint)  
      protected org.apache.camel.component.file.GenericFileEndpoint<org.apache.commons.net.ftp.FTPFile> buildFileEndpoint​(String uri, String remaining, Map<String,​Object> parameters)  
      protected void extractAndSetFtpClientConfigParameters​(Map<String,​Object> parameters, FtpEndpoint<org.apache.commons.net.ftp.FTPFile> answer)
      Extract additional ftp client configuration options from the parameters map (parameters starting with 'ftpClientConfig.').
      protected void extractAndSetFtpClientParameters​(Map<String,​Object> parameters, FtpEndpoint<org.apache.commons.net.ftp.FTPFile> answer)
      Extract additional ftp client options from the parameters map (parameters starting with 'ftpClient.').
      protected String getBaseUri​(String uri)
      Get the base uri part before the options as they can be non URI valid such as the expression using $ chars and the URI constructor will regard $ as an illegal character and we don't want to enforce end users to to escape the $ for the expression (file language)
      protected void setProperties​(org.apache.camel.Endpoint endpoint, Map<String,​Object> 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.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

    • Constructor Detail

      • FtpComponent

        public FtpComponent()

      • FtpComponent

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

    • Method Detail

      • buildFileEndpoint

        protected org.apache.camel.component.file.GenericFileEndpoint<org.apache.commons.net.ftp.FTPFile> buildFileEndpoint​(String uri,
                                                                                                                    String remaining,
                                                                                                                    Map<String,​Object> parameters)
                                                                                                             throws Exception
        Specified by:
        buildFileEndpoint in class org.apache.camel.component.file.GenericFileComponent<org.apache.commons.net.ftp.FTPFile>
        Throws:
        Exception

      • getBaseUri

        protected String getBaseUri​(String uri)
        Get the base uri part before the options as they can be non URI valid such as the expression using $ chars and the URI constructor will regard $ as an illegal character and we don't want to enforce end users to to escape the $ for the expression (file language)

      • extractAndSetFtpClientConfigParameters

        protected void extractAndSetFtpClientConfigParameters​(Map<String,​Object> parameters,
                                                      FtpEndpoint<org.apache.commons.net.ftp.FTPFile> answer)
        Extract additional ftp client configuration options from the parameters map (parameters starting with 'ftpClientConfig.'). To remember these parameters, we set them in the endpoint and we can use them when creating a client.

      • extractAndSetFtpClientParameters

        protected void extractAndSetFtpClientParameters​(Map<String,​Object> parameters,
                                                FtpEndpoint<org.apache.commons.net.ftp.FTPFile> answer)
        Extract additional ftp client options from the parameters map (parameters starting with 'ftpClient.'). To remember these parameters, we set them in the endpoint and we can use them when creating a client.

      • setProperties

        protected void setProperties​(org.apache.camel.Endpoint endpoint,
                             Map<String,​Object> parameters)
                      throws Exception
        Overrides:
        setProperties in class org.apache.camel.support.DefaultComponent
        Throws:
        Exception

      • afterPropertiesSet

        protected void afterPropertiesSet​(org.apache.camel.component.file.GenericFileEndpoint<org.apache.commons.net.ftp.FTPFile> endpoint)
                           throws Exception
        Specified by:
        afterPropertiesSet in class org.apache.camel.component.file.GenericFileComponent<org.apache.commons.net.ftp.FTPFile>
        Throws:
        Exception