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

Class RemoteFileProducer<T>

  • All Implemented Interfaces:
    AutoCloseable, org.apache.camel.EndpointAware, org.apache.camel.IsSingleton, org.apache.camel.Processor, org.apache.camel.Producer, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.StatefulService, org.apache.camel.SuspendableService
    public class RemoteFileProducer<T>
extends org.apache.camel.component.file.GenericFileProducer<T>
    Generic remote file producer for all the FTP variations.

    • Field Summary

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

        endpoint, operations

      • 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void connectIfNecessary​(org.apache.camel.Exchange exchange)  
      void disconnect()  
      protected void doStart()  
      protected void doStop()  
      RemoteFileEndpoint<T> getEndpoint()  
      String getFileSeparator()  
      protected RemoteFileOperations<T> getOperations()  
      void handleFailedWrite​(org.apache.camel.Exchange exchange, Exception exception)
      The file could not be written.
      boolean isSingleton()  
      String normalizePath​(String name)  
      void postWriteCheck​(org.apache.camel.Exchange exchange)  
      void preWriteCheck​(org.apache.camel.Exchange exchange)  
      void process​(org.apache.camel.Exchange exchange)  
      String toString()  

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

        createFileName, createTempFileName, processExchange, setOperations, writeFile

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

        createExchange

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

        build, doBuild, doFail, doInit, 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

    • Method Detail

      • getFileSeparator

        public String getFileSeparator()
        Overrides:
        getFileSeparator in class org.apache.camel.component.file.GenericFileProducer<T>

      • normalizePath

        public String normalizePath​(String name)
        Overrides:
        normalizePath in class org.apache.camel.component.file.GenericFileProducer<T>

      • process

        public void process​(org.apache.camel.Exchange exchange)
             throws Exception
        Specified by:
        process in interface org.apache.camel.Processor
        Overrides:
        process in class org.apache.camel.component.file.GenericFileProducer<T>
        Throws:
        Exception

      • getEndpoint

        public RemoteFileEndpoint<T> getEndpoint()
        Specified by:
        getEndpoint in interface org.apache.camel.EndpointAware
        Overrides:
        getEndpoint in class org.apache.camel.support.DefaultProducer

      • handleFailedWrite

        public void handleFailedWrite​(org.apache.camel.Exchange exchange,
                              Exception exception)
                       throws Exception
        The file could not be written. We need to disconnect from the remote server.
        Overrides:
        handleFailedWrite in class org.apache.camel.component.file.GenericFileProducer<T>
        Throws:
        Exception

      • disconnect

        public void disconnect()
                throws org.apache.camel.component.file.GenericFileOperationFailedException
        Throws:
        org.apache.camel.component.file.GenericFileOperationFailedException

      • preWriteCheck

        public void preWriteCheck​(org.apache.camel.Exchange exchange)
                   throws Exception
        Overrides:
        preWriteCheck in class org.apache.camel.component.file.GenericFileProducer<T>
        Throws:
        Exception

      • postWriteCheck

        public void postWriteCheck​(org.apache.camel.Exchange exchange)
        Overrides:
        postWriteCheck in class org.apache.camel.component.file.GenericFileProducer<T>

      • doStart

        protected void doStart()
                throws Exception
        Overrides:
        doStart in class org.apache.camel.component.file.GenericFileProducer<T>
        Throws:
        Exception

      • doStop

        protected void doStop()
               throws Exception
        Overrides:
        doStop in class org.apache.camel.component.file.GenericFileProducer<T>
        Throws:
        Exception

      • connectIfNecessary

        protected void connectIfNecessary​(org.apache.camel.Exchange exchange)
                           throws org.apache.camel.component.file.GenericFileOperationFailedException
        Throws:
        org.apache.camel.component.file.GenericFileOperationFailedException

      • isSingleton

        public boolean isSingleton()
        Specified by:
        isSingleton in interface org.apache.camel.IsSingleton
        Overrides:
        isSingleton in class org.apache.camel.support.DefaultProducer

      • toString

        public String toString()
        Overrides:
        toString in class org.apache.camel.support.DefaultProducer