org.apache.zookeeper.server
Class ZooKeeperServer

java.lang.Object
  org.apache.zookeeper.server.ZooKeeperServer

All Implemented Interfaces:

ServerStats.Provider, SessionTracker.SessionExpirer

Direct Known Subclasses:

FollowerZooKeeperServer, LeaderZooKeeperServer

public class ZooKeeperServer
extends Object
implements SessionTracker.SessionExpirer, ServerStats.Provider

This class implements a simple standalone ZooKeeperServer. It sets up the following chain of RequestProcessors to process requests: PrepRequestProcessor -> SyncRequestProcessor -> FinalRequestProcessor

Nested Class Summary

static class	ZooKeeperServer.BasicDataTreeBuilder
static interface	ZooKeeperServer.DataTreeBuilder The server delegates loading of the tree to an instance of the interface
static interface	ZooKeeperServer.Factory Create an instance of ZooKeeper server

Field Summary

int	commitLogBuffer
static int	commitLogCount
LinkedList<Leader.Proposal>	committedLog
DataTree	dataTree
static int	DEFAULT_TICK_TIME
protected RequestProcessor	firstProcessor
protected long	hzxid
protected DataTreeBean	jmxDataTreeBean
protected ZooKeeperServerBean	jmxServerBean
protected static org.apache.log4j.Logger	LOG
long	maxCommittedLog
long	minCommittedLog
static Exception	ok
protected boolean	running
protected ConcurrentHashMap<Long,Integer>	sessionsWithTimeouts
protected SessionTracker	sessionTracker
protected int	tickTime

Constructor Summary

ZooKeeperServer()
Creates a ZooKeeperServer instance.

ZooKeeperServer(File snapDir, File logDir, int tickTime)
This constructor is for backward compatibility with the existing unit test code.

ZooKeeperServer(FileTxnSnapLog txnLogFactory, int tickTime, ZooKeeperServer.DataTreeBuilder treeBuilder)
Creates a ZooKeeperServer instance.

ZooKeeperServer(FileTxnSnapLog txnLogFactory, ZooKeeperServer.DataTreeBuilder treeBuilder)
Default constructor, relies on the config for its agrument values

Method Summary

void	addCommittedProposal(Request request) maintains a list of last 500 or so committed requests.
static void	byteBuffer2Record(ByteBuffer bb, Record record)
protected boolean	checkPasswd(long sessionId, byte[] passwd)
void	closeSession(long sessionId)
void	closeSession(ServerCnxn cnxn, org.apache.zookeeper.proto.RequestHeader requestHeader)
protected void	createSessionTracker()
void	decInProcess()
void	deserializeSnapshot(InputArchive ia)
void	expire(long sessionId)
int	getClientPort()
int	getGlobalOutstandingLimit()
int	getInProcess()
long	getLastProcessedZxid() return the last proceesed id from the datatree
FileTxnSnapLog	getLogWriter() the snapshot and logwriter for this instance
long	getOutstandingRequests() return the outstanding requests in the queue, which havent been processed yet
NIOServerCnxn.Factory	getServerCnxnFactory()
long	getServerId()
static int	getSnapCount()
String	getState()
int	getTickTime()
ZooKeeperServer.DataTreeBuilder	getTreeBuilder()
FileTxnSnapLog	getTxnLogFactory()
long	getZxid() This should be called from a synchronized block on this!
void	incInProcess()
boolean	isRunning()
protected void	killSession(long sessionId, long zxid)
void	loadData() Restore sessions and data
protected void	registerJMX()
void	reopenSession(ServerCnxn cnxn, long sessionId, byte[] passwd, int sessionTimeout)
protected void	revalidateSession(ServerCnxn cnxn, long sessionId, int sessionTimeout)
void	serializeSnapshot(OutputArchive oa)
ServerStats	serverStats()
void	setOwner(long id, Object owner) set the owner of this session as owner
void	setServerCnxnFactory(NIOServerCnxn.Factory factory)
void	setTickTime(int tickTime)
void	setTreeBuilder(ZooKeeperServer.DataTreeBuilder treeBuilder)
void	setTxnLogFactory(FileTxnSnapLog txnLog)
protected void	setupRequestProcessors()
void	setZxid(long zxid)
void	shutdown()
void	startup()
void	submitRequest(Request si)
void	takeSnapshot()
void	truncateLog(long zxid) trunccate the log to get in sync with others if in a quorum
protected void	unregisterJMX()

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.apache.log4j.Logger LOG

jmxServerBean

protected ZooKeeperServerBean jmxServerBean

jmxDataTreeBean

protected DataTreeBean jmxDataTreeBean

DEFAULT_TICK_TIME

public static final int DEFAULT_TICK_TIME

See Also:

Constant Field Values

tickTime

protected int tickTime

commitLogCount

public static final int commitLogCount

See Also:

Constant Field Values

commitLogBuffer

public int commitLogBuffer

committedLog

public LinkedList<Leader.Proposal> committedLog

minCommittedLog

public long minCommittedLog

maxCommittedLog

public long maxCommittedLog

dataTree

public DataTree dataTree

sessionTracker

protected SessionTracker sessionTracker

sessionsWithTimeouts

protected ConcurrentHashMap<Long,Integer> sessionsWithTimeouts

hzxid

protected long hzxid

ok

public static final Exception ok

firstProcessor

protected RequestProcessor firstProcessor

running

protected volatile boolean running

Constructor Detail

ZooKeeperServer

public ZooKeeperServer()

Creates a ZooKeeperServer instance. Nothing is setup, use the setX methods to prepare the instance (eg datadir, datalogdir, ticktime, builder, etc...)

Throws:

IOException

ZooKeeperServer

public ZooKeeperServer(FileTxnSnapLog txnLogFactory,
                       int tickTime,
                       ZooKeeperServer.DataTreeBuilder treeBuilder)
                throws IOException

Creates a ZooKeeperServer instance. It sets everything up, but doesn't actually start listening for clients until run() is invoked.

Parameters:

dataDir - the directory to put the data

Throws:

IOException

ZooKeeperServer

public ZooKeeperServer(File snapDir,
                       File logDir,
                       int tickTime)
                throws IOException

This constructor is for backward compatibility with the existing unit test code. It defaults to FileLogProvider persistence provider.

Throws:

IOException

ZooKeeperServer

public ZooKeeperServer(FileTxnSnapLog txnLogFactory,
                       ZooKeeperServer.DataTreeBuilder treeBuilder)
                throws IOException

Default constructor, relies on the config for its agrument values

Throws:

IOException

Method Detail

serverStats

public ServerStats serverStats()

loadData

public void loadData()
              throws IOException,
                     InterruptedException

Restore sessions and data

Throws:

IOException

InterruptedException

addCommittedProposal

public void addCommittedProposal(Request request)

maintains a list of last 500 or so committed requests. This is used for fast follower synchronization.

Parameters:

request - committed request

takeSnapshot

public void takeSnapshot()

serializeSnapshot

public void serializeSnapshot(OutputArchive oa)
                       throws IOException,
                              InterruptedException

Throws:

IOException

InterruptedException

deserializeSnapshot

public void deserializeSnapshot(InputArchive ia)
                         throws IOException

Throws:

IOException

getZxid

public long getZxid()

This should be called from a synchronized block on this!

setZxid

public void setZxid(long zxid)

closeSession

public void closeSession(long sessionId)

killSession

protected void killSession(long sessionId,
                           long zxid)

expire

public void expire(long sessionId)

Specified by:

expire in interface SessionTracker.SessionExpirer

registerJMX

protected void registerJMX()

startup

public void startup()
             throws IOException,
                    InterruptedException

Throws:

IOException

InterruptedException

setupRequestProcessors

protected void setupRequestProcessors()

createSessionTracker

protected void createSessionTracker()

isRunning

public boolean isRunning()

shutdown

public void shutdown()

unregisterJMX

protected void unregisterJMX()

incInProcess

public void incInProcess()

decInProcess

public void decInProcess()

getInProcess

public int getInProcess()

checkPasswd

protected boolean checkPasswd(long sessionId,
                              byte[] passwd)

setOwner

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

set the owner of this session as owner

Parameters:

id - the session id

owner - the owner of the session

Throws:

KeeperException.SessionExpiredException

revalidateSession

protected void revalidateSession(ServerCnxn cnxn,
                                 long sessionId,
                                 int sessionTimeout)
                          throws IOException,
                                 InterruptedException

Throws:

IOException

InterruptedException

reopenSession

public void reopenSession(ServerCnxn cnxn,
                          long sessionId,
                          byte[] passwd,
                          int sessionTimeout)
                   throws IOException,
                          InterruptedException

Throws:

IOException

InterruptedException

closeSession

public void closeSession(ServerCnxn cnxn,
                         org.apache.zookeeper.proto.RequestHeader requestHeader)

getServerId

public long getServerId()

Specified by:

getServerId in interface SessionTracker.SessionExpirer

submitRequest

public void submitRequest(Request si)

byteBuffer2Record

public static void byteBuffer2Record(ByteBuffer bb,
                                     Record record)
                              throws IOException

Throws:

IOException

getSnapCount

public static int getSnapCount()

getGlobalOutstandingLimit

public int getGlobalOutstandingLimit()

setServerCnxnFactory

public void setServerCnxnFactory(NIOServerCnxn.Factory factory)

getServerCnxnFactory

public NIOServerCnxn.Factory getServerCnxnFactory()

getLastProcessedZxid

public long getLastProcessedZxid()

return the last proceesed id from the datatree

Specified by:

getLastProcessedZxid in interface ServerStats.Provider

getOutstandingRequests

public long getOutstandingRequests()

return the outstanding requests in the queue, which havent been processed yet

Specified by:

getOutstandingRequests in interface ServerStats.Provider

truncateLog

public void truncateLog(long zxid)
                 throws IOException

trunccate the log to get in sync with others if in a quorum

Parameters:

zxid - the zxid that it needs to get in sync with others

Throws:

IOException

getLogWriter

public FileTxnSnapLog getLogWriter()

the snapshot and logwriter for this instance

Returns:

getTickTime

public int getTickTime()

setTickTime

public void setTickTime(int tickTime)

getTreeBuilder

public ZooKeeperServer.DataTreeBuilder getTreeBuilder()

setTreeBuilder

public void setTreeBuilder(ZooKeeperServer.DataTreeBuilder treeBuilder)

getClientPort

public int getClientPort()

setTxnLogFactory

public void setTxnLogFactory(FileTxnSnapLog txnLog)

getTxnLogFactory

public FileTxnSnapLog getTxnLogFactory()

getState

public String getState()

Specified by:

getState in interface ServerStats.Provider