jakartaee-9.0/javadoc/jakarta/ws/rs/container/ResourceContext.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>ResourceContext</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="ResourceContext";
         }
     }
     catch(err) {
     }
 //-->
 var methods = {"i0":6,"i1":6};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
 var tableTab = "tableTab";
 var activeTableTab = "activeTableTab";
 </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/container/PreMatching.html" title="annotation in jakarta.ws.rs.container"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../jakarta/ws/rs/container/ResourceInfo.html" title="interface in jakarta.ws.rs.container"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?jakarta/ws/rs/container/ResourceContext.html" target="_top">Frames</a></li>
 <li><a href="ResourceContext.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>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</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.container</div>
 <h2 title="Interface ResourceContext" class="title">Interface ResourceContext</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <hr>
 <br>
 <pre>public interface <span class="typeNameLabel">ResourceContext</span></pre>
 <div class="block">The resource context provides access to instances of resource classes.
  <p>
  This interface can be injected using the <a href="../../../../jakarta/ws/rs/core/Context.html" title="annotation in jakarta.ws.rs.core"><code>Context</code></a> annotation.
  </p>
  <p>
  The resource context can be utilized when instances of managed resource classes are to be returned by sub-resource
  locator methods. Such instances will be injected and managed within the declared scope just like instances of root
  resource classes.
  </p></div>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- ========== METHOD SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.summary">
 <!--   -->
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Method and Description</th>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/container/ResourceContext.html#getResource-java.lang.Class-">getResource</a></span>(java.lang.Class&lt;T&gt;&nbsp;resourceClass)</code>
 <div class="block">Get a resolved instance of a resource or sub-resource class.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>&lt;T&gt;&nbsp;T</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/container/ResourceContext.html#initResource-T-">initResource</a></span>(T&nbsp;resource)</code>
 <div class="block">Initialize the resource or sub-resource instance.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ METHOD DETAIL ========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a name="getResource-java.lang.Class-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getResource</h4>
 <pre>&lt;T&gt;&nbsp;T&nbsp;getResource(java.lang.Class&lt;T&gt;&nbsp;resourceClass)</pre>
 <div class="block">Get a resolved instance of a resource or sub-resource class.
  <p>
  The resolved resource instance is properly initialized in the context of the current request processing scope. The
  scope of the resolved resource instance depends on the managing container. For resources managed by JAX-RS container
  the default scope is per-request.
  </p></div>
 <dl>
 <dt><span class="paramLabel">Type Parameters:</span></dt>
 <dd><code>T</code> - the type of the resource class.</dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>resourceClass</code> - the resource class.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>an instance if it could be resolved, otherwise <code>null</code>.</dd>
 </dl>
 </li>
 </ul>
 <a name="initResource-java.lang.Object-">
 <!--   -->
 </a><a name="initResource-T-">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>initResource</h4>
 <pre>&lt;T&gt;&nbsp;T&nbsp;initResource(T&nbsp;resource)</pre>
 <div class="block">Initialize the resource or sub-resource instance.

  All JAX-RS injectable fields in the resource instance will be properly initialized in the context of the current
  request processing scope.</div>
 <dl>
 <dt><span class="paramLabel">Type Parameters:</span></dt>
 <dd><code>T</code> - resource instance type.</dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>resource</code> - resource instance.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>initialized (same) resource instance.</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/container/PreMatching.html" title="annotation in jakarta.ws.rs.container"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../jakarta/ws/rs/container/ResourceInfo.html" title="interface in jakarta.ws.rs.container"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?jakarta/ws/rs/container/ResourceContext.html" target="_top">Frames</a></li>
 <li><a href="ResourceContext.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>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></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>ResourceContext</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="ResourceContext";
	}
	}
	catch(err) {
	}
	//-->
	var methods = {"i0":6,"i1":6};
	var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
	var altColor = "altColor";
	var rowColor = "rowColor";
	var tableTab = "tableTab";
	var activeTableTab = "activeTableTab";
	</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/container/PreMatching.html" title="annotation in jakarta.ws.rs.container"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../../../jakarta/ws/rs/container/ResourceInfo.html" title="interface in jakarta.ws.rs.container"><span class="typeNameLink">Next Class</span></a></li>
	</ul>
	<ul class="navList">
	<li><a href="../../../../index.html?jakarta/ws/rs/container/ResourceContext.html" target="_top">Frames</a></li>
	<li><a href="ResourceContext.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>Nested \| </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li><a href="#method.summary">Method</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li><a href="#method.detail">Method</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.container</div>
	<h2 title="Interface ResourceContext" class="title">Interface ResourceContext</h2>
	</div>
	<div class="contentContainer">
	<div class="description">
	<ul class="blockList">
	<li class="blockList">
	<hr>
	<br>
	<pre>public interface <span class="typeNameLabel">ResourceContext</span></pre>
	<div class="block">The resource context provides access to instances of resource classes.
	<p>
	This interface can be injected using the <a href="../../../../jakarta/ws/rs/core/Context.html" title="annotation in jakarta.ws.rs.core"><code>Context</code></a> annotation.
	</p>
	<p>
	The resource context can be utilized when instances of managed resource classes are to be returned by sub-resource
	locator methods. Such instances will be injected and managed within the declared scope just like instances of root
	resource classes.
	</p></div>
	</li>
	</ul>
	</div>
	<div class="summary">
	<ul class="blockList">
	<li class="blockList">
	<!-- ========== METHOD SUMMARY =========== -->
	<ul class="blockList">
	<li class="blockList"><a name="method.summary">
	<!-- -->
	</a>
	<h3>Method Summary</h3>
	<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
	<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
	<tr>
	<th class="colFirst" scope="col">Modifier and Type</th>
	<th class="colLast" scope="col">Method and Description</th>
	</tr>
	<tr id="i0" class="altColor">
	<td class="colFirst"><code><T> T</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/container/ResourceContext.html#getResource-java.lang.Class-">getResource</a></span>(java.lang.Class<T> resourceClass)</code>
	<div class="block">Get a resolved instance of a resource or sub-resource class.</div>
	</td>
	</tr>
	<tr id="i1" class="rowColor">
	<td class="colFirst"><code><T> T</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/container/ResourceContext.html#initResource-T-">initResource</a></span>(T resource)</code>
	<div class="block">Initialize the resource or sub-resource instance.</div>
	</td>
	</tr>
	</table>
	</li>
	</ul>
	</li>
	</ul>
	</div>
	<div class="details">
	<ul class="blockList">
	<li class="blockList">
	<!-- ============ METHOD DETAIL ========== -->
	<ul class="blockList">
	<li class="blockList"><a name="method.detail">
	<!-- -->
	</a>
	<h3>Method Detail</h3>
	<a name="getResource-java.lang.Class-">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>getResource</h4>
	<pre><T> T getResource(java.lang.Class<T> resourceClass)</pre>
	<div class="block">Get a resolved instance of a resource or sub-resource class.
	<p>
	The resolved resource instance is properly initialized in the context of the current request processing scope. The
	scope of the resolved resource instance depends on the managing container. For resources managed by JAX-RS container
	the default scope is per-request.
	</p></div>
	<dl>
	<dt><span class="paramLabel">Type Parameters:</span></dt>
	<dd><code>T</code> - the type of the resource class.</dd>
	<dt><span class="paramLabel">Parameters:</span></dt>
	<dd><code>resourceClass</code> - the resource class.</dd>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>an instance if it could be resolved, otherwise <code>null</code>.</dd>
	</dl>
	</li>
	</ul>
	<a name="initResource-java.lang.Object-">
	<!-- -->
	</a><a name="initResource-T-">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>initResource</h4>
	<pre><T> T initResource(T resource)</pre>
	<div class="block">Initialize the resource or sub-resource instance.

	All JAX-RS injectable fields in the resource instance will be properly initialized in the context of the current
	request processing scope.</div>
	<dl>
	<dt><span class="paramLabel">Type Parameters:</span></dt>
	<dd><code>T</code> - resource instance type.</dd>
	<dt><span class="paramLabel">Parameters:</span></dt>
	<dd><code>resource</code> - resource instance.</dd>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>initialized (same) resource instance.</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/container/PreMatching.html" title="annotation in jakarta.ws.rs.container"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../../../jakarta/ws/rs/container/ResourceInfo.html" title="interface in jakarta.ws.rs.container"><span class="typeNameLink">Next Class</span></a></li>
	</ul>
	<ul class="navList">
	<li><a href="../../../../index.html?jakarta/ws/rs/container/ResourceContext.html" target="_top">Frames</a></li>
	<li><a href="ResourceContext.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>Nested \| </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li><a href="#method.summary">Method</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li>Constr \| </li>
	<li><a href="#method.detail">Method</a></li>
	</ul>
	</div>
	<a name="skip.navbar.bottom">
	<!-- -->
	</a></div>
	<!-- ======== END OF BOTTOM NAVBAR ======= -->
	</body>
	</html>