atg.agent.logging
Class AgentAuditRecorder

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.agent.logging.AgentAuditRecorder

All Implemented Interfaces:

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

Direct Known Subclasses:

ConfigurableAgentAuditRecorder, ItemUpdateRecorder

public class AgentAuditRecorder
extends GenericService
implements DataListener

Base class for creating agent event audit recorders.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	CUSTOMER_PROFILE_ID_PROPERTY_NAME The name of the property in the audit item that holds the customer profile id
static java.lang.String	EVENT_DATE_PROPERTY_NAME The name of the property in the audit item that holds the event date
static java.lang.String	IP_ADDRESS_PROPERTY_NAME The name of the property in the audit item that holds the ipaddress
static java.lang.String	ORGANIZATION_ID_PROPERTY_NAME The name of the property in the audit item that holds the organization id
static java.lang.String	PARENT_SESSION_ID_PROPERTY_NAME The name of the property in the audit item that holds the parent session id
static java.lang.String	PROFILE_ID_PROPERTY_NAME The name of the property in the audit item that holds the profile id
static java.lang.String	SESSION_ID_PROPERTY_NAME The name of the property in the audit item that holds the session id

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

AgentAuditRecorder()

Method Summary

void	addDataItem(java.lang.Object pAgentEvent) Creates an audit repository item based on the agent event and adds it to the audit repository.
protected MutableRepositoryItem	createAgentAuditItem(MutableRepository pAgentAuditRepository, AgentEvent pAgentEvent) Creates the mutable audit repository item
MutableRepository	getAgentAuditRepository()
protected void	populateBaseProperties(MutableRepository pAgentAuditRepository, MutableRepositoryItem pAuditItem, AgentEvent pAgentEvent) Populates the base properties of the audit repository item from the agent event.
protected void	populateCustomProperties(MutableRepository pAgentAuditRepository, MutableRepositoryItem pAuditItem, AgentEvent pAgentEvent) Method that is used to implement handling of custom properties of the audit item.
void	setAgentAuditRepository(MutableRepository pAgentAuditRepository) The repository where the agent audit information is stored

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

PROFILE_ID_PROPERTY_NAME

public static final java.lang.String PROFILE_ID_PROPERTY_NAME

The name of the property in the audit item that holds the profile id

See Also:

Constant Field Values

SESSION_ID_PROPERTY_NAME

public static final java.lang.String SESSION_ID_PROPERTY_NAME

The name of the property in the audit item that holds the session id

See Also:

Constant Field Values

PARENT_SESSION_ID_PROPERTY_NAME

public static final java.lang.String PARENT_SESSION_ID_PROPERTY_NAME

The name of the property in the audit item that holds the parent session id

See Also:

Constant Field Values

CUSTOMER_PROFILE_ID_PROPERTY_NAME

public static final java.lang.String CUSTOMER_PROFILE_ID_PROPERTY_NAME

The name of the property in the audit item that holds the customer profile id

See Also:

Constant Field Values

ORGANIZATION_ID_PROPERTY_NAME

public static final java.lang.String ORGANIZATION_ID_PROPERTY_NAME

The name of the property in the audit item that holds the organization id

See Also:

Constant Field Values

IP_ADDRESS_PROPERTY_NAME

public static final java.lang.String IP_ADDRESS_PROPERTY_NAME

The name of the property in the audit item that holds the ipaddress

See Also:

Constant Field Values

EVENT_DATE_PROPERTY_NAME

public static final java.lang.String EVENT_DATE_PROPERTY_NAME

The name of the property in the audit item that holds the event date

See Also:

Constant Field Values

Constructor Detail

AgentAuditRecorder

public AgentAuditRecorder()

Method Detail

setAgentAuditRepository

public void setAgentAuditRepository(MutableRepository pAgentAuditRepository)

The repository where the agent audit information is stored

Parameters:

pAgentAuditRepository - the repository where the agent audit information is stored

getAgentAuditRepository

public MutableRepository getAgentAuditRepository()

Returns:

the repository where the agent audit information is stored

createAgentAuditItem

protected MutableRepositoryItem createAgentAuditItem(MutableRepository pAgentAuditRepository,
                                                     AgentEvent pAgentEvent)
                                              throws RepositoryException

Creates the mutable audit repository item

Parameters:

pAgentAuditRepository - the audit repository

pAgentEvent - the agent event the will be recorded in the item

Returns:

the mutable audit repository item

Throws:

RepositoryException

populateBaseProperties

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

Populates the base properties of the audit repository item from the agent event.

Parameters:

pAuditItem - the audit repository item

pAgentEvent - the agent event

Throws:

AgentAuditLoggingException

populateCustomProperties

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

Method that is used to implement handling of custom properties of the audit item.

Parameters:

pAuditItem -

pAgentEvent -

Throws:

AgentAuditLoggingException

addDataItem

public void addDataItem(java.lang.Object pAgentEvent)

Creates an audit repository item based on the agent event and adds it to the audit repository.

Specified by:

addDataItem in interface DataListener

Parameters:

pAgentAuditRepository -

pAgentEvent -

Throws:

AgentAuditLoggingException