atg.userprofiling
Class PageEvent

java.lang.Object
  java.util.EventObject
      atg.service.event.GenericEvent
          atg.userprofiling.PageEvent

All Implemented Interfaces:

RepositoryUpdateEvent, java.io.Serializable

public class PageEvent
extends GenericEvent
implements RepositoryUpdateEvent

See Also:

Serialized Form

Field Summary

static int[]	ALL_TYPES An array of all of the event type constants for this event.
static java.lang.String	CLASS_VERSION Class version string
protected DynamoHttpServletRequest	mRequest The current request.
static java.lang.String	PAGE_PREFIX Prefix for event topic heirarchy.
static java.lang.String	PAGE_PREFIX_NO_SLASH Variant prefix for event topic heirarchy.
static int	TYPE_VIEW View event type.

Fields inherited from class atg.service.event.GenericEvent

mDate, mTime, mTimestamp, mType, TYPE_VANILLA

Fields inherited from class java.util.EventObject

source

Constructor Summary

PageEvent(java.lang.Object pSource)
Constructs a page event.

PageEvent(java.lang.Object pSource, int pEventType)
Constructs a page event of the given type.

Method Summary

static java.lang.String	buildEventChannel(java.lang.String pPath) Builds an event channel string for the given request path.
static void	clearEventChannelCache() Clears out the cache of event channel strings that have been built for the various paths.
static int	getEventChannelCacheSize() Returns the size of the event channel string cache.
java.lang.String	getPath()
RepositoryItem	getProfile()
DynamoHttpServletRequest	getRequest()
javax.servlet.http.HttpSession	getSession()
RepositoryItem	getUpdatedItem() The item whose updates should be commited after all the updates have been added to the item.
void	setPath(java.lang.String pValue)
void	setProfile(RepositoryItem pValue)
void	setRequest(DynamoHttpServletRequest pValue)
void	setSession(javax.servlet.http.HttpSession pValue)
void	setUpdatedItem(RepositoryItem pValue) The item whose updates should be commited after all the updates have been added to the item.

Methods inherited from class atg.service.event.GenericEvent

getAllTypes, getSource, getTime, getTimeAsDate, getTimeAsTimestamp, getType

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

TYPE_VIEW

public static final int TYPE_VIEW

View event type.

See Also:

Constant Field Values

ALL_TYPES

public static int[] ALL_TYPES

An array of all of the event type constants for this event.

PAGE_PREFIX

public static final java.lang.String PAGE_PREFIX

Prefix for event topic heirarchy.

See Also:

Constant Field Values

PAGE_PREFIX_NO_SLASH

public static final java.lang.String PAGE_PREFIX_NO_SLASH

Variant prefix for event topic heirarchy.

See Also:

Constant Field Values

mRequest

protected DynamoHttpServletRequest mRequest

The current request.

Constructor Detail

PageEvent

public PageEvent(java.lang.Object pSource)

Constructs a page event.

PageEvent

public PageEvent(java.lang.Object pSource,
                 int pEventType)

Constructs a page event of the given type.

Method Detail

setRequest

public void setRequest(DynamoHttpServletRequest pValue)

getRequest

public DynamoHttpServletRequest getRequest()

setSession

public void setSession(javax.servlet.http.HttpSession pValue)

getSession

public javax.servlet.http.HttpSession getSession()

setProfile

public void setProfile(RepositoryItem pValue)

getProfile

public RepositoryItem getProfile()

setPath

public void setPath(java.lang.String pValue)

getPath

public java.lang.String getPath()

setUpdatedItem

public void setUpdatedItem(RepositoryItem pValue)

Description copied from interface: RepositoryUpdateEvent

The item whose updates should be commited after all the updates have been added to the item.

Specified by:

setUpdatedItem in interface RepositoryUpdateEvent

getUpdatedItem

public RepositoryItem getUpdatedItem()

Description copied from interface: RepositoryUpdateEvent

The item whose updates should be commited after all the updates have been added to the item.

Specified by:

getUpdatedItem in interface RepositoryUpdateEvent

buildEventChannel

public static java.lang.String buildEventChannel(java.lang.String pPath)

Builds an event channel string for the given request path. The path will be checked for any query args, etc, which will be stripped off.

Parameters:

pPath - the path info for the request

clearEventChannelCache

public static void clearEventChannelCache()

Clears out the cache of event channel strings that have been built for the various paths. EventChannel strings are built and cached for quick and easy reference. If this cache grows too large, this method can be called to reset that cache.

getEventChannelCacheSize

public static int getEventChannelCacheSize()

Returns the size of the event channel string cache.