atg.agent.logging

Class ConfigurableAgentAuditRecorder

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.agent.logging.AgentAuditRecorder

atg.agent.logging.ConfigurableAgentAuditRecorder

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, DataListener, java.util.EventListener

public class ConfigurableAgentAuditRecorder
extends AgentAuditRecorder

An AgentAuditRecorder extension that allows a configurable a set of properties to be copied from the agent event to the audit item in addition to the base properties.

See Also:

#populateCustomProperties(MutableRepositoryItem, AgentEvent)

Field Summary

Fields

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

Fields inherited from class atg.agent.logging.AgentAuditRecorder

CUSTOMER_PROFILE_ID_PROPERTY_NAME, EVENT_DATE_PROPERTY_NAME, IP_ADDRESS_PROPERTY_NAME, ORGANIZATION_ID_PROPERTY_NAME, PARENT_SESSION_ID_PROPERTY_NAME, PROFILE_ID_PROPERTY_NAME, SESSION_ID_PROPERTY_NAME

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
ConfigurableAgentAuditRecorder()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map	getCustomProperties()
protected void	populateCustomProperties(MutableRepository pAgentAuditRepository, MutableRepositoryItem pAuditItem, AgentEvent pAgentEvent) Copies the properties defined in the customerProperties property from the agent event to the audit item.
void	setCustomProperties(java.util.Map pCustomProperties) Sets the map of properties that will be copied from the agent event to the audit repository item.

Methods inherited from class atg.agent.logging.AgentAuditRecorder

addDataItem, createAgentAuditItem, getAgentAuditRepository, populateBaseProperties, setAgentAuditRepository

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

ConfigurableAgentAuditRecorder

public ConfigurableAgentAuditRecorder()

Method Detail

getCustomProperties

public java.util.Map getCustomProperties()

Returns:

Returns the map of properties that will be copied from the agent event to the audit repository item. Map includes the agent property names mapped to their associated audit item property name.

setCustomProperties

public void setCustomProperties(java.util.Map pCustomProperties)

Sets the map of properties that will be copied from the agent event to the audit repository item. Map includes the agent property names mapped to their associated audit item property name.

Parameters:

pCustomProperties - The customProperties to set.

populateCustomProperties

protected void populateCustomProperties(MutableRepository pAgentAuditRepository,
                            MutableRepositoryItem pAuditItem,
                            AgentEvent pAgentEvent)
                                 throws AgentAuditLoggingException

Copies the properties defined in the customerProperties property from the agent event to the audit item.

Overrides:

populateCustomProperties in class AgentAuditRecorder

Parameters:

pAuditItem -

pAgentEvent -

Throws:

AgentAuditLoggingException