blob: 93e8cf2d6b8a1a7a55030a2e6764e9043b04a29a [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:41:40 EST 2016 -->
<title>ActivationExporter (Apache River v3.0.0 Specification-only API Documentation)</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="ActivationExporter (Apache River v3.0.0 Specification-only API Documentation)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":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";
</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/ActivationExporter.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><a href="../../../net/jini/activation/ActivatableInvocationHandler.html" title="class in net.jini.activation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../net/jini/activation/ActivationGroup.html" title="class in net.jini.activation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?net/jini/activation/ActivationExporter.html" target="_top">Frames</a></li>
<li><a href="ActivationExporter.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><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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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.activation</div>
<h2 title="Class ActivationExporter" class="title">Class ActivationExporter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>net.jini.activation.ActivationExporter</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../net/jini/export/Exporter.html" title="interface in net.jini.export">Exporter</a></dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">ActivationExporter</span>
extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../net/jini/export/Exporter.html" title="interface in net.jini.export">Exporter</a></pre>
<div class="block">An <code>Exporter</code> implementation for exporting an activatable
remote object using its underlying exporter. The proxy returned by
the <code>export</code> method activates the remote object on
demand. Each instance of <code>ActivationExporter</code> can export only
a single remote object.</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>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../net/jini/activation/ActivationExporter.html#ActivationExporter-java.rmi.activation.ActivationID-net.jini.export.Exporter-">ActivationExporter</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/activation/ActivationID.html?is-external=true" title="class or interface in java.rmi.activation">ActivationID</a>&nbsp;id,
<a href="../../../net/jini/export/Exporter.html" title="interface in net.jini.export">Exporter</a>&nbsp;underlyingExporter)</code>
<div class="block">Creates an exporter for an activatable remote object with the
specified activation identifier, underlying exporter, and a
<code>null</code> class loader.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../net/jini/activation/ActivationExporter.html#ActivationExporter-java.rmi.activation.ActivationID-net.jini.export.Exporter-java.lang.ClassLoader-">ActivationExporter</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/activation/ActivationID.html?is-external=true" title="class or interface in java.rmi.activation">ActivationID</a>&nbsp;id,
<a href="../../../net/jini/export/Exporter.html" title="interface in net.jini.export">Exporter</a>&nbsp;underlyingExporter,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;loader)</code>
<div class="block">Creates an exporter for an activatable remote object with the
specified activation identifier, underlying exporter, and
class loader.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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="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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/Remote.html?is-external=true" title="class or interface in java.rmi">Remote</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/activation/ActivationExporter.html#export-java.rmi.Remote-">export</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/Remote.html?is-external=true" title="class or interface in java.rmi">Remote</a>&nbsp;impl)</code>
<div class="block">Exports an activatable remote object.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/activation/ActivationExporter.html#unexport-boolean-">unexport</a></span>(boolean&nbsp;force)</code>
<div class="block">Unexports the activatable remote object that was previously exported
via the <code>export</code> method of the underlying exporter
supplied during construction of this exporter.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ActivationExporter-java.rmi.activation.ActivationID-net.jini.export.Exporter-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ActivationExporter</h4>
<pre>public&nbsp;ActivationExporter(<a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/activation/ActivationID.html?is-external=true" title="class or interface in java.rmi.activation">ActivationID</a>&nbsp;id,
<a href="../../../net/jini/export/Exporter.html" title="interface in net.jini.export">Exporter</a>&nbsp;underlyingExporter)</pre>
<div class="block">Creates an exporter for an activatable remote object with the
specified activation identifier, underlying exporter, and a
<code>null</code> class loader.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - an activation identifier</dd>
<dd><code>underlyingExporter</code> - an exporter</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>id</code> or
<code>underlyingExporter</code> is <code>null</code></dd>
</dl>
</li>
</ul>
<a name="ActivationExporter-java.rmi.activation.ActivationID-net.jini.export.Exporter-java.lang.ClassLoader-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ActivationExporter</h4>
<pre>public&nbsp;ActivationExporter(<a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/activation/ActivationID.html?is-external=true" title="class or interface in java.rmi.activation">ActivationID</a>&nbsp;id,
<a href="../../../net/jini/export/Exporter.html" title="interface in net.jini.export">Exporter</a>&nbsp;underlyingExporter,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;loader)</pre>
<div class="block">Creates an exporter for an activatable remote object with the
specified activation identifier, underlying exporter, and
class loader.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - an activation identifier</dd>
<dd><code>underlyingExporter</code> - an exporter</dd>
<dd><code>loader</code> - the class loader to define the proxy class in, or
<code>null</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>id</code> or
<code>underlyingExporter</code> is <code>null</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="export-java.rmi.Remote-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>export</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/Remote.html?is-external=true" title="class or interface in java.rmi">Remote</a>&nbsp;export(<a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/Remote.html?is-external=true" title="class or interface in java.rmi">Remote</a>&nbsp;impl)
throws <a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/server/ExportException.html?is-external=true" title="class or interface in java.rmi.server">ExportException</a></pre>
<div class="block">Exports an activatable remote object. This exporter exports
<code>impl</code> by calling the <code>export</code> method on the
underlying exporter (supplied during construction of this exporter)
to obtain an underlying proxy. It then constructs and returns a
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/reflect/Proxy.html?is-external=true" title="class or interface in java.lang.reflect"><code>Proxy</code></a> instance where:
<ul>
<li>If the class loader specified at construction is not
<code>null</code>, the proxy's class is defined by the specified
loader. Otherwise, if a security manager exists, its <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/SecurityManager.html?is-external=true#checkPermission-java.security.Permission-" title="class or interface in java.lang"><code>checkPermission</code></a> method is invoked
with the permission <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/RuntimePermission.html?is-external=true" title="class or interface in java.lang"><code>RuntimePermission</code></a>{"getClassLoader")</code>; this invocation may
throw a <code>SecurityException</code>. If the above security check
succeeds, the proxy's class is defined by the class loader of the
underlying proxy's class.
<li>The proxy implements the following ordered list of interfaces
(except if the underlying proxy is an instance of <a href="../../../net/jini/core/constraint/RemoteMethodControl.html" title="interface in net.jini.core.constraint"><code>RemoteMethodControl</code></a>, the interface <a href="../../../net/jini/security/proxytrust/ProxyTrust.html" title="interface in net.jini.security.proxytrust"><code>ProxyTrust</code></a> is not among
the interfaces implemented by the proxy):
<p>for each superclass of the underlying proxy's class, starting
with <code>java.lang.Object</code> and following with each direct
subclass to the direct superclass of the underlying proxy's class,
all of the direct superinterfaces of the given superclass that do
not appear previously in the list, in declaration order (the order
in which they are declared in the class's <code>implements</code>
clause), followed by
<p>all of the direct superinterfaces of the underlying proxy's class
that do not appear previously in the list, in declaration order.
<li>The proxy's invocation handler is an <a href="../../../net/jini/activation/ActivatableInvocationHandler.html" title="class in net.jini.activation"><code>ActivatableInvocationHandler</code></a> instance constructed with the <a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/activation/ActivationID.html?is-external=true" title="class or interface in java.rmi.activation"><code>ActivationID</code></a> and underlying proxy supplied during construction of
this exporter.
</ul></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../net/jini/export/Exporter.html#export-java.rmi.Remote-">export</a></code>&nbsp;in interface&nbsp;<code><a href="../../../net/jini/export/Exporter.html" title="interface in net.jini.export">Exporter</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>impl</code> - a remote object to export</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a proxy for the remote object</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>impl</code> is <code>null</code></dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if an object has already been exported
with this <code>Exporter</code> instance</dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/server/ExportException.html?is-external=true" title="class or interface in java.rmi.server">ExportException</a></code> - if a problem occurs exporting
<code>impl</code> or if the underlying proxy's class
is non-<code>public</code> and implements
non-<code>public</code> interfaces</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><code>Startable</code></dd>
</dl>
</li>
</ul>
<a name="unexport-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>unexport</h4>
<pre>public&nbsp;boolean&nbsp;unexport(boolean&nbsp;force)</pre>
<div class="block">Unexports the activatable remote object that was previously exported
via the <code>export</code> method of the underlying exporter
supplied during construction of this exporter. Returns the result
of unexporting the remote object by calling the
<code>unexport</code> method on the underlying exporter passing
<code>force</code> as the argument.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../net/jini/export/Exporter.html#unexport-boolean-">unexport</a></code>&nbsp;in interface&nbsp;<code><a href="../../../net/jini/export/Exporter.html" title="interface in net.jini.export">Exporter</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>force</code> - if <code>true</code>, the remote object will be
unexported even if there are remote calls pending or in progress;
if <code>false</code>, the remote object may only be unexported if
there are no known remote calls pending or in progress</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the remote object is unexported when
this method returns and <code>false</code> otherwise</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if an object has not been exported
with this <code>Exporter</code> 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="class-use/ActivationExporter.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><a href="../../../net/jini/activation/ActivatableInvocationHandler.html" title="class in net.jini.activation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../net/jini/activation/ActivationGroup.html" title="class in net.jini.activation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?net/jini/activation/ActivationExporter.html" target="_top">Frames</a></li>
<li><a href="ActivationExporter.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><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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>