jakartaee-9.0/javadoc/jakarta/ws/rs/NameBinding.html - tomee-site-pub - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!-- NewPage -->
 <html lang="en">
 <head>
 <title>NameBinding</title>
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="NameBinding";
         }
     }
     catch(err) {
     }
 //-->
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a name="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a name="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../overview-summary.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../index-all.html">Index</a></li>
 <li><a href="../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li><a href="../../../jakarta/ws/rs/MatrixParam.html" title="annotation in jakarta.ws.rs"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../jakarta/ws/rs/NotAcceptableException.html" title="class in jakarta.ws.rs"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../index.html?jakarta/ws/rs/NameBinding.html" target="_top">Frames</a></li>
 <li><a href="NameBinding.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_top");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Required&nbsp;|&nbsp;</li>
 <li>Optional</li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Element</li>
 </ul>
 </div>
 <a name="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="subTitle">jakarta.ws.rs</div>
 <h2 title="Annotation Type NameBinding" class="title">Annotation Type NameBinding</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <hr>
 <br>
 <pre>@Target(value=ANNOTATION_TYPE)
  @Retention(value=RUNTIME)
  @Documented
 public @interface <span class="memberNameLabel">NameBinding</span></pre>
 <div class="block">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 <i>name-binding</i>
  annotation is first defined using the <code>@NameBinding</code> meta-annotation:

  <pre>
   &#64;Target({ ElementType.TYPE, ElementType.METHOD })
   &#64;Retention(value = RetentionPolicy.RUNTIME)
   <b>&#64;NameBinding</b>
   <b>public @interface Logged</b> { }
  </pre>

  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):

  <pre>
   <b>&#64;Logged</b>
   public class LoggingFilter
           implements ContainerRequestFilter, ContainerResponseFilter {
       ...
   }
  </pre>

  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:

  <pre>
   &#64;Path("/")
   public class MyResourceClass {
       &#64;GET
       &#64;Produces("text/plain")
       &#64;Path("{name}")
       <b>&#64;Logged</b>
       public String hello(@PathParam("name") String name) {
           return "Hello " + name;
       }
   }
  </pre>

  A name-binding annotation may also be attached to a custom JAX-RS <a href="../../../jakarta/ws/rs/core/Application.html" title="class in jakarta.ws.rs.core"><code>Application</code></a> subclass. In
  such case a name-bound JAX-RS provider bound by the annotation will be applied to all <a href="../../../jakarta/ws/rs/HttpMethod.html" title="annotation in jakarta.ws.rs"><code>resource and
  sub-resource methods</code></a> in the JAX-RS application:

  <pre>
   <b>&#64;Logged</b>
   &#64;ApplicationPath("myApp")
   public class MyApplication extends jakarta.ws.rs.core.Application {
       ...
   }
  </pre></div>
 <dl>
 <dt><span class="simpleTagLabel">Since:</span></dt>
 <dd>2.0</dd>
 </dl>
 </li>
 </ul>
 </div>
 </div>
 <!-- ========= END OF CLASS DATA ========= -->
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a name="navbar.bottom">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <a name="navbar.bottom.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../overview-summary.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../index-all.html">Index</a></li>
 <li><a href="../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li><a href="../../../jakarta/ws/rs/MatrixParam.html" title="annotation in jakarta.ws.rs"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../jakarta/ws/rs/NotAcceptableException.html" title="class in jakarta.ws.rs"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../index.html?jakarta/ws/rs/NameBinding.html" target="_top">Frames</a></li>
 <li><a href="NameBinding.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_bottom");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Required&nbsp;|&nbsp;</li>
 <li>Optional</li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Element</li>
 </ul>
 </div>
 <a name="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 </body>
 </html>
	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
	<!-- NewPage -->
	<html lang="en">
	<head>
	<title>NameBinding</title>
	<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
	<script type="text/javascript" src="../../../script.js"></script>
	</head>
	<body>
	<script type="text/javascript"><!--
	try {
	if (location.href.indexOf('is-external=true') == -1) {
	parent.document.title="NameBinding";
	}
	}
	catch(err) {
	}
	//-->
	</script>
	<noscript>
	<div>JavaScript is disabled on your browser.</div>
	</noscript>
	<!-- ========= START OF TOP NAVBAR ======= -->
	<div class="topNav"><a name="navbar.top">
	<!-- -->
	</a>
	<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
	<a name="navbar.top.firstrow">
	<!-- -->
	</a>
	<ul class="navList" title="Navigation">
	<li><a href="../../../overview-summary.html">Overview</a></li>
	<li><a href="package-summary.html">Package</a></li>
	<li class="navBarCell1Rev">Class</li>
	<li><a href="package-tree.html">Tree</a></li>
	<li><a href="../../../deprecated-list.html">Deprecated</a></li>
	<li><a href="../../../index-all.html">Index</a></li>
	<li><a href="../../../help-doc.html">Help</a></li>
	</ul>
	</div>
	<div class="subNav">
	<ul class="navList">
	<li><a href="../../../jakarta/ws/rs/MatrixParam.html" title="annotation in jakarta.ws.rs"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../../jakarta/ws/rs/NotAcceptableException.html" title="class in jakarta.ws.rs"><span class="typeNameLink">Next Class</span></a></li>
	</ul>
	<ul class="navList">
	<li><a href="../../../index.html?jakarta/ws/rs/NameBinding.html" target="_top">Frames</a></li>
	<li><a href="NameBinding.html" target="_top">No Frames</a></li>
	</ul>
	<ul class="navList" id="allclasses_navbar_top">
	<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
	</ul>
	<div>
	<script type="text/javascript"><!--
	allClassesLink = document.getElementById("allclasses_navbar_top");
	if(window==top) {
	allClassesLink.style.display = "block";
	}
	else {
	allClassesLink.style.display = "none";
	}
	//-->
	</script>
	</div>
	<div>
	<ul class="subNavList">
	<li>Summary: </li>
	<li>Field \| </li>
	<li>Required \| </li>
	<li>Optional</li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li>Element</li>
	</ul>
	</div>
	<a name="skip.navbar.top">
	<!-- -->
	</a></div>
	<!-- ========= END OF TOP NAVBAR ========= -->
	<!-- ======== START OF CLASS DATA ======== -->
	<div class="header">
	<div class="subTitle">jakarta.ws.rs</div>
	<h2 title="Annotation Type NameBinding" class="title">Annotation Type NameBinding</h2>
	</div>
	<div class="contentContainer">
	<div class="description">
	<ul class="blockList">
	<li class="blockList">
	<hr>
	<br>
	<pre>@Target(value=ANNOTATION_TYPE)
	@Retention(value=RUNTIME)
	@Documented
	public @interface <span class="memberNameLabel">NameBinding</span></pre>
	<div class="block">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 <i>name-binding</i>
	annotation is first defined using the <code>@NameBinding</code> meta-annotation:

	<pre>
	@Target({ ElementType.TYPE, ElementType.METHOD })
	@Retention(value = RetentionPolicy.RUNTIME)
	<b>@NameBinding</b>
	<b>public @interface Logged</b> { }
	</pre>

	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):

	<pre>
	<b>@Logged</b>
	public class LoggingFilter
	implements ContainerRequestFilter, ContainerResponseFilter {
	...
	}
	</pre>

	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:

	<pre>
	@Path("/")
	public class MyResourceClass {
	@GET
	@Produces("text/plain")
	@Path("{name}")
	<b>@Logged</b>
	public String hello(@PathParam("name") String name) {
	return "Hello " + name;
	}
	}
	</pre>

	A name-binding annotation may also be attached to a custom JAX-RS <a href="../../../jakarta/ws/rs/core/Application.html" title="class in jakarta.ws.rs.core"><code>Application</code></a> subclass. In
	such case a name-bound JAX-RS provider bound by the annotation will be applied to all <a href="../../../jakarta/ws/rs/HttpMethod.html" title="annotation in jakarta.ws.rs"><code>resource and
	sub-resource methods</code></a> in the JAX-RS application:

	<pre>
	<b>@Logged</b>
	@ApplicationPath("myApp")
	public class MyApplication extends jakarta.ws.rs.core.Application {
	...
	}
	</pre></div>
	<dl>
	<dt><span class="simpleTagLabel">Since:</span></dt>
	<dd>2.0</dd>
	</dl>
	</li>
	</ul>
	</div>
	</div>
	<!-- ========= END OF CLASS DATA ========= -->
	<!-- ======= START OF BOTTOM NAVBAR ====== -->
	<div class="bottomNav"><a name="navbar.bottom">
	<!-- -->
	</a>
	<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
	<a name="navbar.bottom.firstrow">
	<!-- -->
	</a>
	<ul class="navList" title="Navigation">
	<li><a href="../../../overview-summary.html">Overview</a></li>
	<li><a href="package-summary.html">Package</a></li>
	<li class="navBarCell1Rev">Class</li>
	<li><a href="package-tree.html">Tree</a></li>
	<li><a href="../../../deprecated-list.html">Deprecated</a></li>
	<li><a href="../../../index-all.html">Index</a></li>
	<li><a href="../../../help-doc.html">Help</a></li>
	</ul>
	</div>
	<div class="subNav">
	<ul class="navList">
	<li><a href="../../../jakarta/ws/rs/MatrixParam.html" title="annotation in jakarta.ws.rs"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../../jakarta/ws/rs/NotAcceptableException.html" title="class in jakarta.ws.rs"><span class="typeNameLink">Next Class</span></a></li>
	</ul>
	<ul class="navList">
	<li><a href="../../../index.html?jakarta/ws/rs/NameBinding.html" target="_top">Frames</a></li>
	<li><a href="NameBinding.html" target="_top">No Frames</a></li>
	</ul>
	<ul class="navList" id="allclasses_navbar_bottom">
	<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
	</ul>
	<div>
	<script type="text/javascript"><!--
	allClassesLink = document.getElementById("allclasses_navbar_bottom");
	if(window==top) {
	allClassesLink.style.display = "block";
	}
	else {
	allClassesLink.style.display = "none";
	}
	//-->
	</script>
	</div>
	<div>
	<ul class="subNavList">
	<li>Summary: </li>
	<li>Field \| </li>
	<li>Required \| </li>
	<li>Optional</li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li>Element</li>
	</ul>
	</div>
	<a name="skip.navbar.bottom">
	<!-- -->
	</a></div>
	<!-- ======== END OF BOTTOM NAVBAR ======= -->
	</body>
	</html>