io.dropwizard.jersey.validation.ConstraintMessage Maven / Gradle / Ivy
package io.dropwizard.jersey.validation;
import com.google.common.base.Joiner;
import com.google.common.base.Strings;
import com.google.common.cache.Cache;
import com.google.common.cache.CacheBuilder;
import com.google.common.collect.Iterables;
import io.dropwizard.validation.ValidationMethod;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.reflect.FieldUtils;
import org.apache.commons.lang3.tuple.Pair;
import org.glassfish.jersey.server.model.Invocable;
import org.glassfish.jersey.server.model.Parameter;
import javax.validation.ConstraintViolation;
import javax.validation.ElementKind;
import javax.validation.Path;
import javax.validation.metadata.ConstraintDescriptor;
import javax.ws.rs.CookieParam;
import javax.ws.rs.FormParam;
import javax.ws.rs.HeaderParam;
import javax.ws.rs.MatrixParam;
import javax.ws.rs.PathParam;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Context;
import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.TimeUnit;
public class ConstraintMessage {
private static final Cache>, String> MESSAGES_CACHE =
CacheBuilder.newBuilder()
.expireAfterWrite(1, TimeUnit.HOURS)
.build();
private ConstraintMessage() {
}
/**
* Gets the human friendly location of where the violation was raised.
*/
public static String getMessage(ConstraintViolation v, Invocable invocable) {
final Pair> of =
Pair.of(v.getPropertyPath(), v.getConstraintDescriptor());
final String cachedMessage = MESSAGES_CACHE.getIfPresent(of);
if (cachedMessage == null) {
final String message = calculateMessage(v, invocable);
MESSAGES_CACHE.put(of, message);
return message;
}
return cachedMessage;
}
private static String calculateMessage(ConstraintViolation v, Invocable invocable) {
final Optional returnValueName = getMethodReturnValueName(v);
if (returnValueName.isPresent()) {
final String name = isValidationMethod(v) ?
StringUtils.substringBeforeLast(returnValueName.get(), ".") : returnValueName.get();
return name + " " + v.getMessage();
}
// Take the message specified in a ValidationMethod annotation if it
// is what caused the violation
if (isValidationMethod(v)) {
return v.getMessage();
}
final Optional entity = isRequestEntity(v, invocable);
if (entity.isPresent()) {
// A present entity means that the request body failed validation but
// if the request entity is simple (eg. byte[], String, etc), the entity
// string will be empty, so prepend a message about the request body
final String prefix = Strings.isNullOrEmpty(entity.get()) ? "The request body" : entity.get();
return prefix + " " + v.getMessage();
}
// Check if the violation occurred on a *Param annotation and if so,
// return a human friendly error (eg. "Query param xxx may not be null")
final Optional memberName = getMemberName(v, invocable);
if (memberName.isPresent()) {
return memberName.get() + " " + v.getMessage();
}
return v.getPropertyPath() + " " + v.getMessage();
}
/**
* Determines if constraint violation occurred in the request entity. If it did, return a client
* friendly string representation of where the error occurred (eg. "patient.name")
*/
public static Optional isRequestEntity(ConstraintViolation violation, Invocable invocable) {
final Path.Node parent = Iterables.get(violation.getPropertyPath(), 1, null);
if (parent == null) {
return Optional.empty();
}
final List parameters = invocable.getParameters();
switch (parent.getKind()) {
case PARAMETER:
final Parameter param = parameters.get(parent.as(Path.ParameterNode.class).getParameterIndex());
if (param.getSource().equals(Parameter.Source.UNKNOWN)) {
return Optional.of(Joiner.on('.').join(Iterables.skip(violation.getPropertyPath(), 2)));
}
default:
break;
}
return Optional.empty();
}
/**
* Gets a method parameter (or a parameter field) name, if the violation raised in it.
*/
private static Optional getMemberName(ConstraintViolation violation, Invocable invocable) {
final int size = Iterables.size(violation.getPropertyPath());
if (size < 2) {
return Optional.empty();
}
final Path.Node parent = Iterables.get(violation.getPropertyPath(), size - 2);
final Path.Node member = Iterables.getLast(violation.getPropertyPath());
switch (parent.getKind()) {
case PARAMETER:
// Constraint violation most likely failed with a BeanParam
final List parameters = invocable.getParameters();
final Parameter param = parameters.get(parent.as(Path.ParameterNode.class).getParameterIndex());
// Extract the failing *Param annotation inside the Bean Param
if (param.getSource().equals(Parameter.Source.BEAN_PARAM)) {
final Field field = FieldUtils.getField(param.getRawType(), member.getName(), true);
return getMemberName(field.getDeclaredAnnotations());
}
return Optional.empty();
case METHOD:
// Constraint violation occurred directly on a function
// parameter annotated with *Param
final Method method = invocable.getHandlingMethod();
final int paramIndex = member.as(Path.ParameterNode.class).getParameterIndex();
return getMemberName(method.getParameterAnnotations()[paramIndex]);
default:
return Optional.empty();
}
}
/**
* Gets the method return value name, if the violation is raised in it
*/
private static Optional getMethodReturnValueName(ConstraintViolation violation) {
int returnValueNames = -1;
final StringBuilder result = new StringBuilder("server response");
for (Path.Node node : violation.getPropertyPath()) {
if (node.getKind().equals(ElementKind.RETURN_VALUE)) {
returnValueNames = 0;
} else if (returnValueNames >= 0) {
result.append(returnValueNames++ == 0 ? " " : ".").append(node);
}
}
return returnValueNames >= 0 ? Optional.of(result.toString()) : Optional.empty();
}
/**
* Derives member's name and type from it's annotations
*/
private static Optional getMemberName(Annotation[] memberAnnotations) {
for (Annotation a : memberAnnotations) {
if (a instanceof QueryParam) {
return Optional.of("query param " + ((QueryParam) a).value());
} else if (a instanceof PathParam) {
return Optional.of("path param " + ((PathParam) a).value());
} else if (a instanceof HeaderParam) {
return Optional.of("header " + ((HeaderParam) a).value());
} else if (a instanceof CookieParam) {
return Optional.of("cookie " + ((CookieParam) a).value());
} else if (a instanceof FormParam) {
return Optional.of("form field " + ((FormParam) a).value());
} else if (a instanceof Context) {
return Optional.of("context");
} else if (a instanceof MatrixParam) {
return Optional.of("matrix param " + ((MatrixParam) a).value());
}
}
return Optional.empty();
}
private static boolean isValidationMethod(ConstraintViolation v) {
return v.getConstraintDescriptor().getAnnotation() instanceof ValidationMethod;
}
/**
* Given a set of constraint violations and a Jersey {@link Invocable} where the constraint
* occurred, determine the HTTP Status code for the response. A return value violation is an
* internal server error, an invalid request body is unprocessable entity, and any params that
* are invalid means a bad request
*/
public static > int determineStatus(Set violations, Invocable invocable) {
if (violations.size() > 0) {
final ConstraintViolation violation = violations.iterator().next();
for (Path.Node node : violation.getPropertyPath()) {
switch (node.getKind()) {
case RETURN_VALUE:
return 500;
case PARAMETER:
// Now determine if the parameter is the request entity
final int index = node.as(Path.ParameterNode.class).getParameterIndex();
final Parameter parameter = invocable.getParameters().get(index);
return parameter.getSource().equals(Parameter.Source.UNKNOWN) ? 422 : 400;
default:
continue;
}
}
}
// This shouldn't hit, but if it does, we'll return a unprocessable entity
return 422;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy