Package org.apache.camel.processor

Class LoopProcessor

  • All Implemented Interfaces:
    AutoCloseable, org.apache.camel.AsyncProcessor, org.apache.camel.DelegateProcessor, org.apache.camel.Navigate<org.apache.camel.Processor>, org.apache.camel.Processor, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.spi.IdAware, org.apache.camel.spi.RouteIdAware, org.apache.camel.spi.ShutdownAware, org.apache.camel.spi.ShutdownPrepared, org.apache.camel.StatefulService, org.apache.camel.SuspendableService, org.apache.camel.Traceable
    public class LoopProcessor
extends org.apache.camel.support.processor.DelegateAsyncProcessor
implements org.apache.camel.Traceable, org.apache.camel.spi.IdAware, org.apache.camel.spi.RouteIdAware, org.apache.camel.spi.ShutdownAware
    The processor which sends messages in a loop.

    • Field Summary

      • Fields inherited from class org.apache.camel.support.processor.DelegateAsyncProcessor

        processor

      • 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
      LoopProcessor​(org.apache.camel.CamelContext camelContext, org.apache.camel.Processor processor, org.apache.camel.Expression expression, org.apache.camel.Predicate predicate, boolean copy, boolean breakOnShutdown)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean deferShutdown​(org.apache.camel.ShutdownRunningTask shutdownRunningTask)  
      org.apache.camel.Expression getExpression()  
      String getId()  
      int getPendingExchangesSize()  
      org.apache.camel.Predicate getPredicate()  
      String getRouteId()  
      String getTraceLabel()  
      boolean isCopy()  
      protected org.apache.camel.Exchange prepareExchange​(org.apache.camel.Exchange exchange, int index)
      Prepares the exchange for the next iteration
      void prepareShutdown​(boolean suspendOnly, boolean forced)  
      boolean process​(org.apache.camel.Exchange exchange, org.apache.camel.AsyncCallback callback)  
      void setId​(String id)  
      void setRouteId​(String routeId)  
      String toString()  

      • Methods inherited from class org.apache.camel.support.processor.DelegateAsyncProcessor

        doBuild, doInit, doShutdown, doStart, doStop, getProcessor, hasNext, next, setProcessor, setProcessor

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

        process, processAsync

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

        build, doFail, doLifecycleChange, doResume, 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.spi.IdAware

        setGeneratedId

      • Methods inherited from interface org.apache.camel.Processor

        process

      • 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

      • LoopProcessor

        public LoopProcessor​(org.apache.camel.CamelContext camelContext,
                     org.apache.camel.Processor processor,
                     org.apache.camel.Expression expression,
                     org.apache.camel.Predicate predicate,
                     boolean copy,
                     boolean breakOnShutdown)

    • Method Detail

      • process

        public boolean process​(org.apache.camel.Exchange exchange,
                       org.apache.camel.AsyncCallback callback)
        Specified by:
        process in interface org.apache.camel.AsyncProcessor
        Overrides:
        process in class org.apache.camel.support.processor.DelegateAsyncProcessor

      • deferShutdown

        public boolean deferShutdown​(org.apache.camel.ShutdownRunningTask shutdownRunningTask)
        Specified by:
        deferShutdown in interface org.apache.camel.spi.ShutdownAware

      • getPendingExchangesSize

        public int getPendingExchangesSize()
        Specified by:
        getPendingExchangesSize in interface org.apache.camel.spi.ShutdownAware

      • prepareShutdown

        public void prepareShutdown​(boolean suspendOnly,
                            boolean forced)
        Specified by:
        prepareShutdown in interface org.apache.camel.spi.ShutdownPrepared

      • prepareExchange

        protected org.apache.camel.Exchange prepareExchange​(org.apache.camel.Exchange exchange,
                                                    int index)
        Prepares the exchange for the next iteration
        Parameters:
        exchange - the exchange
        index - the index of the next iteration
        Returns:
        the exchange to use

      • getExpression

        public org.apache.camel.Expression getExpression()

      • getPredicate

        public org.apache.camel.Predicate getPredicate()

      • isCopy

        public boolean isCopy()

      • getTraceLabel

        public String getTraceLabel()
        Specified by:
        getTraceLabel in interface org.apache.camel.Traceable

      • getId

        public String getId()
        Specified by:
        getId in interface org.apache.camel.spi.HasId

      • setId

        public void setId​(String id)
        Specified by:
        setId in interface org.apache.camel.spi.IdAware

      • getRouteId

        public String getRouteId()
        Specified by:
        getRouteId in interface org.apache.camel.spi.RouteIdAware

      • setRouteId

        public void setRouteId​(String routeId)
        Specified by:
        setRouteId in interface org.apache.camel.spi.RouteIdAware

      • toString

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