Package lumis.service.analytics.abtest.track

Class ExperimentVariantsTracker

java.lang.Object

lumis.service.analytics.abtest.track.ExperimentVariantsTracker

All Implemented Interfaces:

java.io.Serializable, java.util.EventListener, HttpSessionBindingListener

public class ExperimentVariantsTracker
extends java.lang.Object
implements HttpSessionBindingListener, java.io.Serializable

Class responsible for dealing with the storage of the ActiveExperimentVariant.

Since:

14.0.0

Version:

$Revision: 24678 $ $Date: 2021-08-21 22:28:26 -0300 (Sat, 21 Aug 2021) $

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ExperimentVariantsTracker()

Method Summary

Modifier and Type	Method	Description
static void	abandonExperiment(HttpSession session, java.lang.String experimentId, java.lang.String trackId)	Abandon the given experiment in the current session.
static ActiveExperimentVariant	applyExperiment(HttpSession session, java.lang.String experimentId, java.lang.String trackId)	Apply the given experiment to the current session.
static void	completeExperiment(HttpSession session, java.lang.String experimentId, java.lang.String trackId)	Complete the given experiment in the current session.
static java.util.Collection<ActiveExperimentVariant>	getActiveExperiments(HttpSession session)	Returns all valid ActiveExperimentVariant in the current session.
void	valueBound(HttpSessionBindingEvent event)
void	valueUnbound(HttpSessionBindingEvent event)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExperimentVariantsTracker

public ExperimentVariantsTracker()

Method Detail

valueBound

public void valueBound(HttpSessionBindingEvent event)

Specified by:

valueBound in interface HttpSessionBindingListener

valueUnbound

public void valueUnbound(HttpSessionBindingEvent event)

Specified by:

valueUnbound in interface HttpSessionBindingListener

getActiveExperiments

public static java.util.Collection<ActiveExperimentVariant> getActiveExperiments(HttpSession session)

Returns all valid ActiveExperimentVariant in the current session.

Parameters:

session - the current session.

Returns:

all valid ActiveExperimentVariant in the current session.

Since:

14.0.0

applyExperiment

public static ActiveExperimentVariant applyExperiment(HttpSession session,
                                                      java.lang.String experimentId,
                                                      java.lang.String trackId)
                                               throws PortalException

Apply the given experiment to the current session.

Parameters:

session - the current session.

experimentId - the experiment identifier to apply to the session.

trackId - the track identifier of the user that will apply the experiment.

Returns:

the applied ActiveExperimentVariant or null if no experiment was applied.

Throws:

PortalException

Since:

14.0.0

completeExperiment

public static void completeExperiment(HttpSession session,
                                      java.lang.String experimentId,
                                      java.lang.String trackId)
                               throws PortalException

Complete the given experiment in the current session.

Parameters:

session - the current session.

experimentId - the experiment identifier to apply to the session.

trackId - the track identifier of the user that will complete the experiment.

Throws:

PortalException

Since:

14.0.0

abandonExperiment

public static void abandonExperiment(HttpSession session,
                                     java.lang.String experimentId,
                                     java.lang.String trackId)
                              throws PortalException

Abandon the given experiment in the current session.

Parameters:

session - the current session.

experimentId - the experiment identifier to apply to the session.

trackId - the track identifier of the user that will abandon the experiment.

Throws:

PortalException

Since:

14.0.0