atg.agent.events

Class AgentEvent

java.lang.Object

atg.agent.events.AgentEvent

All Implemented Interfaces:

atg.service.datacollection.TypedEvent, java.io.Serializable

Direct Known Subclasses:

AgentSessionEndEvent, CallEvent, ItemUpdateAgentEvent

public class AgentEvent
extends java.lang.Object
implements java.io.Serializable, atg.service.datacollection.TypedEvent

Event class that encapsulates the base information for agent related event activities.

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
AgentEvent() Constructs a AgentEvent message.
AgentEvent(java.lang.String pActivityType) Constructs a AgentEvent message

Method Summary

Modifier and Type	Method and Description
RepositoryItem	getAgentProfile()
java.lang.String	getCurrentSiteId() Returns the currentSiteId
RepositoryItem	getCustomerProfile() Returns the customerProfile.
java.lang.String	getCustomerProfileId()
java.sql.Timestamp	getEventDate() Get property EventDate
java.lang.String	getIPAddress() Returns the IP Address that the request originated from
java.lang.String	getOrganizationId()
java.lang.String	getParentSessionId() Returns the parent session id.
java.lang.String	getProfileId()
java.lang.String	getSessionId() Returns the current session id associated with the request when this message is sent in the context of an HTTP request.
java.lang.String	getTicketId() Returns the ticket id associated with the event.
java.lang.String	getType() Returns activity type.
void	initializeBaseProperties(java.lang.String pActivityType) Initializes the base properties of the agent event.
void	setCurrentSiteId(java.lang.String pCurrentSiteId) Sets the currentSiteId
void	setCustomerProfile(RepositoryItem pCustomerProfile) Sets the customerProfile.
void	setCustomerProfileId(java.lang.String pCustomerProfileId) The customer profile id associated with the event.
void	setEventDate(java.sql.Timestamp pEventDate) The Date associated with the event.
void	setIPAddress(java.lang.String pIPAddress) Sets the IPAddress that the request originated from
void	setOrganizationId(java.lang.String pOrganizationId) The organization id associated with the event.
void	setParentSessionId(java.lang.String pParentSessionId) Sets the parent session id.
void	setProfileId(java.lang.String pProfileId) The profile id associated with the event.
void	setSessionId(java.lang.String pSessionId) Sets the session id
void	setTicketId(java.lang.String pTicketId) Sets the ticket id
void	setType(java.lang.String pType) Sets the activity type.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

AGENT_TOOLS_COMPONENT

public static final java.lang.String AGENT_TOOLS_COMPONENT

See Also:

Constant Field Values

mCurrentSiteId

protected java.lang.String mCurrentSiteId

Constructor Detail

AgentEvent

public AgentEvent()

Constructs a AgentEvent message.

AgentEvent

public AgentEvent(java.lang.String pActivityType)

Constructs a AgentEvent message

See Also:

initializeBaseProperties(String)

Method Detail

initializeBaseProperties

public void initializeBaseProperties(java.lang.String pActivityType)

Initializes the base properties of the agent event.

The following properties are initialized

profileId

initialized from ServletUtil.getCurrentUserProfile

parentSessionId

initialized from ServletUtil.getParentSessionId

sessionId

initialized from the current request's HttpSession object

idAddress

initialized from the current request's remove address

eventDate

initialized to the current date and time

activityType

initialized from the provided activity type parameter.

Parameters:

the - activity type of the event.

setProfileId

public void setProfileId(java.lang.String pProfileId)

The profile id associated with the event. This method also sets AgentProfile Repository item. AgentProfile repository item property is a read only property. Most of the api's are using profileId property. This will avoid the integrety issues.

getProfileId

public java.lang.String getProfileId()

setCustomerProfileId

public void setCustomerProfileId(java.lang.String pCustomerProfileId)

The customer profile id associated with the event. This method also sets CustomerProfile Repository item. CustomerProfile repository item property is a read only property. Most of the api's are using customerProfileId property. This will avoid integrety issues.

getCustomerProfileId

public java.lang.String getCustomerProfileId()

getParentSessionId

public java.lang.String getParentSessionId()

Returns the parent session id. This may be different than the request's current session id on app servers which use a separate session id for each web application.

setParentSessionId

public void setParentSessionId(java.lang.String pParentSessionId)

Sets the parent session id.

getSessionId

public java.lang.String getSessionId()

Returns the current session id associated with the request when this message is sent in the context of an HTTP request.

setSessionId

public void setSessionId(java.lang.String pSessionId)

Sets the session id

getTicketId

public java.lang.String getTicketId()

Returns the ticket id associated with the event.

setTicketId

public void setTicketId(java.lang.String pTicketId)

Sets the ticket id

getType

public java.lang.String getType()

Returns activity type.

Activity type maps the event to the appropriate recorder and repository item type in the audit logging system.

Specified by:

getType in interface atg.service.datacollection.TypedEvent

setType

public void setType(java.lang.String pType)

Sets the activity type.

Activity type maps the event to the appropriate recorder and repository item type in the audit logging system.

Specified by:

setType in interface atg.service.datacollection.TypedEvent

getIPAddress

public java.lang.String getIPAddress()

Returns the IP Address that the request originated from

setIPAddress

public void setIPAddress(java.lang.String pIPAddress)

Sets the IPAddress that the request originated from

setEventDate

public void setEventDate(java.sql.Timestamp pEventDate)

The Date associated with the event.

Parameters:

pDate - new value to set

getEventDate

public java.sql.Timestamp getEventDate()

Get property EventDate

Returns:

Date

setOrganizationId

public void setOrganizationId(java.lang.String pOrganizationId)

The organization id associated with the event.

getOrganizationId

public java.lang.String getOrganizationId()

getAgentProfile

public RepositoryItem getAgentProfile()

getCustomerProfile

public RepositoryItem getCustomerProfile()

Returns the customerProfile.

Returns:

customerProfile

setCustomerProfile

public void setCustomerProfile(RepositoryItem pCustomerProfile)

Sets the customerProfile.

Parameters:

pCustomerProfile -

getCurrentSiteId

public java.lang.String getCurrentSiteId()

Returns the currentSiteId

Returns:

the currentSiteId

setCurrentSiteId

public void setCurrentSiteId(java.lang.String pCurrentSiteId)

Sets the currentSiteId

Parameters:

pCurrentSiteId - the currentSiteId to set

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object