package-info.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2011-2014 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.
 */
/**
 * Jersey test framework common classes that support testing JAX-RS and Jersey-based applications.
 *
 * The {@link org.glassfish.jersey.test.JerseyTest} class may be extended to define the testing
 * configuration and functionality.
 * <p>
 * For example, the following class is configured to use Grizzly HTTP test container factory,
 * {@code org.glassfish.jersey.test.grizzly.GrizzlyTestContainerFactory} and test that a simple resource
 * {@code TestResource} returns the expected results for a HTTP GET request:
 * </p>
 * <pre>
 * public class SimpleGrizzlyBasedTest extends JerseyTest {
 *
 *   @Path("root")
 *   public static class TestResource {
 *     @GET
 *     public String get() {
 *       return "GET";
 *     }
 *   }
 *
 *   @Override
 *   protected Application configure() {
 *     enable(TestProperties.LOG_TRAFFIC);
 *     return new ResourceConfig(TestResource.class);
 *   }
 *
 *   @Override
 *   protected TestContainerFactory getTestContainerFactory() {
 *     return new GrizzlyTestContainerFactory();
 *   }
 *
 *   @Test
 *   public void testGet() {
 *     WebTarget t = target("root");
 *
 *     String s = t.request().get(String.class);
 *     Assert.assertEquals("GET", s);
 *   }
 * }
 * </pre>
 * <p>
 * The following tests the same functionality using the Servlet-based Grizzly test container factory,
 * {@code org.glassfish.jersey.test.grizzly.GrizzlyWebTestContainerFactory}:
 * </p>
 * <pre>
 * public class WebBasedTest extends JerseyTest {
 *
 *   @Path("root")
 *   public static class TestResource {
 *     @GET
 *     public String get() {
 *       return "GET";
 *     }
 *   }
 *
 *   @Override
 *   protected DeploymentContext configureDeployment() {
 *     return ServletDeploymentContext.builder("foo")
 *             .contextPath("context").build();
 *   }
 *
 *   @Override
 *   protected TestContainerFactory getTestContainerFactory() {
 *     return new GrizzlyTestContainerFactory();
 *   }
 *
 *   @Test
 *   public void testGet() {
 *     WebTarget t = target("root");
 *
 *     String s = t.request().get(String.class);
 *     Assert.assertEquals("GET", s);
 *   }
 * }
 * </pre>
 * <p>
 * The above test is actually not specific to any Servlet-based test container factory and will work for all
 * provided test container factories. See the documentation on {@link org.glassfish.jersey.test.JerseyTest} for
 * more details on how to set the default test container factory.
 * </p>
 */
package org.glassfish.jersey.test;