blob: fac559f586fb75699d6655efff80e6c0754a1b48 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0) on Sun Aug 28 20:42:03 EST 2016 -->
<title>ReferentUuid (Apache River v3.0.0 API Documentation (internals))</title>
<meta name="date" content="2016-08-28">
<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="ReferentUuid (Apache River v3.0.0 API Documentation (internals))";
}
}
catch(err) {
}
//-->
var methods = {"i0":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="class-use/ReferentUuid.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">
<li>Prev&nbsp;Class</li>
<li><a href="../../../net/jini/id/ReferentUuids.html" title="class in net.jini.id"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?net/jini/id/ReferentUuid.html" target="_top">Frames</a></li>
<li><a href="ReferentUuid.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">net.jini.id</div>
<h2 title="Interface ReferentUuid" class="title">Interface ReferentUuid</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../org/apache/river/norm/AbstractProxy.html" title="class in org.apache.river.norm">AbstractProxy</a>, <a href="../../../org/apache/river/norm/AdminProxy.html" title="class in org.apache.river.norm">AdminProxy</a>, <a href="../../../org/apache/river/outrigger/AdminProxy.html" title="class in org.apache.river.outrigger">AdminProxy</a>, <a href="../../../org/apache/river/reggie/AdminProxy.html" title="class in org.apache.river.reggie">AdminProxy</a>, <a href="../../../org/apache/river/norm/AdminProxy.ConstrainableAdminProxy.html" title="class in org.apache.river.norm">AdminProxy.ConstrainableAdminProxy</a>, <a href="../../../org/apache/river/outrigger/ConstrainableAdminProxy.html" title="class in org.apache.river.outrigger">ConstrainableAdminProxy</a>, <a href="../../../org/apache/river/reggie/ConstrainableAdminProxy.html" title="class in org.apache.river.reggie">ConstrainableAdminProxy</a>, <a href="../../../org/apache/river/reggie/ConstrainableEventLease.html" title="class in org.apache.river.reggie">ConstrainableEventLease</a>, <a href="../../../org/apache/river/landlord/ConstrainableLandlordLease.html" title="class in org.apache.river.landlord">ConstrainableLandlordLease</a>, <a href="../../../org/apache/river/outrigger/ConstrainableParticipantProxy.html" title="class in org.apache.river.outrigger">ConstrainableParticipantProxy</a>, <a href="../../../org/apache/river/reggie/ConstrainableRegistrarProxy.html" title="class in org.apache.river.reggie">ConstrainableRegistrarProxy</a>, <a href="../../../org/apache/river/reggie/ConstrainableRegistration.html" title="class in org.apache.river.reggie">ConstrainableRegistration</a>, <a href="../../../org/apache/river/reggie/ConstrainableServiceLease.html" title="class in org.apache.river.reggie">ConstrainableServiceLease</a>, <a href="../../../org/apache/river/outrigger/ConstrainableSpaceProxy2.html" title="class in org.apache.river.outrigger">ConstrainableSpaceProxy2</a>, <a href="../../../org/apache/river/reggie/EventLease.html" title="class in org.apache.river.reggie">EventLease</a>, <a href="../../../org/apache/river/fiddler/FiddlerAdminProxy.html" title="class in org.apache.river.fiddler">FiddlerAdminProxy</a>, <a href="../../../org/apache/river/fiddler/FiddlerAdminProxy.ConstrainableFiddlerAdminProxy.html" title="class in org.apache.river.fiddler">FiddlerAdminProxy.ConstrainableFiddlerAdminProxy</a>, <a href="../../../org/apache/river/fiddler/FiddlerLease.html" title="class in org.apache.river.fiddler">FiddlerLease</a>, <a href="../../../org/apache/river/fiddler/FiddlerLease.ConstrainableFiddlerLease.html" title="class in org.apache.river.fiddler">FiddlerLease.ConstrainableFiddlerLease</a>, <a href="../../../org/apache/river/fiddler/FiddlerProxy.html" title="class in org.apache.river.fiddler">FiddlerProxy</a>, <a href="../../../org/apache/river/fiddler/FiddlerProxy.ConstrainableFiddlerProxy.html" title="class in org.apache.river.fiddler">FiddlerProxy.ConstrainableFiddlerProxy</a>, <a href="../../../org/apache/river/fiddler/FiddlerRegistration.html" title="class in org.apache.river.fiddler">FiddlerRegistration</a>, <a href="../../../org/apache/river/fiddler/FiddlerRegistration.ConstrainableFiddlerRegistration.html" title="class in org.apache.river.fiddler">FiddlerRegistration.ConstrainableFiddlerRegistration</a>, <a href="../../../org/apache/river/landlord/LandlordLease.html" title="class in org.apache.river.landlord">LandlordLease</a>, <a href="../../../org/apache/river/mercury/ListenerProxy.html" title="class in org.apache.river.mercury">ListenerProxy</a>, <a href="../../../org/apache/river/mercury/ListenerProxy.ConstrainableListenerProxy.html" title="class in org.apache.river.mercury">ListenerProxy.ConstrainableListenerProxy</a>, <a href="../../../org/apache/river/mercury/MailboxAdminProxy.html" title="class in org.apache.river.mercury">MailboxAdminProxy</a>, <a href="../../../org/apache/river/mercury/MailboxAdminProxy.ConstrainableMailboxAdminProxy.html" title="class in org.apache.river.mercury">MailboxAdminProxy.ConstrainableMailboxAdminProxy</a>, <a href="../../../org/apache/river/mercury/MailboxProxy.html" title="class in org.apache.river.mercury">MailboxProxy</a>, <a href="../../../org/apache/river/mercury/MailboxProxy.ConstrainableMailboxProxy.html" title="class in org.apache.river.mercury">MailboxProxy.ConstrainableMailboxProxy</a>, <a href="../../../org/apache/river/norm/NormProxy.html" title="class in org.apache.river.norm">NormProxy</a>, <a href="../../../org/apache/river/norm/NormProxy.ConstrainableNormProxy.html" title="class in org.apache.river.norm">NormProxy.ConstrainableNormProxy</a>, <a href="../../../org/apache/river/outrigger/ParticipantProxy.html" title="class in org.apache.river.outrigger">ParticipantProxy</a>, <a href="../../../org/apache/river/reggie/RegistrarLease.html" title="class in org.apache.river.reggie">RegistrarLease</a>, <a href="../../../org/apache/river/reggie/RegistrarProxy.html" title="class in org.apache.river.reggie">RegistrarProxy</a>, <a href="../../../org/apache/river/mercury/Registration.html" title="class in org.apache.river.mercury">Registration</a>, <a href="../../../org/apache/river/reggie/Registration.html" title="class in org.apache.river.reggie">Registration</a>, <a href="../../../org/apache/river/mercury/Registration.ConstrainableRegistration.html" title="class in org.apache.river.mercury">Registration.ConstrainableRegistration</a>, <a href="../../../org/apache/river/reggie/ServiceLease.html" title="class in org.apache.river.reggie">ServiceLease</a>, <a href="../../../org/apache/river/norm/SetProxy.html" title="class in org.apache.river.norm">SetProxy</a>, <a href="../../../org/apache/river/norm/SetProxy.ConstrainableSetProxy.html" title="class in org.apache.river.norm">SetProxy.ConstrainableSetProxy</a>, <a href="../../../org/apache/river/outrigger/SpaceProxy2.html" title="class in org.apache.river.outrigger">SpaceProxy2</a>, <a href="../../../org/apache/river/mahalo/TxnMgrAdminProxy.html" title="class in org.apache.river.mahalo">TxnMgrAdminProxy</a>, <a href="../../../org/apache/river/mahalo/TxnMgrAdminProxy.ConstrainableTxnMgrAdminProxy.html" title="class in org.apache.river.mahalo">TxnMgrAdminProxy.ConstrainableTxnMgrAdminProxy</a>, <a href="../../../org/apache/river/mahalo/TxnMgrProxy.html" title="class in org.apache.river.mahalo">TxnMgrProxy</a>, <a href="../../../org/apache/river/mahalo/TxnMgrProxy.ConstrainableTxnMgrProxy.html" title="class in org.apache.river.mahalo">TxnMgrProxy.ConstrainableTxnMgrProxy</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ReferentUuid</span></pre>
<div class="block">Defines an interface that allows a proxy for a resource to express the
identity of that resource. Resources include items like services,
leases, service registrations, and lease renewal sets. Any resource that
is represented by proxies that implement this interface has a unique
identity. That identity is expressed by assigning the resource a
universally unique identifier. This universally unique identifier will
be represented using the <code>Uuid</code> class. This <code>Uuid</code>
must be:
<ul>
<li> Sufficient to uniquely identify the resource,
<li> associated with the resource for the resource's entire lifetime,
<li> never assigned to another resource who's proxies implement
<code>ReferentUuid</code>, and
<li> returned by the <code>getReferentUuid</code> method of
any proxy of the resource, if that proxy implements
<code>ReferentUuid</code>.
</ul>
<p>
Given two objects, <code>o1</code> and <code>o2</code>, that implement
<code>ReferentUuid</code>:
<ul>
<li> if <code>o1.equals(o2)</code> is <code>true</code>,
then <code>o1.getReferentUuid</code> and
<code>o2.getReferentUuid</code> should return equivalent
<code>Uuid</code>s.
<li> if <code>o1.getReferentUuid</code> and
<code>o2.getReferentUuid</code> return equivalent
<code>Uuid</code>s, <code>o1.equals(o2)</code> may, but is
not required to be <code>true</code>.
</ul></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Sun Microsystems, Inc.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../net/jini/id/Uuid.html" title="class in net.jini.id"><code>Uuid</code></a></dd>
</dl>
</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><a href="../../../net/jini/id/Uuid.html" title="class in net.jini.id">Uuid</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/id/ReferentUuid.html#getReferentUuid--">getReferentUuid</a></span>()</code>
<div class="block">Return the <code>Uuid</code> that has been assigned to the
resource this proxy represents.</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="getReferentUuid--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getReferentUuid</h4>
<pre><a href="../../../net/jini/id/Uuid.html" title="class in net.jini.id">Uuid</a>&nbsp;getReferentUuid()</pre>
<div class="block">Return the <code>Uuid</code> that has been assigned to the
resource this proxy represents.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <code>Uuid</code> associated with the
resource this proxy represents. Will not
return <code>null</code>.</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="class-use/ReferentUuid.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">
<li>Prev&nbsp;Class</li>
<li><a href="../../../net/jini/id/ReferentUuids.html" title="class in net.jini.id"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?net/jini/id/ReferentUuid.html" target="_top">Frames</a></li>
<li><a href="ReferentUuid.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 ======= -->
<p class="legalCopy"><small>Copyright 2007-2013, multiple authors.<br>Licensed under the <a href=http://www.apache.org/licenses/LICENSE-2.0 target=child >Apache License, Version 2.0</a>, see the <a href=../../../doc-files/NOTICE target=child >NOTICE</a> file for attributions.</small></p>
</body>
</html>