com.dpslink.flash.db.util

Class SiteActivityQueue

java.lang.Object

com.dpslink.flash.db.util.SiteActivityQueue

All Implemented Interfaces:

java.io.Serializable

public class SiteActivityQueue
extends java.lang.Object
implements java.io.Serializable

Handles the persistence of SiteActivity and SiteActivityPage objects during session processing.

A java.util.Timer and a java.util.TimerTask are used to control when persistence occurs. The timer invokes the task at regularly specified intervals, at which time the task determines if any unpersisted objects are in the queue and, if so, processes them accordingly.

• When invoked, the persistence task runs as a background process.
• If the queue is empty, the persistence task immediately terminates and the queue is not checked again until the next timer interval.
• If the queue is not empty, the persistence task processes all objects currently in the queue and then terminates.
• If the persistence task is already busy when the next timer interval occurs, the timer will immediately invoke the persistence task again as soon as the busy task completes.
• When multiple timer intervals are "missed" due to a busy task, all timer intervals are still honored. In order to "catch up", the persistence task is repeatedly invoked (synchronously) for the number of timer intervals that were missed.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	SiteActivityQueue.PersistTask A timer task used to persist the queue of SiteActivity and SiteActivityPage objects.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.ArrayList<JDBCObject<?>>	cvCache A cache of the activities processed.
private static int	cvLoggingFlag A flag that indicates if activity history logging is turned on.
private static java.util.Timer	cvPersistTimer The timer used to control how often an empty queue is checked for new entries.
protected static java.util.ArrayList<JDBCObject<?>>	cvQueue The queue of SiteActivity and SiteActivityPage objects.
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Constructor and Description
SiteActivityQueue()

Method Summary

Modifier and Type	Method and Description
static void	addToQueue(SiteActivity sa) Adds a SiteActivity object to the end of the queue.
static void	addToQueue(SiteActivityPage sap) Adds a SiteActivityPage object to the end of the queue.
static boolean	loggingPages() Answers if accessed pages are being logged.
static boolean	loggingSessions() Answers if session activity is being logged.
static void	removeFromCache(SiteActivity sa) Removes a SiteActivity object from the activity cache.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

cvLoggingFlag

private static int cvLoggingFlag

A flag that indicates if activity history logging is turned on. Based on the "Site.Activity.Logging" value in properties. 0=no logging, 1=log sessions, 2=log sessions and pages.

cvPersistTimer

private static java.util.Timer cvPersistTimer

The timer used to control how often an empty queue is checked for new entries.

cvQueue

protected static java.util.ArrayList<JDBCObject<?>> cvQueue

The queue of SiteActivity and SiteActivityPage objects.

cvCache

protected static java.util.ArrayList<JDBCObject<?>> cvCache

A cache of the activities processed. Used during persistence to determine if a SiteActivity or SiteActivityPage object needs to be added or updated.

Constructor Detail

SiteActivityQueue

public SiteActivityQueue()

Method Detail

addToQueue

public static void addToQueue(SiteActivity sa)

Adds a SiteActivity object to the end of the queue. Typically only invoked by DefaultServlet.queueActivity.

Parameters:

sa - (SiteActivity) The SiteActivity object that is to be added to the queue.

addToQueue

public static void addToQueue(SiteActivityPage sap)

Adds a SiteActivityPage object to the end of the queue. Typically only invoked by DefaultServlet doGet() and doPost() methods.

Parameters:

sap - (SiteActivityPage) The SiteActivityPage object that is to be added to the queue.

removeFromCache

public static void removeFromCache(SiteActivity sa)

Removes a SiteActivity object from the activity cache. Invoked by a SiteActivity object when it is either removed from its session or when the session it is associated with times-out.

Parameters:

sa - (SiteActivity) The SiteActivity object that is to be removed from the cache.

loggingPages

public static boolean loggingPages()

Answers if accessed pages are being logged.

Returns:

boolean - true if pages are being logged, otherwise false.

loggingSessions

public static boolean loggingSessions()

Answers if session activity is being logged.

Returns:

boolean - true if sessions are being logged, otherwise false.