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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jaxrs-ri Show documentation

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.9

Show newest version

/*
 * Copyright (c) 2010, 2019 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package jakarta.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 jakarta.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.
     * @deprecated Automatic discovery of resources and providers or the {@code getClasses} method is preferred over
      * {@code getSingletons}.
     */
    @Deprecated
    public Set