SubResourceHttpMethodsTest.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.subresources;

import com.sun.jersey.api.client.ClientResponse;
import javax.ws.rs.PathParam;
import javax.ws.rs.Path;
import com.sun.jersey.impl.AbstractResourceTester;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.QueryParam;

/**
 *
 * @author Paul.Sandoz@Sun.Com
 */
public class SubResourceHttpMethodsTest extends AbstractResourceTester {
    
    public SubResourceHttpMethodsTest(String testName) {
        super(testName);
    }

    @Path("/")
    static public class SubResourceMethods {
        @GET
        public String getMe() {
            return "/";
        }

        @Path("sub")
        @GET
        public String getMeSub() {
            return "/sub";
        }

        @Path("sub/sub")
        @GET
        public String getMeSubSub() {
            return "/sub/sub";
        }
    }

    public void testSubResourceMethods() {
        initiateWebApplication(SubResourceMethods.class);

        assertEquals("/", resource("/").get(String.class));
        assertEquals("/sub", resource("/sub").get(String.class));
        assertEquals("/sub/sub", resource("/sub/sub").get(String.class));
    }

    @Path("/")
    static public class SubResourceMethodsWithTemplates {
        @GET
        public String getMe() {
            return "/";
        }

        @Path("sub{t}")
        @GET
        public String getMeSub(@PathParam("t") String t) {
            return t;
        }

        @Path("sub/{t}")
        @GET
        public String getMeSubSub(@PathParam("t") String t) {
            return t;
        }

        @Path("subunlimited{t: .*}")
        @GET
        public String getMeSubUnlimited(@PathParam("t") String t) {
            return t;
        }

        @Path("subunlimited/{t: .*}")
        @GET
        public String getMeSubSubUnlimited(@PathParam("t") String t) {
            return t;
        }
    }

    public void testSubResourceMethodsWithTemplates() {
        initiateWebApplication(SubResourceMethodsWithTemplates.class);

        assertEquals("/", resource("/").get(String.class));

        assertEquals("value", resource("/subvalue").get(String.class));
        assertEquals("a", resource("/sub/a").get(String.class));

        assertEquals("value/a", resource("/subunlimitedvalue/a").get(String.class));
        assertEquals("a/b/c/d", resource("/subunlimited/a/b/c/d").get(String.class));
    }

    @Path("/")
    static public class SubResourceMethodsWithDifferentTemplates {
        @Path("{foo}")
        @GET
        public String getFoo(@PathParam("foo") String foo) {
            return foo;
        }

        @Path("{bar}")
        @POST
        public String postBar(@PathParam("bar") String bar) {
            return bar;
        }
    }

    public void testSubResourceMethodsWithDifferentTemplates() {
        initiateWebApplication(SubResourceMethodsWithDifferentTemplates.class);

        assertEquals("foo", resource("/foo").get(String.class));
        assertEquals("bar", resource("/bar").post(String.class));
    }

    @Path("/{p}/")
    static public class SubResourceMethodWithLimitedTemplate {
        @GET
        public String getMe(@PathParam("p") String p, @QueryParam("id") String id) {
            return p + id;
        }

        @GET
        @Path("{id: .*}")
        public String getUnmatchedPath(
                @PathParam("p") String p,
                @PathParam("id") String path) {
          return path;
        }
    }

    public void testSubResourceMethodWithLimitedTemplate() {
        initiateWebApplication(SubResourceMethodWithLimitedTemplate.class);

        assertEquals("topone", resource("/top/?id=one").get(String.class));
        assertEquals("a/b/c/d", resource("/top/a/b/c/d").get(String.class));
    }

    @Path("/{p}")
    static public class SubResourceNoSlashMethodWithLimitedTemplate {
        @GET
        public String getMe(@PathParam("p") String p, @QueryParam("id") String id) {
            System.out.println(id);
            return p + id;
        }

        @GET
        @Path(value="{id: .*}")
        public String getUnmatchedPath(
                @PathParam("p") String p,
                @PathParam("id") String path) {
          return path;
        }
    }

    public void testSubResourceNoSlashMethodWithLimitedTemplate() {
        initiateWebApplication(SubResourceNoSlashMethodWithLimitedTemplate.class);

        assertEquals("topone", resource("/top?id=one").get(String.class));
        assertEquals("a/b/c/d", resource("/top/a/b/c/d").get(String.class));
    }

    @Path("/")
    static public class SubResourceWithSameTemplate {
        public static class SubResource {
            @GET
            @Path("bar")
            public String get() {
                return "BAR";
            }
        }

        @GET
        @Path("foo")
        public String get() {
            return "FOO";
        }

        @Path("foo")
        public SubResource getUnmatchedPath() {
            return new SubResource();
        }
    }

    public void testSubResourceMethodWithSameTemplate() {
        initiateWebApplication(SubResourceWithSameTemplate.class);

        assertEquals("FOO", resource("/foo").get(String.class));
        assertEquals(404, resource("/foo/bar", false).get(ClientResponse.class).getStatus());
    }

    @Path("/")
    static public class SubResourceExplicitRegex {
        @GET
        @Path("{id}")
        public String getSegment(@PathParam("id") String id) {
            return "segment: " + id;
        }

        @GET
        @Path("{id: .+}")
        public String getSegments(@PathParam("id") String id) {
            return "segments: " + id;
        }

        @GET
        @Path("digit/{id: \\d+}")
        public String getDigit(@PathParam("id") int id) {
            return "digit: " + id;
        }

        @GET
        @Path("digit/{id}")
        public String getDigitAnything(@PathParam("id") String id) {
            return "anything: " + id;
        }
    }

    public void testSubResource() {
        initiateWebApplication(SubResourceExplicitRegex.class);

        assertEquals("segments: foo", resource("/foo").get(String.class));
        assertEquals("segments: foo/bar", resource("/foo/bar").get(String.class));

        assertEquals("digit: 123", resource("/digit/123").get(String.class));
        assertEquals("anything: foo", resource("/digit/foo").get(String.class));
    }

    @Path("/")
    static public class SubResourceExplicitRegexCapturingGroups {
        @GET
        @Path("{a: (\\d)(\\d*)}")
        public String getSingle(@PathParam("a") int a) {
            return "" + a;
        }

        @GET
        @Path("{a: (\\d)(\\d*)}-{b: (\\d)(\\d*)}-{c: (\\d)(\\d*)}")
        public String getMultiple(
                @PathParam("a") int a,
                @PathParam("b") int b,
                @PathParam("c") int c) {
            return "" + a + "-" + b + "-" + c;
        }
    }

    public void testSubResourceCapturingGroups() {
        initiateWebApplication(SubResourceExplicitRegexCapturingGroups.class);

        assertEquals("123", resource("/123").get(String.class));
        assertEquals("123-456-789", resource("/123-456-789").get(String.class));
    }


    @Path("/")
    static public class SubResourceXXX {
        @GET
        @Path("{id}/literal")
        public String getSegment(@PathParam("id") String id) {
            return id;
        }

        @GET
        @Path("{id1}/{id2}/{id3}")
        public String getSegments(
                @PathParam("id1") String id1,
                @PathParam("id2") String id2,
                @PathParam("id3") String id3
                ) {
            return id1 + id2 + id3;
        }
    }

    public void testSubResourceXXX() {
        initiateWebApplication(SubResourceXXX.class);

        assertEquals("123", resource("/123/literal").get(String.class));
        assertEquals("123literal789", resource("/123/literal/789").get(String.class));
    }

}