atg.reporting.datacollection

Class RequestLoggingService

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.service.datacollection.GenericDataListenerService

atg.reporting.datacollection.IdGeneratorLoggingService

atg.reporting.datacollection.RequestLoggingService

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, 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, RequestLogging, java.util.EventListener

public class RequestLoggingService
extends atg.reporting.datacollection.IdGeneratorLoggingService
implements RequestLogging

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	REQUEST_ID_ATTRIBUTE_KEY

Fields inherited from class atg.service.datacollection.GenericDataListenerService

mDataListeners

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

Constructors

Constructor and Description
RequestLoggingService() Constructs an instanceof RequestLoggingService

Method Summary

Modifier and Type	Method and Description
int	getMaxLengthContentName() Returns property MaxLengthContentName
java.lang.Long	getRequestId(javax.servlet.http.HttpServletRequest pRequest) Returns the request id associated with this request.
long	getTotalItemCount() Returns property TotalItemCount
boolean	isEnableContentNameTruncation() Returns property EnableContentNameTruncation
java.lang.Long	logRequest(java.lang.String pSessionId, java.lang.String pRequestName, boolean pMember) Generates a log entry about a request
void	setEnableContentNameTruncation(boolean pEnableContentNameTruncation) Sets property EnableContentNameTruncation
void	setMaxLengthContentName(int pMaxLengthContentName) Sets property MaxLengthContentName
void	setRequestId(java.lang.Long pRequestId, javax.servlet.http.HttpServletRequest pRequest) Stores the request id associated with this request.

Methods inherited from class atg.reporting.datacollection.IdGeneratorLoggingService

doStartService, getIdBurnFactor, getIdGenerator, getIdSource, getIdSpace, isEnableLogging, nextId, setEnableLogging, setIdBurnFactor, setIdGenerator, setIdSource, setIdSpace

Methods inherited from class atg.service.datacollection.GenericDataListenerService

addDataListener, getDataListenerCount, getDataListeners, removeDataListener, sendDataItem

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, 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, toString

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, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

REQUEST_ID_ATTRIBUTE_KEY

public static final java.lang.String REQUEST_ID_ATTRIBUTE_KEY

See Also:

Constant Field Values

Constructor Detail

RequestLoggingService

public RequestLoggingService()

Constructs an instanceof RequestLoggingService

Method Detail

setEnableContentNameTruncation

public void setEnableContentNameTruncation(boolean pEnableContentNameTruncation)

Sets property EnableContentNameTruncation

isEnableContentNameTruncation

public boolean isEnableContentNameTruncation()

Returns property EnableContentNameTruncation

setMaxLengthContentName

public void setMaxLengthContentName(int pMaxLengthContentName)

Sets property MaxLengthContentName

getMaxLengthContentName

public int getMaxLengthContentName()

Returns property MaxLengthContentName

getTotalItemCount

public long getTotalItemCount()

Returns property TotalItemCount

logRequest

public java.lang.Long logRequest(java.lang.String pSessionId,
                                 java.lang.String pRequestName,
                                 boolean pMember)
                          throws atg.reporting.datacollection.LoggingException

Generates a log entry about a request

Specified by:

logRequest in interface RequestLogging

Parameters:

pSessionId - the id of the new session

pRequestName - the "name" of the request (e.g. the URI of a HTTP Request)

pMember - true if the request is coming from a "member"

Returns:

the id associated with the log entry

Throws:

LoggingException - if there was a problem while performing the log operation

getRequestId

public java.lang.Long getRequestId(javax.servlet.http.HttpServletRequest pRequest)
                            throws atg.reporting.datacollection.LoggingException

Returns the request id associated with this request. This id can be used by the content viewed logging operation.

Specified by:

getRequestId in interface RequestLogging

Parameters:

pRequest - the request object associated with the current user

Returns:

null if no request id could be found

Throws:

LoggingException - if there was a problem while performing the log operation

See Also:

ContentViewedLogging.logContentViewed

setRequestId

public void setRequestId(java.lang.Long pRequestId,
                         javax.servlet.http.HttpServletRequest pRequest)
                  throws atg.reporting.datacollection.LoggingException

Stores the request id associated with this request. This id can be used by the content viewed logging operation.

Specified by:

setRequestId in interface RequestLogging

Parameters:

pRequestId - the request id

pRequest - the request object associated with the current user

Throws:

LoggingException - if there was a problem while performing the log operation

See Also:

ContentViewedLogging.logContentViewed