lumis.portal.monitor.impl

Class OriginValueProvider

java.lang.Object

lumis.portal.monitor.AbstractMonitorValuesProvider

lumis.portal.monitor.impl.OriginValueProvider

All Implemented Interfaces:

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: 23905 $ $Date: 2020-06-16 15:29:26 +0000 (Tue, 16 Jun 2020) $

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OriginValueProvider(String originUrl, String clientUrl) This class' constructor
OriginValueProvider(URI originURI, URI clientURI) This class' constructor

Method Summary

Modifier and Type	Method and Description
protected abstract String	getMonitorFieldOriginName() Returns the monitor field for the origin name.
protected abstract String	getMonitorFieldOriginType() Returns the monitor field for the origin type.
protected abstract String	getMonitorFieldOriginUrl() Returns the monitor field for the origin URL.
protected Map<String,List<? extends Serializable>>	initValues(SessionConfig sessionConfig, ITransaction transaction) Initializes the monitoring values map.
protected static boolean	sameSite(URI clientUri, 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

Constructor Detail

OriginValueProvider

public OriginValueProvider(String originUrl,
                           String clientUrl)
                    throws URISyntaxException

This class' constructor

Parameters:

originUrl -

clientUrl -

Throws:

URISyntaxException

Since:

12.4.0

OriginValueProvider

public OriginValueProvider(URI originURI,
                           URI clientURI)

This class' constructor

Parameters:

originURI -

clientURI -

Since:

12.4.0

Method Detail

initValues

protected Map<String,List<? extends Serializable>> initValues(SessionConfig sessionConfig,
                                                              ITransaction transaction)
                                                       throws 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.

Specified by:

initValues in class AbstractMonitorValuesProvider

Parameters:

sessionConfig - the session config.

transaction - the transaction.

Returns:

the monitoring data map.

Throws:

Exception

getMonitorFieldOriginUrl

protected abstract 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 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 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(URI clientUri,
                                  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