jakarta.ws.rs.NameBinding 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) 2011, 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;

/**
 * Meta-annotation used to create name binding annotations for filters and interceptors.
 *
 * Name binding via annotations is only supported as part of the Server API. In name binding, a name-binding
 * annotation is first defined using the {@code @NameBinding} meta-annotation:
 *
 *  *  @Target({ ElementType.TYPE, ElementType.METHOD })
 *  @Retention(value = RetentionPolicy.RUNTIME)
 *  @NameBinding
 *  public @interface Logged { }
 * 
 *
 * The defined name-binding annotation is then used to decorate a filter or interceptor class (more than one filter or
 * interceptor may be decorated with the same name-binding annotation):
 *
 *  *  @Logged
 *  public class LoggingFilter
 *          implements ContainerRequestFilter, ContainerResponseFilter {
 *      ...
 *  }
 * 
 *
 * At last, the name-binding annotation is applied to the resource method(s) to which the name-bound JAX-RS provider(s)
 * should be bound to:
 *
 *  *  @Path("/")
 *  public class MyResourceClass {
 *      @GET
 *      @Produces("text/plain")
 *      @Path("{name}")
 *      @Logged
 *      public String hello(@PathParam("name") String name) {
 *          return "Hello " + name;
 *      }
 *  }
 * 
 *
 * A name-binding annotation may also be attached to a custom JAX-RS {@link jakarta.ws.rs.core.Application} subclass. In
 * such case a name-bound JAX-RS provider bound by the annotation will be applied to all {@link HttpMethod resource and
 * sub-resource methods} in the JAX-RS application:
 *
 *  *  @Logged
 *  @ApplicationPath("myApp")
 *  public class MyApplication extends jakarta.ws.rs.core.Application {
 *      ...
 *  }
 * 
 *
 * @author Santiago Pericas-Geertsen
 * @author Marek Potociar
 * @since 2.0
 */
@Target(ElementType.ANNOTATION_TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface NameBinding {
}