AnnotatedEntityTest.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2012-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;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.util.concurrent.ExecutionException;

import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.HttpHeaders;

import org.glassfish.jersey.server.model.ModelValidationException;

import org.junit.Test;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.fail;

/**
 * Tests entity parameter annotated with non injection annotations.
 *
 * @author Miroslav Fuksa
 *
 */
public class AnnotatedEntityTest {

    private ApplicationHandler createApplication(Class<?>... rc) {
        final ResourceConfig resourceConfig = new ResourceConfig(rc);
        return new ApplicationHandler(resourceConfig);
    }

    @Test
    public void testEntityAnnotated() throws ExecutionException, InterruptedException {
        ApplicationHandler app = createApplication(Resource.class);

        ContainerResponse res = app.apply(RequestContextBuilder.from("/resource/pathParam?query=queryParam",
                "POST").entity("entity").build()).get();
        assertEquals(200, res.getStatus());
        assertEquals("entity", res.getEntity());
    }

    @Test
    public void testAllAnnotated() throws ExecutionException, InterruptedException {
        ApplicationHandler app = createApplication(Resource.class);

        ContainerResponse res = app.apply(RequestContextBuilder.from("/resource/pathParam/allAnnotated?query=queryParam",
                "POST").entity("entity").build()).get();
        assertEquals(200, res.getStatus());
        assertEquals("entity", res.getEntity());
    }

    @Test
    public void testContextAnnotated() throws ExecutionException, InterruptedException {
        ApplicationHandler app = createApplication(Resource.class);

        ContainerResponse res = app.apply(RequestContextBuilder.from("/resource/pathParam/context?query=queryParam",
                "POST").entity("entity").build()).get();
        assertEquals(200, res.getStatus());
        assertEquals("entity", res.getEntity());
    }

    @Test
    public void testAmbiguousEntityParameter() throws ExecutionException, InterruptedException {
        try {
            ApplicationHandler app = createApplication(WrongResource.class);
            fail("Model validation should fail.");
        } catch (ModelValidationException ex) {
            // ok - should be thrown
        } catch (Exception e) {
            fail("ModelValidationException should be thrown.");
        }
    }

    @Retention(RetentionPolicy.RUNTIME)
    public static @interface TestAnnotation {
    }

    @Path("resource/{path}")
    public static class Resource {

        @POST
        public String postEntityAnnotated(@PathParam("path") String pathParam, @TestAnnotation String entity,
                                          @QueryParam("query") String queryParam) {

            testParameters(pathParam, entity, queryParam);
            return entity;
        }

        private void testParameters(String pathParam, String entity, String queryParam) {
            assertEquals("pathParam", pathParam);
            assertEquals("queryParam", queryParam);
            assertEquals("entity", entity);
        }

        @POST
        @Path("allAnnotated")
        public String postAllAnnotated(@TestAnnotation @PathParam("path") String pathParam, @TestAnnotation String entity,
                                       @TestAnnotation @QueryParam("query") String queryParam) {

            testParameters(pathParam, entity, queryParam);
            return entity;
        }

        @POST
        @Path("context")
        public String postContextAnnotation(@PathParam("path") String pathParam, @Context HttpHeaders headers,
                                            @TestAnnotation String entity, @QueryParam("query") String queryParam) {
            testParameters(pathParam, entity, queryParam);
            assertNotNull(headers);
            return entity;
        }
    }

    @Path("wrongResource/{path}")
    public static class WrongResource {

        @POST
        public String postEntityAnnotated(@PathParam("path") String pathParam, @TestAnnotation String ambiguousEntity,
                                          String ambiguousParameter,
                                          @QueryParam("query") String queryParam) {

            fail("Should not be called (ambiguous entity parameter).");
            return null;
        }

    }
}