blob: 11daef1b8602e3c39658e98945f0a81c848f5d4f [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:45 EST 2016 -->
<title>BasicProxyPreparer (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="BasicProxyPreparer (Apache River v3.0.0 Specification-only API Documentation)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":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/BasicProxyPreparer.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/security/AuthenticationPermission.html" title="class in net.jini.security"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../net/jini/security/GrantPermission.html" title="class in net.jini.security"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?net/jini/security/BasicProxyPreparer.html" target="_top">Frames</a></li>
<li><a href="BasicProxyPreparer.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><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 name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">net.jini.security</div>
<h2 title="Class BasicProxyPreparer" class="title">Class BasicProxyPreparer</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.security.BasicProxyPreparer</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../net/jini/security/ProxyPreparer.html" title="interface in net.jini.security">ProxyPreparer</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">BasicProxyPreparer</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/security/ProxyPreparer.html" title="interface in net.jini.security">ProxyPreparer</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
<div class="block">A <code>ProxyPreparer</code> for verifying that proxies are trusted,
granting them dynamic permissions, and setting their constraints, as well as
for creating other proxy preparer subclasses that include those
operations. <p>
Applications and configurations can use this class to create proxy preparers
for several common cases. Some examples include creating proxy preparers
that: <ul>
<li> Verify trust, grant permissions, and set new constraints, to prepare a
proxy received from an untrusted source.
<li> Use the proxy's existing constraints when verifying trust in the proxy,
to prepare a trusted proxy received with integrity protection from a trusted
source that supplies constraints, confirming that the proxy's implementation
is trusted locally, but allowing the constraints to be downloaded from a
third party.
<li> Set new constraints, to prepare a trusted proxy received with integrity
protection from a trusted source that is not known to supply the appropriate
constraints.
<li> Grant permissions, to prepare a trusted proxy received with integrity
protection from a trusted source that supplies appropriate constraints, if
the proxy needs permission grants.
<li> Do nothing, to use as a default when retrieving an optional
configuration entry, or to prepare a non-secure proxy. </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="../../../serialized-form.html#net.jini.security.BasicProxyPreparer">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../net/jini/core/constraint/MethodConstraints.html" title="interface in net.jini.core.constraint">MethodConstraints</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/security/BasicProxyPreparer.html#methodConstraints">methodConstraints</a></span></code>
<div class="block">Method constraints to use when verifying if proxies are trusted and for
setting their constraints, if <a href="../../../net/jini/security/BasicProxyPreparer.html#methodConstraintsSpecified"><code>methodConstraintsSpecified</code></a> is
<code>true</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/security/BasicProxyPreparer.html#methodConstraintsSpecified">methodConstraintsSpecified</a></span></code>
<div class="block">Whether to use <a href="../../../net/jini/security/BasicProxyPreparer.html#methodConstraints"><code>methodConstraints</code></a> when verifying if proxies are
trusted and for setting their constraints.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/6/docs/api/java/security/Permission.html?is-external=true" title="class or interface in java.security">Permission</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/security/BasicProxyPreparer.html#permissions">permissions</a></span></code>
<div class="block">Permissions to grant to proxies, or an empty array if no permissions
should be granted.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/security/BasicProxyPreparer.html#verify">verify</a></span></code>
<div class="block">Whether to verify if proxies are trusted.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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/security/BasicProxyPreparer.html#BasicProxyPreparer--">BasicProxyPreparer</a></span>()</code>
<div class="block">Creates a proxy preparer that specifies not to verify proxies, grant
them permissions, or set their constraints.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../net/jini/security/BasicProxyPreparer.html#BasicProxyPreparer-boolean-net.jini.core.constraint.MethodConstraints-java.security.Permission:A-">BasicProxyPreparer</a></span>(boolean&nbsp;verify,
<a href="../../../net/jini/core/constraint/MethodConstraints.html" title="interface in net.jini.core.constraint">MethodConstraints</a>&nbsp;methodConstraints,
<a href="http://docs.oracle.com/javase/6/docs/api/java/security/Permission.html?is-external=true" title="class or interface in java.security">Permission</a>[]&nbsp;permissions)</code>
<div class="block">Creates a proxy preparer that specifies whether proxies should be
verified, specifies permissions to grant them, and specifies what method
constraints to use when verifying and setting constraints.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../net/jini/security/BasicProxyPreparer.html#BasicProxyPreparer-boolean-java.security.Permission:A-">BasicProxyPreparer</a></span>(boolean&nbsp;verify,
<a href="http://docs.oracle.com/javase/6/docs/api/java/security/Permission.html?is-external=true" title="class or interface in java.security">Permission</a>[]&nbsp;permissions)</code>
<div class="block">Creates a proxy preparer that specifies whether proxies should be
verified, using the constraints on the proxy by default, and specifies
what permissions to grant to proxies.</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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/security/BasicProxyPreparer.html#equals-java.lang.Object-">equals</a></span>(<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>&nbsp;object)</code>
<div class="block">Returns <code>true</code> if the given object is an instance of the same
class as this object, with the same value for <code>verify</code>, with
method constraints that are <code>equals</code> or similarly not
specified, and with <code>permissions</code> containing the same
elements, independent of order.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected <a href="../../../net/jini/core/constraint/MethodConstraints.html" title="interface in net.jini.core.constraint">MethodConstraints</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/security/BasicProxyPreparer.html#getMethodConstraints-java.lang.Object-">getMethodConstraints</a></span>(<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>&nbsp;proxy)</code>
<div class="block">Returns the method constraints to use when verifying and setting
constraints on the specified proxy.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/6/docs/api/java/security/Permission.html?is-external=true" title="class or interface in java.security">Permission</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/security/BasicProxyPreparer.html#getPermissions-java.lang.Object-">getPermissions</a></span>(<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>&nbsp;proxy)</code>
<div class="block">Returns the permissions to grant to proxies, or an empty array if no
permissions should be granted.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/security/BasicProxyPreparer.html#grant-java.lang.Object-">grant</a></span>(<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>&nbsp;proxy)</code>
<div class="block">Grants permissions to the proxy.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/security/BasicProxyPreparer.html#hashCode--">hashCode</a></span>()</code>
<div class="block">Returns a hash code value for this object.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/security/BasicProxyPreparer.html#prepareProxy-java.lang.Object-">prepareProxy</a></span>(<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>&nbsp;proxy)</code>
<div class="block">Performs operations on a proxy to prepare it for use, returning the
prepared proxy, which may or may not be the argument itself.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected <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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/security/BasicProxyPreparer.html#setConstraints-java.lang.Object-">setConstraints</a></span>(<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>&nbsp;proxy)</code>
<div class="block">Sets constraints on the proxy.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/security/BasicProxyPreparer.html#toString--">toString</a></span>()</code>
<div class="block">Returns a string representation of this object.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../net/jini/security/BasicProxyPreparer.html#verify-java.lang.Object-">verify</a></span>(<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>&nbsp;proxy)</code>
<div class="block">Verifies that the proxy is trusted.</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#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#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#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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="verify">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>verify</h4>
<pre>protected final&nbsp;boolean verify</pre>
<div class="block">Whether to verify if proxies are trusted.</div>
</li>
</ul>
<a name="methodConstraintsSpecified">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>methodConstraintsSpecified</h4>
<pre>protected final&nbsp;boolean methodConstraintsSpecified</pre>
<div class="block">Whether to use <a href="../../../net/jini/security/BasicProxyPreparer.html#methodConstraints"><code>methodConstraints</code></a> when verifying if proxies are
trusted and for setting their constraints.</div>
</li>
</ul>
<a name="methodConstraints">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>methodConstraints</h4>
<pre>protected final&nbsp;<a href="../../../net/jini/core/constraint/MethodConstraints.html" title="interface in net.jini.core.constraint">MethodConstraints</a> methodConstraints</pre>
<div class="block">Method constraints to use when verifying if proxies are trusted and for
setting their constraints, if <a href="../../../net/jini/security/BasicProxyPreparer.html#methodConstraintsSpecified"><code>methodConstraintsSpecified</code></a> is
<code>true</code>. Set to <code>null</code> if
<code>methodConstraintsSpecified</code> is <code>false</code>.</div>
</li>
</ul>
<a name="permissions">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>permissions</h4>
<pre>protected final&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/security/Permission.html?is-external=true" title="class or interface in java.security">Permission</a>[] permissions</pre>
<div class="block">Permissions to grant to proxies, or an empty array if no permissions
should be granted. The value is always non-<code>null</code>.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="BasicProxyPreparer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BasicProxyPreparer</h4>
<pre>public&nbsp;BasicProxyPreparer()</pre>
<div class="block">Creates a proxy preparer that specifies not to verify proxies, grant
them permissions, or set their constraints.</div>
</li>
</ul>
<a name="BasicProxyPreparer-boolean-java.security.Permission:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BasicProxyPreparer</h4>
<pre>public&nbsp;BasicProxyPreparer(boolean&nbsp;verify,
<a href="http://docs.oracle.com/javase/6/docs/api/java/security/Permission.html?is-external=true" title="class or interface in java.security">Permission</a>[]&nbsp;permissions)</pre>
<div class="block">Creates a proxy preparer that specifies whether proxies should be
verified, using the constraints on the proxy by default, and specifies
what permissions to grant to proxies.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>verify</code> - whether to verify if proxies are trusted</dd>
<dd><code>permissions</code> - permissions to grant, or <code>null</code> if no
permissions should be granted</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>permissions</code> is not
<code>null</code> and any of its elements are <code>null</code></dd>
</dl>
</li>
</ul>
<a name="BasicProxyPreparer-boolean-net.jini.core.constraint.MethodConstraints-java.security.Permission:A-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BasicProxyPreparer</h4>
<pre>public&nbsp;BasicProxyPreparer(boolean&nbsp;verify,
<a href="../../../net/jini/core/constraint/MethodConstraints.html" title="interface in net.jini.core.constraint">MethodConstraints</a>&nbsp;methodConstraints,
<a href="http://docs.oracle.com/javase/6/docs/api/java/security/Permission.html?is-external=true" title="class or interface in java.security">Permission</a>[]&nbsp;permissions)</pre>
<div class="block">Creates a proxy preparer that specifies whether proxies should be
verified, specifies permissions to grant them, and specifies what method
constraints to use when verifying and setting constraints.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>verify</code> - whether to verify if proxies are trusted</dd>
<dd><code>methodConstraints</code> - method constraints to use when verifying
and setting constraints</dd>
<dd><code>permissions</code> - permissions to grant, or <code>null</code> if no
permissions should be granted</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>permissions</code> is not
<code>null</code> and any of its elements are <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="getMethodConstraints-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMethodConstraints</h4>
<pre>protected&nbsp;<a href="../../../net/jini/core/constraint/MethodConstraints.html" title="interface in net.jini.core.constraint">MethodConstraints</a>&nbsp;getMethodConstraints(<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>&nbsp;proxy)</pre>
<div class="block">Returns the method constraints to use when verifying and setting
constraints on the specified proxy. <p>
The default implementation returns the value of <a href="../../../net/jini/security/BasicProxyPreparer.html#methodConstraints"><code>methodConstraints</code></a> if <a href="../../../net/jini/security/BasicProxyPreparer.html#methodConstraintsSpecified"><code>methodConstraintsSpecified</code></a> is
<code>true</code>, else returns the constraints on the specified proxy
if it implements <a href="../../../net/jini/core/constraint/RemoteMethodControl.html" title="interface in net.jini.core.constraint"><code>RemoteMethodControl</code></a>, else returns
<code>null</code>. <p>
Subclasses may wish to override this method, for example, to augment the
existing constraints on the proxy rather than replacing them.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>proxy</code> - the proxy being prepared</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the method constraints to use when verifying and setting
constraints on the proxy</dd>
</dl>
</li>
</ul>
<a name="getPermissions-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPermissions</h4>
<pre>protected&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/security/Permission.html?is-external=true" title="class or interface in java.security">Permission</a>[]&nbsp;getPermissions(<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>&nbsp;proxy)</pre>
<div class="block">Returns the permissions to grant to proxies, or an empty array if no
permissions should be granted. The return value need not be newly
created, but cannot be <code>null</code>. <p>
The default implementation returns the value of <a href="../../../net/jini/security/BasicProxyPreparer.html#permissions"><code>permissions</code></a>. <p>
Subclasses may wish to override this method, for example, to grant
permissions that depend on principal constraints found on the proxy.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>proxy</code> - the proxy being prepared</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the permissions to grant to the proxy</dd>
</dl>
</li>
</ul>
<a name="prepareProxy-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepareProxy</h4>
<pre>public&nbsp;<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>&nbsp;prepareProxy(<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>&nbsp;proxy)
throws <a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre>
<div class="block">Performs operations on a proxy to prepare it for use, returning the
prepared proxy, which may or may not be the argument itself. <p>
The default implementation provides the following behavior. If
<code>proxy</code> is <code>null</code>, throws a <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang"><code>NullPointerException</code></a>. Otherwise, calls <a href="../../../net/jini/security/BasicProxyPreparer.html#verify-java.lang.Object-"><code>verify</code></a>
with <code>proxy</code>. If the <code>verify</code> call succeeds, calls
<a href="../../../net/jini/security/BasicProxyPreparer.html#grant-java.lang.Object-"><code>grant</code></a> with <code>proxy</code>. If the <code>grant</code>
call succeeds, returns the result of calling <a href="../../../net/jini/security/BasicProxyPreparer.html#setConstraints-java.lang.Object-"><code>setConstraints</code></a> with <code>proxy</code>. <p>
Subclasses may wish to override this method, for example, to perform
additional operations, typically calling the default implementation via
<code>super</code>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../net/jini/security/ProxyPreparer.html#prepareProxy-java.lang.Object-">prepareProxy</a></code>&nbsp;in interface&nbsp;<code><a href="../../../net/jini/security/ProxyPreparer.html" title="interface in net.jini.security">ProxyPreparer</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>proxy</code> - the proxy to prepare</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the prepared proxy</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>proxy</code> is <code>null</code></dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code> - if a communication-related exception occurs</dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></code> - if a security exception occurs</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../net/jini/security/BasicProxyPreparer.html#verify-java.lang.Object-"><code>verify</code></a>,
<a href="../../../net/jini/security/BasicProxyPreparer.html#grant-java.lang.Object-"><code>grant</code></a>,
<a href="../../../net/jini/security/BasicProxyPreparer.html#setConstraints-java.lang.Object-"><code>setConstraints</code></a></dd>
</dl>
</li>
</ul>
<a name="verify-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>verify</h4>
<pre>protected&nbsp;void&nbsp;verify(<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>&nbsp;proxy)
throws <a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></pre>
<div class="block">Verifies that the proxy is trusted. Called by the default implementation
of <a href="../../../net/jini/security/BasicProxyPreparer.html#prepareProxy-java.lang.Object-"><code>prepareProxy</code></a>. <p>
The default implementation provides the following behavior. If
<code>proxy</code> is <code>null</code>, throws a <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang"><code>NullPointerException</code></a>. Otherwise, if <a href="../../../net/jini/security/BasicProxyPreparer.html#verify"><code>verify</code></a> is
<code>true</code>, calls <a href="../../../net/jini/security/Security.html#verifyObjectTrust-java.lang.Object-java.lang.ClassLoader-java.util.Collection-"><code>Security.verifyObjectTrust</code></a>, with <code>proxy</code>, <code>null</code>
for the class loader, and, for the context, a collection containing the
result of calling <a href="../../../net/jini/security/BasicProxyPreparer.html#getMethodConstraints-java.lang.Object-"><code>getMethodConstraints</code></a>
with <code>proxy</code>, or an empty collection if the constraints are
<code>null</code>. <p>
Subclasses may wish to override this method, for example, to specify a
different class loader or context when verifying the proxy.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>proxy</code> - the proxy to verify</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>proxy</code> is <code>null</code></dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/rmi/RemoteException.html?is-external=true" title="class or interface in java.rmi">RemoteException</a></code> - if a communication-related exception occurs</dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></code> - if verifying that the proxy is trusted fails</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../net/jini/security/BasicProxyPreparer.html#prepareProxy-java.lang.Object-"><code>prepareProxy</code></a>,
<a href="../../../net/jini/security/BasicProxyPreparer.html#getMethodConstraints-java.lang.Object-"><code>getMethodConstraints</code></a>,
<a href="../../../net/jini/security/Security.html#verifyObjectTrust-java.lang.Object-java.lang.ClassLoader-java.util.Collection-"><code>Security.verifyObjectTrust</code></a></dd>
</dl>
</li>
</ul>
<a name="grant-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>grant</h4>
<pre>protected&nbsp;void&nbsp;grant(<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>&nbsp;proxy)</pre>
<div class="block">Grants permissions to the proxy. Called by the default implementation of
<a href="../../../net/jini/security/BasicProxyPreparer.html#prepareProxy-java.lang.Object-"><code>prepareProxy</code></a> unless <a href="../../../net/jini/security/BasicProxyPreparer.html#verify-java.lang.Object-"><code>verify</code></a>
throws an exception. <p>
The default implementation provides the following behavior. If
<code>proxy</code> is <code>null</code>, throws a <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang"><code>NullPointerException</code></a>. Otherwise, calls <a href="../../../net/jini/security/BasicProxyPreparer.html#getPermissions-java.lang.Object-"><code>getPermissions</code></a> with <code>proxy</code> to determine what permissions
should be granted. If the permissions are not empty, calls <a href="../../../net/jini/security/Security.html#grant-java.lang.Class-java.security.Permission:A-"><code>Security.grant</code></a>, with the proxy's
class as the class argument and those permissions. If <code>grant</code>
discovers that dynamic permission grants are not supported and throws a
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang"><code>UnsupportedOperationException</code></a>, catches that exception and throws
a <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang"><code>SecurityException</code></a>. <p>
Subclasses may wish to override this method, for example, to alter the
principals for which permission grants are made.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>proxy</code> - the proxy to grant permissions</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></code> - if a security exception occurs</dd>
<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 proxy is <code>null</code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../net/jini/security/BasicProxyPreparer.html#prepareProxy-java.lang.Object-"><code>prepareProxy</code></a>,
<a href="../../../net/jini/security/BasicProxyPreparer.html#getPermissions-java.lang.Object-"><code>getPermissions</code></a>,
<a href="../../../net/jini/security/Security.html#grant-java.lang.Class-java.security.Permission:A-"><code>Security.grant</code></a></dd>
</dl>
</li>
</ul>
<a name="setConstraints-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConstraints</h4>
<pre>protected&nbsp;<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>&nbsp;setConstraints(<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>&nbsp;proxy)</pre>
<div class="block">Sets constraints on the proxy. Called by the default implementation of
<a href="../../../net/jini/security/BasicProxyPreparer.html#prepareProxy-java.lang.Object-"><code>prepareProxy</code></a> unless <a href="../../../net/jini/security/BasicProxyPreparer.html#verify-java.lang.Object-"><code>verify</code></a>
or <a href="../../../net/jini/security/BasicProxyPreparer.html#grant-java.lang.Object-"><code>grant</code></a> throw an exception. <p>
The default implementation provides the following behavior. If
<code>proxy</code> is <code>null</code>, throws a <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang"><code>NullPointerException</code></a>. Otherwise, if <a href="../../../net/jini/security/BasicProxyPreparer.html#methodConstraintsSpecified"><code>methodConstraintsSpecified</code></a>
is <code>false</code>, returns the proxy, else if object does not
implement <a href="../../../net/jini/core/constraint/RemoteMethodControl.html" title="interface in net.jini.core.constraint"><code>RemoteMethodControl</code></a>, throws a <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang"><code>SecurityException</code></a>, else returns the result of calling <a href="../../../net/jini/core/constraint/RemoteMethodControl.html#setConstraints-net.jini.core.constraint.MethodConstraints-"><code>RemoteMethodControl.setConstraints</code></a>
on the proxy, using the value returned from calling <a href="../../../net/jini/security/BasicProxyPreparer.html#getMethodConstraints-java.lang.Object-"><code>getMethodConstraints</code></a> with <code>proxy</code>. <p>
Subclasses may wish to override this method, for example, to support
verifying objects that do not implement <a href="../../../net/jini/core/constraint/RemoteMethodControl.html" title="interface in net.jini.core.constraint"><code>RemoteMethodControl</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>proxy</code> - the proxy</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the proxy with updated constraints</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>proxy</code> is <code>null</code></dd>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang">SecurityException</a></code> - if a security exception occurs</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../net/jini/security/BasicProxyPreparer.html#prepareProxy-java.lang.Object-"><code>prepareProxy</code></a>,
<a href="../../../net/jini/security/BasicProxyPreparer.html#getMethodConstraints-java.lang.Object-"><code>getMethodConstraints</code></a>,
<a href="../../../net/jini/core/constraint/RemoteMethodControl.html#setConstraints-net.jini.core.constraint.MethodConstraints-"><code>RemoteMethodControl.setConstraints</code></a></dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
<div class="block">Returns a string representation of this object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><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></code>&nbsp;in class&nbsp;<code><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></code></dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(<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>&nbsp;object)</pre>
<div class="block">Returns <code>true</code> if the given object is an instance of the same
class as this object, with the same value for <code>verify</code>, with
method constraints that are <code>equals</code> or similarly not
specified, and with <code>permissions</code> containing the same
elements, independent of order.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><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></code>&nbsp;in class&nbsp;<code><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></code></dd>
</dl>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<div class="block">Returns a hash code value for this object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><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></code>&nbsp;in class&nbsp;<code><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></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/BasicProxyPreparer.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/security/AuthenticationPermission.html" title="class in net.jini.security"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../net/jini/security/GrantPermission.html" title="class in net.jini.security"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?net/jini/security/BasicProxyPreparer.html" target="_top">Frames</a></li>
<li><a href="BasicProxyPreparer.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><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 name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>