com.sun.jersey.spi.spring.container.servlet.package-info Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jersey-spring Show documentation

There is a newer version: 1.19.4

/*
 * 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 Spring-based Web applications.
 * 
 * Spring support is enabled by referencing the class
 * {@link com.sun.jersey.spi.spring.container.servlet.SpringServlet} in the
 * web.xml. For example:
 * 
 *   <web-app>
 *     <context-param>
 *       <param-name>contextConfigLocation</param-name>
 *       <param-value>classpath:applicationContext.xml</param-value>
 *     </context-param>
 *     <listener>
 *       <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
 *     </listener>
 *     <servlet>
 *       <servlet-name>Jersey Spring Web Application</servlet-name>
 *       <servlet-class>com.sun.jersey.spi.spring.container.servlet.SpringServlet</servlet-class>
 *     </servlet>
 *     <servlet-mapping>
 *       <servlet-name>Jersey Spring Web Application</servlet-name>
 *       <url-pattern>/*</url-pattern>
 *     </servlet-mapping>
 *   </web-app>
 *


 * Any root resource classes or provider classes declared by Spring (in the XML
 * configuration or by auto-wiring) will be automatically registered. It is
 * possible to intermix Spring and non-Spring registration of classes by
 * additionally using the normal Jersey-based registration mechanisms. For example,
 * in the following web.xml:
 *  *   <web-app>
 *     <context-param>
 *       <param-name>contextConfigLocation</param-name>
 *       <param-value>classpath:applicationContext.xml</param-value>
 *     </context-param>
 *     <listener>
 *       <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
 *     </listener>
 *     <servlet>
 *       <servlet-name>Jersey Spring Web Application</servlet-name>
 *       <servlet-class>com.sun.jersey.spi.spring.container.servlet.SpringServlet</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 Spring Web Application</servlet-name>
 *       <url-pattern>/*</url-pattern>
 *     </servlet-mapping>
 *   </web-app>
 * 
 * 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>
 *     <context-param>
 *       <param-name>contextConfigLocation</param-name>
 *       <param-value>classpath:applicationContext.xml</param-value>
 *     </context-param>
 *     <listener>
 *       <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
 *     </listener>
 *     <filter>
 *       <filter-name>Jersey Spring Web Application</filter-name>
 *       <filter-class>com.sun.jersey.spi.spring.container.servlet.SpringServlet</filter-class>
 *     </filter>
 *     <filter-mapping>
 *       <filter-name>Jersey Spring Web Application</filter-name>
 *       <url-pattern>/*</url-pattern>
 *     </filter-mapping>
 *   </web-app>
 * 
 * Spring-based classes will be registered and any root resource and provider
 * classes in the package managed will also be registered. A class
 * will only be registered at most once so it does not matter if there are Spring
 * managed classes present in the managed package.
 * Components managed by Spring will not be managed by Jersey and the 
 * Jersey-based life-cycle annotations on a resource class will be ignored.
 *

* */ package com.sun.jersey.spi.spring.container.servlet;