|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.service.datacollection.GenericDataListenerService atg.reporting.datacollection.IdGeneratorLoggingService atg.reporting.datacollection.UserEventLoggingService
public class UserEventLoggingService
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.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 |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public UserEventLoggingService()
Method Detail |
---|
public void setNewSessionLoggingEventTypeName(java.lang.String pNewSessionLoggingEventTypeName)
public java.lang.String getNewSessionLoggingEventTypeName()
public void setSessionExpirationLoggingEventTypeName(java.lang.String pSessionExpirationLoggingEventTypeName)
public java.lang.String getSessionExpirationLoggingEventTypeName()
public void setLoginLoggingEventTypeName(java.lang.String pLoginLoggingEventTypeName)
public java.lang.String getLoginLoggingEventTypeName()
public void setRegistrationLoggingEventTypeName(java.lang.String pRegistrationLoggingEventTypeName)
public java.lang.String getRegistrationLoggingEventTypeName()
public void setLogoutLoggingEventTypeName(java.lang.String pLogoutLoggingEventTypeName)
public java.lang.String getLogoutLoggingEventTypeName()
public void setUserEventTypes(atg.reporting.datacollection.UserEventTypes pUserEventTypes)
public atg.reporting.datacollection.UserEventTypes getUserEventTypes()
public long getTotalItemCount()
public void doStartService() throws ServiceException
doStartService
in class atg.reporting.datacollection.IdGeneratorLoggingService
ServiceException
- if the Service had a problem starting uppublic java.lang.String[] getEventTypes()
public java.lang.Integer getEventTypeId(java.lang.String pTypeName) throws atg.reporting.datacollection.LoggingException
pTypeName
- the name of the type (e.g. "new session")
LoggingException
- if there was a problem fetching the user
event type idpublic java.lang.Long logNewSession(java.lang.String pSessionId, java.lang.String pProfileId, boolean pMember) throws atg.reporting.datacollection.LoggingException
logNewSession
in interface UserEventLogging
pSessionId
- the id of the new sessionpProfileId
- the id of the user who started the new sessionpMember
- true if the action is coming from a "member"
LoggingException
- if there was a problem while performing the log operationpublic java.lang.Long logEndSession(java.lang.String pSessionId, java.lang.String pProfileId, boolean pMember) throws atg.reporting.datacollection.LoggingException
logEndSession
in interface UserEventLogging
pSessionId
- the id of the expired sessionpProfileId
- the id of the user whose session expiredpMember
- true if the action is coming from a "member"
LoggingException
- if there was a problem while performing the log operationpublic java.lang.Long logLogin(java.lang.String pSessionId, java.lang.String pProfileId, boolean pMember) throws atg.reporting.datacollection.LoggingException
logLogin
in interface UserEventLogging
pSessionId
- the id of the user's sessionpProfileId
- the id of the user who logged inpMember
- true if the action is coming from a "member"
LoggingException
- if there was a problem while performing the log operationpublic java.lang.Long logRegistration(java.lang.String pSessionId, java.lang.String pProfileId, boolean pMember) throws atg.reporting.datacollection.LoggingException
logRegistration
in interface UserEventLogging
pSessionId
- the id of the user's sessionpProfileId
- the id of the user who registeredpMember
- true if the action is coming from a "member"
LoggingException
- if there was a problem while performing the log operationpublic java.lang.Long logLogout(java.lang.String pSessionId, java.lang.String pProfileId, boolean pMember) throws atg.reporting.datacollection.LoggingException
logLogout
in interface UserEventLogging
pSessionId
- the id of the user's sessionpProfileId
- the id of the user who logged outpMember
- true if the action is coming from a "member"
LoggingException
- if there was a problem while performing the log operation
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |