| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>ConstrainedTo</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="ConstrainedTo"; |
| } |
| } |
| 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/ClientErrorException.html" title="class in jakarta.ws.rs"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/ws/rs/Consumes.html" title="annotation in jakarta.ws.rs"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/ws/rs/ConstrainedTo.html" target="_top">Frames</a></li> |
| <li><a href="ConstrainedTo.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><a href="#annotation.type.required.element.summary">Required</a> | </li> |
| <li>Optional</li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.element.detail">Element</a></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 ConstrainedTo" class="title">Annotation Type ConstrainedTo</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>@Target(value=TYPE) |
| @Retention(value=RUNTIME) |
| @Documented |
| public @interface <span class="memberNameLabel">ConstrainedTo</span></pre> |
| <div class="block">Indicates the run-time context in which an annotated JAX-RS provider is applicable. If a <code>@ConstrainedTo</code> |
| 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. |
| <p> |
| The following example illustrates restricting a <a href="../../../jakarta/ws/rs/ext/MessageBodyReader.html" title="interface in jakarta.ws.rs.ext"><code>MessageBodyReader</code></a> provider implementation to |
| run only as part of a <a href="../../../jakarta/ws/rs/RuntimeType.html#CLIENT"><code>JAX-RS client run-time</code></a>: |
| </p> |
| |
| <pre> |
| @ConstrainedTo(RuntimeType.CLIENT) |
| public class MyReader implements MessageBodyReader { |
| ... |
| } |
| </pre> |
| <p> |
| The following example illustrates restricting a <a href="../../../jakarta/ws/rs/ext/WriterInterceptor.html" title="interface in jakarta.ws.rs.ext"><code>WriterInterceptor</code></a> provider implementation to |
| run only as part of a <a href="../../../jakarta/ws/rs/RuntimeType.html#SERVER"><code>JAX-RS server run-time</code></a>: |
| </p> |
| |
| <pre> |
| @ConstrainedTo(RuntimeType.SERVER) |
| public class MyWriterInterceptor implements WriterInterceptor { |
| ... |
| } |
| </pre> |
| <p> |
| 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. |
| </p> |
| <p> |
| For example, the following restriction of a <a href="../../../jakarta/ws/rs/client/ClientRequestFilter.html" title="interface in jakarta.ws.rs.client"><code>ClientRequestFilter</code></a> to run only as part of a |
| JAX-RS server run-time would be considered invalid: |
| </p> |
| |
| <pre> |
| // reported as invalid and ignored by JAX-RS runtime |
| @ConstrainedTo(RuntimeType.SERVER) |
| public class MyFilter implements ClientRequestFilter { |
| ... |
| } |
| </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.required.element.summary"> |
| <!-- --> |
| </a> |
| <h3>Required Element Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation"> |
| <caption><span>Required Elements</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Required Element and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../jakarta/ws/rs/RuntimeType.html" title="enum in jakarta.ws.rs">RuntimeType</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/ws/rs/ConstrainedTo.html#value--">value</a></span></code> |
| <div class="block">Define the <a href="../../../jakarta/ws/rs/RuntimeType.html" title="enum in jakarta.ws.rs"><code>constraint type</code></a> to be placed on a JAX-RS provider.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="annotation.type.element.detail"> |
| <!-- --> |
| </a> |
| <h3>Element Detail</h3> |
| <a name="value--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>value</h4> |
| <pre>public abstract <a href="../../../jakarta/ws/rs/RuntimeType.html" title="enum in jakarta.ws.rs">RuntimeType</a> value</pre> |
| <div class="block">Define the <a href="../../../jakarta/ws/rs/RuntimeType.html" title="enum in jakarta.ws.rs"><code>constraint type</code></a> to be placed on a JAX-RS provider.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>applicable run-time context.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </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/ClientErrorException.html" title="class in jakarta.ws.rs"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/ws/rs/Consumes.html" title="annotation in jakarta.ws.rs"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/ws/rs/ConstrainedTo.html" target="_top">Frames</a></li> |
| <li><a href="ConstrainedTo.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><a href="#annotation.type.required.element.summary">Required</a> | </li> |
| <li>Optional</li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#annotation.type.element.detail">Element</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |