Package org.apache.camel.component.jt400

Class Jt400DataQueueConsumer

  • All Implemented Interfaces:
    AutoCloseable, Runnable, org.apache.camel.Consumer, org.apache.camel.EndpointAware, org.apache.camel.health.HealthCheckAware, org.apache.camel.PollingConsumerPollingStrategy, org.apache.camel.RouteAware, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.RouteIdAware, org.apache.camel.StatefulService, org.apache.camel.Suspendable, org.apache.camel.SuspendableService
    public class Jt400DataQueueConsumer
extends org.apache.camel.support.ScheduledPollConsumer
    A scheduled Consumer that polls a data queue for data

    • Field Summary

      • 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
      Jt400DataQueueConsumer​(Jt400Endpoint endpoint, org.apache.camel.Processor processor)
      Creates a new consumer instance

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      protected void doStart()  
      protected void doStop()  
      Jt400Endpoint getEndpoint()  
      protected int poll()  
      org.apache.camel.Exchange receive()
      Deprecated.
      org.apache.camel.Exchange receive​(long timeout)
      Receives an entry from a data queue and returns an Exchange to send this data If the endpoint's format is set to Jt400Configuration.Format.binary, the data queue entry's data will be received/sent as a byte[].
      org.apache.camel.Exchange receiveNoWait()
      Deprecated.

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

        addLastErrorDetail, afterConfigureScheduler, afterPoll, beforePoll, doBuild, doInit, doShutdown, doSuspend, getBackoffCounter, getBackoffErrorThreshold, getBackoffIdleThreshold, getBackoffMultiplier, getCounter, getDelay, getErrorCounter, getInitialDelay, getLastError, getLastErrorDetails, getPollStrategy, getRepeatCount, getRunLoggingLevel, getScheduledExecutorService, getScheduler, getSchedulerProperties, getSuccessCounter, getTimeUnit, initialHealthCheckState, isFirstPollDone, isGreedy, isPollAllowed, isPolling, isSchedulerStarted, isSendEmptyMessageWhenIdle, isStartScheduler, isUseFixedDelay, onInit, processEmptyMessage, run, setBackoffErrorThreshold, setBackoffIdleThreshold, setBackoffMultiplier, setDelay, setGreedy, setInitialDelay, setPollStrategy, setRepeatCount, setRunLoggingLevel, setScheduledExecutorService, setScheduler, setSchedulerProperties, setSendEmptyMessageWhenIdle, setStartScheduler, setTimeUnit, setUseFixedDelay, startScheduler

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

        createExchange, createUoW, defaultConsumerCallback, doneUoW, getAsyncProcessor, getExceptionHandler, getHealthCheck, getProcessor, getRoute, getRouteId, handleException, handleException, releaseExchange, setExceptionHandler, setHealthCheck, setRoute, setRouteId, toString

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

        build, doFail, doLifecycleChange, doResume, 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.health.HealthCheckAware

        getHealthCheck, setHealthCheck

      • 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

      • Jt400DataQueueConsumer

        public Jt400DataQueueConsumer​(Jt400Endpoint endpoint,
                              org.apache.camel.Processor processor)
        Creates a new consumer instance

    • Method Detail

      • getEndpoint

        public Jt400Endpoint getEndpoint()
        Specified by:
        getEndpoint in interface org.apache.camel.EndpointAware
        Overrides:
        getEndpoint in class org.apache.camel.support.DefaultConsumer

      • poll

        protected int poll()
            throws Exception
        Specified by:
        poll in class org.apache.camel.support.ScheduledPollConsumer
        Throws:
        Exception

      • doStart

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

      • doStop

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

      • receive

        @Deprecated
public org.apache.camel.Exchange receive()
        Deprecated.

      • receiveNoWait

        @Deprecated
public org.apache.camel.Exchange receiveNoWait()
        Deprecated.

      • receive

        public org.apache.camel.Exchange receive​(long timeout)
        Receives an entry from a data queue and returns an Exchange to send this data If the endpoint's format is set to Jt400Configuration.Format.binary, the data queue entry's data will be received/sent as a byte[]. If the endpoint's format is set to Jt400Configuration.Format.text, the data queue entry's data will be received/sent as a String.

        The following message headers may be set by the receiver

        • SENDER_INFORMATION: The Sender Information from the Data Queue
        • KEY: The message key if the endpoint is configured to connect to a KeyedDataQueue
        Parameters:
        timeout - time to wait when reading from data queue. A value of -1 indicates a blocking read.