Package org.ametys.web.analytics

Class AbstractWebAnalyticsProvider

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.analytics.AbstractWebAnalyticsProvider

All Implemented Interfaces:

LogEnabled, PluginAware, WebAnalyticsProvider, Configurable

Direct Known Subclasses:

GoogleAnalyticsProvider, MatomoAnalyticsProvider

public abstract class AbstractWebAnalyticsProvider
extends AbstractLogEnabled
implements WebAnalyticsProvider, Configurable, PluginAware

Abstract web analytics provider for static configuration

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_id	The provider id
protected I18nizableText	_label	The provider label
protected String	_pluginName	The plugin name
static final String	RANDOM_NUMBER_TOKEN	Token to replace in the url by a random id value

Constructor Summary

Constructors

Constructor	Description
AbstractWebAnalyticsProvider()

Method Summary

Modifier and Type	Method	Description
protected String	_encodeValue(String value)	Encode a value to use as an identifier component.
void	configure(Configuration configuration)
String	getId()	Get the id of the provider
I18nizableText	getLabel()	Get the label of the provider
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.web.analytics.WebAnalyticsProvider

getEventImageUri, getEventLinkCampaignParams

Field Details

RANDOM_NUMBER_TOKEN

public static final String RANDOM_NUMBER_TOKEN

Token to replace in the url by a random id value

See Also:

• Constant Field Values

_id

protected String _id

The provider id

_label

protected I18nizableText _label

The provider label

_pluginName

protected String _pluginName

The plugin name

Constructor Details

AbstractWebAnalyticsProvider

public AbstractWebAnalyticsProvider()

Method Details

setPluginInfo

public void setPluginInfo(String pluginName,
 String featureName,
 String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getId

public String getId()

Description copied from interface: WebAnalyticsProvider

Get the id of the provider

Specified by:

getId in interface WebAnalyticsProvider

Returns:

the id

getLabel

public I18nizableText getLabel()

Description copied from interface: WebAnalyticsProvider

Get the label of the provider

Specified by:

getLabel in interface WebAnalyticsProvider

Returns:

the label

_encodeValue

protected String _encodeValue(String value)
                       throws URISyntaxException

Encode a value to use as an identifier component.

Parameters:

value - the value to encode.

Returns:

the encoded value.

Throws:

URISyntaxException - if an error occurs encoding the value.