javax.ws.rs

Annotation Type NameBinding


  • @Target(value=ANNOTATION_TYPE)
     @Retention(value=RUNTIME)
     @Documented
    public @interface NameBinding
    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 @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 Application subclass. In such case a name-bound JAX-RS provider bound by the annotation will be applied to all resource and sub-resource methods in the JAX-RS application:
      @Logged
      @ApplicationPath("myApp")
      public class MyApplication extends javax.ws.rs.core.Application {
          ...
      }
     

    Since:
    2.0
    Author:
    Santiago Pericas-Geertsen, Marek Potociar

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/ws/rs/NameBinding.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com, NameBinding (Java(TM) EE 7 Specification APIs)

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.