com.hazelcast.cp.internal.session

Class ProxySessionManagerService

java.lang.Object

com.hazelcast.cp.internal.session.AbstractProxySessionManager

com.hazelcast.cp.internal.session.ProxySessionManagerService

All Implemented Interfaces:

RaftManagedService, GracefulShutdownAwareService, ManagedService

public class ProxySessionManagerService
extends AbstractProxySessionManager
implements GracefulShutdownAwareService, RaftManagedService

Server-side implementation of Raft proxy session manager

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME Name of the service

Fields inherited from class com.hazelcast.cp.internal.session.AbstractProxySessionManager

NO_SESSION_ID

Constructor Summary

Constructors

Constructor and Description
ProxySessionManagerService(NodeEngine nodeEngine)

Method Summary

Modifier and Type	Method and Description
protected ICompletableFuture<Object>	closeSession(RaftGroupId groupId, Long sessionId) Closes the given session on the Raft group
protected long	generateThreadId(RaftGroupId groupId) Generates a cluster-wide unique thread id for the caller
protected ICompletableFuture<Object>	heartbeat(RaftGroupId groupId, long sessionId) Commits a heartbeat for the session on the Raft group
void	init(NodeEngine nodeEngine, Properties properties) Initializes this service.
void	onCPSubsystemRestart() Called when the CP subsystem is restarted.
boolean	onShutdown(long timeout, TimeUnit unit) A hook method that's called during graceful shutdown to provide safety for data managed by this service.
protected SessionResponse	requestNewSession(RaftGroupId groupId) Creates a new session on the Raft group
void	reset() Resets this service back to its initial state.
protected ScheduledFuture<?>	scheduleWithRepetition(Runnable task, long period, TimeUnit unit) Schedules the given task for repeating execution
void	shutdown(boolean terminate) Shuts down this service.

Methods inherited from class com.hazelcast.cp.internal.session.AbstractProxySessionManager

acquireSession, acquireSession, getOrCreateUniqueThreadId, getSession, getSessionAcquireCount, invalidateSession, releaseSession, releaseSession, resetInternalState, shutdown

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_NAME

public static final String SERVICE_NAME

Name of the service

See Also:

Constant Field Values

Constructor Detail

ProxySessionManagerService

public ProxySessionManagerService(NodeEngine nodeEngine)

Method Detail

generateThreadId

protected long generateThreadId(RaftGroupId groupId)

Description copied from class: AbstractProxySessionManager

Generates a cluster-wide unique thread id for the caller

Specified by:

generateThreadId in class AbstractProxySessionManager

requestNewSession

protected SessionResponse requestNewSession(RaftGroupId groupId)

Description copied from class: AbstractProxySessionManager

Creates a new session on the Raft group

Specified by:

requestNewSession in class AbstractProxySessionManager

heartbeat

protected ICompletableFuture<Object> heartbeat(RaftGroupId groupId,
                                               long sessionId)

Description copied from class: AbstractProxySessionManager

Commits a heartbeat for the session on the Raft group

Specified by:

heartbeat in class AbstractProxySessionManager

closeSession

protected ICompletableFuture<Object> closeSession(RaftGroupId groupId,
                                                  Long sessionId)

Description copied from class: AbstractProxySessionManager

Closes the given session on the Raft group

Specified by:

closeSession in class AbstractProxySessionManager

scheduleWithRepetition

protected ScheduledFuture<?> scheduleWithRepetition(Runnable task,
                                                    long period,
                                                    TimeUnit unit)

Description copied from class: AbstractProxySessionManager

Schedules the given task for repeating execution

Specified by:

scheduleWithRepetition in class AbstractProxySessionManager

onShutdown

public boolean onShutdown(long timeout,
                          TimeUnit unit)

Description copied from interface: GracefulShutdownAwareService

A hook method that's called during graceful shutdown to provide safety for data managed by this service. Shutdown process is blocked until this method returns or shutdown timeouts. If this method does not return in time, then it's considered as failed to gracefully shutdown.

Specified by:

onShutdown in interface GracefulShutdownAwareService

Parameters:

timeout - timeout for graceful shutdown

unit - time unit

Returns:

true if graceful shutdown is successful, false otherwise

init

public 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)

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

shutdown

public 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

onCPSubsystemRestart

public void onCPSubsystemRestart()

Description copied from interface: RaftManagedService

Called when the CP subsystem is restarted.

Specified by:

onCPSubsystemRestart in interface RaftManagedService