Package org.dspace.matomo

Class MatomoAbstractHandler

java.lang.Object

org.dspace.matomo.MatomoAbstractHandler

All Implemented Interfaces:

MatomoUsageEventHandler

Direct Known Subclasses:

MatomoAsyncBulkRequestHandler, MatomoSyncEventHandler

public abstract class MatomoAbstractHandler
extends Object
implements MatomoUsageEventHandler

This class represents an abstract class that will be used to handle the UsageEvent.

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
protected final MatomoRequestDetailsBuilder	builder
protected final MatomoClient	matomoClient

Constructor Summary

Constructors

Constructor	Description
MatomoAbstractHandler(MatomoClient matomoClient, MatomoRequestDetailsBuilder builder)

Method Summary

Modifier and Type	Method	Description
abstract void	handleEvent(UsageEvent usageEvent)	This method handles the UsageEvent in order to send that request to Matomo
abstract void	sendEvents()	Sends all the pending request to the Matomo tracking endpoint.
protected MatomoRequestDetails	toDetails(UsageEvent usageEvent)	Converts a DSpace usage event into a Matomo request details object.

Methods inherited from class java.lang.Object

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

Field Details

matomoClient

protected final MatomoClient matomoClient

builder

protected final MatomoRequestDetailsBuilder builder

Constructor Details

MatomoAbstractHandler

public MatomoAbstractHandler(MatomoClient matomoClient,
 MatomoRequestDetailsBuilder builder)

Method Details

toDetails

protected MatomoRequestDetails toDetails(UsageEvent usageEvent)

Converts a DSpace usage event into a Matomo request details object.

Parameters:

usageEvent - The DSpace usage event to convert

Returns:

MatomoRequestDetails object containing the converted event details

handleEvent

public abstract void handleEvent(UsageEvent usageEvent)

Description copied from interface: MatomoUsageEventHandler

This method handles the UsageEvent in order to send that request to Matomo

Specified by:

handleEvent in interface MatomoUsageEventHandler

sendEvents

public abstract void sendEvents()

Description copied from interface: MatomoUsageEventHandler

Sends all the pending request to the Matomo tracking endpoint.

Specified by:

sendEvents in interface MatomoUsageEventHandler