Package lumis.portal.monitor.impl

Class InitialOriginValuesProvider

java.lang.Object

lumis.portal.monitor.AbstractMonitorValuesProvider

lumis.portal.monitor.impl.OriginValueProvider

lumis.portal.monitor.impl.InitialOriginValuesProvider

All Implemented Interfaces:

java.io.Serializable, IMonitorValuesProvider, PortalRequestContext.IPortalRequestContextCampaignProvider

public class InitialOriginValuesProvider
extends OriginValueProvider
implements PortalRequestContext.IPortalRequestContextCampaignProvider

A values provider that fills lum_client.initialorigin.* values.

Since:

12.3.0

Version:

$Revision$ $Date$

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface lumis.portal.PortalRequestContext.IPortalRequestContextCampaignProvider

PortalRequestContext.IPortalRequestContextCampaignProvider.IPortalRequestContextCampaign

Field Summary

Fields inherited from class lumis.portal.monitor.impl.OriginValueProvider

gclid, utmContent, utmMedium, utmName, utmSource, utmTerm

Method Summary

Modifier and Type	Method	Description
static void	adjustAndAddToContext(javax.servlet.http.HttpServletRequest request, java.lang.String currentURL, java.lang.String originURL, java.lang.String utmSource, java.lang.String utmMedium, java.lang.String utmTerm, java.lang.String utmContent, java.lang.String utmName, java.lang.String gclid)	Adjust the HTTP session value, if needed, and attach to monitor context.
protected java.lang.String	getMonitorFieldOriginName()	Returns the monitor field for the origin name.
protected java.lang.String	getMonitorFieldOriginType()	Returns the monitor field for the origin type.
protected java.lang.String	getMonitorFieldOriginUrl()	Returns the monitor field for the origin URL.
PortalRequestContext.IPortalRequestContextCampaignProvider.IPortalRequestContextCampaign	getPortalRequestContextCampaign()	Returns the value used for the campaign entry in the PortalRequestContext.
protected java.util.Map<java.lang.String,java.util.List<? extends java.io.Serializable>>	initValues(SessionConfig sessionConfig, ITransaction transaction)	Initializes the monitoring values map.

Methods inherited from class lumis.portal.monitor.impl.OriginValueProvider

sameSite

Methods inherited from class lumis.portal.monitor.AbstractMonitorValuesProvider

getValues

Methods inherited from class java.lang.Object

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

Method Detail

adjustAndAddToContext

public static void adjustAndAddToContext(javax.servlet.http.HttpServletRequest request,
                                         java.lang.String currentURL,
                                         java.lang.String originURL,
                                         java.lang.String utmSource,
                                         java.lang.String utmMedium,
                                         java.lang.String utmTerm,
                                         java.lang.String utmContent,
                                         java.lang.String utmName,
                                         java.lang.String gclid)
                                  throws java.net.URISyntaxException

Adjust the HTTP session value, if needed, and attach to monitor context.

Parameters:

request - the request.

currentURL - the currently accessed URL

originURL - the origin URL

utmSource - the UTM source

utmMedium - the UTM medium

utmTerm - the UTM term

utmContent - the UTM content

utmName - the UTM name

gclid - the gclid parameter

Throws:

java.net.URISyntaxException - throw if the provided originUrl is invalid.

Since:

14.0.0

getMonitorFieldOriginUrl

protected java.lang.String getMonitorFieldOriginUrl()

Description copied from class: OriginValueProvider

Returns the monitor field for the origin URL.

Specified by:

getMonitorFieldOriginUrl in class OriginValueProvider

Returns:

the monitor field for the origin URL.

getMonitorFieldOriginName

protected java.lang.String getMonitorFieldOriginName()

Description copied from class: OriginValueProvider

Returns the monitor field for the origin name.

Specified by:

getMonitorFieldOriginName in class OriginValueProvider

Returns:

the monitor field for the origin name.

getMonitorFieldOriginType

protected java.lang.String getMonitorFieldOriginType()

Description copied from class: OriginValueProvider

Returns the monitor field for the origin type.

Specified by:

getMonitorFieldOriginType in class OriginValueProvider

Returns:

the monitor field for the origin type.

initValues

protected java.util.Map<java.lang.String,java.util.List<? extends java.io.Serializable>> initValues(SessionConfig sessionConfig,
                                                                                                          ITransaction transaction)
                                                                                                   throws java.lang.Exception

Description copied from class: AbstractMonitorValuesProvider

Initializes the monitoring values map. This method will only be called once and the results will be cached. The implementations must not return null. If no value is present, an empty map should be returned instead. Also, any null value in a list will be ignored, meaning that a list with only null will be considered a empty list.

Overrides:

initValues in class OriginValueProvider

Parameters:

sessionConfig - the session config.

transaction - the transaction.

Returns:

the monitoring data map.

Throws:

java.lang.Exception

getPortalRequestContextCampaign

public PortalRequestContext.IPortalRequestContextCampaignProvider.IPortalRequestContextCampaign getPortalRequestContextCampaign()

Description copied from interface: PortalRequestContext.IPortalRequestContextCampaignProvider

Returns the value used for the campaign entry in the PortalRequestContext.

Specified by:

getPortalRequestContextCampaign in interface PortalRequestContext.IPortalRequestContextCampaignProvider

Returns:

the value for the campaign.