org.tentackle.persist

Class ModificationTracker

java.lang.Object

java.lang.Thread

org.tentackle.task.DefaultTaskDispatcher

org.tentackle.pdo.DefaultSessionTaskDispatcher

org.tentackle.persist.ModificationTracker

All Implemented Interfaces:

Runnable, Killable, Supervisable, Terminatable, ExclusiveSessionProvider, SessionTaskDispatcher, TaskDispatcher

Direct Known Subclasses:

DbPdoTracker

public class ModificationTracker
extends DefaultSessionTaskDispatcher
implements ExclusiveSessionProvider

The modification tracker for the tentackle persistence layer.

Author:

harald

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
static long	defaultPollingInterval default polling interval in milliseconds.

Fields inherited from class org.tentackle.task.DefaultTaskDispatcher

INSTANCE_COUNTER

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
ModificationTracker(String name) Creates a tracker to be configured.

Method Summary

Modifier and Type	Method and Description
void	addModificationListener(ModificationListener listener) Adds a modification listener.
void	addShutdownRunnable(Runnable runnable) Adds a shutdown runnable. The runnables will be executed on termination of this tracker.
protected void	cleanup()
long	countModification(String tableName) Counts the modification for a table. Used by the persistence layer to update the modification table.
protected ModificationEvent	createModificationEvent(Collection<ModificationEventDetail> details) Creates a modification event.
protected long	extractMasterSerial(MasterSerial masterSerial) Extracts the master serial from the master serial object.
List<IdSerialTuple>	getAllSerials() Gets the serials of all monitored tables. Used in remote connections.
IdSerialTuple	getIdSerialForName(String tableName) Gets the pair of id/serial for a given tablename. Used in remote connections.
long	getMasterSerial() Gets the current master serial. Used in remote connections.
Db	getSession()
void	invalidate() Invalidates the modification table and re-initializes all entries and counters.
protected void	lockInternal()
boolean	releaseSession(Session session)
boolean	removeModificationListener(ModificationListener listener) Removes a modification listener.
boolean	removeShutdownRunnable(Runnable runnable) Removes a shutdown runnable.
Session	requestSession()
void	setSession(Session session)
protected void	unlockInternal(long sleepMs)

Methods inherited from class org.tentackle.pdo.DefaultSessionTaskDispatcher

addTask, createLock, isSessionClosedOnTermination, isSessionKeptAlive, run, setSessionClosedOnTermination, setSessionKeptAlive

Methods inherited from class org.tentackle.task.DefaultTaskDispatcher

addTaskAndWait, addTaskListener, assertAlive, assertIntervalsInRange, assertNotAlive, assertNotKilled, executeTask, fireCompleted, fireStarted, getAllTasks, getDeadInterval, getQueueSize, getShutdownIdleTimeout, getSleepInterval, getTerminationCause, interrupt, isDead, isInstanceOfTaskPending, isKilled, isQueueEmpty, isTaskDispatcherThread, isTaskPending, isTerminationRequested, isUsingMutexLocking, kill, lock, nextTask, removeTask, removeTaskListener, requestTermination, setDead, setDeadInterval, setShutdownIdleTimeout, setSleepInterval, setUsingMutexLocking, sleepForInterval, startedAt, terminate, terminatedAt, toDiagnosticString, unlock, waitForTask

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tentackle.task.TaskDispatcher

addTaskAndWait, addTaskListener, getAllTasks, getDeadInterval, getQueueSize, getShutdownIdleTimeout, getSleepInterval, isAlive, isInstanceOfTaskPending, isQueueEmpty, isTaskPending, isUsingMutexLocking, lock, removeTask, removeTaskListener, setDeadInterval, setShutdownIdleTimeout, setSleepInterval, setUsingMutexLocking, start, toDiagnosticString, unlock, waitForTask

Methods inherited from interface org.tentackle.daemon.Terminatable

isTerminationRequested, requestTermination, terminate

Field Detail

defaultPollingInterval

public static long defaultPollingInterval

default polling interval in milliseconds.

Constructor Detail

ModificationTracker

public ModificationTracker(String name)

Creates a tracker to be configured.

Parameters:

name - the thread's name

Method Detail

requestSession

public Session requestSession()

Specified by:

requestSession in interface ExclusiveSessionProvider

releaseSession

public boolean releaseSession(Session session)

Specified by:

releaseSession in interface ExclusiveSessionProvider

getSession

public Db getSession()

Specified by:

getSession in interface SessionTaskDispatcher

Overrides:

getSession in class DefaultSessionTaskDispatcher

setSession

public void setSession(Session session)

Specified by:

setSession in interface SessionTaskDispatcher

Overrides:

setSession in class DefaultSessionTaskDispatcher

cleanup

protected void cleanup()

Overrides:

cleanup in class DefaultSessionTaskDispatcher

addShutdownRunnable

public void addShutdownRunnable(Runnable runnable)

Adds a shutdown runnable.
The runnables will be executed on termination of this tracker.

Parameters:

runnable - the runnable

removeShutdownRunnable

public boolean removeShutdownRunnable(Runnable runnable)

Removes a shutdown runnable.

Notice that the first occurrence of the runnable is removed.

Parameters:

runnable - the runnable

Returns:

true if runnable removed, false if no such runnable registered

addModificationListener

public void addModificationListener(ModificationListener listener)

Adds a modification listener.

Parameters:

listener - the listener to add

removeModificationListener

public boolean removeModificationListener(ModificationListener listener)

Removes a modification listener.

Parameters:

listener - the listener to remove

Returns:

true if listener removed

getMasterSerial

public long getMasterSerial()

Gets the current master serial.
Used in remote connections.

Returns:

the current master serial

getIdSerialForName

public IdSerialTuple getIdSerialForName(String tableName)

Gets the pair of id/serial for a given tablename.
Used in remote connections.

Parameters:

tableName - the table to lookup

Returns:

the id/serial pair for the tablename, never null

getAllSerials

public List<IdSerialTuple> getAllSerials()

Gets the serials of all monitored tables.
Used in remote connections.

Returns:

the serials

countModification

public long countModification(String tableName)

Counts the modification for a table.
Used by the persistence layer to update the modification table.

Parameters:

tableName - the table name

Returns:

the (guessed lowest) table serial (may be higher already)

invalidate

public void invalidate()

Invalidates the modification table and re-initializes all entries and counters.

lockInternal

protected void lockInternal()

Overrides:

lockInternal in class DefaultTaskDispatcher

unlockInternal

protected void unlockInternal(long sleepMs)

Overrides:

unlockInternal in class DefaultSessionTaskDispatcher

createModificationEvent

protected ModificationEvent createModificationEvent(Collection<ModificationEventDetail> details)

Creates a modification event.

Parameters:

details - the event details, null or empty if master event

Returns:

the event

extractMasterSerial

protected long extractMasterSerial(MasterSerial masterSerial)

Extracts the master serial from the master serial object.

Application can override this method to process the optional application data.

Parameters:

masterSerial - the master serial object

Returns:

the long serial