org.apache.zookeeper.server.quorum

Class LearnerSessionTracker

java.lang.Object

org.apache.zookeeper.server.quorum.UpgradeableSessionTracker

org.apache.zookeeper.server.quorum.LearnerSessionTracker

All Implemented Interfaces:

SessionTracker

public class LearnerSessionTracker
extends UpgradeableSessionTracker

The learner session tracker is used by learners (followers and observers) to track zookeeper sessions which may or may not be echoed to the leader. When a new session is created it is saved locally in a wrapped LocalSessionTracker. It can subsequently be upgraded to a global session as required. If an upgrade is requested the session is removed from local collections while keeping the same session ID. It is up to the caller to queue a session creation request for the leader. A secondary function of the learner session tracker is to remember sessions which have been touched in this service. This information is passed along to the leader with a ping.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.zookeeper.server.SessionTracker

SessionTracker.Session, SessionTracker.SessionExpirer

Field Summary

Fields inherited from class org.apache.zookeeper.server.quorum.UpgradeableSessionTracker

localSessionTracker

Constructor Summary

Constructors

Constructor and Description
LearnerSessionTracker(SessionTracker.SessionExpirer expirer, ConcurrentMap<Long,Integer> sessionsWithTimeouts, int tickTime, long id, boolean localSessionsEnabled, ZooKeeperServerListener listener)

Method Summary

Modifier and Type	Method and Description
boolean	addGlobalSession(long sessionId, int sessionTimeout) Add a global session to those being tracked.
boolean	addSession(long sessionId, int sessionTimeout) Add a session to those being tracked.
void	checkSession(long sessionId, Object owner) Checks whether the SessionTracker is aware of this session, the session is still active, and the owner matches.
long	createSession(int sessionTimeout)
void	dumpSessions(PrintWriter pwriter) Text dump of session information, suitable for debugging.
Map<Long,Set<Long>>	getSessionExpiryMap() Returns a mapping of time to session IDs that expire at that time.
boolean	isGlobalSession(long sessionId)
void	removeSession(long sessionId)
void	setOwner(long sessionId, Object owner)
void	setSessionClosing(long sessionId) Mark that the session is in the process of closing.
void	shutdown()
Map<Long,Integer>	snapshot()
void	start()
boolean	touchSession(long sessionId, int sessionTimeout)

Methods inherited from class org.apache.zookeeper.server.quorum.UpgradeableSessionTracker

checkGlobalSession, createLocalSessionTracker, isLocalSession, isTrackingSession, upgradeSession

Methods inherited from class java.lang.Object

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

Constructor Detail

LearnerSessionTracker

public LearnerSessionTracker(SessionTracker.SessionExpirer expirer,
                             ConcurrentMap<Long,Integer> sessionsWithTimeouts,
                             int tickTime,
                             long id,
                             boolean localSessionsEnabled,
                             ZooKeeperServerListener listener)

Method Detail

removeSession

public void removeSession(long sessionId)

start

public void start()

Overrides:

start in class UpgradeableSessionTracker

shutdown

public void shutdown()

isGlobalSession

public boolean isGlobalSession(long sessionId)

Specified by:

isGlobalSession in class UpgradeableSessionTracker

addGlobalSession

public boolean addGlobalSession(long sessionId,
                                int sessionTimeout)

Description copied from interface: SessionTracker

Add a global session to those being tracked.

Parameters:

sessionId - sessionId

sessionTimeout - sessionTimeout

Returns:

whether the session was newly added (if false, already existed)

addSession

public boolean addSession(long sessionId,
                          int sessionTimeout)

Description copied from interface: SessionTracker

Add a session to those being tracked. The session is added as a local session if they are enabled, otherwise as global.

Parameters:

sessionId - sessionId

sessionTimeout - sessionTimeout

Returns:

whether the session was newly added (if false, already existed)

touchSession

public boolean touchSession(long sessionId,
                            int sessionTimeout)

Returns:

false if session is no longer active

snapshot

public Map<Long,Integer> snapshot()

createSession

public long createSession(int sessionTimeout)

checkSession

public void checkSession(long sessionId,
                         Object owner)
                  throws KeeperException.SessionExpiredException,
                         KeeperException.SessionMovedException

Description copied from interface: SessionTracker

Checks whether the SessionTracker is aware of this session, the session is still active, and the owner matches. If the owner wasn't previously set, this sets the owner of the session. UnknownSessionException should never been thrown to the client. It is only used internally to deal with possible local session from other machine

Throws:

KeeperException.SessionExpiredException

KeeperException.SessionMovedException

setOwner

public void setOwner(long sessionId,
                     Object owner)
              throws KeeperException.SessionExpiredException

Throws:

KeeperException.SessionExpiredException

dumpSessions

public void dumpSessions(PrintWriter pwriter)

Description copied from interface: SessionTracker

Text dump of session information, suitable for debugging.

Parameters:

pwriter - the output writer

setSessionClosing

public void setSessionClosing(long sessionId)

Description copied from interface: SessionTracker

Mark that the session is in the process of closing.

getSessionExpiryMap

public Map<Long,Set<Long>> getSessionExpiryMap()

Description copied from interface: SessionTracker

Returns a mapping of time to session IDs that expire at that time.