FormParamTest.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2010 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
 * https://glassfish.dev.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 com.sun.jersey.impl.methodparams;

import com.sun.jersey.api.client.ClientResponse;
import com.sun.jersey.api.client.WebResource;
import com.sun.jersey.api.container.ContainerException;
import com.sun.jersey.api.core.InjectParam;
import com.sun.jersey.api.representation.Form;
import com.sun.jersey.core.header.FormDataContentDisposition;
import com.sun.jersey.impl.AbstractResourceTester;
import java.math.BigDecimal;
import java.util.Date;
import java.util.List;
import javax.mail.internet.MimeMultipart;
import javax.ws.rs.Consumes;
import javax.ws.rs.DefaultValue;
import javax.ws.rs.FormParam;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.UriInfo;
import javax.xml.bind.annotation.XmlRootElement;

/**
 *
 * @author Paul.Sandoz@Sun.Com
 */
public class FormParamTest extends AbstractResourceTester {

    public FormParamTest(String testName) {
        super(testName);
    }

    @Path("/")
    public static class FormResourceNoConsumes {
        @POST
        public String post(
                @FormParam("a") String a,
                MultivaluedMap<String, String> form) {
            assertEquals(a, form.getFirst("a"));
            return a;
        }
    }

    public void testFormResourceNoConsumes() {
        initiateWebApplication(FormResourceNoConsumes.class);

        WebResource r = resource("/");

        Form form = new Form();
        form.add("a", "foo");

        String s = r.type(MediaType.APPLICATION_OCTET_STREAM_TYPE).post(String.class, form);
        assertEquals("foo", s);
    }

    @XmlRootElement
    public static class JAXBBean {

        public String value;

        public JAXBBean() {}

        public boolean equals(Object o) {
            if (!(o instanceof JAXBBean))
                return false;
            return ((JAXBBean) o).value.equals(value);
        }

        public String toString() {
            return "JAXBClass: "+value;
        }
    }

    @Path("/")
    public static class FormResourceX {
        @POST
        @Consumes(MediaType.APPLICATION_FORM_URLENCODED)
        public String post(
                @FormParam("a") String a,
                @FormParam("b") String b,
                MultivaluedMap<String, String> form,
                @Context UriInfo ui,
                @QueryParam("a") String qa) {
            assertEquals(a, form.getFirst("a"));
            assertEquals(b, form.getFirst("b"));
            return a + b;
        }
    }

    @Path("/")
    public static class FormResourceY {
        @POST
        @Consumes(MediaType.APPLICATION_FORM_URLENCODED)
        public String post(
                @FormParam("a") String a,
                @FormParam("b") String b,
                Form form,
                @Context UriInfo ui,
                @QueryParam("a") String qa) {
            assertEquals(a, form.getFirst("a"));
            assertEquals(b, form.getFirst("b"));
            return a + b;
        }
    }

    public void testFormParamX() {
        initiateWebApplication(FormResourceX.class);

        WebResource r = resource("/");

        Form form = new Form();
        form.add("a", "foo");
        form.add("b", "bar");

        String s = r.post(String.class, form);
        assertEquals("foobar", s);
    }

    public void testFormParamY() {
        initiateWebApplication(FormResourceY.class);

        WebResource r = resource("/");

        Form form = new Form();
        form.add("a", "foo");
        form.add("b", "bar");

        String s = r.post(String.class, form);
        assertEquals("foobar", s);
    }

    @Path("/")
    public static class FormParamTypes
    {
        @POST
        @Consumes(MediaType.APPLICATION_FORM_URLENCODED)
        public String createSubscription(
                @FormParam("int") int i,
                @FormParam("float") float f,
                @FormParam("decimal") BigDecimal d
                ) {
            return "" + i + " " + f + " " + d;
        }
    }

    public void testFormParamTypes() {
        initiateWebApplication(FormParamTypes.class);

        WebResource r = resource("/");

        Form form = new Form();
        form.add("int", "1");
        form.add("float", "3.14");
        form.add("decimal", "3.14");

        String s = r.post(String.class, form);
        assertEquals("1 3.14 3.14", s);
    }

    @Path("/")
    public static class FormDefaultValueParamTypes
    {
        @POST
        @Consumes(MediaType.APPLICATION_FORM_URLENCODED)
        public String createSubscription(
                @DefaultValue("1") @FormParam("int") int i,
                @DefaultValue("3.14") @FormParam("float") float f,
                @DefaultValue("3.14") @FormParam("decimal") BigDecimal d
                ) {
            return "" + i + " " + f + " " + d;
        }
    }

    public void testFormDefaultValueParamTypes() {
        initiateWebApplication(FormDefaultValueParamTypes.class);

        WebResource r = resource("/");

        Form form = new Form();

        String s = r.post(String.class, form);
        assertEquals("1 3.14 3.14", s);
    }


    public static class TrimmedString {
       private final String string;

       public TrimmedString(String string) {
          this.string = string.trim();
       }

       @Override
       public String toString() {
          return string;
       }
    }

    @Path("/")
    public static class FormConstructorValueParamTypes
    {
        @POST
        @Consumes(MediaType.APPLICATION_FORM_URLENCODED)
        public String createSubscription(
                @DefaultValue("") @FormParam("trim") TrimmedString s) {
            return s.toString();
        }
    }

    public void testFormConstructorValueParamTypes() {
        initiateWebApplication(FormConstructorValueParamTypes.class);

        WebResource r = resource("/");

        Form form = new Form();

        String s = r.post(String.class, form);
        assertEquals("", s);
    }


    @Path("/")
    public static class MultipartFormResourceX {
        @POST
        @Consumes({"multipart/form-data", MediaType.APPLICATION_FORM_URLENCODED})
        public String post(
                @FormParam("a") String a,
                @FormParam("b") String b,
                @FormParam("c") JAXBBean c,
                @FormParam("c") FormDataContentDisposition cdc,
                MimeMultipart m,
                @Context UriInfo ui,
                @QueryParam("a") String qa) throws Exception {
            assertEquals(3, m.getCount());
            return a + b + cdc.getFileName();
        }
    }

    @Path("/")
    public static class FormResourceJAXB {
        @POST
        @Consumes(MediaType.APPLICATION_FORM_URLENCODED)
        public JAXBBean post(
                @FormParam("a") JAXBBean a,
                @FormParam("b") List<JAXBBean> b) {
            assertEquals("a", a.value);
            assertEquals(2, b.size());
            assertEquals("b1", b.get(0).value);
            assertEquals("b2", b.get(1).value);
            return a;
        }
    }

    public void testFormParamJAXB() {
        initiateWebApplication(FormResourceJAXB.class);

        WebResource r = resource("/");

        Form form = new Form();
        form.add("a", "<jaxbBean><value>a</value></jaxbBean>");
        form.add("b", "<jaxbBean><value>b1</value></jaxbBean>");
        form.add("b", "<jaxbBean><value>b2</value></jaxbBean>");

        JAXBBean b = r.post(JAXBBean.class, form);
        assertEquals("a", b.value);
    }

    public void testFormParamJAXBError() {
        initiateWebApplication(FormResourceJAXB.class);

        WebResource r = resource("/", false);

        Form form = new Form();
        form.add("a", "<x><value>a</value></jaxbBean>");
        form.add("b", "<x><value>b1</value></jaxbBean>");
        form.add("b", "<x><value>b2</value></jaxbBean>");

        ClientResponse cr = r.post(ClientResponse.class, form);
        assertEquals(400, cr.getStatus());
    }

    @Path("/")
    public static class FormResourceDate {
        @POST
        @Consumes(MediaType.APPLICATION_FORM_URLENCODED)
        public String post(
                @FormParam("a") Date a,
                @FormParam("b") Date b,
                @FormParam("c") Date c) {
            assertNotNull(a);
            assertNotNull(b);
            assertNotNull(c);
            return "POST";
        }
    }

    public void testFormParamDate() {
        initiateWebApplication(FormResourceDate.class);

        WebResource r = resource("/");

        String date_RFC1123 = "Sun, 06 Nov 1994 08:49:37 GMT";
        String date_RFC1036 = "Sunday, 06-Nov-94 08:49:37 GMT";
        String date_ANSI_C = "Sun Nov  6 08:49:37 1994";

        Form form = new Form();
        form.add("a", date_RFC1123);
        form.add("b", date_RFC1036);
        form.add("c", date_ANSI_C);

        String b = r.post(String.class, form);
        assertEquals("POST", b);
    }

    public static class ParamBean {
        @FormParam("a") String a;

        @FormParam("b") String b;

        @Context UriInfo ui;

        @QueryParam("a") String qa;
    }

    @Path("/")
    public static class FormResourceBean {
        @POST
        @Consumes(MediaType.APPLICATION_FORM_URLENCODED)
        public String post(
                @InjectParam ParamBean pb,
                @FormParam("a") String a,
                @FormParam("b") String b,
                Form form) {
            assertEquals(pb.a, form.getFirst("a"));
            assertEquals(pb.b, form.getFirst("b"));
            return pb.a + pb.b;
        }
    }

    public void testFormParamBean() {
        initiateWebApplication(FormResourceBean.class);

        WebResource r = resource("/");

        Form form = new Form();
        form.add("a", "foo");
        form.add("b", "bar");

        String s = r.post(String.class, form);
        assertEquals("foobar", s);
    }

    @Path("/")
    public static class FormResourceBeanNoFormParam {
        @POST
        @Consumes(MediaType.APPLICATION_FORM_URLENCODED)
        public String post(@InjectParam ParamBean pb) {
            return pb.a + pb.b;
        }
    }

    public void testFormParamBeanNoFormParam() {
        initiateWebApplication(FormResourceBeanNoFormParam.class);

        WebResource r = resource("/");

        Form form = new Form();
        form.add("a", "foo");
        form.add("b", "bar");

        String s = r.post(String.class, form);
        assertEquals("foobar", s);
    }

    @Path("/")
    public static class FormResourceBeanConstructor {
        private final ParamBean pb;

        public FormResourceBeanConstructor(@InjectParam ParamBean pb) {
            this.pb = pb;
        }

        @GET
        public String get() {
            return "GET";
        }
        
        @POST
        @Consumes(MediaType.TEXT_PLAIN)
        public String postText(String s) {
            return s;
        }
        
        @POST
        @Consumes(MediaType.APPLICATION_FORM_URLENCODED)
        public String post(String s) {
            assertTrue(s.contains("a=foo"));
            assertTrue(s.contains("b=bar"));

            return pb.a + pb.b;
        }
    }

    public void testFormParamBeanConstructor() {
        initiateWebApplication(FormResourceBeanConstructor.class);

        WebResource r = resource("/");

        Form form = new Form();
        form.add("a", "foo");
        form.add("b", "bar");

        String s = r.post(String.class, form);
        assertEquals("foobar", s);
    }

    public void testFormParamBeanConstructorIllegalState() {
        initiateWebApplication(FormResourceBeanConstructor.class);

        WebResource r = resource("/");

        boolean caught = false;
        try {
            ClientResponse cr = r.get(ClientResponse.class);
        } catch (ContainerException ex) {
            assertEquals(IllegalStateException.class, ex.getCause().getCause().getClass());
            caught = true;
        }
        assertTrue(caught);


        caught = false;
        try {
            ClientResponse cr = r.post(ClientResponse.class, "text");
        } catch (ContainerException ex) {
            assertEquals(IllegalStateException.class, ex.getCause().getCause().getClass());
            caught = true;
        }
        assertTrue(caught);
    }


    @Path("/")
    public static class FormResourceBeanConstructorFormParam {
        private final ParamBean pb;

        public FormResourceBeanConstructorFormParam(@InjectParam ParamBean pb) {
            this.pb = pb;
        }

        @POST
        @Consumes(MediaType.APPLICATION_FORM_URLENCODED)
        public String post(
                @FormParam("a") String a,
                @FormParam("b") String b,
                Form form) {
            assertEquals(a, form.getFirst("a"));
            assertEquals(b, form.getFirst("b"));
            return a + b;
        }
    }

    public void testFormParamBeanConstructorFormParam() {
        initiateWebApplication(FormResourceBeanConstructorFormParam.class);

        WebResource r = resource("/");

        Form form = new Form();
        form.add("a", "foo");
        form.add("b", "bar");

        String s = r.post(String.class, form);
        assertEquals("foobar", s);
    }
}