Google Git
Sign in
eclipse / www.eclipse.org / jetty / 0691ed4645700e2e07b7266349674e533c045a24 / . / javadoc / jetty-10 / org / eclipse / jetty / plus / jndi / NamingEntry.html
blob: c98dbd747fddeb134f1c7222413f12fa394bc768 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.14.1) on Mon Apr 04 09:09:38 CDT 2022 -->
<title>NamingEntry (Eclipse Jetty API Doc - v10.0.9)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2022-04-04">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="NamingEntry (Eclipse Jetty API Doc - v10.0.9)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/NamingEntry.html">Use</a></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" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.eclipse.jetty.plus.jndi</a></div>
<h2 title="Class NamingEntry" class="title">Class NamingEntry</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.eclipse.jetty.plus.jndi.NamingEntry</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="EnvEntry.html" title="class in org.eclipse.jetty.plus.jndi">EnvEntry</a></code>, <code><a href="Link.html" title="class in org.eclipse.jetty.plus.jndi">Link</a></code>, <code><a href="Resource.html" title="class in org.eclipse.jetty.plus.jndi">Resource</a></code>, <code><a href="Transaction.html" title="class in org.eclipse.jetty.plus.jndi">Transaction</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">NamingEntry</span>
extends java.lang.Object</pre>
<div class="block">NamingEntry
<p>
Base class for all jndi related entities. Instances of
subclasses of this class are declared in jetty.xml or in a
webapp's WEB-INF/jetty-env.xml file.
<p>
NOTE: that all NamingEntries will be bound in a single namespace.
The "global" level is just in the top level context. The "local"
level is a context specific to a webapp.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#__contextName">__contextName</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_jndiName">_jndiName</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_namingEntryNameString">_namingEntryNameString</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_objectNameString">_objectNameString</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.Object</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#_scope">_scope</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.Object,java.lang.String)">NamingEntry</a></span>&#8203;(java.lang.Object&nbsp;scope,
java.lang.String&nbsp;jndiName)</code></th>
<td class="colLast">
<div class="block">Create a naming entry.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String)">NamingEntry</a></span>&#8203;(java.lang.String&nbsp;jndiName)</code></th>
<td class="colLast">
<div class="block">Create a NamingEntry.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bindToENC(java.lang.String)">bindToENC</a></span>&#8203;(java.lang.String&nbsp;localName)</code></th>
<td class="colLast">
<div class="block">Add a <code>java:comp/env</code> binding for the object represented by this NamingEntry,
but bind it as the name supplied</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJndiName()">getJndiName</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the unique name of the object
relative to the scope</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJndiNameInScope()">getJndiNameInScope</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the name of the object, fully
qualified with the scope</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#release()">release</a></span>()</code></th>
<td class="colLast">
<div class="block">Unbind this NamingEntry entirely</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#save(java.lang.Object)">save</a></span>&#8203;(java.lang.Object&nbsp;object)</code></th>
<td class="colLast">
<div class="block">Save the NamingEntry for later use.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toStringMetaData()">toStringMetaData</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unbindENC()">unbindENC</a></span>()</code></th>
<td class="colLast">
<div class="block">Unbind this NamingEntry from a java:comp/env</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="__contextName">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>__contextName</h4>
<pre>public static final&nbsp;java.lang.String __contextName</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.eclipse.jetty.plus.jndi.NamingEntry.__contextName">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="_scope">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_scope</h4>
<pre>protected final&nbsp;java.lang.Object _scope</pre>
</li>
</ul>
<a id="_jndiName">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_jndiName</h4>
<pre>protected final&nbsp;java.lang.String _jndiName</pre>
</li>
</ul>
<a id="_namingEntryNameString">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_namingEntryNameString</h4>
<pre>protected&nbsp;java.lang.String _namingEntryNameString</pre>
</li>
</ul>
<a id="_objectNameString">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>_objectNameString</h4>
<pre>protected&nbsp;java.lang.String _objectNameString</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(java.lang.Object,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>NamingEntry</h4>
<pre>protected&nbsp;NamingEntry&#8203;(java.lang.Object&nbsp;scope,
java.lang.String&nbsp;jndiName)
throws javax.naming.NamingException</pre>
<div class="block">Create a naming entry.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>scope</code> - an object representing the scope of the name to be bound into jndi, where null means jvm scope.</dd>
<dd><code>jndiName</code> - the name that will be associated with an object bound into jndi</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>javax.naming.NamingException</code> - if jndiName is null</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>NamingEntry</h4>
<pre>protected&nbsp;NamingEntry&#8203;(java.lang.String&nbsp;jndiName)
throws javax.naming.NamingException</pre>
<div class="block">Create a NamingEntry.
A NamingEntry is a name associated with a value which can later
be looked up in JNDI by a webapp.
We create the NamingEntry and put it into JNDI where it can
be linked to the webapp's env-entry, resource-ref etc entries.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jndiName</code> - the name of the object which will eventually be in java:comp/env</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>javax.naming.NamingException</code> - if unable to create naming entry</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="bindToENC(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bindToENC</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;bindToENC&#8203;(java.lang.String&nbsp;localName)
throws javax.naming.NamingException</pre>
<div class="block">Add a <code>java:comp/env</code> binding for the object represented by this NamingEntry,
but bind it as the name supplied</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>localName</code> - the local name to bind</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>javax.naming.NamingException</code> - if unable to bind</dd>
</dl>
</li>
</ul>
<a id="unbindENC()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unbindENC</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;unbindENC()</pre>
<div class="block">Unbind this NamingEntry from a java:comp/env</div>
</li>
</ul>
<a id="release()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>release</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;release()</pre>
<div class="block">Unbind this NamingEntry entirely</div>
</li>
</ul>
<a id="getJndiName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJndiName</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getJndiName()</pre>
<div class="block">Get the unique name of the object
relative to the scope</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the unique jndi name of the object</dd>
</dl>
</li>
</ul>
<a id="getJndiNameInScope()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJndiNameInScope</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getJndiNameInScope()</pre>
<div class="block">Get the name of the object, fully
qualified with the scope</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name of the object, fully qualified with the scope</dd>
</dl>
</li>
</ul>
<a id="save(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>save</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;save&#8203;(java.lang.Object&nbsp;object)
throws javax.naming.NamingException</pre>
<div class="block">Save the NamingEntry for later use.
<p>
Saving is done by binding both the NamingEntry
itself, and the value it represents into
JNDI. In this way, we can link to the
value it represents later, but also
still retrieve the NamingEntry itself too.
<p>
The object is bound at scope/jndiName and
the NamingEntry is bound at scope/__/jndiName.
<p>
eg
<pre>
jdbc/foo : DataSource
__/jdbc/foo : NamingEntry
</pre></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>object</code> - the object to save</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>javax.naming.NamingException</code> - if unable to save</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="NamingEntryUtil.html#getNameForScope(java.lang.Object)"><code>NamingEntryUtil.getNameForScope(Object)</code></a></dd>
</dl>
</li>
</ul>
<a id="toStringMetaData()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toStringMetaData</h4>
<pre class="methodSignature">protected&nbsp;java.lang.String&nbsp;toStringMetaData()</pre>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/NamingEntry.html">Use</a></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" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 1995&#x2013;2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p>
</footer>
</body>
</html>