org.apache.camel.component.ignite.cache

Class IgniteCacheEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.ignite.AbstractIgniteEndpoint

org.apache.camel.component.ignite.cache.IgniteCacheEndpoint

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-cache",
             title="Ignite Cache",
             syntax="ignite-cache:[cacheName]",
             label="nosql,cache,compute",
             consumerClass=IgniteCacheContinuousQueryConsumer.class)
public class IgniteCacheEndpoint
extends AbstractIgniteEndpoint

The Ignite Cache endpoint is one of camel-ignite endpoints which allows you to interact with an Ignite Cache. This offers both a Producer (to invoke cache operations on an Ignite cache) and a Consumer (to consume changes from a continuous query).

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
IgniteCacheEndpoint(String endpointUri, String remaining, Map<String,Object> parameters, IgniteCacheComponent igniteComponent)
IgniteCacheEndpoint(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()
String	getCacheName() Gets the cache name.
org.apache.ignite.cache.CachePeekMode	getCachePeekMode() Gets the CachePeekMode, only needed for operations that require it (IgniteCacheOperation.SIZE).
IgniteCacheOperation	getOperation() Gets the cache operation to invoke.
int	getPageSize() Gets the page size.
org.apache.ignite.cache.query.Query<javax.cache.Cache.Entry<Object,Object>>	getQuery() Gets the query to execute, only needed for operations that require it, and for the Continuous Query Consumer.
org.apache.ignite.cache.CacheEntryEventSerializableFilter<Object,Object>	getRemoteFilter() Gets the remote filter, only used by the Continuous Query Consumer.
long	getTimeInterval() Gets the time interval for the Continuous Query Consumer.
boolean	isAutoUnsubscribe() Gets whether auto unsubscribe is enabled in the Continuous Query Consumer.
boolean	isFailIfInexistentCache() Whether to fail the initialization if the cache doesn't exist.
boolean	isFireExistingQueryResults() Gets whether to process existing results that match the query.
boolean	isOneExchangePerUpdate() Gets whether to pack each update in an individual Exchange, even if multiple updates are received in one batch.
void	setAutoUnsubscribe(boolean autoUnsubscribe) Whether auto unsubscribe is enabled in the Continuous Query Consumer.
void	setCacheName(String cacheName) The cache name.
void	setCachePeekMode(org.apache.ignite.cache.CachePeekMode cachePeekMode) The CachePeekMode, only needed for operations that require it (IgniteCacheOperation.SIZE).
void	setFailIfInexistentCache(boolean failIfInexistentCache) Whether to fail the initialization if the cache doesn't exist.
void	setFireExistingQueryResults(boolean fireExistingQueryResults) Whether to process existing results that match the query.
void	setOneExchangePerUpdate(boolean oneExchangePerUpdate) Whether to pack each update in an individual Exchange, even if multiple updates are received in one batch.
void	setOperation(IgniteCacheOperation operation) The cache operation to invoke.
void	setPageSize(int pageSize) The page size.
void	setQuery(org.apache.ignite.cache.query.Query<javax.cache.Cache.Entry<Object,Object>> query) The Query to execute, only needed for operations that require it, and for the Continuous Query Consumer.
void	setRemoteFilter(org.apache.ignite.cache.CacheEntryEventSerializableFilter<Object,Object> remoteFilter) The remote filter, only used by the Continuous Query Consumer.
void	setTimeInterval(long timeInterval) The time interval for the Continuous Query Consumer.

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

IgniteCacheEndpoint

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

Deprecated.

IgniteCacheEndpoint

public IgniteCacheEndpoint(String endpointUri,
                           String remaining,
                           Map<String,Object> parameters,
                           IgniteCacheComponent igniteComponent)

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

getCacheName

public String getCacheName()

Gets the cache name.

Returns:

setCacheName

public void setCacheName(String cacheName)

The cache name.

Parameters:

cacheName - cache name

getOperation

public IgniteCacheOperation getOperation()

Gets the cache operation to invoke.

Returns:

cache name

setOperation

public void setOperation(IgniteCacheOperation operation)

The cache operation to invoke.

Possible values: GET, PUT, REMOVE, SIZE, REBALANCE, QUERY, CLEAR.

Parameters:

operation -

isFailIfInexistentCache

public boolean isFailIfInexistentCache()

Whether to fail the initialization if the cache doesn't exist.

Returns:

setFailIfInexistentCache

public void setFailIfInexistentCache(boolean failIfInexistentCache)

Whether to fail the initialization if the cache doesn't exist.

Parameters:

failIfInexistentCache -

getCachePeekMode

public org.apache.ignite.cache.CachePeekMode getCachePeekMode()

Gets the CachePeekMode, only needed for operations that require it (IgniteCacheOperation.SIZE).

Returns:

setCachePeekMode

public void setCachePeekMode(org.apache.ignite.cache.CachePeekMode cachePeekMode)

The CachePeekMode, only needed for operations that require it (IgniteCacheOperation.SIZE).

Parameters:

cachePeekMode -

getQuery

public org.apache.ignite.cache.query.Query<javax.cache.Cache.Entry<Object,Object>> getQuery()

Gets the query to execute, only needed for operations that require it, and for the Continuous Query Consumer.

Returns:

setQuery

public void setQuery(org.apache.ignite.cache.query.Query<javax.cache.Cache.Entry<Object,Object>> query)

The Query to execute, only needed for operations that require it, and for the Continuous Query Consumer.

Parameters:

query -

getRemoteFilter

public org.apache.ignite.cache.CacheEntryEventSerializableFilter<Object,Object> getRemoteFilter()

Gets the remote filter, only used by the Continuous Query Consumer.

Returns:

setRemoteFilter

public void setRemoteFilter(org.apache.ignite.cache.CacheEntryEventSerializableFilter<Object,Object> remoteFilter)

The remote filter, only used by the Continuous Query Consumer.

Parameters:

remoteFilter -

isOneExchangePerUpdate

public boolean isOneExchangePerUpdate()

Gets whether to pack each update in an individual Exchange, even if multiple updates are received in one batch. Only used by the Continuous Query Consumer.

Returns:

setOneExchangePerUpdate

public void setOneExchangePerUpdate(boolean oneExchangePerUpdate)

Whether to pack each update in an individual Exchange, even if multiple updates are received in one batch. Only used by the Continuous Query Consumer.

Parameters:

oneExchangePerUpdate -

isAutoUnsubscribe

public boolean isAutoUnsubscribe()

Gets whether auto unsubscribe is enabled in the Continuous Query Consumer.

Returns:

setAutoUnsubscribe

public void setAutoUnsubscribe(boolean autoUnsubscribe)

Whether auto unsubscribe is enabled in the Continuous Query Consumer.

Parameters:

autoUnsubscribe -

getPageSize

public int getPageSize()

Gets the page size. Only used by the Continuous Query Consumer.

Returns:

setPageSize

public void setPageSize(int pageSize)

The page size. Only used by the Continuous Query Consumer.

Parameters:

pageSize -

isFireExistingQueryResults

public boolean isFireExistingQueryResults()

Gets whether to process existing results that match the query. Used on initialization of the Continuous Query Consumer.

Returns:

setFireExistingQueryResults

public void setFireExistingQueryResults(boolean fireExistingQueryResults)

Whether to process existing results that match the query. Used on initialization of the Continuous Query Consumer.

Parameters:

fireExistingQueryResults -

getTimeInterval

public long getTimeInterval()

Gets the time interval for the Continuous Query Consumer.

Returns:

setTimeInterval

public void setTimeInterval(long timeInterval)

The time interval for the Continuous Query Consumer.

Parameters:

timeInterval -