Package org.apache.camel.component.ignite.queue

Class IgniteQueueEndpoint

java.lang.Object
org.apache.camel.support.service.BaseService
org.apache.camel.support.service.ServiceSupport
org.apache.camel.support.DefaultEndpoint
org.apache.camel.component.ignite.AbstractIgniteEndpoint
org.apache.camel.component.ignite.queue.IgniteQueueEndpoint
All Implemented Interfaces:
AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.ComponentAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasCamelContext, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService
@UriEndpoint(firstVersion="2.17.0", scheme="ignite-queue", title="Ignite Queues", syntax="ignite-queue:name", category={CACHE,CLUSTERING,MESSAGING}, producerOnly=true, headersClass=IgniteConstants.class) public class IgniteQueueEndpoint extends AbstractIgniteEndpoint
Interact with Ignite Queue data structures. This endpoint only supports producers.

  • 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
    IgniteQueueEndpoint(String endpointUri, String remaining, Map<String,Object> parameters, IgniteQueueComponent igniteComponent)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.camel.Consumer
    createConsumer(org.apache.camel.Processor processor)
     
    org.apache.camel.Producer
    createProducer()
     
    int
    getCapacity()
    Gets the queue capacity.
    org.apache.ignite.configuration.CollectionConfiguration
    getConfiguration()
    Gets the collection configuration.
    String
    getName()
    Gets the queue name.
    IgniteQueueOperation
    getOperation()
    Gets the queue operation to perform.
    Long
    getTimeoutMillis()
    Gets the queue timeout in milliseconds.
    void
    setCapacity(int capacity)
    The queue capacity.
    void
    setConfiguration(org.apache.ignite.configuration.CollectionConfiguration configuration)
    The collection configuration.
    void
    setName(String name)
    The queue name.
    void
    setOperation(IgniteQueueOperation operation)
    The operation to invoke on the Ignite Queue.
    void
    setTimeoutMillis(Long timeoutMillis)
    The queue timeout in milliseconds.

    Methods inherited from class org.apache.camel.component.ignite.AbstractIgniteEndpoint

    ignite, igniteComponent, isPropagateIncomingBodyIfNoReturnValue, isTreatCollectionsAsCacheObjects, setPropagateIncomingBodyIfNoReturnValue, setTreatCollectionsAsCacheObjects

    Methods inherited from class org.apache.camel.support.DefaultEndpoint

    configureConsumer, configureExchange, configurePollingConsumer, configureProperties, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, doInit, equals, getCamelContext, getComponent, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, isLenientProperties, isPollingConsumerBlockWhenFull, isPollingConsumerCopy, isSingleton, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setComponent, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerCopy, setPollingConsumerQueueSize, setProperties, toString

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

    build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, doStart, doStop, 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 class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.apache.camel.ComponentAware

    getComponent

    Methods inherited from interface org.apache.camel.Endpoint

    getEndpointBaseUri, isSingletonProducer

    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 Details

  • Method Details

    • createProducer

      public org.apache.camel.Producer createProducer() throws Exception
      Throws:
      Exception

    • createConsumer

      public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor) throws Exception
      Throws:
      Exception

    • getName

      public String getName()
      Gets the queue name.

    • setName

      public void setName(String name)
      The queue name.

    • getOperation

      public IgniteQueueOperation getOperation()
      Gets the queue operation to perform.

    • setOperation

      public void setOperation(IgniteQueueOperation operation)
      The operation to invoke on the Ignite Queue. Superseded by the IgniteConstants.IGNITE_QUEUE_OPERATION header in the IN message. Possible values: CONTAINS, ADD, SIZE, REMOVE, ITERATOR, CLEAR, RETAIN_ALL, ARRAY, DRAIN, ELEMENT, PEEK, OFFER, POLL, TAKE, PUT.

    • getCapacity

      public int getCapacity()
      Gets the queue capacity. Default: non-bounded.

    • setCapacity

      public void setCapacity(int capacity)
      The queue capacity. Default: non-bounded.

    • getConfiguration

      public org.apache.ignite.configuration.CollectionConfiguration getConfiguration()
      Gets the collection configuration. Default: empty configuration.

    • setConfiguration

      public void setConfiguration(org.apache.ignite.configuration.CollectionConfiguration configuration)
      The collection configuration. Default: empty configuration.

      You can also conveniently set inner properties by using configuration.xyz=123 options.

    • getTimeoutMillis

      public Long getTimeoutMillis()
      Gets the queue timeout in milliseconds. Default: no timeout.

    • setTimeoutMillis

      public void setTimeoutMillis(Long timeoutMillis)
      The queue timeout in milliseconds. Default: no timeout.