atg.userprofiling.dms

Class DPSMessage

java.lang.Object

atg.nucleus.dms.DASMessage

atg.userprofiling.dms.DPSMessage

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ClickThroughMessage, EndSessionMessage, PageVisitMessage, ProfilePropertyUpdateMessage, ProfileUpdateMessage, SearchMessage, ViewItemMessage

public class DPSMessage
extends DASMessage

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
DPSMessage() Constructs a DPS message with no profileId.
DPSMessage(java.lang.String pProfileId) Constructs a DPS message.
DPSMessage(java.lang.String pProfileId, java.lang.String pSessionId) Constructs an instance of DPSMessage
DPSMessage(java.lang.String pProfileId, java.lang.String pSessionId, java.lang.String pParentSessionId) Constructs an instance of DPSMessage
DPSMessage(java.lang.String pProfileId, java.lang.String pSessionId, java.lang.String pParentSessionId, java.lang.String pScenarioPathInfo) Constructs an instance of DPSMessage

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getParentSessionId() Get property ParentSessionId
java.lang.String	getProfileId()
java.lang.String	getRealmId() get RealmId
java.lang.String	getScenarioPathInfo() Get property ScenarioPathInfo
java.lang.String	getSessionId() Gets the SessionId property
java.lang.String[]	getSiteGroupIds() get SiteGroupIds
java.lang.String	getSiteId() Set the site id.
void	setParentSessionId(java.lang.String pParentSessionId) Set property ParentSessionId
void	setProfileId(java.lang.String pProfileId)
void	setRealmId(java.lang.String pRealmId) set RealmId
void	setScenarioPathInfo(java.lang.String pScenarioPathInfo) Set property ScenarioPathInfo
void	setSessionId(java.lang.String pSessionId) Sets the SessionId property
void	setSiteId(java.lang.String pSiteId) With the provided String, set the siteId on this message.
protected void	setSiteIdFromSiteContextManager() Set the Site Id using the utility method on the SiteContextManager.
protected java.lang.String	toStringProperties() Returns the String representation of all the public properties of this message.

Methods inherited from class atg.nucleus.dms.DASMessage

limitSize, toString

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

SITE_GROUP_STORAGE_ADAPTER_PATH

protected static final java.lang.String SITE_GROUP_STORAGE_ADAPTER_PATH

See Also:

Constant Field Values

Constructor Detail

DPSMessage

public DPSMessage(java.lang.String pProfileId)

Constructs a DPS message.

DPSMessage

public DPSMessage(java.lang.String pProfileId,
          java.lang.String pSessionId)

Constructs an instance of DPSMessage

Parameters:

pProfileId - the id of the profile that caused the event

pSessionId - the id of the session that caused the event

DPSMessage

public DPSMessage(java.lang.String pProfileId,
          java.lang.String pSessionId,
          java.lang.String pParentSessionId)

Constructs an instance of DPSMessage

Parameters:

pProfileId - the id of the profile that caused the event

pSessionId - the id of the session that caused the event

pParentSessionId - the id of the parent session, if any

DPSMessage

public DPSMessage(java.lang.String pProfileId,
          java.lang.String pSessionId,
          java.lang.String pParentSessionId,
          java.lang.String pScenarioPathInfo)

Constructs an instance of DPSMessage

Parameters:

pProfileId - the id of the profile that caused the event

pSessionId - the id of the session that caused the event

pParentSessionId - the id of the parent session, if any

DPSMessage

public DPSMessage()

Constructs a DPS message with no profileId.

Method Detail

setProfileId

public void setProfileId(java.lang.String pProfileId)

getProfileId

public java.lang.String getProfileId()

setSessionId

public void setSessionId(java.lang.String pSessionId)

Sets the SessionId property

getSessionId

public java.lang.String getSessionId()

Gets the SessionId property

setParentSessionId

public void setParentSessionId(java.lang.String pParentSessionId)

Set property ParentSessionId

Parameters:

pParentSessionId - new value to set

getParentSessionId

public java.lang.String getParentSessionId()

Get property ParentSessionId

Returns:

ParentSessionId

setScenarioPathInfo

public void setScenarioPathInfo(java.lang.String pScenarioPathInfo)

Set property ScenarioPathInfo

Parameters:

pScenarioPathInfo - new value to set

getScenarioPathInfo

public java.lang.String getScenarioPathInfo()

Get property ScenarioPathInfo

Returns:

ScenarioPathInfo

setRealmId

public void setRealmId(java.lang.String pRealmId)

set RealmId

Parameters:

pRealmId - the RealmId

getRealmId

public java.lang.String getRealmId()

get RealmId

Returns:

the RealmId

setSiteId

public void setSiteId(java.lang.String pSiteId)

With the provided String, set the siteId on this message.

Parameters:

pSiteId - the SiteId value to set.

getSiteId

public java.lang.String getSiteId()

Set the site id.

getSiteGroupIds

public java.lang.String[] getSiteGroupIds()

get SiteGroupIds

Returns:

the SiteGroupIds

setSiteIdFromSiteContextManager

protected void setSiteIdFromSiteContextManager()

Set the Site Id using the utility method on the SiteContextManager. Though this method gets called during the construction of the message, a non-null value is not guaranteed.

toStringProperties

protected java.lang.String toStringProperties()

Returns the String representation of all the public properties of this message.

Overrides:

toStringProperties in class DASMessage