Package org.apache.camel.processor.saga

Class SagaProcessor

  • 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.StatefulService, org.apache.camel.SuspendableService, org.apache.camel.Traceable
    Direct Known Subclasses:
    MandatorySagaProcessor, NeverSagaProcessor, NotSupportedSagaProcessor, RequiredSagaProcessor, RequiresNewSagaProcessor, SupportsSagaProcessor
    public abstract class SagaProcessor
extends org.apache.camel.support.processor.DelegateAsyncProcessor
implements org.apache.camel.Traceable, org.apache.camel.spi.IdAware, org.apache.camel.spi.RouteIdAware
    Processor for handling sagas.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected SagaCompletionMode completionMode  
      protected org.apache.camel.saga.CamelSagaService sagaService  
      protected org.apache.camel.saga.CamelSagaStep step  

      • 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
      SagaProcessor​(org.apache.camel.CamelContext camelContext, org.apache.camel.Processor childProcessor, org.apache.camel.saga.CamelSagaService sagaService, SagaCompletionMode completionMode, org.apache.camel.saga.CamelSagaStep step)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected CompletableFuture<org.apache.camel.saga.CamelSagaCoordinator> getCurrentSagaCoordinator​(org.apache.camel.Exchange exchange)  
      String getId()  
      String getRouteId()  
      org.apache.camel.saga.CamelSagaService getSagaService()  
      String getTraceLabel()  
      protected void handleSagaCompletion​(org.apache.camel.Exchange exchange, org.apache.camel.saga.CamelSagaCoordinator coordinator, org.apache.camel.saga.CamelSagaCoordinator previousCoordinator, org.apache.camel.AsyncCallback callback)  
      protected void ifNotException​(Throwable ex, org.apache.camel.Exchange exchange, boolean handleCompletion, org.apache.camel.saga.CamelSagaCoordinator coordinator, org.apache.camel.saga.CamelSagaCoordinator previousCoordinator, org.apache.camel.AsyncCallback callback, Runnable code)  
      protected void ifNotException​(Throwable ex, org.apache.camel.Exchange exchange, org.apache.camel.AsyncCallback callback, Runnable code)  
      protected void setCurrentSagaCoordinator​(org.apache.camel.Exchange exchange, org.apache.camel.saga.CamelSagaCoordinator coordinator)  
      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, process, 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

    • Field Detail

      • sagaService

        protected org.apache.camel.saga.CamelSagaService sagaService

      • step

        protected org.apache.camel.saga.CamelSagaStep step

    • Constructor Detail

      • SagaProcessor

        public SagaProcessor​(org.apache.camel.CamelContext camelContext,
                     org.apache.camel.Processor childProcessor,
                     org.apache.camel.saga.CamelSagaService sagaService,
                     SagaCompletionMode completionMode,
                     org.apache.camel.saga.CamelSagaStep step)

    • Method Detail

      • getCurrentSagaCoordinator

        protected CompletableFuture<org.apache.camel.saga.CamelSagaCoordinator> getCurrentSagaCoordinator​(org.apache.camel.Exchange exchange)

      • setCurrentSagaCoordinator

        protected void setCurrentSagaCoordinator​(org.apache.camel.Exchange exchange,
                                         org.apache.camel.saga.CamelSagaCoordinator coordinator)

      • handleSagaCompletion

        protected void handleSagaCompletion​(org.apache.camel.Exchange exchange,
                                    org.apache.camel.saga.CamelSagaCoordinator coordinator,
                                    org.apache.camel.saga.CamelSagaCoordinator previousCoordinator,
                                    org.apache.camel.AsyncCallback callback)

      • getSagaService

        public org.apache.camel.saga.CamelSagaService getSagaService()

      • 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

      • getTraceLabel

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

      • ifNotException

        protected void ifNotException​(Throwable ex,
                              org.apache.camel.Exchange exchange,
                              org.apache.camel.AsyncCallback callback,
                              Runnable code)

      • ifNotException

        protected void ifNotException​(Throwable ex,
                              org.apache.camel.Exchange exchange,
                              boolean handleCompletion,
                              org.apache.camel.saga.CamelSagaCoordinator coordinator,
                              org.apache.camel.saga.CamelSagaCoordinator previousCoordinator,
                              org.apache.camel.AsyncCallback callback,
                              Runnable code)