atg.reporting.datacollection
Class UserEventLoggingService

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.service.datacollection.GenericDataListenerService
              atg.reporting.datacollection.IdGeneratorLoggingService
                  atg.reporting.datacollection.UserEventLoggingService

All Implemented Interfaces:

NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, UserEventLogging, java.util.EventListener

public class UserEventLoggingService
extends atg.reporting.datacollection.IdGeneratorLoggingService
implements UserEventLogging

Field Summary

static java.lang.String

CLASS_VERSION Class version string

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

UserEventLoggingService()
Constructs an instanceof UserEventLoggingService

Method Summary

void	doStartService() Loads the logging event type ids.
java.lang.Integer	getEventTypeId(java.lang.String pTypeName) Returns the id of the given named user event type
java.lang.String[]	getEventTypes() Returns the list of the known user event types available for logging
java.lang.String	getLoginLoggingEventTypeName() Returns property LoginLoggingEventTypeName
java.lang.String	getLogoutLoggingEventTypeName() Returns property LogoutLoggingEventTypeName
java.lang.String	getNewSessionLoggingEventTypeName() Returns property NewSessionLoggingEventTypeName
java.lang.String	getRegistrationLoggingEventTypeName() Returns property RegistrationLoggingEventTypeName
java.lang.String	getSessionExpirationLoggingEventTypeName() Returns property SessionExpirationLoggingEventTypeName
long	getTotalItemCount() Returns property TotalItemCount
atg.reporting.datacollection.UserEventTypes	getUserEventTypes() Returns property UserEventTypes
java.lang.Long	logEndSession(java.lang.String pSessionId, java.lang.String pProfileId, boolean pMember) Generates a log entry indicating that a session was expired
java.lang.Long	logLogin(java.lang.String pSessionId, java.lang.String pProfileId, boolean pMember) Generates a log entry indicating that a user logged into the system
java.lang.Long	logLogout(java.lang.String pSessionId, java.lang.String pProfileId, boolean pMember) Generates a log entry indicating that a user logged out of the system
java.lang.Long	logNewSession(java.lang.String pSessionId, java.lang.String pProfileId, boolean pMember) Generates a log entry indicating that a new session was created
java.lang.Long	logRegistration(java.lang.String pSessionId, java.lang.String pProfileId, boolean pMember) Generates a log entry indicating that a new user registered
void	setLoginLoggingEventTypeName(java.lang.String pLoginLoggingEventTypeName) Sets property LoginLoggingEventTypeName
void	setLogoutLoggingEventTypeName(java.lang.String pLogoutLoggingEventTypeName) Sets property LogoutLoggingEventTypeName
void	setNewSessionLoggingEventTypeName(java.lang.String pNewSessionLoggingEventTypeName) Sets property NewSessionLoggingEventTypeName
void	setRegistrationLoggingEventTypeName(java.lang.String pRegistrationLoggingEventTypeName) Sets property RegistrationLoggingEventTypeName
void	setSessionExpirationLoggingEventTypeName(java.lang.String pSessionExpirationLoggingEventTypeName) Sets property SessionExpirationLoggingEventTypeName
void	setUserEventTypes(atg.reporting.datacollection.UserEventTypes pUserEventTypes) Sets property UserEventTypes

Methods inherited from class atg.reporting.datacollection.IdGeneratorLoggingService

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, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, 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 java.lang.String CLASS_VERSION

Class version string

Constructor Detail

UserEventLoggingService

public UserEventLoggingService()

Constructs an instanceof UserEventLoggingService

Method Detail

setNewSessionLoggingEventTypeName

public void setNewSessionLoggingEventTypeName(java.lang.String pNewSessionLoggingEventTypeName)

Sets property NewSessionLoggingEventTypeName

getNewSessionLoggingEventTypeName

public java.lang.String getNewSessionLoggingEventTypeName()

Returns property NewSessionLoggingEventTypeName

setSessionExpirationLoggingEventTypeName

public void setSessionExpirationLoggingEventTypeName(java.lang.String pSessionExpirationLoggingEventTypeName)

Sets property SessionExpirationLoggingEventTypeName

getSessionExpirationLoggingEventTypeName

public java.lang.String getSessionExpirationLoggingEventTypeName()

Returns property SessionExpirationLoggingEventTypeName

setLoginLoggingEventTypeName

public void setLoginLoggingEventTypeName(java.lang.String pLoginLoggingEventTypeName)

Sets property LoginLoggingEventTypeName

getLoginLoggingEventTypeName

public java.lang.String getLoginLoggingEventTypeName()

Returns property LoginLoggingEventTypeName

setRegistrationLoggingEventTypeName

public void setRegistrationLoggingEventTypeName(java.lang.String pRegistrationLoggingEventTypeName)

Sets property RegistrationLoggingEventTypeName

getRegistrationLoggingEventTypeName

public java.lang.String getRegistrationLoggingEventTypeName()

Returns property RegistrationLoggingEventTypeName

setLogoutLoggingEventTypeName

public void setLogoutLoggingEventTypeName(java.lang.String pLogoutLoggingEventTypeName)

Sets property LogoutLoggingEventTypeName

getLogoutLoggingEventTypeName

public java.lang.String getLogoutLoggingEventTypeName()

Returns property LogoutLoggingEventTypeName

setUserEventTypes

public void setUserEventTypes(atg.reporting.datacollection.UserEventTypes pUserEventTypes)

Sets property UserEventTypes

getUserEventTypes

public atg.reporting.datacollection.UserEventTypes getUserEventTypes()

Returns property UserEventTypes

getTotalItemCount

public long getTotalItemCount()

Returns property TotalItemCount

doStartService

public void doStartService()
                    throws ServiceException

Loads the logging event type ids. Perform any necessary initializations to startup service.

Overrides:

doStartService in class atg.reporting.datacollection.IdGeneratorLoggingService

Throws:

ServiceException - if the Service had a problem starting up

getEventTypes

public java.lang.String[] getEventTypes()

Returns the list of the known user event types available for logging

getEventTypeId

public java.lang.Integer getEventTypeId(java.lang.String pTypeName)
                                 throws atg.reporting.datacollection.LoggingException

Returns the id of the given named user event type

Parameters:

pTypeName - the name of the type (e.g. "new session")

Returns:

the id of the type, or null if the type name is not valid

Throws:

LoggingException - if there was a problem fetching the user event type id

logNewSession

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

Generates a log entry indicating that a new session was created

Specified by:

logNewSession in interface UserEventLogging

Parameters:

pSessionId - the id of the new session

pProfileId - the id of the user who started the new session

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

Throws:

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

logEndSession

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

Generates a log entry indicating that a session was expired

Specified by:

logEndSession in interface UserEventLogging

Parameters:

pSessionId - the id of the expired session

pProfileId - the id of the user whose session expired

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

Throws:

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

logLogin

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

Generates a log entry indicating that a user logged into the system

Specified by:

logLogin in interface UserEventLogging

Parameters:

pSessionId - the id of the user's session

pProfileId - the id of the user who logged in

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

Throws:

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

logRegistration

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

Generates a log entry indicating that a new user registered

Specified by:

logRegistration in interface UserEventLogging

Parameters:

pSessionId - the id of the user's session

pProfileId - the id of the user who registered

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

Throws:

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

logLogout

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

Generates a log entry indicating that a user logged out of the system

Specified by:

logLogout in interface UserEventLogging

Parameters:

pSessionId - the id of the user's session

pProfileId - the id of the user who logged out

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

Throws:

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