jakarta.ws.rs.ConstrainedTo 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.8

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;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Indicates the run-time context in which an annotated JAX-RS provider is applicable. If a {@code @ConstrainedTo}
 * annotation is not present on a JAX-RS provider type declaration, the declared provider may be used in any run-time
 * context. If such a annotation is present, the JAX-RS runtime will enforce the specified usage restriction.
 * 
 * The following example illustrates restricting a {@link jakarta.ws.rs.ext.MessageBodyReader} provider implementation to
 * run only as part of a {@link RuntimeType#CLIENT JAX-RS client run-time}:
 * 
 *
 *  *  @ConstrainedTo(RuntimeType.CLIENT)
 *  public class MyReader implements MessageBodyReader {
 *      ...
 *  }
 * 
 * 
 * The following example illustrates restricting a {@link jakarta.ws.rs.ext.WriterInterceptor} provider implementation to
 * run only as part of a {@link RuntimeType#SERVER JAX-RS server run-time}:
 * 
 *
 *  *  @ConstrainedTo(RuntimeType.SERVER)
 *  public class MyWriterInterceptor implements WriterInterceptor {
 *      ...
 *  }
 * 
 * 
 * It is a configuration error to constraint a JAX-RS provider implementation to a run-time context in which the
 * provider cannot be applied. In such case a JAX-RS runtime SHOULD inform a user about the issue and ignore the
 * provider implementation in further processing.
 * 
 * 
 * For example, the following restriction of a {@link jakarta.ws.rs.client.ClientRequestFilter} to run only as part of a
 * JAX-RS server run-time would be considered invalid:
 * 
 *
 *  *  // reported as invalid and ignored by JAX-RS runtime
 *  @ConstrainedTo(RuntimeType.SERVER)
 *  public class MyFilter implements ClientRequestFilter {
 *      ...
 *  }
 * 
 *
 * @author Marek Potociar
 * @since 2.0
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ConstrainedTo {

    /**
     * Define the {@link RuntimeType constraint type} to be placed on a JAX-RS provider.
     *
     * @return applicable run-time context.
     */
    RuntimeType value();
}