com.cloudera.gertrude

Class AbstractExperimentState

java.lang.Object

com.cloudera.gertrude.AbstractExperimentState

All Implemented Interfaces:

ExperimentState

public abstract class AbstractExperimentState
extends Object
implements ExperimentState

Abstract base class that implements the core functionality of the ExperimentState interface. Clients should create their own ExperimentState implementations that use this instance as a base class, since there are core methods in the framework (such as ExperimentHandler.handle(AbstractExperimentState) that expect to operate on a subclass of AbstractExperimentState. More details on the purpose of this split are described in the documentation of the ExperimentState interface.

Constructor Summary

Constructors

Constructor and Description
AbstractExperimentState()

Method Summary

Methods

Modifier and Type	Method and Description
Set<Integer>	forceExperimentIds() Indicate a set of experiment IDs that this ExperimentState should be forced into by the ExperimentHandler.handle(AbstractExperimentState) method.
<T> T	get(ExperimentFlag<T> flag) Returns the value of the given ExperimentFlag for this ExperimentState.
abstract com.google.common.base.Optional<String>	getDiversionIdentifier(int diversionId) Return the identifier to use for this instance with the diversion criterion that has the given identifer.
Set<Integer>	getExperimentIds() Returns the integer identifiers for the experiments that this state was diverted into.
float	getFloat(ExperimentFlag<Double> doubleFlag) A convenience method for acccessing the value of a ExperimentFlag<Double> as a float.
int	getInt(ExperimentFlag<Long> longFlag) A convenience method for acccessing the value of a ExperimentFlag<Long> as an int.
long	getRequestTimeMsec() Returns the time that this ExperimentState instance was created in milliseconds.
boolean	isDiverted() Indicates whether or not this ExperimentState has been passed to ExperimentHandler.handle(com.cloudera.gertrude.AbstractExperimentState).

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractExperimentState

public AbstractExperimentState()

Method Detail

getDiversionIdentifier

public abstract com.google.common.base.Optional<String> getDiversionIdentifier(int diversionId)

Description copied from interface: ExperimentState

Return the identifier to use for this instance with the diversion criterion that has the given identifer.

Clients must override this method in order to specify the identifiers that they support for a given request, and what the values of those identifiers are for each request.

Remember that these identifiers are used for randomly diverting requests into experiments, so they should be unique for each entity that we are experimenting on. For example, using the country that a request comes from is a relatively poor choice of a diversion identifier compared to a random account ID or browser cookie.

Specified by:

getDiversionIdentifier in interface ExperimentState

Parameters:

diversionId - The unique id of the requested diversion criterion

Returns:

an identifier to use for diverting this request into an experiment or domain

forceExperimentIds

public Set<Integer> forceExperimentIds()

Description copied from interface: ExperimentState

Indicate a set of experiment IDs that this ExperimentState should be forced into by the ExperimentHandler.handle(AbstractExperimentState) method.

By default, this method returns an empty set. Subclasses may override this method to provide clients with a way to force a request to be in a certain experiment in order to test or debug a scenario.

Specified by:

forceExperimentIds in interface ExperimentState

Returns:

the ids of the experiments that this request should be in

get

public <T> T get(ExperimentFlag<T> flag)

Description copied from interface: ExperimentState

Returns the value of the given ExperimentFlag for this ExperimentState.

If the FlagValue that was calculated for this flag can be cached on a per-request basis, then this instance will keep the calculated value in a cache so that it is not re-computed unnecessarily during the same request.

If this state has not yet been diverted by the ExperimentHandler, then the default value of the flag is returned, but not stored in the cache.

Specified by:

get in interface ExperimentState

Parameters:

flag - the flag whose value is returned

Returns:

the value of the flag for this instance

getInt

public int getInt(ExperimentFlag<Long> longFlag)

Description copied from interface: ExperimentState

A convenience method for acccessing the value of a ExperimentFlag<Long> as an int.

Specified by:

getInt in interface ExperimentState

Parameters:

longFlag - the flag

Returns:

the integer point value of the flag

getFloat

public float getFloat(ExperimentFlag<Double> doubleFlag)

Description copied from interface: ExperimentState

A convenience method for acccessing the value of a ExperimentFlag<Double> as a float.

Specified by:

getFloat in interface ExperimentState

Parameters:

doubleFlag - the flag

Returns:

the floating point value of the flag

getExperimentIds

public Set<Integer> getExperimentIds()

Description copied from interface: ExperimentState

Returns the integer identifiers for the experiments that this state was diverted into.

Specified by:

getExperimentIds in interface ExperimentState

Returns:

the integer identifiers for the experiments that this state was diverted into

isDiverted

public boolean isDiverted()

Description copied from interface: ExperimentState

Indicates whether or not this ExperimentState has been passed to ExperimentHandler.handle(com.cloudera.gertrude.AbstractExperimentState).

Specified by:

isDiverted in interface ExperimentState

Returns:

true if this instance has already been diverted, false otherwise

getRequestTimeMsec

public long getRequestTimeMsec()

Description copied from interface: ExperimentState

Returns the time that this ExperimentState instance was created in milliseconds. Used for determining whether a particular experiment should be active or inactive for this request.

Specified by:

getRequestTimeMsec in interface ExperimentState

Returns:

the time that this object was created in milliseconds