atg.reporting.datacollection

Interface RequestLogging

All Known Implementing Classes:

RequestLoggingService

public interface RequestLogging

Defines methods that perform logging methods about a user's requests through the system

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Long	getRequestId(javax.servlet.http.HttpServletRequest pRequest) Returns the request id associated with this request.
java.lang.Long	logRequest(java.lang.String pSessionId, java.lang.String pRequestName, boolean pMember) Generates a log entry about a request
void	setRequestId(java.lang.Long pRequestId, javax.servlet.http.HttpServletRequest pRequest) Stores the request id associated with this request.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Method Detail

logRequest

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

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

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.

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

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.

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