Package org.dspace.matomo.factory

Class MatomoRequestCustomVariablesEnricher

java.lang.Object

org.dspace.matomo.factory.MatomoRequestCustomVariablesEnricher

All Implemented Interfaces:

MatomoRequestDetailsEnricher

public class MatomoRequestCustomVariablesEnricher
extends Object
implements MatomoRequestDetailsEnricher

This class adds the _cvar parameter to the MatomoRequestDetails

Author:

Vincenzo Mecca (vins01-4science - vincenzo.mecca at 4science.com)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PK_CVAR
static final String	VARIABLE_PATTERN

Constructor Summary

Constructors

Constructor	Description
MatomoRequestCustomVariablesEnricher()

Method Summary

Modifier and Type	Method	Description
MatomoRequestDetails	enrich(UsageEvent usageEvent, MatomoRequestDetails matomoRequestDetails)	Enriches the provided MatomoRequestDetails with additional parameters based on the UsageEvent.
static Map<Integer,Map.Entry<String,String>>	parse(String value)	Parses a JSON representation of custom variables.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dspace.matomo.factory.MatomoRequestDetailsEnricher

compose

Field Details

VARIABLE_PATTERN

public static final String VARIABLE_PATTERN

See Also:

• Constant Field Values

PK_CVAR

public static final String PK_CVAR

See Also:

• Constant Field Values

Constructor Details

MatomoRequestCustomVariablesEnricher

public MatomoRequestCustomVariablesEnricher()

Method Details

enrich

public MatomoRequestDetails enrich(UsageEvent usageEvent,
 MatomoRequestDetails matomoRequestDetails)

Description copied from interface: MatomoRequestDetailsEnricher

Enriches the provided MatomoRequestDetails with additional parameters based on the UsageEvent.

Specified by:

enrich in interface MatomoRequestDetailsEnricher

Parameters:

usageEvent - The usage event containing information to enrich the request details

matomoRequestDetails - The request details object to be enriched with additional parameters

Returns:

The enriched MatomoRequestDetails object

parse

public static Map<Integer,Map.Entry<String,String>> parse(String value)

Parses a JSON representation of custom variables.

The format is as follows: {"1":["key1","value1"],"2":["key2","value2"]}

Example: {"1":["OS","Windows"],"2":["Browser","Firefox"]}

This is mainly used to parse the custom variables from the cookie.

Parameters:

value - The JSON representation of the custom variables to parse or null

Returns:

The parsed custom variables or null if the given value is null or empty