atg.adc
Class ADCRequestData

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.adc.ADCRequestData

All Implemented Interfaces:

atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

Direct Known Subclasses:

CommerceADCRequestData

public class ADCRequestData
extends GenericService

This component keeps track of all the relevant events seen during processing of the current request, as well as other relevant request information.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

ADCRequestData()

Method Summary

void	addEvent(javax.jms.Message pEvent) Add the event to the mEvents HashMap.
java.util.Collection	getAllEvents() Return all of the events seen so far in this request.
java.lang.String	getCategory()
ServiceMap	getClientRequestData()
java.util.List	getEvents(java.lang.String pJMSType) Return all the events of a particular type seen so far in this request.
java.lang.String	getExtraTags()
java.lang.String	getPageName()
java.lang.String	getProductCategory()
Profile	getProfile()
DynamoHttpServletRequest	getRequest()
ADCSessionData	getSessionData()
boolean	hasEvent(java.lang.String pJMSType) Checks to see if any events of the given type have been seen.
boolean	isNoTagForCurrentPage()
void	setCategory(java.lang.String pCategory) The page category associated with the request
void	setClientRequestData(ServiceMap pClientRequestData) Map of optional extra request data components for each ADC client
void	setExtraTags(java.lang.String pExtraTags) Extra tags to be included on page
void	setNoTagForCurrentPage(boolean pNoTagForCurrentPage) boolean that, if true, indicates not to perform auto-tagging on the current page.
void	setPageName(java.lang.String pPageName) The name of the page in the current request.
void	setProductCategory(java.lang.String pProductCategory) The product category associated with the request
void	setProfile(Profile pProfile) The current user profile
void	setRequest(DynamoHttpServletRequest pRequest) The current request
void	setSessionData(ADCSessionData pSessionData) The ADCSessionData component which contains any relevant session information

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Constructor Detail

ADCRequestData

public ADCRequestData()

Method Detail

setCategory

public void setCategory(java.lang.String pCategory)

The page category associated with the request

Parameters:

pCategory - the page category associated with the request

getCategory

public java.lang.String getCategory()

Returns:

The page category associated with the request

setClientRequestData

public void setClientRequestData(ServiceMap pClientRequestData)

Map of optional extra request data components for each ADC client

Parameters:

pClientRequestData - the map of client request data components

getClientRequestData

public ServiceMap getClientRequestData()

Returns:

The map of client request data components

setExtraTags

public void setExtraTags(java.lang.String pExtraTags)

Extra tags to be included on page

Parameters:

pExtraTags - extra tags to be included on page

getExtraTags

public java.lang.String getExtraTags()

Returns:

Extra tags to be included on page

setNoTagForCurrentPage

public void setNoTagForCurrentPage(boolean pNoTagForCurrentPage)

boolean that, if true, indicates not to perform auto-tagging on the current page.

Parameters:

pNoTagForCurrentPage - boolean that, if true, indicates not to perform auto-tagging on the current page

isNoTagForCurrentPage

public boolean isNoTagForCurrentPage()

Returns:

boolean that, if true, indications not to perform auto-tagging on the current page

setPageName

public void setPageName(java.lang.String pPageName)

The name of the page in the current request.

Parameters:

pPageName - the name of the page in the current request.

getPageName

public java.lang.String getPageName()

Returns:

The name of the page in the current request

setProductCategory

public void setProductCategory(java.lang.String pProductCategory)

The product category associated with the request

Parameters:

pCategory - the product category associated with the request

getProductCategory

public java.lang.String getProductCategory()

Returns:

The product category associated with the request

setProfile

public void setProfile(Profile pProfile)

The current user profile

Parameters:

pProfile - the current user profile

getProfile

public Profile getProfile()

Returns:

The current user profile

setRequest

public void setRequest(DynamoHttpServletRequest pRequest)

The current request

Parameters:

pRequest - the current request

getRequest

public DynamoHttpServletRequest getRequest()

Returns:

The current request

setSessionData

public void setSessionData(ADCSessionData pSessionData)

The ADCSessionData component which contains any relevant session information

Parameters:

pSessionData - the ADCSessionData component

getSessionData

public ADCSessionData getSessionData()

Returns:

the ADCSessionData component which contains any relevant session information

addEvent

public void addEvent(javax.jms.Message pEvent)

Add the event to the mEvents HashMap.

Parameters:

pEvent - The event that should be remembered

getEvents

public java.util.List getEvents(java.lang.String pJMSType)

Return all the events of a particular type seen so far in this request.

Parameters:

pJMSType - THe JMSType of the events being request

Returns:

A List of the events. If no events of the type have been seen, then null.

getAllEvents

public java.util.Collection getAllEvents()

Return all of the events seen so far in this request.

Returns:

a Collection of all the events

hasEvent

public boolean hasEvent(java.lang.String pJMSType)

Checks to see if any events of the given type have been seen. If so, returns true, if not returns false

Parameters:

pJMSType - The JMS type of the event to check for

Returns:

true if an event of the given type has been saved