org.eclipse.microprofile.lra.tck.participant.api

Class ActivityController

java.lang.Object

org.eclipse.microprofile.lra.tck.participant.api.ActivityController

@ApplicationScoped
 @Path(value="activities")
public class ActivityController
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACCEPT_WORK
static String	ACCEPT_WORK_RESOURCE_METHOD
static String	ACTIVITIES_PATH
static String	CANCEL_ON_FAMILY_RESOURCE_METHOD
static String	CANCEL_ON_RESOURCE_METHOD
static String	COMPENSATED_COUNT_RESOURCE_METHOD
static String	COMPLETED_COUNT_RESOURCE_METHOD
static String	LEAVE_RESOURCE_METHOD
static String	MULTI_LEVEL_NESTED_ACTIVITY_RESOURCE_METHOD
static String	NESTED_ACTIVITY_RESOURCE_METHOD
static String	RENEW_TIME_LIMIT_RESOURCE_METHOD
static String	START_VIA_API_RESOURCE_METHOD
static String	TIME_LIMIT_RESOURCE_METHOD
static String	WORK_RESOURCE_METHOD

Constructor Summary

Constructors

Constructor and Description
ActivityController()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	acceptWork(String rcvId, String lraId)
javax.ws.rs.core.Response	activityWithLRA(String rcvId, String lraId)
javax.ws.rs.core.Response	cancelOn(String lraId)
javax.ws.rs.core.Response	cancelOnFamily(String lraId)
javax.ws.rs.core.Response	compensate(String txId) Performing a PUT on "participant URL"/compensate will cause the participant to compensate the work that was done within the scope of the transaction.
String	compensatedStatus(String txId)
javax.ws.rs.core.Response	compensateWork(String lraId, String userData)
javax.ws.rs.core.Response	complete(String txId) Performing a PUT on "participant URL"/complete will cause the participant to tidy up and it can forget this transaction.
String	completedStatus(String txId)
javax.ws.rs.core.Response	completeWork(String lraId, String userData)
javax.ws.rs.core.Response	extendTimeLimit(String lraId)
javax.ws.rs.core.Response	findAll()
void	forget(String txId)
javax.ws.rs.core.Response	forgetWork(String lraId)
javax.ws.rs.core.Response	getCompensatedCount()
javax.ws.rs.core.Response	getCompletedCount()
javax.ws.rs.core.Response	leaveWork(String lraId)
javax.ws.rs.core.Response	leaveWorkViaAPI(String lraUrl) Test that participants can leave an LRA using the LRAClient programmatic API
javax.ws.rs.core.Response	multiLevelNestedActivity(String rcvId, String nestedLRAId, Integer nestedCnt)
javax.ws.rs.core.Response	nestedActivity(String rcvId, String nestedLRAId)
javax.ws.rs.core.Response	status(String lraId) Performing a GET on the participant URL will return the current status of the participant CompensatorStatus, or 404 if the participant is no longer present.
javax.ws.rs.core.Response	subActivity(String lraId)
javax.ws.rs.core.Response	supportsLRACall(String lraId)
javax.ws.rs.core.Response	timeLimit(String lraId)

Methods inherited from class java.lang.Object

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

Field Detail

ACTIVITIES_PATH

public static final String ACTIVITIES_PATH

See Also:

Constant Field Values

ACCEPT_WORK

public static final String ACCEPT_WORK

See Also:

Constant Field Values

ACCEPT_WORK_RESOURCE_METHOD

public static final String ACCEPT_WORK_RESOURCE_METHOD

See Also:

Constant Field Values

LEAVE_RESOURCE_METHOD

public static final String LEAVE_RESOURCE_METHOD

See Also:

Constant Field Values

START_VIA_API_RESOURCE_METHOD

public static final String START_VIA_API_RESOURCE_METHOD

See Also:

Constant Field Values

WORK_RESOURCE_METHOD

public static final String WORK_RESOURCE_METHOD

See Also:

Constant Field Values

NESTED_ACTIVITY_RESOURCE_METHOD

public static final String NESTED_ACTIVITY_RESOURCE_METHOD

See Also:

Constant Field Values

MULTI_LEVEL_NESTED_ACTIVITY_RESOURCE_METHOD

public static final String MULTI_LEVEL_NESTED_ACTIVITY_RESOURCE_METHOD

See Also:

Constant Field Values

COMPLETED_COUNT_RESOURCE_METHOD

public static final String COMPLETED_COUNT_RESOURCE_METHOD

See Also:

Constant Field Values

COMPENSATED_COUNT_RESOURCE_METHOD

public static final String COMPENSATED_COUNT_RESOURCE_METHOD

See Also:

Constant Field Values

CANCEL_ON_RESOURCE_METHOD

public static final String CANCEL_ON_RESOURCE_METHOD

See Also:

Constant Field Values

CANCEL_ON_FAMILY_RESOURCE_METHOD

public static final String CANCEL_ON_FAMILY_RESOURCE_METHOD

See Also:

Constant Field Values

TIME_LIMIT_RESOURCE_METHOD

public static final String TIME_LIMIT_RESOURCE_METHOD

See Also:

Constant Field Values

RENEW_TIME_LIMIT_RESOURCE_METHOD

public static final String RENEW_TIME_LIMIT_RESOURCE_METHOD

See Also:

Constant Field Values

Constructor Detail

ActivityController

public ActivityController()

Method Detail

status

@GET
 @Path(value="/status")
 @Produces(value="application/json")
public javax.ws.rs.core.Response status(@HeaderParam(value="Long-Running-Action")
                                                                                                          String lraId)
                                                                                                   throws javax.ws.rs.NotFoundException

Performing a GET on the participant URL will return the current status of the participant CompensatorStatus, or 404 if the participant is no longer present.

Parameters:

lraId - the id of the LRA

Returns:

the status of the LRA

Throws:

javax.ws.rs.NotFoundException - if the activity was not found

leaveWorkViaAPI

@PUT
 @Path(value="/leave/{LraUrl}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response leaveWorkViaAPI(@PathParam(value="LraUrl")
                                                                                                                           String lraUrl)
                                                                                                                    throws javax.ws.rs.NotFoundException,
                                                                                                                           MalformedURLException

Test that participants can leave an LRA using the LRAClient programmatic API

Parameters:

lraUrl - the id of the LRA

Returns:

the url of the LRA if it was successfully removed

Throws:

javax.ws.rs.NotFoundException - if the activity was not found

MalformedURLException - if the LRA is malformed

leaveWork

@PUT
 @Path(value="/leave")
 @Produces(value="application/json")
public javax.ws.rs.core.Response leaveWork(@HeaderParam(value="Long-Running-Action")
                                                                                                            String lraId)
                                                                                                     throws javax.ws.rs.NotFoundException

Throws:

javax.ws.rs.NotFoundException

completeWork

@PUT
 @Path(value="/complete")
 @Produces(value="application/json")
public javax.ws.rs.core.Response completeWork(@HeaderParam(value="Long-Running-Action")
                                                                                                                  String lraId,
                                                                                                                  String userData)
                                                                                                           throws javax.ws.rs.NotFoundException

Throws:

javax.ws.rs.NotFoundException

compensateWork

@PUT
 @Path(value="/compensate")
 @Produces(value="application/json")
public javax.ws.rs.core.Response compensateWork(@HeaderParam(value="Long-Running-Action")
                                                                                                                      String lraId,
                                                                                                                      String userData)
                                                                                                               throws javax.ws.rs.NotFoundException

Throws:

javax.ws.rs.NotFoundException

forgetWork

@DELETE
 @Path(value="/forget")
 @Produces(value="application/json")
public javax.ws.rs.core.Response forgetWork(@HeaderParam(value="Long-Running-Action")
                                                                                                                 String lraId)

acceptWork

@PUT
 @Path(value="acceptWork")
public javax.ws.rs.core.Response acceptWork(@HeaderParam(value="Long-Running-Action-Recovery")
                                                                            String rcvId,
                                                                            @HeaderParam(value="Long-Running-Action")
                                                                            String lraId)

supportsLRACall

@PUT
 @Path(value="/supports")
public javax.ws.rs.core.Response supportsLRACall(@HeaderParam(value="Long-Running-Action")
                                                                                String lraId)

subActivity

@PUT
 @Path(value="/startViaApi")
public javax.ws.rs.core.Response subActivity(@HeaderParam(value="Long-Running-Action")
                                                                               String lraId)

activityWithLRA

@PUT
 @Path(value="/work")
public javax.ws.rs.core.Response activityWithLRA(@HeaderParam(value="Long-Running-Action-Recovery")
                                                                            String rcvId,
                                                                            @HeaderParam(value="Long-Running-Action")
                                                                            String lraId)

nestedActivity

@PUT
 @Path(value="/nestedActivity")
public javax.ws.rs.core.Response nestedActivity(@HeaderParam(value="Long-Running-Action-Recovery")
                                                                                     String rcvId,
                                                                                     @HeaderParam(value="Long-Running-Action")
                                                                                     String nestedLRAId)

multiLevelNestedActivity

@PUT
 @Path(value="/multiLevelNestedActivity")
public javax.ws.rs.core.Response multiLevelNestedActivity(@HeaderParam(value="Long-Running-Action-Recovery")
                                                                                                         String rcvId,
                                                                                                         @HeaderParam(value="Long-Running-Action")
                                                                                                         String nestedLRAId,
                                                                                                         @QueryParam(value="nestedCnt") @DefaultValue(value="1")
                                                                                                         Integer nestedCnt)

findAll

@GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response findAll()

getCompletedCount

@GET
 @Path(value="/completedactivitycount")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getCompletedCount()

getCompensatedCount

@GET
 @Path(value="/compensatedactivitycount")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getCompensatedCount()

cancelOn

@GET
 @Path(value="/cancelOn")
 @Produces(value="application/json")
public javax.ws.rs.core.Response cancelOn(@HeaderParam(value="Long-Running-Action")
                                                                                                              String lraId)

cancelOnFamily

@GET
 @Path(value="/cancelOnFamily")
 @Produces(value="application/json")
public javax.ws.rs.core.Response cancelOnFamily(@HeaderParam(value="Long-Running-Action")
                                                                                                                          String lraId)

timeLimit

@GET
 @Path(value="/timeLimit")
 @Produces(value="application/json")
public javax.ws.rs.core.Response timeLimit(@HeaderParam(value="Long-Running-Action")
                                                                                                                String lraId)

extendTimeLimit

@GET
 @Path(value="/renewTimeLimit")
 @Produces(value="application/json")
public javax.ws.rs.core.Response extendTimeLimit(@HeaderParam(value="Long-Running-Action")
                                                                                                                           String lraId)

compensate

@PUT
 @Path(value="/{TxId}/compensate")
 @Produces(value="application/json")
public javax.ws.rs.core.Response compensate(@PathParam(value="TxId")
                                                                                                                         String txId)
                                                                                                                  throws javax.ws.rs.NotFoundException

Performing a PUT on "participant URL"/compensate will cause the participant to compensate the work that was done within the scope of the transaction. The participant will either return a 200 OK code and a "status URL" which indicates the outcome and which can be probed (via GET) and will simply return the same (implicit) information: "URL"/cannot-compensate "URL"/cannot-complete

Parameters:

txId - the id of the LRA

Returns:

the final status of the activity

Throws:

javax.ws.rs.NotFoundException - if the activity does not exist

complete

@PUT
 @Path(value="/{TxId}/complete")
 @Produces(value="application/json")
public javax.ws.rs.core.Response complete(@PathParam(value="TxId")
                                                                                                                     String txId)
                                                                                                              throws javax.ws.rs.NotFoundException

Performing a PUT on "participant URL"/complete will cause the participant to tidy up and it can forget this transaction. The participant will either return a 200 OK code and a "status URL" which indicates the outcome and which can be probed (via GET) and will simply return the same (implicit) information: "URL"/cannot-compensate "URL"/cannot-complete

Parameters:

txId - the id of the LRA

Returns:

the final status of the activity

Throws:

javax.ws.rs.NotFoundException - if the activity does not exist

forget

@PUT
 @Path(value="/{TxId}/forget")
public void forget(@PathParam(value="TxId")
                                                       String txId)
                                                throws javax.ws.rs.NotFoundException

Throws:

javax.ws.rs.NotFoundException

completedStatus

@GET
 @Path(value="/{TxId}/completed")
 @Produces(value="application/json")
public String completedStatus(@PathParam(value="TxId")
                                                                                                          String txId)

compensatedStatus

@GET
 @Path(value="/{TxId}/compensated")
 @Produces(value="application/json")
public String compensatedStatus(@PathParam(value="TxId")
                                                                                                              String txId)