All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.ws.rs.core.Application Maven / Gradle / Ivy

Go to download

A bundle project producing JAX-RS RI bundles. The primary artifact is an "all-in-one" OSGi-fied JAX-RS RI bundle (jaxrs-ri.jar). Attached to that are two compressed JAX-RS RI archives. The first archive (jaxrs-ri.zip) consists of binary RI bits and contains the API jar (under "api" directory), RI libraries (under "lib" directory) as well as all external RI dependencies (under "ext" directory). The secondary archive (jaxrs-ri-src.zip) contains buildable JAX-RS RI source bundle and contains the API jar (under "api" directory), RI sources (under "src" directory) as well as all external RI dependencies (under "ext" directory). The second archive also contains "build.xml" ANT script that builds the RI sources. To build the JAX-RS RI simply unzip the archive, cd to the created jaxrs-ri directory and invoke "ant" from the command line.

There is a newer version: 3.1.8
Show newest version
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2010-2013 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.
 */
package javax.ws.rs.core;

import java.util.Collections;
import java.util.Map;
import java.util.Set;

/**
 * Defines the components of a JAX-RS application and supplies additional
 * meta-data. A JAX-RS application or implementation supplies a concrete
 * subclass of this abstract class.
 * 

* The implementation-created instance of an Application subclass may be * injected into resource classes and providers using * {@link javax.ws.rs.core.Context}. *

*

* In case any of the {@code Application} subclass methods or it's constructor * throws a {@link RuntimeException}, the deployment of the application SHOULD * be aborted with a failure. *

* * @author Paul Sandoz * @author Marc Hadley * @author Marek Potociar * @since 1.0 */ public class Application { /** * Get a set of root resource, provider and {@link Feature feature} classes. * * The default life-cycle for resource class instances is per-request. The default * life-cycle for providers (registered directly or via a feature) is singleton. *

* Implementations should warn about and ignore classes that do not * conform to the requirements of root resource or provider/feature classes. * Implementations should warn about and ignore classes for which * {@link #getSingletons()} returns an instance. Implementations MUST * NOT modify the returned set. *

*

* The default implementation returns an empty set. *

* * @return a set of root resource and provider classes. Returning {@code null} * is equivalent to returning an empty set. */ public Set> getClasses() { return Collections.emptySet(); } /** * Get a set of root resource, provider and {@link Feature feature} instances. * * Fields and properties of returned instances are injected with their declared * dependencies (see {@link Context}) by the runtime prior to use. *

* Implementations should warn about and ignore classes that do not * conform to the requirements of root resource or provider classes. * Implementations should flag an error if the returned set includes * more than one instance of the same class. Implementations MUST * NOT modify the returned set. *

*

* The default implementation returns an empty set. *

* * @return a set of root resource and provider instances. Returning {@code null} * is equivalent to returning an empty set. */ public Set getSingletons() { return Collections.emptySet(); } /** * Get a map of custom application-wide properties. *

* The returned properties are reflected in the application {@link Configuration configuration} * passed to the server-side features or injected into server-side JAX-RS components. *

*

* The set of returned properties may be further extended or customized at deployment time * using container-specific features and deployment descriptors. For example, in a Servlet-based * deployment scenario, web application's {@code } and Servlet {@code } * values may be used to extend or override values of the properties programmatically returned * by this method. *

*

* The default implementation returns an empty set. *

* * @return a map of custom application-wide properties. Returning {@code null} * is equivalent to returning an empty set. * @since 2.0 */ public Map getProperties() { return Collections.emptyMap(); } }