Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
   *
   * Copyright (c) 2010-2011 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.
  */
Provides support for servlet-based and filter-based Web applications.

Web application support is enabled by referencing the servlet ServletContainer in the web.xml.

For example, the following will deploy Jersey and automatically register any root resource or provider classes present in the directory "/WEB-INF/classes" or jar files present in the directory "/WEB-INF/lib":

   <web-app>
     <servlet>
       <servlet-name>Jersey Web Application</servlet-name>
       <servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>
     </servlet>
     <servlet-mapping>
       <servlet-name>Jersey Web Application</servlet-name>
       <url-pattern>/*</url-pattern>
     </servlet-mapping>
   </web-app>
 

A deployment approach, that is more portable with respect to maven and application servers, is to declare the package names where root resource and provider classes reside. For example, the following will deploy Jersey and automatically register any root resource or provider classes present in the package "managed", or any sub-packages.

   <web-app>
     <servlet>
       <servlet-name>Jersey Web Application</servlet-name>
       <servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>
       <init-param>
           <param-name>com.sun.jersey.config.property.packages</param-name>
           <param-value>managed</param-value>
       </init-param>
     </servlet>
     <servlet-mapping>
       <servlet-name>Jersey Web Application</servlet-name>
       <url-pattern>/*</url-pattern>
     </servlet-mapping>
   </web-app>
 
The deployment approach that is portable accross JAX-RS implementations is to register an implementation of javax.ws.rs.core.Application. For example given an implementation as follows:
   package com.foo;

   import ...
 
   public class MyApplicaton extends Application {
       public Set<Class<?>> getClasses() {
           Set<Class<?>> s = new HashSet<Class<?>>();
           s.add(HelloWorldResource.class);
           return s;
       }
   }
 
then that implementation can be registered as follows:
   <web-app>
     <servlet>
       <servlet-name>Jersey Web Application</servlet-name>
       <servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>
       <init-param>
           <param-name>javax.ws.rs.Application</param-name>
           <param-value>com.foo.MyApplication</param-value>
       </init-param>
     </servlet>
     <servlet-mapping>
       <servlet-name>Jersey Web Application</servlet-name>
       <url-pattern>/*</url-pattern>
     </servlet-mapping>
   </web-app>
 
It is possible to combine package-based registration and javax.ws.rs.core.Application registered by extending com.sun.jersey.api.core.PackagesResourceConfig and registering the extended class, for example:
   public class MyApplication extends PackagesResourceConfig {
       public MyApplication() {
           super("org.foo.rest;org.bar.rest");
       }
   }
 
The above examples apply to Servlet-based configurations but they equally applicable to Filter-based configurations. For example, the following presents the same package-based configuration as above but utilizing a filter:
   <web-app>
     <filter>
       <filter-name>Jersey Web Application</filter-name>
       <filter-class>com.sun.jersey.spi.container.servlet.ServletContainer</filter-class>
       <init-param>
           <param-name>com.sun.jersey.config.property.packages</param-name>
           <param-value>managed</param-value>
       </init-param>
     </filter>
     <filter-mapping>
       <filter-name>Jersey Web Application</filter-name>
       <url-pattern>/*</url-pattern>
     </filter-mapping>
   </web-app>
 
package com.sun.jersey.spi.container.servlet;
New to GrepCode? Check out our FAQ X