blob: 5f37b67883a15ee7d05dd7f4d1e1ac4259457a7d [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>SystemPermissionSet (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="SystemPermissionSet (guacamole-ext 1.1.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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/SystemPermissionSet.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/permission/SystemPermission.Type.html" title="enum in org.apache.guacamole.net.auth.permission"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/guacamole/net/auth/permission/SystemPermissionSet.html" target="_top">Frames</a></li>
<li><a href="SystemPermissionSet.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>Constr&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>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.permission</div>
<h2 title="Interface SystemPermissionSet" class="title">Interface SystemPermissionSet</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../../../org/apache/guacamole/net/auth/permission/PermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">PermissionSet</a>&lt;<a href="../../../../../../org/apache/guacamole/net/auth/permission/SystemPermission.html" title="class in org.apache.guacamole.net.auth.permission">SystemPermission</a>&gt;</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleSystemPermissionSet.html" title="class in org.apache.guacamole.net.auth.simple">SimpleSystemPermissionSet</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">SystemPermissionSet</span>
extends <a href="../../../../../../org/apache/guacamole/net/auth/permission/PermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">PermissionSet</a>&lt;<a href="../../../../../../org/apache/guacamole/net/auth/permission/SystemPermission.html" title="class in org.apache.guacamole.net.auth.permission">SystemPermission</a>&gt;</pre>
<div class="block">A set of permissions which affects the system as a whole.</div>
</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>static <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/permission/SystemPermissionSet.html#EMPTY_SET">EMPTY_SET</a></span></code>
<div class="block">An immutable instance of SystemPermissionSet which contains no
permissions.</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="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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/permission/SystemPermissionSet.html#addPermission-org.apache.guacamole.net.auth.permission.SystemPermission.Type-">addPermission</a></span>(<a href="../../../../../../org/apache/guacamole/net/auth/permission/SystemPermission.Type.html" title="enum in org.apache.guacamole.net.auth.permission">SystemPermission.Type</a>&nbsp;permission)</code>
<div class="block">Adds the specified permission.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/permission/SystemPermissionSet.html#addPermissions-java.util.Set-">addPermissions</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../../org/apache/guacamole/net/auth/permission/SystemPermission.html" title="class in org.apache.guacamole.net.auth.permission">SystemPermission</a>&gt;&nbsp;permissions)</code>
<div class="block">Adds the specified permissions, if not already granted.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../../org/apache/guacamole/net/auth/permission/SystemPermission.html" title="class in org.apache.guacamole.net.auth.permission">SystemPermission</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/permission/SystemPermissionSet.html#getPermissions--">getPermissions</a></span>()</code>
<div class="block">Returns a Set which contains all permissions granted within this
permission set.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/permission/SystemPermissionSet.html#hasPermission-org.apache.guacamole.net.auth.permission.SystemPermission.Type-">hasPermission</a></span>(<a href="../../../../../../org/apache/guacamole/net/auth/permission/SystemPermission.Type.html" title="enum in org.apache.guacamole.net.auth.permission">SystemPermission.Type</a>&nbsp;permission)</code>
<div class="block">Tests whether the permission of the given type is granted.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/permission/SystemPermissionSet.html#removePermission-org.apache.guacamole.net.auth.permission.SystemPermission.Type-">removePermission</a></span>(<a href="../../../../../../org/apache/guacamole/net/auth/permission/SystemPermission.Type.html" title="enum in org.apache.guacamole.net.auth.permission">SystemPermission.Type</a>&nbsp;permission)</code>
<div class="block">Removes the specified permission.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/permission/SystemPermissionSet.html#removePermissions-java.util.Set-">removePermissions</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../../org/apache/guacamole/net/auth/permission/SystemPermission.html" title="class in org.apache.guacamole.net.auth.permission">SystemPermission</a>&gt;&nbsp;permissions)</code>
<div class="block">Removes each of the specified permissions, if granted.</div>
</td>
</tr>
</table>
</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="EMPTY_SET">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>EMPTY_SET</h4>
<pre>static final&nbsp;<a href="../../../../../../org/apache/guacamole/net/auth/permission/SystemPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">SystemPermissionSet</a> EMPTY_SET</pre>
<div class="block">An immutable instance of SystemPermissionSet which contains no
permissions.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="hasPermission-org.apache.guacamole.net.auth.permission.SystemPermission.Type-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasPermission</h4>
<pre>boolean&nbsp;hasPermission(<a href="../../../../../../org/apache/guacamole/net/auth/permission/SystemPermission.Type.html" title="enum in org.apache.guacamole.net.auth.permission">SystemPermission.Type</a>&nbsp;permission)
throws org.apache.guacamole.GuacamoleException</pre>
<div class="block">Tests whether the permission of the given type is granted.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>permission</code> - The permission to check.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the permission is granted, false otherwise.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while checking permissions, or if permissions
cannot be checked due to lack of permissions to do so.</dd>
</dl>
</li>
</ul>
<a name="addPermission-org.apache.guacamole.net.auth.permission.SystemPermission.Type-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPermission</h4>
<pre>void&nbsp;addPermission(<a href="../../../../../../org/apache/guacamole/net/auth/permission/SystemPermission.Type.html" title="enum in org.apache.guacamole.net.auth.permission">SystemPermission.Type</a>&nbsp;permission)
throws org.apache.guacamole.GuacamoleException</pre>
<div class="block">Adds the specified permission.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>permission</code> - The permission to add.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while adding the permission, or if permission to
add permissions is denied.</dd>
</dl>
</li>
</ul>
<a name="removePermission-org.apache.guacamole.net.auth.permission.SystemPermission.Type-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removePermission</h4>
<pre>void&nbsp;removePermission(<a href="../../../../../../org/apache/guacamole/net/auth/permission/SystemPermission.Type.html" title="enum in org.apache.guacamole.net.auth.permission">SystemPermission.Type</a>&nbsp;permission)
throws org.apache.guacamole.GuacamoleException</pre>
<div class="block">Removes the specified permission.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>permission</code> - The permission to remove.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while removing the permission, or if permission
to remove permissions is denied.</dd>
</dl>
</li>
</ul>
<a name="getPermissions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPermissions</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../../org/apache/guacamole/net/auth/permission/SystemPermission.html" title="class in org.apache.guacamole.net.auth.permission">SystemPermission</a>&gt;&nbsp;getPermissions()
throws org.apache.guacamole.GuacamoleException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/guacamole/net/auth/permission/PermissionSet.html#getPermissions--">PermissionSet</a></code></span></div>
<div class="block">Returns a Set which contains all permissions granted within this
permission set.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/guacamole/net/auth/permission/PermissionSet.html#getPermissions--">getPermissions</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/guacamole/net/auth/permission/PermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">PermissionSet</a>&lt;<a href="../../../../../../org/apache/guacamole/net/auth/permission/SystemPermission.html" title="class in org.apache.guacamole.net.auth.permission">SystemPermission</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A Set containing all permissions granted within this permission set.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while retrieving permissions, or if permissions
cannot be retrieved due to lack of permissions to do so.</dd>
</dl>
</li>
</ul>
<a name="addPermissions-java.util.Set-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addPermissions</h4>
<pre>void&nbsp;addPermissions(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../../org/apache/guacamole/net/auth/permission/SystemPermission.html" title="class in org.apache.guacamole.net.auth.permission">SystemPermission</a>&gt;&nbsp;permissions)
throws org.apache.guacamole.GuacamoleException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/guacamole/net/auth/permission/PermissionSet.html#addPermissions-java.util.Set-">PermissionSet</a></code></span></div>
<div class="block">Adds the specified permissions, if not already granted. If a specified
permission is already granted, no operation is performed regarding that
permission.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/guacamole/net/auth/permission/PermissionSet.html#addPermissions-java.util.Set-">addPermissions</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/guacamole/net/auth/permission/PermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">PermissionSet</a>&lt;<a href="../../../../../../org/apache/guacamole/net/auth/permission/SystemPermission.html" title="class in org.apache.guacamole.net.auth.permission">SystemPermission</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>permissions</code> - The permissions to add.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while adding the permissions, or if permission to
add permissions is denied.</dd>
</dl>
</li>
</ul>
<a name="removePermissions-java.util.Set-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removePermissions</h4>
<pre>void&nbsp;removePermissions(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<a href="../../../../../../org/apache/guacamole/net/auth/permission/SystemPermission.html" title="class in org.apache.guacamole.net.auth.permission">SystemPermission</a>&gt;&nbsp;permissions)
throws org.apache.guacamole.GuacamoleException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../../org/apache/guacamole/net/auth/permission/PermissionSet.html#removePermissions-java.util.Set-">PermissionSet</a></code></span></div>
<div class="block">Removes each of the specified permissions, if granted. If a specified
permission is not granted, no operation is performed regarding that
permission.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/guacamole/net/auth/permission/PermissionSet.html#removePermissions-java.util.Set-">removePermissions</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/apache/guacamole/net/auth/permission/PermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">PermissionSet</a>&lt;<a href="../../../../../../org/apache/guacamole/net/auth/permission/SystemPermission.html" title="class in org.apache.guacamole.net.auth.permission">SystemPermission</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>permissions</code> - The permissions to remove.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while removing the permissions, or if permission
to remove permissions is denied.</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/SystemPermissionSet.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/permission/SystemPermission.Type.html" title="enum in org.apache.guacamole.net.auth.permission"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/guacamole/net/auth/permission/SystemPermissionSet.html" target="_top">Frames</a></li>
<li><a href="SystemPermissionSet.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>Constr&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>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>