com.hazelcast.cp.internal.datastructures.spi.blocking

Class AbstractBlockingService<W extends WaitKey,R extends BlockingResource<W>,RR extends ResourceRegistry<W,R>>

java.lang.Object

com.hazelcast.cp.internal.datastructures.spi.blocking.AbstractBlockingService<W,R,RR>

Type Parameters:

W - concrete type of the WaitKey

R - concrete type of the resource

RR - concrete ty;e lf the resource registry

All Implemented Interfaces:

RaftManagedService, RaftRemoteService, SnapshotAwareService<RR>, RaftNodeLifecycleAwareService, SessionAwareService, LiveOperationsTracker, ManagedService

Direct Known Subclasses:

RaftCountDownLatchService, RaftLockService, RaftSemaphoreService

public abstract class AbstractBlockingService<W extends WaitKey,R extends BlockingResource<W>,RR extends ResourceRegistry<W,R>>
extends Object
implements RaftManagedService, RaftNodeLifecycleAwareService, RaftRemoteService, SessionAwareService, SnapshotAwareService<RR>, LiveOperationsTracker

Base class for services that maintain blocking resources. Contains common behaviour that will be needed by service implementations.

Field Summary

Fields

Modifier and Type	Field and Description
protected ILogger	logger
protected NodeEngineImpl	nodeEngine
protected RaftService	raftService
static long	WAIT_TIMEOUT_TASK_UPPER_BOUND_MILLIS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBlockingService(NodeEngine nodeEngine)

Method Summary

Modifier and Type	Method and Description
protected abstract RR	createNewRegistry(CPGroupId groupId) Creates a registry for the given Raft group.
boolean	destroyRaftObject(CPGroupId groupId, String name) Destroys the given CP data structure on the CP group.
protected abstract Object	expiredWaitKeyResponse() Creates the response object that will be sent for a expired wait key.
void	expireWaitKeys(CPGroupId groupId, Collection<Tuple2<String,UUID>> keys)
Collection<Long>	getAttachedSessions(CPGroupId groupId) Returns a collection of session ids that this service has attached some resources.
Collection<Tuple2<Address,Long>>	getLiveOperations(CPGroupId groupId)
protected RR	getOrInitRegistry(CPGroupId groupId)
RR	getRegistryOrNull(CPGroupId groupId)
protected void	heartbeatSession(CPGroupId groupId, long sessionId)
void	init(NodeEngine nodeEngine, Properties properties) Initializes this service.
protected void	initImpl() Subclasses can implement their custom initialization logic here
protected void	notifyWaitKeys(CPGroupId groupId, String name, Collection<W> keys, Object result)
void	onCPSubsystemRestart() Called when the CP subsystem is restarted.
void	onRaftGroupDestroyed(CPGroupId groupId) Called on the thread of the Raft group when the given Raft node is destroyed, either gracefully or forcefully.
void	onRaftNodeSteppedDown(CPGroupId groupId) Called on the thread of the Raft group when the given Raft node is stepped down, either because it is shutting down, or it could not be added to the Raft group
protected void	onRegistryRestored(RR registry)
void	onSessionClose(CPGroupId groupId, long sessionId) Called when a session is closed.
void	populate(LiveOperations liveOperations) Populate the LiveOperations
void	reset() Resets this service back to its initial state.
void	restoreSnapshot(CPGroupId groupId, long commitIndex, RR registry) Restores the snapshot for specified CPGroupId.
protected void	scheduleTimeout(CPGroupId groupId, String name, UUID invocationUid, long timeoutMs)
protected abstract String	serviceName() Returns name of the service.
void	setSessionAccessor(SessionAccessor accessor) Injects SessionAccessor in order to enable the custom service to validate and trigger session activity
void	shutdown(boolean terminate) Shuts down this service.
protected void	shutdownImpl(boolean terminate) Subclasses can implement their custom shutdown logic here
RR	takeSnapshot(CPGroupId groupId, long commitIndex) Creates a snapshot for specified CPGroupId.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hazelcast.cp.internal.datastructures.spi.RaftRemoteService

createProxy

Field Detail

WAIT_TIMEOUT_TASK_UPPER_BOUND_MILLIS

public static final long WAIT_TIMEOUT_TASK_UPPER_BOUND_MILLIS

See Also:

Constant Field Values

nodeEngine

protected final NodeEngineImpl nodeEngine

logger

protected final ILogger logger

raftService

protected volatile RaftService raftService

Constructor Detail

AbstractBlockingService

protected AbstractBlockingService(NodeEngine nodeEngine)

Method Detail

init

public final void init(NodeEngine nodeEngine,
                       Properties properties)

Description copied from interface: ManagedService

Initializes this service.

Specified by:

init in interface ManagedService

Parameters:

nodeEngine - the NodeEngine that this service belongs to

properties - the Properties (can be used to pass settings to the service)

initImpl

protected void initImpl()

Subclasses can implement their custom initialization logic here

reset

public void reset()

Description copied from interface: ManagedService

Resets this service back to its initial state.

TODO: what is the purpose of reset

Specified by:

reset in interface ManagedService

onCPSubsystemRestart

public void onCPSubsystemRestart()

Description copied from interface: RaftManagedService

Called when the CP subsystem is restarted.

Specified by:

onCPSubsystemRestart in interface RaftManagedService

shutdown

public final void shutdown(boolean terminate)

Description copied from interface: ManagedService

Shuts down this service.

TODO: what is the purpose of the terminate variable

Specified by:

shutdown in interface ManagedService

Parameters:

terminate - true to shut down this service

shutdownImpl

protected void shutdownImpl(boolean terminate)

Subclasses can implement their custom shutdown logic here

serviceName

protected abstract String serviceName()

Returns name of the service.

createNewRegistry

protected abstract RR createNewRegistry(CPGroupId groupId)

Creates a registry for the given Raft group.

expiredWaitKeyResponse

protected abstract Object expiredWaitKeyResponse()

Creates the response object that will be sent for a expired wait key.

onRegistryRestored

protected void onRegistryRestored(RR registry)

destroyRaftObject

public boolean destroyRaftObject(CPGroupId groupId,
                                 String name)

Description copied from interface: RaftRemoteService

Destroys the given CP data structure on the CP group. This operation is committed on the given CP group.

Specified by:

destroyRaftObject in interface RaftRemoteService

takeSnapshot

public final RR takeSnapshot(CPGroupId groupId,
                             long commitIndex)

Description copied from interface: SnapshotAwareService

Creates a snapshot for specified CPGroupId. The snapshot object returned from this method will be stored among the Raft log and it can be sent to other Raft nodes anytime. Therefore, this method must not return a snapshot object that can mutate after the takeSnapshot() call.

Specified by:

takeSnapshot in interface SnapshotAwareService<RR extends ResourceRegistry<W,R>>

Parameters:

groupId - CPGroupId which is snapshot requested for

commitIndex - commitIndex of the taken snapshot

Returns:

snapshot for specified CPGroupId.

restoreSnapshot

public final void restoreSnapshot(CPGroupId groupId,
                                  long commitIndex,
                                  RR registry)

Description copied from interface: SnapshotAwareService

Restores the snapshot for specified CPGroupId.

Specified by:

restoreSnapshot in interface SnapshotAwareService<RR extends ResourceRegistry<W,R>>

Parameters:

groupId - CPGroupId of the snapshot to be restored

commitIndex - commitIndex of the restored snapshot

registry - snapshot for specified CPGroupId

setSessionAccessor

public void setSessionAccessor(SessionAccessor accessor)

Description copied from interface: SessionAwareService

Injects SessionAccessor in order to enable the custom service to validate and trigger session activity

Specified by:

setSessionAccessor in interface SessionAwareService

onSessionClose

public final void onSessionClose(CPGroupId groupId,
                                 long sessionId)

Description copied from interface: SessionAwareService

Called when a session is closed.

Specified by:

onSessionClose in interface SessionAwareService

getAttachedSessions

public final Collection<Long> getAttachedSessions(CPGroupId groupId)

Description copied from interface: SessionAwareService

Returns a collection of session ids that this service has attached some resources.

Specified by:

getAttachedSessions in interface SessionAwareService

onRaftGroupDestroyed

public final void onRaftGroupDestroyed(CPGroupId groupId)

Description copied from interface: RaftNodeLifecycleAwareService

Called on the thread of the Raft group when the given Raft node is destroyed, either gracefully or forcefully.

Specified by:

onRaftGroupDestroyed in interface RaftNodeLifecycleAwareService

onRaftNodeSteppedDown

public final void onRaftNodeSteppedDown(CPGroupId groupId)

Description copied from interface: RaftNodeLifecycleAwareService

Called on the thread of the Raft group when the given Raft node is stepped down, either because it is shutting down, or it could not be added to the Raft group

Specified by:

onRaftNodeSteppedDown in interface RaftNodeLifecycleAwareService

populate

public final void populate(LiveOperations liveOperations)

Description copied from interface: LiveOperationsTracker

Populate the LiveOperations

Specified by:

populate in interface LiveOperationsTracker

Parameters:

liveOperations - the LiveOperations to populate.

expireWaitKeys

public final void expireWaitKeys(CPGroupId groupId,
                                 Collection<Tuple2<String,UUID>> keys)

getRegistryOrNull

public final RR getRegistryOrNull(CPGroupId groupId)

getLiveOperations

public Collection<Tuple2<Address,Long>> getLiveOperations(CPGroupId groupId)

getOrInitRegistry

protected final RR getOrInitRegistry(CPGroupId groupId)

scheduleTimeout

protected final void scheduleTimeout(CPGroupId groupId,
                                     String name,
                                     UUID invocationUid,
                                     long timeoutMs)

heartbeatSession

protected final void heartbeatSession(CPGroupId groupId,
                                      long sessionId)

notifyWaitKeys

protected final void notifyWaitKeys(CPGroupId groupId,
                                    String name,
                                    Collection<W> keys,
                                    Object result)