ConstructorSelectionTest.java

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

import java.io.IOException;
import java.io.InputStream;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;

import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.client.Entity;
import javax.ws.rs.core.Application;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.Request;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.UriInfo;
import javax.ws.rs.ext.MessageBodyReader;
import javax.ws.rs.ext.Provider;
import javax.ws.rs.ext.Providers;

import org.glassfish.jersey.server.ResourceConfig;
import org.glassfish.jersey.test.JerseyTest;

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

/**
 * Test to verify the proper constructor is selected.
 *
 * @author Marek Potociar (marek.potociar at oracle.com)
 */
public class ConstructorSelectionTest extends JerseyTest {

    /**
     * A resource with multiple constructors.
     */
    @Path("resource-test")
    public static class MultipleConstructorResource {
        private HttpHeaders headers;
        private UriInfo info;
        private Application application;
        private Request request;
        private Providers provider;

        public MultipleConstructorResource(){
        }

        public MultipleConstructorResource(@Context HttpHeaders headers){
            this.headers = headers;
        }


        public MultipleConstructorResource(@Context HttpHeaders headers,
                                           @Context UriInfo info){
            this.headers = headers;
            this.info = info;
        }

        public MultipleConstructorResource(@Context HttpHeaders headers,
                                           @Context UriInfo info,
                                           @Context Application application){
            this.application = application;
            this.headers = headers;
            this.info = info;
        }

        public MultipleConstructorResource(@Context HttpHeaders headers,
                                           @Context UriInfo info,
                                           @Context Application application,
                                           @Context Request request){
            this.application = application;
            this.headers = headers;
            this.info = info;
            this.request = request;
        }

        protected MultipleConstructorResource(@Context HttpHeaders headers,
                                              @Context UriInfo info,
                                              @Context Application application,
                                              @Context Request request,
                                              @Context Providers provider){
            this.application = application;
            this.headers = headers;
            this.info = info;
            this.request = request;
            this.provider = provider;
        }

        @GET
        public Response isUsedConstructorWithMostAttributes(){
            boolean ok = application != null;
            ok &= headers != null;
            ok &= info != null;
            ok &= request != null;
            ok &= provider == null;
            Response.Status status = ok ? Response.Status.OK : Response.Status.INTERNAL_SERVER_ERROR;
            return Response.status(status).build();
        }
    }

    /**
     * Provider with multiple constructors.
     */
    @Provider
    @Consumes(MediaType.TEXT_PLAIN)
    public static class StringReader implements MessageBodyReader<String> {
        private HttpHeaders headers;
        private UriInfo info;
        private Application application;
        private Request request;
        private Providers providers;

        protected StringReader(@Context HttpHeaders headers, @Context UriInfo info,
                               @Context Application application, @Context Request request,
                               @Context Providers providers) {
            super();
            this.headers = headers;
            this.info = info;
            this.application = application;
            this.request = request;
            this.providers = providers;
        }

        public StringReader(@Context HttpHeaders headers, @Context UriInfo info,
                            @Context Application application, @Context Request request) {
            super();
            this.headers = headers;
            this.info = info;
            this.application = application;
            this.request = request;
        }

        public StringReader(@Context HttpHeaders headers, @Context UriInfo info,
                            @Context Application application) {
            super();
            this.headers = headers;
            this.info = info;
            this.application = application;
        }

        public StringReader(@Context HttpHeaders headers, @Context UriInfo info) {
            super();
            this.headers = headers;
            this.info = info;
        }

        public StringReader(@Context HttpHeaders headers) {
            super();
            this.headers = headers;
        }

        @Override
        public boolean isReadable(Class<?> type, Type genericType,
                                  Annotation[] annotations, MediaType mediaType) {
            return type == String.class;
        }

        @Override
        public String readFrom(Class<String> type, Type genericType,
                               Annotation[] annotations, MediaType mediaType,
                               MultivaluedMap<String, String> httpHeaders, InputStream entityStream)
                throws IOException, WebApplicationException {
            if (headers == null || info == null || application == null || request == null || providers != null) {
                return "fail";
            }
            return "pass";
        }
    }

    @Path("provider-test")
    public static class ProviderResource {

        @POST
        public String echo(String entity) {
            return entity;
        }

    }

    @Override
    protected Application configure() {
        return new ResourceConfig(MultipleConstructorResource.class, ProviderResource.class, StringReader.class);
    }

    /**
     * JERSEY-1529 reproducer.
     */
    @Test
    public void testResourceConstructorSelection() {
        final Response response = target("resource-test").request().get();

        assertNotNull("Returned response must not be null.", response);
        assertEquals("Resource constructor with most arguments has not been selected.", 200, response.getStatus());
    }

    /**
     * JERSEY-1712 reproducer.
     */
    @Test
    public void testProviderConstructorSelection() {
        final Response response = target("provider-test").request().post(Entity.text("echo"));

        assertNotNull("Returned response must not be null.", response);
        assertEquals(200, response.getStatus());
        assertEquals("pass", response.readEntity(String.class));
    }
}