ParamConverterPriorityTest.java

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

import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.List;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Application;
import javax.ws.rs.core.Response;
import javax.ws.rs.ext.ParamConverter;
import javax.ws.rs.ext.ParamConverterProvider;

import javax.annotation.Priority;

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

import org.junit.Test;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.greaterThanOrEqualTo;
import static org.hamcrest.Matchers.typeCompatibleWith;

/**
 * @author Pavel Bucek (pavel.bucek at oracle.com)
 */
public class ParamConverterPriorityTest extends JerseyTest {

    private static final List<Class<? extends ParamConverterProvider>> CONVERTER_PROVIDER_CALL_ORDER = new ArrayList<>();

    @Override
    protected Application configure() {
        return new ResourceConfig(ParamConverterPriorityResource.class,
                                  MyParamConverterProvider1.class,
                                  MyParamConverterProvider2.class,
                                  MyParamConverterProvider3.class);
    }

    @Test
    public void test() {
        Response response = target().queryParam("test", "value").request().get();

        assertThat(CONVERTER_PROVIDER_CALL_ORDER.size(), greaterThanOrEqualTo(3));
        assertThat(CONVERTER_PROVIDER_CALL_ORDER.get(0), typeCompatibleWith(MyParamConverterProvider2.class));
        assertThat(CONVERTER_PROVIDER_CALL_ORDER.get(1), typeCompatibleWith(MyParamConverterProvider1.class));
        assertThat(CONVERTER_PROVIDER_CALL_ORDER.get(2), typeCompatibleWith(MyParamConverterProvider3.class));
    }

    @Path("/")
    public static class ParamConverterPriorityResource {

        @GET
        public String get(@QueryParam("test") String param) {
            return param;
        }
    }

    @Priority(200)
    public static class MyParamConverterProvider1 implements ParamConverterProvider {
        @Override
        public <T> ParamConverter<T> getConverter(Class<T> rawType, Type genericType, Annotation[] annotations) {
            CONVERTER_PROVIDER_CALL_ORDER.add(this.getClass());
            return null;
        }
    }

    @Priority(100)
    public static class MyParamConverterProvider2 implements ParamConverterProvider {
        @Override
        public <T> ParamConverter<T> getConverter(Class<T> rawType, Type genericType, Annotation[] annotations) {
            CONVERTER_PROVIDER_CALL_ORDER.add(this.getClass());
            return null;
        }
    }

    @Priority(300)
    public static class MyParamConverterProvider3 implements ParamConverterProvider {
        @Override
        public <T> ParamConverter<T> getConverter(Class<T> rawType, Type genericType, Annotation[] annotations) {
            CONVERTER_PROVIDER_CALL_ORDER.add(this.getClass());
            return null;
        }
    }
}