Google Git
Sign in
apache / guacamole-website / eaa291ada94e6f8f691438e7bc079399638ef859 / . / doc / 1.1.0 / guacamole-ext / org / apache / guacamole / net / auth / Permissions.html
blob: 0491e3e6321ed8622d5896e9bb426e0559f08061 [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_212) on Sun Jan 26 10:16:17 PST 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Permissions (guacamole-ext 1.1.0 API)</title>
<meta name="date" content="2020-01-26">
<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="Permissions (guacamole-ext 1.1.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":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/Permissions.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="../../../../../org/apache/guacamole/net/auth/Identifiable.html" title="interface in org.apache.guacamole.net.auth"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/guacamole/net/auth/RelatedObjectSet.html" title="interface in org.apache.guacamole.net.auth"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/guacamole/net/auth/Permissions.html" target="_top">Frames</a></li>
<li><a href="Permissions.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">org.apache.guacamole.net.auth</div>
<h2 title="Interface Permissions" class="title">Interface Permissions</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../../../org/apache/guacamole/net/auth/User.html" title="interface in org.apache.guacamole.net.auth">User</a>, <a href="../../../../../org/apache/guacamole/net/auth/UserGroup.html" title="interface in org.apache.guacamole.net.auth">UserGroup</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/guacamole/net/auth/AbstractUser.html" title="class in org.apache.guacamole.net.auth">AbstractUser</a>, <a href="../../../../../org/apache/guacamole/net/auth/AbstractUserGroup.html" title="class in org.apache.guacamole.net.auth">AbstractUserGroup</a>, <a href="../../../../../org/apache/guacamole/net/auth/DelegatingUser.html" title="class in org.apache.guacamole.net.auth">DelegatingUser</a>, <a href="../../../../../org/apache/guacamole/net/auth/DelegatingUserGroup.html" title="class in org.apache.guacamole.net.auth">DelegatingUserGroup</a>, <a href="../../../../../org/apache/guacamole/net/auth/simple/SimpleUser.html" title="class in org.apache.guacamole.net.auth.simple">SimpleUser</a>, <a href="../../../../../org/apache/guacamole/net/auth/simple/SimpleUserGroup.html" title="class in org.apache.guacamole.net.auth.simple">SimpleUserGroup</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Permissions</span></pre>
<div class="block">An object which may be granted permissions to access/manipulate various
other objects or aspects of the system. The permissions granted are exposed
through subclasses of PermissionSet, and may be mutable depending on the
access level of the current user.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/Permissions.html#getActiveConnectionPermissions--">getActiveConnectionPermissions</a></span>()</code>
<div class="block">Returns all permissions given to this object regarding currently-active
connections.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/Permissions.html#getConnectionGroupPermissions--">getConnectionGroupPermissions</a></span>()</code>
<div class="block">Returns all connection group permissions given to this object.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/Permissions.html#getConnectionPermissions--">getConnectionPermissions</a></span>()</code>
<div class="block">Returns all connection permissions given to this object.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/Permissions.html#getSharingProfilePermissions--">getSharingProfilePermissions</a></span>()</code>
<div class="block">Returns all sharing profile permissions given to this object.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/guacamole/net/auth/permission/SystemPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">SystemPermissionSet</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/Permissions.html#getSystemPermissions--">getSystemPermissions</a></span>()</code>
<div class="block">Returns all system-level permissions given to this object.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/Permissions.html#getUserGroupPermissions--">getUserGroupPermissions</a></span>()</code>
<div class="block">Returns all user group permissions given to this object.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/Permissions.html#getUserPermissions--">getUserPermissions</a></span>()</code>
<div class="block">Returns all user permissions given to this object.</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="getActiveConnectionPermissions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActiveConnectionPermissions</h4>
<pre><a href="../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a>&nbsp;getActiveConnectionPermissions()
throws org.apache.guacamole.GuacamoleException</pre>
<div class="block">Returns all permissions given to this object regarding currently-active
connections.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An ObjectPermissionSet of all active connection permissions granted
to this object.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while retrieving permissions, or if reading all
permissions is not allowed.</dd>
</dl>
</li>
</ul>
<a name="getConnectionGroupPermissions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnectionGroupPermissions</h4>
<pre><a href="../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a>&nbsp;getConnectionGroupPermissions()
throws org.apache.guacamole.GuacamoleException</pre>
<div class="block">Returns all connection group permissions given to this object.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An ObjectPermissionSet of all connection group permissions granted
to this object.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while retrieving permissions, or if reading all
permissions is not allowed.</dd>
</dl>
</li>
</ul>
<a name="getConnectionPermissions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnectionPermissions</h4>
<pre><a href="../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a>&nbsp;getConnectionPermissions()
throws org.apache.guacamole.GuacamoleException</pre>
<div class="block">Returns all connection permissions given to this object.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An ObjectPermissionSet of all connection permissions granted to this
object.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while retrieving permissions, or if reading all
permissions is not allowed.</dd>
</dl>
</li>
</ul>
<a name="getSharingProfilePermissions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSharingProfilePermissions</h4>
<pre><a href="../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a>&nbsp;getSharingProfilePermissions()
throws org.apache.guacamole.GuacamoleException</pre>
<div class="block">Returns all sharing profile permissions given to this object.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An ObjectPermissionSet of all sharing profile permissions granted to
this object.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while retrieving permissions, or if reading all
permissions is not allowed.</dd>
</dl>
</li>
</ul>
<a name="getSystemPermissions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSystemPermissions</h4>
<pre><a href="../../../../../org/apache/guacamole/net/auth/permission/SystemPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">SystemPermissionSet</a>&nbsp;getSystemPermissions()
throws org.apache.guacamole.GuacamoleException</pre>
<div class="block">Returns all system-level permissions given to this object.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A SystemPermissionSet of all system-level permissions granted to
this object.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while retrieving permissions, or if reading all
permissions is not allowed.</dd>
</dl>
</li>
</ul>
<a name="getUserPermissions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserPermissions</h4>
<pre><a href="../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a>&nbsp;getUserPermissions()
throws org.apache.guacamole.GuacamoleException</pre>
<div class="block">Returns all user permissions given to this object.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An ObjectPermissionSet of all user permissions granted to this
object.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while retrieving permissions, or if reading all
permissions is not allowed.</dd>
</dl>
</li>
</ul>
<a name="getUserGroupPermissions--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getUserGroupPermissions</h4>
<pre><a href="../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a>&nbsp;getUserGroupPermissions()
throws org.apache.guacamole.GuacamoleException</pre>
<div class="block">Returns all user group permissions given to this object.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An ObjectPermissionSet of all user group permissions granted to this
object.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while retrieving permissions, or if reading all
permissions is not allowed.</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/Permissions.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="../../../../../org/apache/guacamole/net/auth/Identifiable.html" title="interface in org.apache.guacamole.net.auth"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/guacamole/net/auth/RelatedObjectSet.html" title="interface in org.apache.guacamole.net.auth"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/guacamole/net/auth/Permissions.html" target="_top">Frames</a></li>
<li><a href="Permissions.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 &#169; 2020. All rights reserved.</small></p>
</body>
</html>