public class PageEventTrigger
extends java.lang.Object
For PageViewedEvents, both the D4 style events will be
fired (if sendD4StyleEvents is set to true in Nucleus.properties) as
well as the JMS Message,
atg.userprofiling.dms.PageVisitMessage
For ClickThroughMessages, only the JMS Message will be sent. There is no corresponding D4 style event that is fired.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
static java.lang.String |
SCENARIO_PATH_INFO_SEPARATOR
The separator for the scenario path info
|
Constructor and Description |
---|
PageEventTrigger()
Constructs an instanceof PageEventTrigger
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getClickThroughProfileIdParameter() |
java.lang.String |
getClickThroughReferrerParameter() |
java.lang.String |
getClickThroughSourceParameter() |
atg.service.event.EventDistributor |
getDistributor()
The EventDistributor to send fired events to.
|
atg.userprofiling.dms.DPSMessageSource |
getMessageSource()
Returns property messageSource
|
java.lang.String[] |
getNoPageEventMimeTypes()
Returns property noPageEventMimeTypes
|
long |
getNumClickThroughEvents() |
long |
getNumPageViewedEvents()
Returns property NumPageViewedEvents
|
java.lang.String |
getProfilePath()
Returns property ProfilePath
|
java.lang.String |
getRequestPageName(DynamoHttpServletRequest pRequest,
boolean pRemoveQueryArgs) |
java.lang.String |
getSourceNameDelimiter() |
boolean |
getUsePathInfo() |
WebAppRegistry |
getWebAppRegistry()
Get property
WebAppRegistry |
boolean |
isNoIncludedPages() |
boolean |
isNoRedirectedPages() |
boolean |
isRemoveClickThroughURIArguments() |
boolean |
isRemoveURIArguments()
Returns property RemoveURIArguments
|
void |
sendClickThroughEvent(DynamoHttpServletRequest pRequest)
Sends a click through event using the parameters defined
in
pRequest . |
void |
sendClickThroughEvent(DynamoHttpServletRequest pRequest,
java.lang.String[] pSourceNames)
This sends a ClickThroughMessage using the current request and the
value of the source parameter.
|
void |
sendClickThroughEvent(DynamoHttpServletRequest pRequest,
java.lang.String pSourcePath,
java.lang.String pDestinationPath,
java.lang.String[] pSourceNames)
Sends a ClickThroughMessage using the method arguments.
|
void |
sendClickThroughEvent(DynamoHttpServletRequest pRequest,
java.lang.String pSourcePath,
java.lang.String pDestinationPath,
java.lang.String pSourceScenarioPathInfo,
java.lang.String pDestinationScenarioPathInfo,
java.lang.String[] pSourceNames)
Sends a ClickThroughMessage using the method arguments.
|
void |
sendClickThroughEvent(java.lang.String pSourcePath,
java.lang.String pDestinationPath,
java.lang.String[] pSourceNames,
java.lang.String pProfileId)
Sends a ClickThroughMessage
|
void |
sendClickThroughEvent(java.lang.String pSourcePath,
java.lang.String pDestinationPath,
java.lang.String pSourceScenarioPathInfo,
java.lang.String pDestinationScenarioPathInfo,
java.lang.String[] pSourceNames,
RepositoryItem pProfile,
java.lang.String pSessionId,
java.lang.String pParentSessionId)
Sends a ClickThroughMessage
|
void |
sendClickThroughEvent(java.lang.String pSourcePath,
java.lang.String pDestinationPath,
java.lang.String pSourceScenarioPathInfo,
java.lang.String pDestinationScenarioPathInfo,
java.lang.String[] pSourceNames,
java.lang.String pProfileId)
Sends a ClickThroughMessage
|
void |
sendClickThroughEvent(java.lang.String pSourcePath,
java.lang.String pDestinationPath,
java.lang.String pSourceScenarioPathInfo,
java.lang.String pDestinationScenarioPathInfo,
java.lang.String[] pSourceNames,
java.lang.String pProfileId,
java.lang.String pSessionId,
java.lang.String pParentSessionId)
Sends a ClickThroughMessage
|
void |
sendPageViewedEvent(DynamoHttpServletRequest pRequest)
Send a page viewed event.
|
void |
sendPageViewedEvent(java.lang.String pPageName)
Send a page viewed event with out attached request, session, or
profile properties
|
void |
sendPageViewedEvent(java.lang.String pPageName,
java.lang.String pScenarioPathInfo,
DynamoHttpServletRequest pRequest)
Send a page viewed event.
|
void |
sendPageViewedEvent(java.lang.String pPageName,
java.lang.String pScenarioPathInfo,
DynamoHttpServletRequest pRequest,
javax.servlet.http.HttpSession pSession,
RepositoryItem pProfile)
Send a page viewed event with the given information.
|
void |
setClickThroughProfileIdParameter(java.lang.String pClickThroughProfileIdParameter) |
void |
setClickThroughReferrerParameter(java.lang.String pClickThroughReferrerParameter)
Sets the name of the request parameter that is used to identify the
source path of the referring page.
|
void |
setClickThroughSourceParameter(java.lang.String pClickThroughSourceParameter)
Sets the name of the source parameter that will be used to generate
ClickThroughMessages
|
void |
setDistributor(atg.service.event.EventDistributor pValue)
The EventDistributor to send fired events to.
|
void |
setMessageSource(atg.userprofiling.dms.DPSMessageSource pMessageSource)
Sets property messageSource
|
void |
setNoIncludedPages(boolean pNoIncludedPages) |
void |
setNoPageEventMimeTypes(java.lang.String[] pNoPageEventMimeTypes)
Sets property noPageEventMimeTypes
|
void |
setNoRedirectedPages(boolean pNoRedirectedPages) |
void |
setProfilePath(java.lang.String pProfilePath)
Sets property ProfilePath
|
void |
setRemoveClickThroughURIArguments(boolean pRemoveClickThroughURIArguments) |
void |
setRemoveURIArguments(boolean pRemoveURIArguments)
Sets property RemoveURIArguments
|
void |
setSourceNameDelimiter(java.lang.String pSourceNameDelimiter) |
void |
setUsePathInfo(boolean pUsePathInfo)
Sets the property UsePathInfo.
|
void |
setWebAppRegistry(WebAppRegistry pWebAppRegistry)
Set property
WebAppRegistry |
public static java.lang.String CLASS_VERSION
public static final java.lang.String SCENARIO_PATH_INFO_SEPARATOR
public PageEventTrigger()
public void setWebAppRegistry(WebAppRegistry pWebAppRegistry)
WebAppRegistry
pWebAppRegistry
- new value to setpublic WebAppRegistry getWebAppRegistry()
WebAppRegistry
WebAppRegistry
public void setDistributor(atg.service.event.EventDistributor pValue)
public atg.service.event.EventDistributor getDistributor()
public void setClickThroughSourceParameter(java.lang.String pClickThroughSourceParameter)
pClickThroughsourceParameter
- the name of the request parameter
that will be examined in order to generate ClickThroughMessagespublic java.lang.String getClickThroughSourceParameter()
public void setClickThroughReferrerParameter(java.lang.String pClickThroughReferrerParameter)
pClickThroughReferrerParameter
- the name of the request parameter
that is used to identify the path of the referring pagepublic java.lang.String getClickThroughReferrerParameter()
public void setClickThroughProfileIdParameter(java.lang.String pClickThroughProfileIdParameter)
public java.lang.String getClickThroughProfileIdParameter()
public void setProfilePath(java.lang.String pProfilePath)
public java.lang.String getProfilePath()
public long getNumPageViewedEvents()
public long getNumClickThroughEvents()
public void setRemoveURIArguments(boolean pRemoveURIArguments)
public boolean isRemoveURIArguments()
public void setUsePathInfo(boolean pUsePathInfo)
pUsePathInfo
- new value to setpublic boolean getUsePathInfo()
public void setMessageSource(atg.userprofiling.dms.DPSMessageSource pMessageSource)
public atg.userprofiling.dms.DPSMessageSource getMessageSource()
public void setNoPageEventMimeTypes(java.lang.String[] pNoPageEventMimeTypes)
public java.lang.String[] getNoPageEventMimeTypes()
public void setSourceNameDelimiter(java.lang.String pSourceNameDelimiter)
public java.lang.String getSourceNameDelimiter()
public void setRemoveClickThroughURIArguments(boolean pRemoveClickThroughURIArguments)
public boolean isRemoveClickThroughURIArguments()
public void setNoIncludedPages(boolean pNoIncludedPages)
public boolean isNoIncludedPages()
public void setNoRedirectedPages(boolean pNoRedirectedPages)
public boolean isNoRedirectedPages()
public void sendClickThroughEvent(DynamoHttpServletRequest pRequest)
pRequest
. A Message will not get sent unless
pRequest
contains the parameter defined by
getClickThroughSourceParameter
pRequest
- the current request objectpublic void sendClickThroughEvent(DynamoHttpServletRequest pRequest, java.lang.String[] pSourceNames)
pRequest
ObjectpRequest
- the current requestpSourceNames
- an array of logical source namespublic void sendClickThroughEvent(DynamoHttpServletRequest pRequest, java.lang.String pSourcePath, java.lang.String pDestinationPath, java.lang.String[] pSourceNames)
pRequest
ObjectpRequest
- the current requestpSourcePath
- the path info of the referring pagepDestinationPath
- the path info of the current requestpSourceNames
- an array of logical source namespublic void sendClickThroughEvent(DynamoHttpServletRequest pRequest, java.lang.String pSourcePath, java.lang.String pDestinationPath, java.lang.String pSourceScenarioPathInfo, java.lang.String pDestinationScenarioPathInfo, java.lang.String[] pSourceNames)
pRequest
ObjectpRequest
- the current requestpSourcePath
- the path info of the referring pagepDestinationPath
- the path info of the current requestpSourceScenarioPathInfo
- the application name and relative path of the source URLpDestinationScenarioPathInfo
- the application name and relative path of the destination URLpSourceNames
- an array of logical source namespublic void sendClickThroughEvent(java.lang.String pSourcePath, java.lang.String pDestinationPath, java.lang.String[] pSourceNames, java.lang.String pProfileId)
pSourcePath
- the path info of the referring page. At this
point it could be a fully qualified URI with protocol, domain name
and URI arguments, but this will be dealt with laterpDestinationPath
- the path info of the current request. This
is expected to be the strict pathInfopSourceNames
- an array of logical source namespProfile
- the Profile RepositoryItem associated with this
clicked linkpublic void sendClickThroughEvent(java.lang.String pSourcePath, java.lang.String pDestinationPath, java.lang.String pSourceScenarioPathInfo, java.lang.String pDestinationScenarioPathInfo, java.lang.String[] pSourceNames, java.lang.String pProfileId)
pSourcePath
- the path info of the referring page. At this
point it could be a fully qualified URI with protocol, domain name
and URI arguments, but this will be dealt with laterpDestinationPath
- the path info of the current request. This
is expected to be the strict pathInfopSourceScenarioPathInfo
- the application name and relative path of the source URLpDestinationScenarioPathInfo
- the application name and relative path of the destination URLpSourceNames
- an array of logical source namespProfile
- the Profile RepositoryItem associated with this
clicked linkpublic void sendClickThroughEvent(java.lang.String pSourcePath, java.lang.String pDestinationPath, java.lang.String pSourceScenarioPathInfo, java.lang.String pDestinationScenarioPathInfo, java.lang.String[] pSourceNames, RepositoryItem pProfile, java.lang.String pSessionId, java.lang.String pParentSessionId)
pSourcePath
- the path info of the referring page. At this
point it could be a fully qualified URI with protocol, domain name
and URI arguments, but this will be dealt with laterpDestinationPath
- the path info of the current request. This
is expected to be the strict pathInfopSourceScenarioPathInfo
- the application name and relative path of the source URLpDestinationScenarioPathInfo
- the application name and relative path of the destination URLpSourceNames
- an array of logical source namespProfile
- the Profile RepositoryItem associated with this
clicked linkpSessionId
- session idpParentSessionId
- parent session idpublic void sendClickThroughEvent(java.lang.String pSourcePath, java.lang.String pDestinationPath, java.lang.String pSourceScenarioPathInfo, java.lang.String pDestinationScenarioPathInfo, java.lang.String[] pSourceNames, java.lang.String pProfileId, java.lang.String pSessionId, java.lang.String pParentSessionId)
pSourcePath
- the path info of the referring page. At this
point it could be a fully qualified URI with protocol, domain name
and URI arguments, but this will be dealt with laterpDestinationPath
- the path info of the current request. This
is expected to be the strict pathInfopSourceScenarioPathInfo
- the application name and relative path of the source URLpDestinationScenarioPathInfo
- the application name and relative path of the destination URLpSourceNames
- an array of logical source namespProfile
- the Profile RepositoryItem associated with this
clicked linkpSessionId
- session idpParentSessionId
- parent session idpublic void sendPageViewedEvent(DynamoHttpServletRequest pRequest)
public java.lang.String getRequestPageName(DynamoHttpServletRequest pRequest, boolean pRemoveQueryArgs)
public void sendPageViewedEvent(java.lang.String pPageName)
public void sendPageViewedEvent(java.lang.String pPageName, java.lang.String pScenarioPathInfo, DynamoHttpServletRequest pRequest)
public void sendPageViewedEvent(java.lang.String pPageName, java.lang.String pScenarioPathInfo, DynamoHttpServletRequest pRequest, javax.servlet.http.HttpSession pSession, RepositoryItem pProfile)