Merge "J-443: Provide SPI for ValidationResult - added test for property injected validation result - enabled cdi field injected components to get validated - Marek review: New API renames and other minor updates (mostly checkstyle warning fixes)"

Author: Marek Potociar

core-server/src/main/java/org/glassfish/jersey/server/model/ResourceMethodInvoker.java

@@ -83,6 +83,7 @@
 import org.glassfish.jersey.server.model.internal.ResourceMethodDispatcherFactory;
 import org.glassfish.jersey.server.model.internal.ResourceMethodInvocationHandlerFactory;
 import org.glassfish.jersey.server.monitoring.RequestEvent;
+import org.glassfish.jersey.server.spi.ValidationInterceptor;
 import org.glassfish.jersey.server.spi.internal.ResourceMethodDispatcher;
 import org.glassfish.jersey.server.spi.internal.ResourceMethodInvocationHandlerProvider;
 

core-server/src/main/java/org/glassfish/jersey/server/model/internal/AbstractJavaResourceMethodDispatcher.java

@@ -39,7 +39,6 @@
  */
 package org.glassfish.jersey.server.model.internal;
 
-import java.lang.reflect.Field;
 import java.lang.reflect.InvocationHandler;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
@@ -51,7 +50,6 @@
 import javax.ws.rs.core.Response;
 import javax.ws.rs.core.SecurityContext;
 
-import javax.validation.ConstraintViolationException;
 import javax.validation.ValidationException;
 
 import org.glassfish.jersey.message.internal.TracingLogger;
@@ -85,9 +83,9 @@ abstract class AbstractJavaResourceMethodDispatcher implements ResourceMethodDis
      * @param methodHandler  method invocation handler.
      * @param validator      input/output parameter validator.
      */
-    AbstractJavaResourceMethodDispatcher(Invocable resourceMethod,
-                                         InvocationHandler methodHandler,
-                                         ConfiguredValidator validator) {
+    AbstractJavaResourceMethodDispatcher(final Invocable resourceMethod,
+                                         final InvocationHandler methodHandler,
+                                         final ConfiguredValidator validator) {
         this.method = resourceMethod.getDefinitionMethod();
         this.methodHandler = methodHandler;
         this.resourceMethod = resourceMethod;
@@ -133,25 +131,7 @@ final Object invoke(final ContainerRequest containerRequest, final Object resour
         try {
             // Validate resource class & method input parameters.
             if (validator != null) {
-                try {
-                    validator.validateResourceAndInputParams(resource, resourceMethod, args);
-                } catch (ConstraintViolationException e) {
-                    // First check for a property
-                    if (ValidationResultUtil.hasValidationResultProperty(resource)) {
-                        final Method validationResultGetter = ValidationResultUtil.getValidationResultGetter(resource);
-                        ValidationResultUtil.updateValidationResultProperty(resource, validationResultGetter,
-                                e.getConstraintViolations());
-                    } else {
-                        // Then check for a field
-                        final Field validationResult = ValidationResultUtil.getValidationResultField(resource);
-                        if (validationResult != null) {
-                            ValidationResultUtil.updateValidationResultField(resource, validationResult,
-                                    e.getConstraintViolations());
-                        } else {
-                            throw e;
-                        }
-                    }
-                }
+                validator.validateResourceAndInputParams(resource, resourceMethod, args);
             }
 
             final PrivilegedAction invokeMethodAction = new PrivilegedAction() {

core-server/src/main/java/org/glassfish/jersey/server/model/internal/JavaResourceMethodDispatcherProvider.java

@@ -51,6 +51,7 @@
 
 import org.glassfish.jersey.server.ContainerRequest;
 import org.glassfish.jersey.server.model.Invocable;
+import org.glassfish.jersey.server.spi.ValidationInterceptor;
 import org.glassfish.jersey.server.spi.internal.ParameterValueHelper;
 import org.glassfish.jersey.server.spi.internal.ResourceMethodDispatcher;
 
@@ -79,18 +80,19 @@ public ResourceMethodDispatcher create(final Invocable resourceMethod,
 
         ResourceMethodDispatcher resourceMethodDispatcher;
         if (Response.class.isAssignableFrom(returnType)) {
-            resourceMethodDispatcher = new ResponseOutInvoker(resourceMethod, invocationHandler, valueProviders, validator);
-// TODO should we support JResponse?
-//        } else if (JResponse.class.isAssignableFrom(returnType)) {
-//            return new JResponseOutInvoker(resourceMethod, pp, invocationHandler);
+            resourceMethodDispatcher =
+                    new ResponseOutInvoker(resourceMethod, invocationHandler, valueProviders, validator);
         } else if (returnType != void.class) {
             if (returnType == Object.class || GenericEntity.class.isAssignableFrom(returnType)) {
-                resourceMethodDispatcher = new ObjectOutInvoker(resourceMethod, invocationHandler, valueProviders, validator);
+                resourceMethodDispatcher =
+                        new ObjectOutInvoker(resourceMethod, invocationHandler, valueProviders, validator);
             } else {
-                resourceMethodDispatcher = new TypeOutInvoker(resourceMethod, invocationHandler, valueProviders, validator);
+                resourceMethodDispatcher =
+                        new TypeOutInvoker(resourceMethod, invocationHandler, valueProviders, validator);
             }
         } else {
-            resourceMethodDispatcher = new VoidOutInvoker(resourceMethod, invocationHandler, valueProviders, validator);
+            resourceMethodDispatcher
+                    = new VoidOutInvoker(resourceMethod, invocationHandler, valueProviders, validator);
         }
 
         // Inject validator.

core-server/src/main/java/org/glassfish/jersey/server/model/internal/ResourceMethodDispatcherFactory.java

@@ -51,6 +51,7 @@
 import org.glassfish.jersey.server.internal.LocalizationMessages;
 import org.glassfish.jersey.server.internal.inject.ConfiguredValidator;
 import org.glassfish.jersey.server.model.Invocable;
+import org.glassfish.jersey.server.spi.ValidationInterceptor;
 import org.glassfish.jersey.server.spi.internal.ResourceMethodDispatcher;
 
 import org.glassfish.hk2.api.ServiceLocator;

core-server/src/main/java/org/glassfish/jersey/server/model/internal/VoidVoidDispatcherProvider.java

@@ -51,6 +51,7 @@
 import org.glassfish.jersey.server.ContainerRequest;
 import org.glassfish.jersey.server.internal.inject.ConfiguredValidator;
 import org.glassfish.jersey.server.model.Invocable;
+import org.glassfish.jersey.server.spi.ValidationInterceptor;
 import org.glassfish.jersey.server.spi.internal.ResourceMethodDispatcher;
 
 /**

core-server/src/main/java/org/glassfish/jersey/server/spi/ValidationInterceptor.java

@@ -0,0 +1,82 @@
+/*
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
+ *
+ * Copyright (c) 2015 Oracle and/or its affiliates. All rights reserved.
+ *
+ * The contents of this file are subject to the terms of either the GNU
+ * General Public License Version 2 only ("GPL") or the Common Development
+ * and Distribution License("CDDL") (collectively, the "License").  You
+ * may not use this file except in compliance with the License.  You can
+ * obtain a copy of the License at
+ * http://glassfish.java.net/public/CDDL+GPL_1_1.html
+ * or packager/legal/LICENSE.txt.  See the License for the specific
+ * language governing permissions and limitations under the License.
+ *
+ * When distributing the software, include this License Header Notice in each
+ * file and include the License file at packager/legal/LICENSE.txt.
+ *
+ * GPL Classpath Exception:
+ * Oracle designates this particular file as subject to the "Classpath"
+ * exception as provided by Oracle in the GPL Version 2 section of the License
+ * file that accompanied this code.
+ *
+ * Modifications:
+ * If applicable, add the following below the License Header, with the fields
+ * enclosed by brackets [] replaced by your own identifying information:
+ * "Portions Copyright [year] [name of copyright owner]"
+ *
+ * Contributor(s):
+ * If you wish your version of this file to be governed by only the CDDL or
+ * only the GPL Version 2, indicate your decision by adding "[Contributor]
+ * elects to include this software in this distribution under the [CDDL or GPL
+ * Version 2] license."  If you don't indicate a single choice of license, a
+ * recipient has the option to distribute your version of this file under
+ * either the CDDL, the GPL Version 2 or to extend the choice of license to
+ * its licensees as provided above.  However, if you add GPL Version 2 code
+ * and therefore, elected the GPL Version 2 license, then the option applies
+ * only if the new code is made subject to such option by the copyright
+ * holder.
+ */
+package org.glassfish.jersey.server.spi;
+
+import javax.validation.ConstraintViolationException;
+import javax.validation.ValidationException;
+
+import org.glassfish.jersey.spi.Contract;
+
+/**
+ * Interceptor for method validation processing.
+ *
+ * Allows to override the default Jersey behaviour. By default, the Jersey runtime throws a
+ * {@link javax.validation.ValidationException} or one of its subclasses,
+ * that gets mapped to a HTTP 400 response, if any validation issues occur. In such case
+ * the actual resource method does not get invoked at all.
+ * <p>
+ * Validation interceptor implementation allows to e.g. swallow the {@link ConstraintViolationException}
+ * and handle the validation issues in the resource method. It is also possible to tweak
+ * validated components. This could be utilized in case of proxied resources,
+ * when field validation is not possible on a dynamic proxy, and the validator requires
+ * the original delegated instance.
+ * </p>
+ * <p>
+ * Each validation interceptor implementation must invoke proceed
+ * method on provided interceptor context as part of interception processing.
+ * </p>
+ *
+ * @author Jakub Podlesak (jakub.podleak at oracle.com)
+ * @since 2.18
+ */
+@Contract
+public interface ValidationInterceptor {
+
+    /**
+     * Used to intercept resource method validation processing.
+     * <p/>
+     * To allow further validation processing, every and each implementation
+     * must invoke {@link ValidationInterceptorContext#proceed()} method.
+     *
+     * @param context method validation context.
+     * @throws ValidationException in case the validation exception should be thrown as a result of the validation processing.
+     */
+    public void onValidate(ValidationInterceptorContext context) throws ValidationException;
+}

core-server/src/main/java/org/glassfish/jersey/server/spi/ValidationInterceptorContext.java

@@ -0,0 +1,100 @@
+/*
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
+ *
+ * Copyright (c) 2015 Oracle and/or its affiliates. All rights reserved.
+ *
+ * The contents of this file are subject to the terms of either the GNU
+ * General Public License Version 2 only ("GPL") or the Common Development
+ * and Distribution License("CDDL") (collectively, the "License").  You
+ * may not use this file except in compliance with the License.  You can
+ * obtain a copy of the License at
+ * http://glassfish.java.net/public/CDDL+GPL_1_1.html
+ * or packager/legal/LICENSE.txt.  See the License for the specific
+ * language governing permissions and limitations under the License.
+ *
+ * When distributing the software, include this License Header Notice in each
+ * file and include the License file at packager/legal/LICENSE.txt.
+ *
+ * GPL Classpath Exception:
+ * Oracle designates this particular file as subject to the "Classpath"
+ * exception as provided by Oracle in the GPL Version 2 section of the License
+ * file that accompanied this code.
+ *
+ * Modifications:
+ * If applicable, add the following below the License Header, with the fields
+ * enclosed by brackets [] replaced by your own identifying information:
+ * "Portions Copyright [year] [name of copyright owner]"
+ *
+ * Contributor(s):
+ * If you wish your version of this file to be governed by only the CDDL or
+ * only the GPL Version 2, indicate your decision by adding "[Contributor]
+ * elects to include this software in this distribution under the [CDDL or GPL
+ * Version 2] license."  If you don't indicate a single choice of license, a
+ * recipient has the option to distribute your version of this file under
+ * either the CDDL, the GPL Version 2 or to extend the choice of license to
+ * its licensees as provided above.  However, if you add GPL Version 2 code
+ * and therefore, elected the GPL Version 2 license, then the option applies
+ * only if the new code is made subject to such option by the copyright
+ * holder.
+ */
+package org.glassfish.jersey.server.spi;
+
+import javax.validation.ValidationException;
+
+import org.glassfish.jersey.server.model.Invocable;
+
+/**
+ * Context for resource method validation interception processing (see {@link ValidationInterceptor}).
+ * The context gives access to key validation data.
+ * It also allows interceptor implementation to tweak resource and/or parameters that are going to be validated.
+ *
+ * @author Jakub Podlesak (jakub.podlesak at oracle.com)
+ * @see ValidationInterceptor
+ * @since 2.18
+ */
+public interface ValidationInterceptorContext {
+
+    /**
+     * Provide actual resource instance that will get validated.
+     *
+     * @return current resource instance.
+     */
+    public Object getResource();
+
+    /**
+     * Setter for resource instance that should get validated.
+     *
+     * @param resource instance to validate
+     */
+    public void setResource(Object resource);
+
+    /**
+     * Provide invocable for which validation will been done.
+     *
+     * @return actual invocable instance.
+     */
+    public Invocable getInvocable();
+
+    /**
+     * Provide method parameters for which validation will be done.
+     *
+     * @return actual method parameters.
+     */
+    public Object[] getArgs();
+
+    /**
+     * Method parameters setter.
+     *
+     * @param args method parameters to be used for validation.
+     */
+    public void setArgs(Object[] args);
+
+    /**
+     * Proceed with validation.
+     *
+     * This method must be invoked by a validation interceptor implementation.
+     *
+     * @throws javax.validation.ValidationException in case the further validation processing failed with a validation error.
+     */
+    public void proceed() throws ValidationException;
+}

core-server/src/main/java/org/glassfish/jersey/server/spi/internal/ResourceMethodDispatcher.java

@@ -40,6 +40,7 @@
 package org.glassfish.jersey.server.spi.internal;
 
 import java.lang.reflect.InvocationHandler;
+import java.util.List;
 
 import javax.ws.rs.ProcessingException;
 import javax.ws.rs.core.Request;
@@ -49,6 +50,7 @@
 import org.glassfish.jersey.server.internal.inject.ConfiguredValidator;
 import org.glassfish.jersey.server.internal.process.MappableException;
 import org.glassfish.jersey.server.model.Invocable;
+import org.glassfish.jersey.server.spi.ValidationInterceptor;
 
 /**
  * A resource method dispatcher responsible for consuming a JAX-RS {@link Request request}