io.narayana.lra.client.NarayanaLRAClient Maven / Gradle / Ivy
/*
Copyright The Narayana Authors
SPDX-License-Identifier: Apache-2.0
*/
package io.narayana.lra.client;
import io.narayana.lra.Current;
import io.narayana.lra.LRAConstants;
import io.narayana.lra.LRAData;
import io.narayana.lra.logging.LRALogger;
import jakarta.enterprise.context.RequestScoped;
import jakarta.ws.rs.DELETE;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.NotFoundException;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.PUT;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.WebApplicationException;
import jakarta.ws.rs.client.Client;
import jakarta.ws.rs.client.ClientBuilder;
import jakarta.ws.rs.client.Entity;
import jakarta.ws.rs.container.Suspended;
import jakarta.ws.rs.core.GenericType;
import jakarta.ws.rs.core.HttpHeaders;
import jakarta.ws.rs.core.Link;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.MultivaluedHashMap;
import jakarta.ws.rs.core.MultivaluedMap;
import jakarta.ws.rs.core.Response;
import jakarta.ws.rs.core.UriBuilder;
import jakarta.ws.rs.core.UriInfo;
import org.eclipse.microprofile.lra.annotation.AfterLRA;
import org.eclipse.microprofile.lra.annotation.Compensate;
import org.eclipse.microprofile.lra.annotation.Complete;
import org.eclipse.microprofile.lra.annotation.Forget;
import org.eclipse.microprofile.lra.annotation.LRAStatus;
import org.eclipse.microprofile.lra.annotation.Status;
import org.eclipse.microprofile.lra.annotation.ws.rs.Leave;
import java.io.Closeable;
import java.io.UnsupportedEncodingException;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
import java.time.temporal.ChronoUnit;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import static io.narayana.lra.LRAConstants.AFTER;
import static io.narayana.lra.LRAConstants.CLIENT_ID_PARAM_NAME;
import static io.narayana.lra.LRAConstants.COMPENSATE;
import static io.narayana.lra.LRAConstants.COMPLETE;
import static io.narayana.lra.LRAConstants.COORDINATOR_PATH_NAME;
import static io.narayana.lra.LRAConstants.FORGET;
import static io.narayana.lra.LRAConstants.LEAVE;
import static io.narayana.lra.LRAConstants.NARAYANA_LRA_API_VERSION_HEADER_NAME;
import static io.narayana.lra.LRAConstants.NARAYANA_LRA_PARTICIPANT_DATA_HEADER_NAME;
import static io.narayana.lra.LRAConstants.NARAYANA_LRA_PARTICIPANT_LINK_HEADER_NAME;
import static io.narayana.lra.LRAConstants.PARENT_LRA_PARAM_NAME;
import static io.narayana.lra.LRAConstants.RECOVERY_COORDINATOR_PATH_NAME;
import static io.narayana.lra.LRAConstants.STATUS;
import static io.narayana.lra.LRAConstants.TIMELIMIT_PARAM_NAME;
import static jakarta.ws.rs.core.Response.Status.BAD_REQUEST;
import static jakarta.ws.rs.core.Response.Status.GONE;
import static jakarta.ws.rs.core.Response.Status.INTERNAL_SERVER_ERROR;
import static jakarta.ws.rs.core.Response.Status.NOT_ACCEPTABLE;
import static jakarta.ws.rs.core.Response.Status.NOT_FOUND;
import static jakarta.ws.rs.core.Response.Status.NO_CONTENT;
import static jakarta.ws.rs.core.Response.Status.OK;
import static jakarta.ws.rs.core.Response.Status.PRECONDITION_FAILED;
import static org.eclipse.microprofile.lra.annotation.ws.rs.LRA.LRA_HTTP_RECOVERY_HEADER;
/**
* WARNING: NarayanaLRAClient is an internal utility class and is subject to change
* (however it will be made available with improved guarantees in a subsequent release).
*
* A utility class for controlling the lifecycle of Long Running Actions (LRAs) but the preferred mechanism is to use
* the annotation in the {@link org.eclipse.microprofile.lra.annotation} package
*/
@Deprecated
@RequestScoped
public class NarayanaLRAClient implements Closeable {
/**
* Key for looking up the config property that specifies which is the URL
* to connect to the Narayana LRA coordinator
*/
public static final String LRA_COORDINATOR_URL_KEY = "lra.coordinator.url";
// LRA Coordinator API
private static final String START_PATH = "/start";
private static final String LEAVE_PATH = "/%s/remove";
private static final String STATUS_PATH = "/%s/status";
private static final String CLOSE_PATH = "/%s/close";
private static final String CANCEL_PATH = "/%s/cancel";
private static final String LINK_TEXT = "Link";
/**
* constrain how long client operations take before giving up
*
* WARNING: NarayanaLRAClient is an internal utility class and is subject to change
* (but it will be made available with improved guarantees in a subsequent release).
*/
private static final long CLIENT_TIMEOUT = Long.getLong("lra.internal.client.timeout", 10);
private static final long START_TIMEOUT = Long.getLong("lra.internal.client.timeout.start", CLIENT_TIMEOUT);
private static final long JOIN_TIMEOUT = Long.getLong("lra.internal.client.timeout.join", CLIENT_TIMEOUT);
private static final long END_TIMEOUT = Long.getLong("lra.internal.client.end.timeout", CLIENT_TIMEOUT);
private static final long LEAVE_TIMEOUT = Long.getLong("lra.internal.client.leave.timeout", CLIENT_TIMEOUT);
private static final long QUERY_TIMEOUT = Long.getLong("lra.internal.client.query.timeout", CLIENT_TIMEOUT);
private URI coordinatorUrl;
/**
* Creating LRA client. The URL of the LRA coordinator will be taken
* from system property {@link NarayanaLRAClient#LRA_COORDINATOR_URL_KEY}.
* If not defined as default value is taken {@code http://localhost:8080/lra-coordinator}.
* The LRA recovery coordinator will be searched at the sub-path {@value LRAConstants#RECOVERY_COORDINATOR_PATH_NAME}.
*
* @throws IllegalStateException thrown when the URL taken from the system property value is not a URL format
*/
public NarayanaLRAClient() {
this(System.getProperty(NarayanaLRAClient.LRA_COORDINATOR_URL_KEY,
"http://localhost:8080/" + COORDINATOR_PATH_NAME));
}
/**
* Creating LRA client where expecting LRA coordinator being available through
* protocol protocol at host:port/coordinatorPath.
*
* @param protocol protocol used to contact the LRA coordinator
* @param host hostname where the LRA coordinator will be contacted
* @param port port where the LRA coordinator will be contacted
* @param coordinatorPath path where the LRA coordinator will be contacted
*/
public NarayanaLRAClient(String protocol, String host, int port, String coordinatorPath) {
coordinatorUrl = UriBuilder.fromPath(coordinatorPath).scheme(protocol).host(host).port(port).build();
}
/**
* Creating LRA client where expecting LRA coordinator being available
* at the provided uri.
* The LRA recovery coordinator will be searched at the sub-path {@value LRAConstants#RECOVERY_COORDINATOR_PATH_NAME}.
*
* @param coordinatorUrl uri of the LRA coordinator
*/
public NarayanaLRAClient(URI coordinatorUrl) {
this.coordinatorUrl = coordinatorUrl;
}
/**
* Creating LRA client where expecting LRA coordinator being available
* at the provided URL defined by String.
* The LRA recovery coordinator will be searched at the sub-path {@value LRAConstants#RECOVERY_COORDINATOR_PATH_NAME}.
*
* @param coordinatorUrl url of the LRA coordinator
* @throws IllegalStateException thrown when the provided URL String is not a URL format
*/
public NarayanaLRAClient(String coordinatorUrl) {
try {
this.coordinatorUrl = new URI(coordinatorUrl);
} catch (URISyntaxException use) {
throw new IllegalStateException("Cannot convert the provided coordinator url String "
+ coordinatorUrl + " to URL format", use);
}
}
/**
* Method changes the client's notion about the place where the LRA coordinator can be contacted.
* It takes the provided URI and tries to derive the URL path of the coordinator responsible
* for the LRA id. The URL is then used as endpoint for later use of this LRA Narayana client instance.
*
* @param lraId LRA id consisting of the coordinator URL and the LRA uid
*/
public void setCurrentLRA(URI lraId) {
try {
this.coordinatorUrl = LRAConstants.getLRACoordinatorUrl(lraId);
} catch (IllegalStateException e) {
String logMsg = LRALogger.i18nLogger.error_invalidLraIdFormatToConvertToCoordinatorUrl(lraId.toASCIIString(), e);
LRALogger.logger.error(logMsg);
throwGenericLRAException(lraId, BAD_REQUEST.getStatusCode(), logMsg, null);
}
}
public List getAllLRAs() {
Client client = null;
try {
client = getClient();
Response response = client.target(coordinatorUrl)
.request()
.header(NARAYANA_LRA_API_VERSION_HEADER_NAME, LRAConstants.CURRENT_API_VERSION_STRING)
.async()
.get()
.get(QUERY_TIMEOUT, TimeUnit.SECONDS);
if (response.getStatus() != OK.getStatusCode()) {
LRALogger.logger.debugf("Error getting all LRAs from the coordinator, response status: %d", response.getStatus());
throw new WebApplicationException(response);
}
return response.readEntity(new GenericType>() {});
} catch (InterruptedException | ExecutionException | TimeoutException e) {
throw new WebApplicationException("getAllLRAs client request timed out, try again later",
Response.Status.SERVICE_UNAVAILABLE.getStatusCode());
} finally {
if (client != null) {
client.close();
}
}
}
/**
* Starting LRA. You provide client id determining the LRA being started.
*
* @param clientID client id determining the LRA
* @return LRA id as URL
* @throws WebApplicationException thrown when start of the LRA failed
*/
public URI startLRA(String clientID) throws WebApplicationException {
return startLRA(clientID, 0L);
}
/**
* Starting LRA. You provide client id that joins the LRA context
* and is passed when working with the LRA.
*
* @param clientID client id determining the LRA
* @param timeout timeout value in seconds, when timeout-ed the LRA will be compensated
* @return LRA id as URL
* @throws WebApplicationException thrown when start of the LRA failed
*/
private URI startLRA(String clientID, Long timeout) throws WebApplicationException {
return startLRA(clientID, timeout, ChronoUnit.SECONDS);
}
/**
* Starting LRA. You provide client id that joins the LRA context
* and is passed when working with the LRA.
*
* @param clientID client id determining the LRA
* @param timeout timeout value, when timeout-ed the LRA will be compensated
* @param unit timeout unit, when null seconds are used
* @return LRA id as URL
* @throws WebApplicationException thrown when start of the LRA failed
*/
private URI startLRA(String clientID, Long timeout, ChronoUnit unit) throws WebApplicationException {
return startLRA(getCurrent(), clientID, timeout, unit);
}
public URI startLRA(URI parentLRA, String clientID, Long timeout, ChronoUnit unit) throws WebApplicationException {
return startLRA(parentLRA, clientID, timeout, unit, true);
}
/**
* Starting LRA. You provide client id that joins the LRA context
* and is passed when working with the LRA.
*
* @param parentLRA when the newly started LRA should be nested with this LRA parent, when null the newly started LRA is top-level
* @param clientID client id determining the LRA
* @param timeout timeout value, when timeout-ed the LRA will be compensated
* @param unit timeout unit, when null seconds are used
* @return LRA id as URL
* @throws WebApplicationException thrown when start of the LRA failed
*/
public URI startLRA(URI parentLRA, String clientID, Long timeout, ChronoUnit unit, boolean verbose) throws WebApplicationException {
Client client = null;
Response response = null;
URI lra;
if (clientID == null) {
clientID = "";
}
if (timeout == null) {
timeout = 0L;
} else if (timeout < 0) {
throwGenericLRAException(parentLRA, BAD_REQUEST.getStatusCode(),
"Invalid timeout value: " + timeout, null);
return null;
}
if (unit == null) {
unit = ChronoUnit.SECONDS;
}
lraTracef("startLRA for client %s with parent %s", clientID, parentLRA);
try {
String encodedParentLRA = parentLRA == null ? "" : URLEncoder.encode(parentLRA.toString(), StandardCharsets.UTF_8.name());
client = getClient();
response = client.target(coordinatorUrl)
.path(START_PATH)
.queryParam(CLIENT_ID_PARAM_NAME, clientID)
.queryParam(TIMELIMIT_PARAM_NAME, Duration.of(timeout, unit).toMillis())
.queryParam(PARENT_LRA_PARAM_NAME, encodedParentLRA)
.request()
.header(NARAYANA_LRA_API_VERSION_HEADER_NAME, LRAConstants.CURRENT_API_VERSION_STRING)
.async()
.post(null)
.get(START_TIMEOUT, TimeUnit.SECONDS);
// validate the HTTP status code says an LRA resource was created
if (isUnexpectedResponseStatus(response, Response.Status.CREATED)) {
String responseEntity = response.hasEntity() ? response.readEntity(String.class) : "";
String logMsg = LRALogger.i18nLogger.error_lraCreationUnexpectedStatus(response.getStatus(), responseEntity);
if (verbose) {
LRALogger.logger.error(logMsg);
}
throwGenericLRAException(null, response.getStatus(), // Remark the catch block already catches this one
logMsg, null);
return null;
}
lra = URI.create(response.getHeaderString(HttpHeaders.LOCATION));
lraTrace(lra, "startLRA returned");
Current.push(lra);
Current.addActiveLRACache(lra);
return lra;
} catch (UnsupportedEncodingException uee) {
String logMsg = LRALogger.i18nLogger.error_invalidFormatToEncodeParentUri(parentLRA, uee);
if (verbose) {
LRALogger.logger.error(logMsg);
}
throwGenericLRAException(null, INTERNAL_SERVER_ERROR.getStatusCode(),
logMsg, uee);
return null;
} catch (InterruptedException | ExecutionException | TimeoutException e) {
LRALogger.i18nLogger.warn_startLRAFailed(e.getMessage(), e);
throw new WebApplicationException("start LRA client request failed, try again later", e,
Response.Status.SERVICE_UNAVAILABLE.getStatusCode());
} finally {
if (client != null) {
client.close();
}
}
}
public void cancelLRA(URI lraId) throws WebApplicationException {
endLRA(lraId, false, null, null);
}
public void closeLRA(URI lraId) throws WebApplicationException {
endLRA(lraId, true, null, null);
}
public void cancelLRA(URI lraId, String compensator, String userData) throws WebApplicationException {
endLRA(lraId, false, compensator, userData);
}
public void closeLRA(URI lraId, String compensator, String userData) throws WebApplicationException {
endLRA(lraId, true, compensator, userData);
}
/**
* Joining the LRA with identity of `lraId` as participant defined by URIs for complete, compensate, forget, leave,
* after and status.
*
* @param lraId the URI of the LRA to join
* @param timeLimit how long the participant is prepared to wait for LRA completion
* @param compensateUri URI for compensation notifications
* @param completeUri URI for completion notifications
* @param forgetUri URI for forget callback
* @param leaveUri URI for leave requests
* @param statusUri URI for reporting the status of the participant
* @param compensatorData data provided during compensation
* @return a recovery URL for this enlistment
* @throws WebApplicationException if the LRA coordinator failed to enlist the participant
*/
public URI joinLRA(URI lraId, Long timeLimit,
URI compensateUri, URI completeUri, URI forgetUri, URI leaveUri, URI afterUri, URI statusUri,
String compensatorData) throws WebApplicationException {
return enlistCompensator(lraId, timeLimit, "",
compensateUri, completeUri,
forgetUri, leaveUri, afterUri, statusUri,
null);
}
public URI joinLRA(URI lraId, Long timeLimit,
URI compensateUri, URI completeUri, URI forgetUri, URI leaveUri, URI afterUri, URI statusUri,
StringBuilder compensatorData) throws WebApplicationException {
return enlistCompensator(lraId, timeLimit, "",
compensateUri, completeUri,
forgetUri, leaveUri, afterUri, statusUri,
compensatorData);
}
/**
* Joining the LRA with identity of `lraId` as participant defined by a participant URI.
*
* @param lraId the URI of the LRA to join
* @param timeLimit how long the participant is prepared to wait for LRA completion
* @param participantUri URI of participant for enlistment
* @param compensatorData data provided during compensation
* @return a recovery URL for this enlistment
* @throws WebApplicationException if the LRA coordinator failed to enlist the participant
*/
public URI joinLRA(URI lraId, Long timeLimit,
URI participantUri, StringBuilder compensatorData) throws WebApplicationException {
validateURI(participantUri, false, "Invalid participant URL: %s");
StringBuilder linkHeaderValue
= makeLink(new StringBuilder(), null, "participant", participantUri.toASCIIString());
return enlistCompensator(lraId, timeLimit, linkHeaderValue.toString(), compensatorData);
}
public void leaveLRA(URI lraId, String body) throws WebApplicationException {
Client client = null;
Response response;
try {
client = getClient();
response = client.target(coordinatorUrl)
.path(String.format(LEAVE_PATH, LRAConstants.getLRAUid(lraId)))
.request()
.header(NARAYANA_LRA_API_VERSION_HEADER_NAME, LRAConstants.CURRENT_API_VERSION_STRING)
.async()
.put(body == null ? Entity.text("") : Entity.text(body))
.get(LEAVE_TIMEOUT, TimeUnit.SECONDS);
if (OK.getStatusCode() != response.getStatus()) {
String logMsg = LRALogger.i18nLogger.error_lraLeaveUnexpectedStatus(lraId, response.getStatus(),
response.hasEntity() ? response.readEntity(String.class) : "");
LRALogger.logger.error(logMsg);
throwGenericLRAException(null, response.getStatus(), logMsg, null);
}
} catch (InterruptedException | ExecutionException | TimeoutException e) {
throw new WebApplicationException("leave LRA client request timed out, try again later",
Response.Status.SERVICE_UNAVAILABLE.getStatusCode());
} finally {
if (client != null) {
client.close();
}
}
}
/**
* For particular compensator class it returns termination uris based on the provided base uri.
* You get map of string and URI.
*
* @param compensatorClass compensator class to examine
* @param uriInfo the uri that triggered this join request.
* @return map of URI
*/
public static Map getTerminationUris(Class compensatorClass, UriInfo uriInfo, Long timeout) {
Map paths = new HashMap<>();
final boolean[] asyncTermination = {false};
URI baseUri = uriInfo.getBaseUri();
/*
* Calculate which path to prepend to the LRA participant methods. If there is more than one matching URI
* then the second matched URI comes from either the class level Path annotation or from a sub-resource locator.
* In both cases the second matched URI can be used as a prefix for the LRA participant URIs:
*/
List matchedURIs = uriInfo.getMatchedURIs();
int matchedURI = (matchedURIs.size() > 1 ? 1 : 0);
final String uriPrefix = baseUri + matchedURIs.get(matchedURI);
String timeoutValue = timeout != null ? Long.toString(timeout) : "0";
Arrays.stream(compensatorClass.getMethods()).forEach(method -> {
Path pathAnnotation = method.getAnnotation(Path.class);
if (pathAnnotation != null) {
if (checkMethod(paths, method, COMPENSATE, pathAnnotation,
method.getAnnotation(Compensate.class), uriPrefix) != 0) {
paths.put(TIMELIMIT_PARAM_NAME, timeoutValue);
if (isAsyncCompletion(method)) {
asyncTermination[0] = true;
}
}
if (checkMethod(paths, method, COMPLETE, pathAnnotation,
method.getAnnotation(Complete.class), uriPrefix) != 0) {
paths.put(TIMELIMIT_PARAM_NAME, timeoutValue);
if (isAsyncCompletion(method)) {
asyncTermination[0] = true;
}
}
checkMethod(paths, method, STATUS, pathAnnotation,
method.getAnnotation(Status.class), uriPrefix);
checkMethod(paths, method, FORGET, pathAnnotation,
method.getAnnotation(Forget.class), uriPrefix);
checkMethod(paths, method, LEAVE, pathAnnotation, method.getAnnotation(Leave.class), uriPrefix);
checkMethod(paths, method, AFTER, pathAnnotation, method.getAnnotation(AfterLRA.class), uriPrefix);
}
});
if (asyncTermination[0] && !paths.containsKey(STATUS) && !paths.containsKey(FORGET)) {
String logMsg = LRALogger.i18nLogger.error_asyncTerminationBeanMissStatusAndForget(compensatorClass);
LRALogger.logger.warn(logMsg);
throw new WebApplicationException(
Response.status(BAD_REQUEST)
.entity(logMsg)
.build());
}
StringBuilder linkHeaderValue = new StringBuilder();
if (!paths.isEmpty()) {
paths.forEach((k, v) -> makeLink(linkHeaderValue, null, k, v));
paths.put(LINK_TEXT, linkHeaderValue.toString());
}
return paths;
}
/**
* Providing information if method is defined to be completed asynchronously.
* This means that {@link Suspended} annotation is available amongst the method parameters
* while the method is annotated with {@link Complete} or {@link Compensate}.
*
* @param method method to be checked for async completion
* @return true if method is to complete asynchronously, false if synchronously
*/
public static boolean isAsyncCompletion(Method method) {
if (method.isAnnotationPresent(Complete.class) || method.isAnnotationPresent(Compensate.class)) {
for (Annotation[] ann : method.getParameterAnnotations()) {
for (Annotation an : ann) {
if (Suspended.class.isAssignableFrom(an.annotationType())) {
LRALogger.logger.warn("JAX-RS @Suspended annotation is untested");
return true;
}
}
}
}
return false;
}
private static int checkMethod(Map paths,
Method method, String rel,
Path pathAnnotation,
Annotation annotationClass,
String uriPrefix) {
/*
* If the annotationClass is null the requested participant annotation is not present,
* but we also need to check for conformance with the interoperability spec,
* ie look for paths of the form:
* `/compensate`
* `/complete`
* etc
*/
if (annotationClass == null) {
// TODO support standard compenators with: && !pathAnnotation.value().endsWith(rel)) {
// ie ones that do not use the @Compensate annotation
return 0;
}
// search for a matching JAX-RS method
for (Annotation annotation : method.getDeclaredAnnotations()) {
String name = annotation.annotationType().getName();
if (name.equals(GET.class.getName()) ||
name.equals(PUT.class.getName()) ||
name.equals(POST.class.getName()) ||
name.equals(DELETE.class.getName())) {
String pathValue = pathAnnotation.value();
pathValue = pathValue.startsWith("/") ? pathValue : "/" + pathValue;
String url = String.format("%s%s?%s=%s", uriPrefix, pathValue, LRAConstants.HTTP_METHOD_NAME, name);
paths.put(rel, url);
break;
}
}
return 1;
}
public LRAStatus getStatus(URI uri) throws WebApplicationException {
Client client = null;
Response response;
URL lraId;
try {
lraId = uri.toURL();
} catch (MalformedURLException mue) {
throwGenericLRAException(null,
Response.Status.INTERNAL_SERVER_ERROR.getStatusCode(),
"Could not convert LRA to a URL : " + mue.getClass().getName() + ":" + mue.getMessage(), mue);
return null;
}
try {
client = getClient();
response = client.target(coordinatorUrl)
.path(String.format(STATUS_PATH, LRAConstants.getLRAUid(uri)))
.request()
.header(NARAYANA_LRA_API_VERSION_HEADER_NAME, LRAConstants.CURRENT_API_VERSION_STRING)
.async()
.get()
.get(QUERY_TIMEOUT, TimeUnit.SECONDS);
if (response.getStatus() == NOT_FOUND.getStatusCode()) {
String responseEntity = response.hasEntity() ? response.readEntity(String.class) : "";
String errorMsg = "The requested LRA it '" + lraId + "' was not found and the status can't be obtained, "
+ "response content: " + responseEntity;
throw new NotFoundException(errorMsg, Response.status(NOT_FOUND).entity(errorMsg).build());
}
if (response.getStatus() == NO_CONTENT.getStatusCode()) {
return LRAStatus.Active;
}
if (response.getStatus() != OK.getStatusCode()) {
String logMsg = LRALogger.i18nLogger.error_invalidStatusCode(coordinatorUrl, response.getStatus(), lraId);
LRALogger.logger.error(logMsg);
throwGenericLRAException(uri, response.getStatus(),
logMsg, null);
}
if (!response.hasEntity()) {
String logMsg = LRALogger.i18nLogger.error_noContentOnGetStatus(coordinatorUrl, lraId);
LRALogger.logger.error(logMsg);
throwGenericLRAException(uri, Response.Status.INTERNAL_SERVER_ERROR.getStatusCode(),
logMsg, null);
}
// convert the returned String into a status
try {
return fromString(response.readEntity(String.class));
} catch (IllegalArgumentException iae) {
String logMsg = LRALogger.i18nLogger.error_invalidArgumentOnStatusFromCoordinator(coordinatorUrl, lraId, iae);
LRALogger.logger.error(logMsg);
throwGenericLRAException(uri,Response.Status.INTERNAL_SERVER_ERROR.getStatusCode(),
logMsg, iae);
}
} catch (InterruptedException | ExecutionException | TimeoutException e) {
throw new WebApplicationException("get LRA status client request timed out, try again later",
Response.Status.SERVICE_UNAVAILABLE.getStatusCode());
} finally {
if (client != null) {
client.close();
}
}
return null;
}
/**
*
* @param status the string that is to be converted to a CompensatorStatus
* @return the corresponding status or empty
* @throws IllegalArgumentException if the status is not a valid enum constant
*/
private static LRAStatus fromString(String status) {
if (status == null) {
throw new IllegalArgumentException("The status parameter is null");
}
return LRAStatus.valueOf(status);
}
private static StringBuilder makeLink(StringBuilder b, String uriPrefix, String key, String value) {
if (value == null) {
return b;
}
String terminationUri = uriPrefix == null ? value : String.format("%s%s", uriPrefix, value);
Link link = Link.fromUri(terminationUri).title(key + " URI").rel(key).type(MediaType.TEXT_PLAIN).build();
if (b.length() != 0) {
b.append(',');
}
return b.append(link);
}
private URI enlistCompensator(URI lraUri, Long timelimit, String uriPrefix,
URI compensateUri, URI completeUri,
URI forgetUri, URI leaveUri, URI afterUri, URI statusUri,
StringBuilder compensatorData) {
validateURI(completeUri, true, "Invalid complete URL: %s");
validateURI(compensateUri, true, "Invalid compensate URL: %s");
validateURI(leaveUri, true, "Invalid status URL: %s");
validateURI(afterUri, true, "Invalid after URL: %s");
validateURI(forgetUri, true, "Invalid forgetUri URL: %s");
validateURI(statusUri, true, "Invalid status URL: %s");
Map terminateURIs = new HashMap<>();
terminateURIs.put(COMPENSATE, compensateUri);
terminateURIs.put(COMPLETE, completeUri);
terminateURIs.put(LEAVE, leaveUri);
terminateURIs.put(AFTER, afterUri);
terminateURIs.put(STATUS, statusUri);
terminateURIs.put(FORGET, forgetUri);
// register with the coordinator
// put the lra id in an http header
StringBuilder linkHeaderValue = new StringBuilder();
terminateURIs.forEach((k, v) -> makeLink(linkHeaderValue, uriPrefix, k, v == null ? null : v.toASCIIString()));
return enlistCompensator(lraUri, timelimit, linkHeaderValue.toString(), compensatorData);
}
public URI enlistCompensator(URI uri, Long timelimit, String linkHeader, StringBuilder compensatorData) {
// register with the coordinator
// put the lra id in an http header
Client client = null;
Response response = null;
URL lraId = null;
String data = compensatorData == null ? null : compensatorData.toString();
try {
lraId = uri.toURL();
} catch (MalformedURLException mue) {
throwGenericLRAException(null, Response.Status.INTERNAL_SERVER_ERROR.getStatusCode(),
"Could not convert LRA to a URL : " + mue.getClass().getName() + ":" + mue.getMessage(), mue);
}
if (timelimit == null || timelimit < 0) {
timelimit = 0L;
}
try {
client = getClient();
try {
MultivaluedMap headers = new MultivaluedHashMap<>();
headers.add(NARAYANA_LRA_API_VERSION_HEADER_NAME, LRAConstants.CURRENT_API_VERSION_STRING);
if (data != null) {
headers.add(NARAYANA_LRA_PARTICIPANT_DATA_HEADER_NAME, data);
}
headers.add("Link", linkHeader);
response = client.target(coordinatorUrl)
.path(LRAConstants.getLRAUid(uri))
.queryParam(TIMELIMIT_PARAM_NAME, timelimit)
.request()
.headers(headers)
.async()
.put(Entity.text(compensatorData == null ? linkHeader : data))
.get(JOIN_TIMEOUT, TimeUnit.SECONDS);
String responseEntity = response.hasEntity() ? response.readEntity(String.class) : "";
if (response.getStatus() == Response.Status.PRECONDITION_FAILED.getStatusCode()) {
String logMsg = LRALogger.i18nLogger.error_tooLateToJoin(lraId, responseEntity);
LRALogger.logger.error(logMsg);
throw new WebApplicationException(logMsg,
Response.status(PRECONDITION_FAILED).entity(logMsg).build());
} else if (response.getStatus() == NOT_FOUND.getStatusCode()) {
String logMsg = LRALogger.i18nLogger.info_failedToEnlistingLRANotFound(
lraId, coordinatorUrl, NOT_FOUND.getStatusCode(), NOT_FOUND.getReasonPhrase(), GONE.getStatusCode(), GONE.getReasonPhrase());
LRALogger.logger.info(logMsg);
throw new WebApplicationException(logMsg);
} else if (response.getStatus() != OK.getStatusCode()) {
String logMsg = LRALogger.i18nLogger.error_failedToEnlist(lraId, coordinatorUrl, response.getStatus());
LRALogger.logger.error(logMsg);
throwGenericLRAException(uri, response.getStatus(), logMsg, null);
}
String recoveryUrl = null;
String prevParticipantData = response.getHeaderString(NARAYANA_LRA_PARTICIPANT_DATA_HEADER_NAME);
if (compensatorData != null && prevParticipantData != null) {
compensatorData.setLength(0);
compensatorData.append(prevParticipantData);
}
try {
recoveryUrl = response.getHeaderString(LRA_HTTP_RECOVERY_HEADER);
return new URI(recoveryUrl);
} catch (URISyntaxException e) {
LRALogger.logger.infof(e,"join %s returned an invalid recovery URI '%s': %s", lraId, recoveryUrl, responseEntity);
throwGenericLRAException(null, Response.Status.SERVICE_UNAVAILABLE.getStatusCode(),
"join " + lraId + " returned an invalid recovery URI '" + recoveryUrl + "' : " + responseEntity, e);
return null;
}
} catch (WebApplicationException webApplicationException) {
throw new WebApplicationException(uri.toASCIIString(), GONE); // not sure why we think it's gone
} catch (InterruptedException | ExecutionException | TimeoutException e) {
throw new WebApplicationException("join LRA client request timed out, try again later",
Response.Status.SERVICE_UNAVAILABLE.getStatusCode());
}
} finally {
if (client != null) {
client.close();
}
}
}
private void endLRA(URI lra, boolean confirm, String compensator, String userData) throws WebApplicationException {
Client client = null;
Response response = null;
lraTracef(lra, "%s LRA", confirm ? "close" : "compensate");
try {
client = getClient();
String lraUid = LRAConstants.getLRAUid(lra);
try {
response = client.target(coordinatorUrl)
.path(confirm ? String.format(CLOSE_PATH, lraUid) : String.format(CANCEL_PATH, lraUid))
.request()
.header(NARAYANA_LRA_API_VERSION_HEADER_NAME, LRAConstants.CURRENT_API_VERSION_STRING)
.header(NARAYANA_LRA_PARTICIPANT_LINK_HEADER_NAME, compensator)
.header(NARAYANA_LRA_PARTICIPANT_DATA_HEADER_NAME, userData)
.async()
.put(Entity.text(""))
.get(END_TIMEOUT, TimeUnit.SECONDS);
} catch (InterruptedException | ExecutionException | TimeoutException e) {
throw new WebApplicationException("end LRA client request timed out, try again later",
Response.Status.SERVICE_UNAVAILABLE.getStatusCode());
}
if (isUnexpectedResponseStatus(response, OK, Response.Status.ACCEPTED, NOT_FOUND)) {
String warnMsg = LRALogger.i18nLogger.error_lraTerminationUnexpectedStatus(response.getStatus(),
response.hasEntity() ? response.readEntity(String.class) : "");
LRALogger.logger.warn(warnMsg);
throwGenericLRAException(lra, INTERNAL_SERVER_ERROR.getStatusCode(), warnMsg, null);
}
if (response.getStatus() == NOT_FOUND.getStatusCode()) {
String errorMsg = LRALogger.i18nLogger.get_couldNotCompleteCompensateOnReturnedStatus(
confirm ? "close" : "compensate", lra, coordinatorUrl, NOT_FOUND.getReasonPhrase());
LRALogger.logger.info(errorMsg);
throw new NotFoundException(errorMsg,
Response.status(NOT_FOUND).entity(lra.toASCIIString()).build());
}
} finally {
Current.pop(lra);
Current.removeActiveLRACache(lra);
if (client != null) {
client.close();
}
}
}
private void validateURI(URI uri, boolean nullAllowed, String message) {
if (uri == null) {
if (!nullAllowed) {
throwGenericLRAException(null, NOT_ACCEPTABLE.getStatusCode(),
String.format(message, "null value"), null);
}
} else {
try {
// the passed in URI should be a valid URL - verify that that is the case
uri.toURL();
} catch (MalformedURLException mue) {
throwGenericLRAException(null, NOT_ACCEPTABLE.getStatusCode(),
String.format(message, mue.getClass().getName() + ":" + mue.getMessage()) + " uri=" + uri, mue);
}
}
}
private boolean isUnexpectedResponseStatus(Response response, Response.Status... expected) {
for (Response.Status anExpected : expected) {
if (response.getStatus() == anExpected.getStatusCode()) {
return false;
}
}
return true;
}
public String getCoordinatorUrl() {
return coordinatorUrl.toString();
}
public String getRecoveryUrl() {
return getCoordinatorUrl() + "/" + RECOVERY_COORDINATOR_PATH_NAME;
}
public URI getCurrent() {
return Current.peek();
}
private void lraTracef(String reasonFormat, Object... parameters) {
if (LRALogger.logger.isTraceEnabled()) {
LRALogger.logger.tracef(reasonFormat, parameters);
}
}
private void lraTrace(URI lra, String reason) {
if (LRALogger.logger.isTraceEnabled()) {
lraTracef(lra, reason, (Object[]) null);
}
}
private void lraTracef(URI lra, String reasonFormat, Object... parameters) {
if (LRALogger.logger.isTraceEnabled()) {
lraTracef(reasonFormat + ", lra id: %s", parameters, lra);
}
}
public void close() {
}
private void throwGenericLRAException(URI lraId, int statusCode, String message, Throwable cause) throws WebApplicationException {
String errorMsg = String.format("%s: %s", lraId, message);
throw new WebApplicationException(errorMsg, cause, Response.status(statusCode).entity(errorMsg).build());
}
private Client getClient() {
return ClientBuilder.newClient();
}
}