jakarta.ws.rs.container.ResourceContext Maven / Gradle / Ivy

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

Show newest version

/*
 * Copyright (c) 2012, 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.container;

import jakarta.ws.rs.core.Context;

/**
 * The resource context provides access to instances of resource classes.
 * 
 * This interface can be injected using the {@link Context} annotation.
 * 
 * 
 * The resource context can be utilized when instances of managed resource classes are to be returned by sub-resource
 * locator methods. Such instances will be injected and managed within the declared scope just like instances of root
 * resource classes.
 * 
 *
 * @author Marek Potociar
 */
public interface ResourceContext {

    /**
     * Get a resolved instance of a resource or sub-resource class.
     * 
     * The resolved resource instance is properly initialized in the context of the current request processing scope. The
     * scope of the resolved resource instance depends on the managing container. For resources managed by JAX-RS container
     * the default scope is per-request.
     * 
     *
     * @param  the type of the resource class.
     * @param resourceClass the resource class.
     * @return an instance if it could be resolved, otherwise {@code null}.
     */
    public  T getResource(Class resourceClass);

    /**
     * Initialize the resource or sub-resource instance.
     *
     * All JAX-RS injectable fields in the resource instance will be properly initialized in the context of the current
     * request processing scope.
     *
     * @param  resource instance type.
     * @param resource resource instance.
     * @return initialized (same) resource instance.
     */
    public  T initResource(T resource);
}