| <!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>SimpleObjectPermissionSet (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="SimpleObjectPermissionSet (guacamole-ext 1.1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":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/SimpleObjectPermissionSet.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/simple/SimpleDirectory.html" title="class in org.apache.guacamole.net.auth.simple"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleRelatedObjectSet.html" title="class in org.apache.guacamole.net.auth.simple"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/guacamole/net/auth/simple/SimpleObjectPermissionSet.html" target="_top">Frames</a></li> |
| <li><a href="SimpleObjectPermissionSet.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.simple</div> |
| <h2 title="Class SimpleObjectPermissionSet" class="title">Class SimpleObjectPermissionSet</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/8/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>org.apache.guacamole.net.auth.simple.SimpleObjectPermissionSet</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a>, <a href="../../../../../../org/apache/guacamole/net/auth/permission/PermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">PermissionSet</a><<a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermission.html" title="class in org.apache.guacamole.net.auth.permission">ObjectPermission</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">SimpleObjectPermissionSet</span> |
| extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a></pre> |
| <div class="block">A read-only implementation of ObjectPermissionSet which uses a backing Set |
| of Permissions to determine which permissions are present.</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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.guacamole.net.auth.permission.ObjectPermissionSet"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.guacamole.net.auth.permission.<a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a></h3> |
| <code><a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html#EMPTY_SET">EMPTY_SET</a></code></li> |
| </ul> |
| </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"> </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="../../../../../../org/apache/guacamole/net/auth/simple/SimpleObjectPermissionSet.html#SimpleObjectPermissionSet--">SimpleObjectPermissionSet</a></span>()</code> |
| <div class="block">Creates a new empty SimpleObjectPermissionSet.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleObjectPermissionSet.html#SimpleObjectPermissionSet-java.util.Collection-">SimpleObjectPermissionSet</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> identifiers)</code> |
| <div class="block">Creates a new SimpleObjectPermissionSet which contains only READ |
| permissions for each of the given identifiers.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleObjectPermissionSet.html#SimpleObjectPermissionSet-java.util.Collection-java.util.Collection-">SimpleObjectPermissionSet</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> identifiers, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermission.Type.html" title="enum in org.apache.guacamole.net.auth.permission">ObjectPermission.Type</a>> types)</code> |
| <div class="block">Creates a new SimpleObjectPermissionSet which contains permissions for |
| all possible unique combinations of the given identifiers and permission |
| types.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleObjectPermissionSet.html#SimpleObjectPermissionSet-java.util.Set-">SimpleObjectPermissionSet</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><<a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermission.html" title="class in org.apache.guacamole.net.auth.permission">ObjectPermission</a>> permissions)</code> |
| <div class="block">Creates a new SimpleObjectPermissionSet which contains the permissions |
| within the given Set.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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/simple/SimpleObjectPermissionSet.html#addPermission-org.apache.guacamole.net.auth.permission.ObjectPermission.Type-java.lang.String-">addPermission</a></span>(<a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermission.Type.html" title="enum in org.apache.guacamole.net.auth.permission">ObjectPermission.Type</a> permission, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> identifier)</code> |
| <div class="block">Adds the specified permission for the object having the given |
| identifier.</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/simple/SimpleObjectPermissionSet.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><<a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermission.html" title="class in org.apache.guacamole.net.auth.permission">ObjectPermission</a>> 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/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/8/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="../../../../../../org/apache/guacamole/net/auth/simple/SimpleObjectPermissionSet.html#getAccessibleObjects-java.util.Collection-java.util.Collection-">getAccessibleObjects</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermission.Type.html" title="enum in org.apache.guacamole.net.auth.permission">ObjectPermission.Type</a>> permissionTypes, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> identifiers)</code> |
| <div class="block">Tests whether this user has the specified permissions for the objects |
| having the given identifiers.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <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><<a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermission.html" title="class in org.apache.guacamole.net.auth.permission">ObjectPermission</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleObjectPermissionSet.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="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleObjectPermissionSet.html#hasPermission-org.apache.guacamole.net.auth.permission.ObjectPermission.Type-java.lang.String-">hasPermission</a></span>(<a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermission.Type.html" title="enum in org.apache.guacamole.net.auth.permission">ObjectPermission.Type</a> permission, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> identifier)</code> |
| <div class="block">Tests whether the permission of the given type is granted for the |
| object having the given identifier.</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/simple/SimpleObjectPermissionSet.html#removePermission-org.apache.guacamole.net.auth.permission.ObjectPermission.Type-java.lang.String-">removePermission</a></span>(<a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermission.Type.html" title="enum in org.apache.guacamole.net.auth.permission">ObjectPermission.Type</a> permission, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> identifier)</code> |
| <div class="block">Removes the specified permission for the object having the given |
| identifier.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleObjectPermissionSet.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><<a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermission.html" title="class in org.apache.guacamole.net.auth.permission">ObjectPermission</a>> permissions)</code> |
| <div class="block">Removes each of the specified permissions, if granted.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleObjectPermissionSet.html#setPermissions-java.util.Set-">setPermissions</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><<a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermission.html" title="class in org.apache.guacamole.net.auth.permission">ObjectPermission</a>> permissions)</code> |
| <div class="block">Sets the Set which backs this SimpleObjectPermissionSet.</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 java.lang.<a href="http://docs.oracle.com/javase/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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="SimpleObjectPermissionSet--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SimpleObjectPermissionSet</h4> |
| <pre>public SimpleObjectPermissionSet()</pre> |
| <div class="block">Creates a new empty SimpleObjectPermissionSet. If you are not extending |
| SimpleObjectPermissionSet and only need an immutable, empty |
| ObjectPermissionSet, consider using <a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html#EMPTY_SET"><code>ObjectPermissionSet.EMPTY_SET</code></a> |
| instead.</div> |
| </li> |
| </ul> |
| <a name="SimpleObjectPermissionSet-java.util.Collection-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SimpleObjectPermissionSet</h4> |
| <pre>public SimpleObjectPermissionSet(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> identifiers, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermission.Type.html" title="enum in org.apache.guacamole.net.auth.permission">ObjectPermission.Type</a>> types)</pre> |
| <div class="block">Creates a new SimpleObjectPermissionSet which contains permissions for |
| all possible unique combinations of the given identifiers and permission |
| types.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifiers</code> - The identifiers which should be associated permissions having each |
| of the given permission types.</dd> |
| <dd><code>types</code> - The types of permissions which should be granted for each of the |
| given identifiers.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SimpleObjectPermissionSet-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SimpleObjectPermissionSet</h4> |
| <pre>public SimpleObjectPermissionSet(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> identifiers)</pre> |
| <div class="block">Creates a new SimpleObjectPermissionSet which contains only READ |
| permissions for each of the given identifiers.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>identifiers</code> - The identifiers which should each be associated with READ |
| permission.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SimpleObjectPermissionSet-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SimpleObjectPermissionSet</h4> |
| <pre>public SimpleObjectPermissionSet(<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><<a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermission.html" title="class in org.apache.guacamole.net.auth.permission">ObjectPermission</a>> permissions)</pre> |
| <div class="block">Creates a new SimpleObjectPermissionSet which contains the permissions |
| within the given Set.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>permissions</code> - The Set of permissions this SimpleObjectPermissionSet should |
| contain.</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="setPermissions-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPermissions</h4> |
| <pre>protected void setPermissions(<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><<a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermission.html" title="class in org.apache.guacamole.net.auth.permission">ObjectPermission</a>> permissions)</pre> |
| <div class="block">Sets the Set which backs this SimpleObjectPermissionSet. Future function |
| calls on this SimpleObjectPermissionSet will use the provided Set.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>permissions</code> - The Set of permissions this SimpleObjectPermissionSet should |
| contain.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPermissions--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPermissions</h4> |
| <pre>public <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><<a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermission.html" title="class in org.apache.guacamole.net.auth.permission">ObjectPermission</a>> getPermissions()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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/ObjectPermissionSet.html#getPermissions--">getPermissions</a></code> in interface <code><a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/guacamole/net/auth/permission/PermissionSet.html#getPermissions--">getPermissions</a></code> in interface <code><a href="../../../../../../org/apache/guacamole/net/auth/permission/PermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">PermissionSet</a><<a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermission.html" title="class in org.apache.guacamole.net.auth.permission">ObjectPermission</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A Set containing all permissions granted within this permission set.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasPermission-org.apache.guacamole.net.auth.permission.ObjectPermission.Type-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasPermission</h4> |
| <pre>public boolean hasPermission(<a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermission.Type.html" title="enum in org.apache.guacamole.net.auth.permission">ObjectPermission.Type</a> permission, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> identifier) |
| throws org.apache.guacamole.GuacamoleException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html#hasPermission-org.apache.guacamole.net.auth.permission.ObjectPermission.Type-java.lang.String-">ObjectPermissionSet</a></code></span></div> |
| <div class="block">Tests whether the permission of the given type is granted for the |
| object having the given identifier.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html#hasPermission-org.apache.guacamole.net.auth.permission.ObjectPermission.Type-java.lang.String-">hasPermission</a></code> in interface <code><a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>permission</code> - The permission to check.</dd> |
| <dd><code>identifier</code> - The identifier of the object affected by the permission being |
| checked.</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.ObjectPermission.Type-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addPermission</h4> |
| <pre>public void addPermission(<a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermission.Type.html" title="enum in org.apache.guacamole.net.auth.permission">ObjectPermission.Type</a> permission, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> identifier) |
| throws org.apache.guacamole.GuacamoleException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html#addPermission-org.apache.guacamole.net.auth.permission.ObjectPermission.Type-java.lang.String-">ObjectPermissionSet</a></code></span></div> |
| <div class="block">Adds the specified permission for the object having the given |
| identifier.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html#addPermission-org.apache.guacamole.net.auth.permission.ObjectPermission.Type-java.lang.String-">addPermission</a></code> in interface <code><a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>permission</code> - The permission to add.</dd> |
| <dd><code>identifier</code> - The identifier of the object affected by the permission being |
| added.</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.ObjectPermission.Type-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removePermission</h4> |
| <pre>public void removePermission(<a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermission.Type.html" title="enum in org.apache.guacamole.net.auth.permission">ObjectPermission.Type</a> permission, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> identifier) |
| throws org.apache.guacamole.GuacamoleException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html#removePermission-org.apache.guacamole.net.auth.permission.ObjectPermission.Type-java.lang.String-">ObjectPermissionSet</a></code></span></div> |
| <div class="block">Removes the specified permission for the object having the given |
| identifier.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html#removePermission-org.apache.guacamole.net.auth.permission.ObjectPermission.Type-java.lang.String-">removePermission</a></code> in interface <code><a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>permission</code> - The permission to remove.</dd> |
| <dd><code>identifier</code> - The identifier of the object affected by the permission being |
| added.</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="getAccessibleObjects-java.util.Collection-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAccessibleObjects</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getAccessibleObjects(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermission.Type.html" title="enum in org.apache.guacamole.net.auth.permission">ObjectPermission.Type</a>> permissionTypes, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> identifiers) |
| throws org.apache.guacamole.GuacamoleException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html#getAccessibleObjects-java.util.Collection-java.util.Collection-">ObjectPermissionSet</a></code></span></div> |
| <div class="block">Tests whether this user has the specified permissions for the objects |
| having the given identifiers. The identifier of an object is returned |
| in a new collection if at least one of the specified permissions is |
| granted for that object.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html#getAccessibleObjects-java.util.Collection-java.util.Collection-">getAccessibleObjects</a></code> in interface <code><a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>permissionTypes</code> - The permissions to check. An identifier will be included in the |
| resulting collection if at least one of these permissions is granted |
| for the associated object</dd> |
| <dd><code>identifiers</code> - The identifiers of the objects affected by the permissions being |
| checked.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A collection containing the subset of identifiers for which at least |
| one of the specified permissions is granted.</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="addPermissions-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addPermissions</h4> |
| <pre>public void 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><<a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermission.html" title="class in org.apache.guacamole.net.auth.permission">ObjectPermission</a>> permissions) |
| throws org.apache.guacamole.GuacamoleException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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/ObjectPermissionSet.html#addPermissions-java.util.Set-">addPermissions</a></code> in interface <code><a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a></code></dd> |
| <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> in interface <code><a href="../../../../../../org/apache/guacamole/net/auth/permission/PermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">PermissionSet</a><<a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermission.html" title="class in org.apache.guacamole.net.auth.permission">ObjectPermission</a>></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>public void 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><<a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermission.html" title="class in org.apache.guacamole.net.auth.permission">ObjectPermission</a>> permissions) |
| throws org.apache.guacamole.GuacamoleException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <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/ObjectPermissionSet.html#removePermissions-java.util.Set-">removePermissions</a></code> in interface <code><a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a></code></dd> |
| <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> in interface <code><a href="../../../../../../org/apache/guacamole/net/auth/permission/PermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">PermissionSet</a><<a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermission.html" title="class in org.apache.guacamole.net.auth.permission">ObjectPermission</a>></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/SimpleObjectPermissionSet.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/simple/SimpleDirectory.html" title="class in org.apache.guacamole.net.auth.simple"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleRelatedObjectSet.html" title="class in org.apache.guacamole.net.auth.simple"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/guacamole/net/auth/simple/SimpleObjectPermissionSet.html" target="_top">Frames</a></li> |
| <li><a href="SimpleObjectPermissionSet.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2020. All rights reserved.</small></p> |
| </body> |
| </html> |