Package org.apache.camel.component.file

Class GenericFileProducer<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 GenericFileProducer<T>
extends org.apache.camel.support.DefaultProducer
    Generic file producer

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected GenericFileEndpoint<T> endpoint  
      protected GenericFileOperations<T> 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
      String createFileName​(org.apache.camel.Exchange exchange)  
      String createTempFileName​(org.apache.camel.Exchange exchange, String fileName)  
      protected void doStart()  
      protected void doStop()  
      String getFileSeparator()  
      void handleFailedWrite​(org.apache.camel.Exchange exchange, Exception exception)
      If we fail writing out a file, we will call this method.
      String normalizePath​(String name)  
      void postWriteCheck​(org.apache.camel.Exchange exchange)
      Perform any actions that need to occur after we are done such as disconnecting.
      void preWriteCheck​(org.apache.camel.Exchange exchange)
      Perform any actions that need to occur before we write such as connecting to an FTP server etc.
      void process​(org.apache.camel.Exchange exchange)  
      protected void processExchange​(org.apache.camel.Exchange exchange, String target)
      Perform the work to process the fileExchange
      void setOperations​(GenericFileOperations<T> operations)
      Sets the operations to be used.
      void writeFile​(org.apache.camel.Exchange exchange, String fileName)  

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

        createExchange, getEndpoint, isSingleton, toString

      • 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()

      • normalizePath

        public String normalizePath​(String name)

      • process

        public void process​(org.apache.camel.Exchange exchange)
             throws Exception
        Throws:
        Exception

      • setOperations

        public void setOperations​(GenericFileOperations<T> operations)
        Sets the operations to be used.

        Can be used to set a fresh operations in case of recovery attempts

        Parameters:
        operations - the operations

      • processExchange

        protected void processExchange​(org.apache.camel.Exchange exchange,
                               String target)
                        throws Exception
        Perform the work to process the fileExchange
        Parameters:
        exchange - fileExchange
        target - the target filename
        Throws:
        Exception - is thrown if some error

      • handleFailedWrite

        public void handleFailedWrite​(org.apache.camel.Exchange exchange,
                              Exception exception)
                       throws Exception
        If we fail writing out a file, we will call this method. This hook is provided to disconnect from servers or clean up files we created (if needed).
        Throws:
        Exception

      • preWriteCheck

        public void preWriteCheck​(org.apache.camel.Exchange exchange)
                   throws Exception
        Perform any actions that need to occur before we write such as connecting to an FTP server etc.
        Throws:
        Exception

      • postWriteCheck

        public void postWriteCheck​(org.apache.camel.Exchange exchange)
        Perform any actions that need to occur after we are done such as disconnecting.

      • createFileName

        public String createFileName​(org.apache.camel.Exchange exchange)

      • createTempFileName

        public String createTempFileName​(org.apache.camel.Exchange exchange,
                                 String fileName)

      • doStart

        protected void doStart()
                throws Exception
        Overrides:
        doStart in class org.apache.camel.support.DefaultProducer
        Throws:
        Exception

      • doStop

        protected void doStop()
               throws Exception
        Overrides:
        doStop in class org.apache.camel.support.DefaultProducer
        Throws:
        Exception