Package lumis.service.analytics.abtest.rest

Class ABTestResource

java.lang.Object

lumis.service.analytics.abtest.rest.ABTestResource

@Path("/lumis/service/analytics/abtest/api/rest")
public class ABTestResource
extends Object

Perform operations with the A/B Test API using REST.

Since:

14.0.0

Version:

$Revision: 24476 $ $Date: 2021-04-28 11:28:23 -0300 (Wed, 28 Apr 2021) $

Constructor Summary

Constructors

Constructor	Description
ABTestResource()

Method Summary

Modifier and Type	Method	Description
void	abandonExperiment(HttpServletRequest request, String experimentId, String reqData)	Abandon the ActiveExperimentVariant.
String	applyExperiment(HttpServletRequest request, String experimentId, String reqData)	Perform the operation of creating a new ActiveExperimentVariant if need and respond with the ABTestExperimentVariant configuration.
void	experimentGoalAchieved(HttpServletRequest request, String experimentId, String reqData)	Complete the ActiveExperimentVariant.

Methods inherited from class java.lang.Object

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

Constructor Detail

ABTestResource

public ABTestResource()

Method Detail

applyExperiment

@Path("/applyExperiment/{targetExperiment:[a-fA-F0-9]{32}}")
@POST
@Consumes({"application/json","text/plain"})
@Produces("application/json")
public String applyExperiment(@Context
                              HttpServletRequest request,
                              @PathParam("targetExperiment")
                              String experimentId,
                              @NotNull
                              String reqData)
                       throws PortalException

Perform the operation of creating a new ActiveExperimentVariant if need and respond with the ABTestExperimentVariant configuration.

Parameters:

request - The request to save the applied experiment.

experimentId - The experiment to be applied.

reqData - JSON object containing the additional data.

Returns:

A JSON containing the variant configuration or null if the session is not in a ActiveExperimentVariant.

Throws:

PortalException

Since:

14.0.0

experimentGoalAchieved

@Path("/experimentGoalAchieved/{targetExperiment:[a-fA-F0-9]{32}}")
@POST
public void experimentGoalAchieved(@Context
                                   HttpServletRequest request,
                                   @PathParam("targetExperiment")
                                   String experimentId,
                                   @NotNull
                                   String reqData)
                            throws PortalException

Complete the ActiveExperimentVariant.

Parameters:

request - The request of the applied experiment.

experimentId - The experiment to be complete.

reqData - JSON object containing the additional data.

Throws:

PortalException

Since:

14.0.0

abandonExperiment

@Path("/abandonExperiment/{targetExperiment:[a-fA-F0-9]{32}}")
@POST
public void abandonExperiment(@Context
                              HttpServletRequest request,
                              @PathParam("targetExperiment")
                              String experimentId,
                              @NotNull
                              String reqData)
                       throws PortalException

Abandon the ActiveExperimentVariant.

Parameters:

request - The request of the applied experiment.

experimentId - The experiment to be abandon.

reqData - JSON object containing the additional data.

Throws:

PortalException

Since:

14.0.0