org.apache.ignite.internal.processors.cache.query.continuous

Class CacheContinuousQueryHandler<K,V>

java.lang.Object

org.apache.ignite.internal.processors.cache.query.continuous.CacheContinuousQueryHandler<K,V>

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, GridContinuousHandler

Direct Known Subclasses:

CacheContinuousQueryHandlerV2

public class CacheContinuousQueryHandler<K,V>
extends Object
implements GridContinuousHandler

Continuous query handler.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	CacheContinuousQueryHandler.DeployableObject Deployable object.

Nested classes/interfaces inherited from interface org.apache.ignite.internal.processors.continuous.GridContinuousHandler

GridContinuousHandler.RegisterStatus

Constructor Summary

Constructors

Constructor and Description
CacheContinuousQueryHandler() Required by Externalizable.
CacheContinuousQueryHandler(String cacheName, Object topic, javax.cache.event.CacheEntryUpdatedListener<K,V> locLsnr, CacheEntryEventSerializableFilter<K,V> rmtFilter, boolean oldValRequired, boolean sync, boolean ignoreExpired, boolean ignoreClsNotFound) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	cacheName()
GridContinuousHandler	clone() Clones this handler.
GridContinuousBatch	createBatch() Creates new batch.
boolean	filter(org.apache.ignite.internal.processors.cache.query.continuous.CacheContinuousQueryEvent evt, boolean primary)
javax.cache.event.CacheEntryEventFilter	getEventFilter()
void	internal(boolean internal)
boolean	isEvents()
boolean	isMessaging()
boolean	isQuery()
boolean	keepBinary()
void	keepBinary(boolean keepBinary)
void	localCache(boolean locCache)
void	notifyCallback(UUID nodeId, UUID routineId, Collection<?> objs, GridKernalContext ctx) Notifies local callback.
void	notifyExisting(boolean notifyExisting)
void	onBatchAcknowledged(UUID routineId, GridContinuousBatch batch, GridKernalContext ctx) Called when ack for a batch is received from client.
void	onClientDisconnected() Client node disconnected callback.
void	onNodeLeft() Node which started routine leave topology.
Object	orderedTopic()
void	p2pMarshal(GridKernalContext ctx) Deploys and marshals inner objects (called only if peer deployment is enabled).
void	p2pUnmarshal(UUID nodeId, GridKernalContext ctx) Unmarshals inner objects (called only if peer deployment is enabled).
void	readExternal(ObjectInput in)
GridContinuousHandler.RegisterStatus	register(UUID nodeId, UUID routineId, GridKernalContext ctx) Registers listener.
void	skipPrimaryCheck(boolean skipPrimaryCheck)
void	taskNameHash(int taskHash)
String	toString()
void	unregister(UUID routineId, GridKernalContext ctx) Unregisters listener.
void	updateCounters(AffinityTopologyVersion topVer, Map<UUID,Map<Integer,Long>> cntrsPerNode, Map<Integer,Long> cntrs)
void	waitTopologyFuture(GridKernalContext ctx) Wait topology.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CacheContinuousQueryHandler

public CacheContinuousQueryHandler()

Required by Externalizable.

CacheContinuousQueryHandler

public CacheContinuousQueryHandler(String cacheName,
                           Object topic,
                           javax.cache.event.CacheEntryUpdatedListener<K,V> locLsnr,
                           CacheEntryEventSerializableFilter<K,V> rmtFilter,
                           boolean oldValRequired,
                           boolean sync,
                           boolean ignoreExpired,
                           boolean ignoreClsNotFound)

Constructor.

Parameters:

cacheName - Cache name.

topic - Topic for ordered messages.

locLsnr - Local listener.

rmtFilter - Remote filter.

oldValRequired - Old value required flag.

sync - Synchronous flag.

ignoreExpired - Ignore expired events flag.

Method Detail

internal

public void internal(boolean internal)

Parameters:

internal - Internal query.

notifyExisting

public void notifyExisting(boolean notifyExisting)

Parameters:

notifyExisting - Notify existing.

localCache

public void localCache(boolean locCache)

Parameters:

locCache - Local cache.

taskNameHash

public void taskNameHash(int taskHash)

Parameters:

taskHash - Task hash.

skipPrimaryCheck

public void skipPrimaryCheck(boolean skipPrimaryCheck)

Parameters:

skipPrimaryCheck - Whether to skip primary check for REPLICATED cache.

isEvents

public boolean isEvents()

Specified by:

isEvents in interface GridContinuousHandler

Returns:

True if for events.

isMessaging

public boolean isMessaging()

Specified by:

isMessaging in interface GridContinuousHandler

Returns:

True if for messaging.

isQuery

public boolean isQuery()

Specified by:

isQuery in interface GridContinuousHandler

Returns:

True if for continuous queries.

keepBinary

public boolean keepBinary()

Specified by:

keepBinary in interface GridContinuousHandler

Returns:

True if Ignite Binary objects should be passed to the listener and filter.

keepBinary

public void keepBinary(boolean keepBinary)

Parameters:

keepBinary - Keep binary flag.

cacheName

public String cacheName()

Specified by:

cacheName in interface GridContinuousHandler

Returns:

Cache name if this is a continuous query handler.

updateCounters

public void updateCounters(AffinityTopologyVersion topVer,
                  Map<UUID,Map<Integer,Long>> cntrsPerNode,
                  Map<Integer,Long> cntrs)

Specified by:

updateCounters in interface GridContinuousHandler

Parameters:

topVer - Topology version.

cntrsPerNode - Init state partition counters for node.

cntrs - Init state for partition counters.

register

public GridContinuousHandler.RegisterStatus register(UUID nodeId,
                                            UUID routineId,
                                            GridKernalContext ctx)
                                              throws IgniteCheckedException

Registers listener.

Specified by:

register in interface GridContinuousHandler

Parameters:

nodeId - ID of the node that started routine.

routineId - Routine ID.

ctx - Kernal context.

Returns:

Whether listener was actually registered.

Throws:

IgniteCheckedException - In case of error.

getEventFilter

public javax.cache.event.CacheEntryEventFilter getEventFilter()

Returns:

Cache entry event filter.

waitTopologyFuture

public void waitTopologyFuture(GridKernalContext ctx)
                        throws IgniteCheckedException

Wait topology.

Throws:

IgniteCheckedException

unregister

public void unregister(UUID routineId,
              GridKernalContext ctx)

Unregisters listener.

Specified by:

unregister in interface GridContinuousHandler

Parameters:

routineId - Routine ID.

ctx - Kernal context.

notifyCallback

public void notifyCallback(UUID nodeId,
                  UUID routineId,
                  Collection<?> objs,
                  GridKernalContext ctx)

Notifies local callback.

Specified by:

notifyCallback in interface GridContinuousHandler

Parameters:

nodeId - ID of the node where notification came from.

routineId - Routine ID.

objs - Notification objects.

ctx - Kernal context.

filter

public boolean filter(org.apache.ignite.internal.processors.cache.query.continuous.CacheContinuousQueryEvent evt,
             boolean primary)

Parameters:

primary - Primary.

evt - Query event.

Returns:

True if event passed filter otherwise true.

onClientDisconnected

public void onClientDisconnected()

Client node disconnected callback.

Specified by:

onClientDisconnected in interface GridContinuousHandler

onNodeLeft

public void onNodeLeft()

Node which started routine leave topology.

Specified by:

onNodeLeft in interface GridContinuousHandler

p2pMarshal

public void p2pMarshal(GridKernalContext ctx)
                throws IgniteCheckedException

Deploys and marshals inner objects (called only if peer deployment is enabled).

Specified by:

p2pMarshal in interface GridContinuousHandler

Parameters:

ctx - Kernal context.

Throws:

IgniteCheckedException - In case of error.

p2pUnmarshal

public void p2pUnmarshal(UUID nodeId,
                GridKernalContext ctx)
                  throws IgniteCheckedException

Unmarshals inner objects (called only if peer deployment is enabled).

Specified by:

p2pUnmarshal in interface GridContinuousHandler

Parameters:

nodeId - Sender node ID.

ctx - Kernal context.

Throws:

IgniteCheckedException - In case of error.

createBatch

public GridContinuousBatch createBatch()

Creates new batch.

Specified by:

createBatch in interface GridContinuousHandler

Returns:

New batch.

onBatchAcknowledged

public void onBatchAcknowledged(UUID routineId,
                       GridContinuousBatch batch,
                       GridKernalContext ctx)

Called when ack for a batch is received from client.

Specified by:

onBatchAcknowledged in interface GridContinuousHandler

Parameters:

routineId - Routine ID.

batch - Acknowledged batch.

ctx - Kernal context.

orderedTopic

@Nullable
public Object orderedTopic()

Specified by:

orderedTopic in interface GridContinuousHandler

Returns:

Topic for ordered notifications. If null, notifications will be sent in non-ordered messages.

clone

public GridContinuousHandler clone()

Clones this handler.

Specified by:

clone in interface GridContinuousHandler

Overrides:

clone in class Object

Returns:

Clone of this handler.

toString

public String toString()

Overrides:

toString in class Object

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException