Package lumis.portal.monitor.impl

Class OriginValueProvider

java.lang.Object

lumis.portal.monitor.AbstractMonitorValuesProvider

lumis.portal.monitor.impl.OriginValueProvider

All Implemented Interfaces:

java.io.Serializable, IMonitorValuesProvider

Direct Known Subclasses:

ClientOriginValuesProvider, InitialOriginValuesProvider

public abstract class OriginValueProvider
extends AbstractMonitorValuesProvider

A value provider for init origin values based in a origin URL and a client URL.

Since:

12.4.0

Version:

$Revision: 24476 $ $Date: 2021-04-28 11:28:23 -0300 (Wed, 28 Apr 2021) $

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	gclid
protected java.lang.String	utmContent
protected java.lang.String	utmMedium
protected java.lang.String	utmName
protected java.lang.String	utmSource
protected java.lang.String	utmTerm

Constructor Summary

Constructors

Constructor	Description
OriginValueProvider(java.lang.String originUrl, java.lang.String clientUrl, java.lang.String utmSource, java.lang.String utmMedium, java.lang.String utmTerm, java.lang.String utmContent, java.lang.String utmName, java.lang.String gclid)	This class' constructor
OriginValueProvider(java.net.URI originURI, java.net.URI clientURI, java.lang.String utmSource, java.lang.String utmMedium, java.lang.String utmTerm, java.lang.String utmContent, java.lang.String utmName, java.lang.String gclid)	This class' constructor

Method Summary

Modifier and Type	Method	Description
protected abstract java.lang.String	getMonitorFieldOriginName()	Returns the monitor field for the origin name.
protected abstract java.lang.String	getMonitorFieldOriginType()	Returns the monitor field for the origin type.
protected abstract java.lang.String	getMonitorFieldOriginUrl()	Returns the monitor field for the origin URL.
protected java.util.Map<java.lang.String,java.util.List<? extends java.io.Serializable>>	initValues(SessionConfig sessionConfig, ITransaction transaction)	Initializes the monitoring values map.
protected static boolean	sameSite(java.net.URI clientUri, java.net.URI originUri)	Compare if the given URI's are from the same domain.

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

Field Detail

utmSource

protected final java.lang.String utmSource

utmMedium

protected final java.lang.String utmMedium

utmTerm

protected final java.lang.String utmTerm

utmContent

protected final java.lang.String utmContent

utmName

protected final java.lang.String utmName

gclid

protected final java.lang.String gclid

Constructor Detail

OriginValueProvider

public OriginValueProvider(java.lang.String originUrl,
                           java.lang.String clientUrl,
                           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

This class' constructor

Parameters:

originUrl -

clientUrl -

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

Since:

14.0.0

OriginValueProvider

public OriginValueProvider(java.net.URI originURI,
                           java.net.URI clientURI,
                           java.lang.String utmSource,
                           java.lang.String utmMedium,
                           java.lang.String utmTerm,
                           java.lang.String utmContent,
                           java.lang.String utmName,
                           java.lang.String gclid)

This class' constructor

Parameters:

originURI -

clientURI -

utmSource - the UTM source

utmMedium - the UTM medium

utmTerm - the UTM term

utmContent - the UTM content

utmName - the UTM name

gclid - the gclid parameter

Since:

14.0.0

Method Detail

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.

Specified by:

initValues in class AbstractMonitorValuesProvider

Parameters:

sessionConfig - the session config.

transaction - the transaction.

Returns:

the monitoring data map.

Throws:

java.lang.Exception

getMonitorFieldOriginUrl

protected abstract java.lang.String getMonitorFieldOriginUrl()

Returns the monitor field for the origin URL.

Returns:

the monitor field for the origin URL.

Since:

12.4.0

getMonitorFieldOriginName

protected abstract java.lang.String getMonitorFieldOriginName()

Returns the monitor field for the origin name.

Returns:

the monitor field for the origin name.

Since:

12.4.0

getMonitorFieldOriginType

protected abstract java.lang.String getMonitorFieldOriginType()

Returns the monitor field for the origin type.

Returns:

the monitor field for the origin type.

Since:

12.4.0

sameSite

protected static boolean sameSite(java.net.URI clientUri,
                                  java.net.URI originUri)

Compare if the given URI's are from the same domain.

Parameters:

clientUri - the client URI.

originUri - the origin URI.

Returns:

true if the URI's are from the same domain, false otherwise.

Since:

12.4.0