jakarta.ws.rs.ext.ContextResolver 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) 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.ext;

/**
 * Contract for a provider that supplies context information to resource classes and other providers.
 *
 * A {@code ContextResolver} implementation may be annotated with {@link jakarta.ws.rs.Produces} to restrict the media
 * types for which it will be considered suitable.
 * 
 * Providers implementing {@code ContextResolver} contract must be either programmatically registered in a JAX-RS
 * runtime or must be annotated with {@link jakarta.ws.rs.ext.Provider @Provider} annotation to be automatically
 * discovered by the JAX-RS runtime during a provider scanning phase.
 * 
 *
 * @param  type of the context
 * @author Paul Sandoz
 * @author Marc Hadley
 * @see jakarta.ws.rs.core.Context
 * @see Providers#getContextResolver(Class, jakarta.ws.rs.core.MediaType)
 * @see Provider
 * @see jakarta.ws.rs.Produces
 * @since 1.0
 */
public interface ContextResolver {

    /**
     * Get a context of type {@code T} that is applicable to the supplied type.
     *
     * @param type the class of object for which a context is desired
     * @return a context for the supplied type or {@code null} if a context for the supplied type is not available from this
     * provider.
     */
    T getContext(Class type);
}