org.apache.camel.component.ignite.queue

Class IgniteQueueEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.ignite.AbstractIgniteEndpoint

org.apache.camel.component.ignite.queue.IgniteQueueEndpoint

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, 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]",
             label="nosql,cache",
             producerOnly=true)
public class IgniteQueueEndpoint
extends AbstractIgniteEndpoint

The Ignite Queue endpoint is one of camel-ignite endpoints which allows you to interact with Ignite Queue data structures. This endpoint only supports producers.

Field Summary

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

component

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
IgniteQueueEndpoint(String endpointUri, String remaining, Map<String,Object> parameters, IgniteQueueComponent igniteComponent)
IgniteQueueEndpoint(String endpointUri, URI remainingUri, Map<String,Object> parameters, IgniteComponent igniteComponent) Deprecated.

Method Summary

Modifier and Type	Method and 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, isSingleton, isTreatCollectionsAsCacheObjects, setPropagateIncomingBodyIfNoReturnValue, setTreatCollectionsAsCacheObjects

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

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, doStart, doStop, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

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

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, 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.Service

start, stop

Constructor Detail

IgniteQueueEndpoint

@Deprecated
public IgniteQueueEndpoint(String endpointUri,
                                       URI remainingUri,
                                       Map<String,Object> parameters,
                                       IgniteComponent igniteComponent)
                                throws Exception

Deprecated.

Throws:

Exception

IgniteQueueEndpoint

public IgniteQueueEndpoint(String endpointUri,
                           String remaining,
                           Map<String,Object> parameters,
                           IgniteQueueComponent igniteComponent)
                    throws Exception

Throws:

Exception

Method Detail

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.

Returns:

setName

public void setName(String name)

The queue name.

Parameters:

name -

getOperation

public IgniteQueueOperation getOperation()

Gets the queue operation to perform.

Returns:

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.

Parameters:

operation -

getCapacity

public int getCapacity()

Gets the queue capacity. Default: non-bounded.

Returns:

setCapacity

public void setCapacity(int capacity)

The queue capacity. Default: non-bounded.

Parameters:

capacity -

getConfiguration

public org.apache.ignite.configuration.CollectionConfiguration getConfiguration()

Gets the collection configuration. Default: empty configuration.

Returns:

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.

Parameters:

configuration -

getTimeoutMillis

public Long getTimeoutMillis()

Gets the queue timeout in milliseconds. Default: no timeout.

Returns:

setTimeoutMillis

public void setTimeoutMillis(Long timeoutMillis)

The queue timeout in milliseconds. Default: no timeout.

Parameters:

timeoutMillis -