http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/2441fd18/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/simple/SimpleUser.html ---------------------------------------------------------------------- diff --git a/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/simple/SimpleUser.html b/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/simple/SimpleUser.html new file mode 100644 index 0000000..c791463 --- /dev/null +++ b/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/simple/SimpleUser.html @@ -0,0 +1,591 @@ +<!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_111) on Sun Jan 22 20:31:53 PST 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>SimpleUser (guacamole-ext 0.9.11-incubating API)</title> +<meta name="date" content="2017-01-22"> +<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="SimpleUser (guacamole-ext 0.9.11-incubating 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/SimpleUser.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/SimpleSystemPermissionSet.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/SimpleUserContext.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/SimpleUser.html" target="_top">Frames</a></li> +<li><a href="SimpleUser.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 SimpleUser" class="title">Class SimpleUser</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><a href="../../../../../../org/apache/guacamole/net/auth/AbstractIdentifiable.html" title="class in org.apache.guacamole.net.auth">org.apache.guacamole.net.auth.AbstractIdentifiable</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../org/apache/guacamole/net/auth/AbstractUser.html" title="class in org.apache.guacamole.net.auth">org.apache.guacamole.net.auth.AbstractUser</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.guacamole.net.auth.simple.SimpleUser</li> +</ul> +</li> +</ul> +</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/Identifiable.html" title="interface in org.apache.guacamole.net.auth">Identifiable</a>, <a href="../../../../../../org/apache/guacamole/net/auth/User.html" title="interface in org.apache.guacamole.net.auth">User</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">SimpleUser</span> +extends <a href="../../../../../../org/apache/guacamole/net/auth/AbstractUser.html" title="class in org.apache.guacamole.net.auth">AbstractUser</a></pre> +<div class="block">An extremely basic User implementation.</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Michael Jumper</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </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/SimpleUser.html#SimpleUser--">SimpleUser</a></span>()</code> +<div class="block">Creates a completely uninitialized SimpleUser.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleUser.html#SimpleUser-java.lang.String-">SimpleUser</a></span>(<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> username)</code> +<div class="block">Creates a new SimpleUser having the given username and no permissions.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleUser.html#SimpleUser-java.lang.String-java.util.Collection-java.util.Collection-">SimpleUser</a></span>(<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> username, + <a href="http://docs.oracle.com/javase/6/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/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> connectionIdentifiers, + <a href="http://docs.oracle.com/javase/6/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/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> connectionGroupIdentifiers)</code> +<div class="block">Creates a new SimpleUser having the given username and READ access to + the connections and groups having the given identifiers.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleUser.html#SimpleUser-java.lang.String-java.util.Collection-java.util.Collection-java.util.Collection-">SimpleUser</a></span>(<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> username, + <a href="http://docs.oracle.com/javase/6/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/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> userIdentifiers, + <a href="http://docs.oracle.com/javase/6/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/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> connectionIdentifiers, + <a href="http://docs.oracle.com/javase/6/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/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> connectionGroupIdentifiers)</code> +<div class="block">Creates a new SimpleUser having the given username and READ access to + the users, connections, and groups having the given identifiers.</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><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/simple/SimpleUser.html#getActiveConnectionPermissions--">getActiveConnectionPermissions</a></span>()</code> +<div class="block">Returns all permissions given to this user regarding currently-active + connections.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<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>,<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="../../../../../../org/apache/guacamole/net/auth/simple/SimpleUser.html#getAttributes--">getAttributes</a></span>()</code> +<div class="block">Returns all attributes associated with this user.</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/simple/SimpleUser.html#getConnectionGroupPermissions--">getConnectionGroupPermissions</a></span>()</code> +<div class="block">Returns all connection group permissions given to this user.</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/simple/SimpleUser.html#getConnectionPermissions--">getConnectionPermissions</a></span>()</code> +<div class="block">Returns all connection permissions given to this user.</div> +</td> +</tr> +<tr id="i4" 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/simple/SimpleUser.html#getSharingProfilePermissions--">getSharingProfilePermissions</a></span>()</code> +<div class="block">Returns all sharing profile permissions given to this user.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<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/simple/SimpleUser.html#getSystemPermissions--">getSystemPermissions</a></span>()</code> +<div class="block">Returns all system-level permissions given to this user.</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/simple/SimpleUser.html#getUserPermissions--">getUserPermissions</a></span>()</code> +<div class="block">Returns all user permissions given to this user.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleUser.html#setAttributes-java.util.Map-">setAttributes</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<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>,<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>> attributes)</code> +<div class="block">Sets the given attributes.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.guacamole.net.auth.AbstractUser"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.guacamole.net.auth.<a href="../../../../../../org/apache/guacamole/net/auth/AbstractUser.html" title="class in org.apache.guacamole.net.auth">AbstractUser</a></h3> +<code><a href="../../../../../../org/apache/guacamole/net/auth/AbstractUser.html#getPassword--">getPassword</a>, <a href="../../../../../../org/apache/guacamole/net/auth/AbstractUser.html#setPassword-java.lang.String-">setPassword</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.guacamole.net.auth.AbstractIdentifiable"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.guacamole.net.auth.<a href="../../../../../../org/apache/guacamole/net/auth/AbstractIdentifiable.html" title="class in org.apache.guacamole.net.auth">AbstractIdentifiable</a></h3> +<code><a href="../../../../../../org/apache/guacamole/net/auth/AbstractIdentifiable.html#equals-java.lang.Object-">equals</a>, <a href="../../../../../../org/apache/guacamole/net/auth/AbstractIdentifiable.html#getIdentifier--">getIdentifier</a>, <a href="../../../../../../org/apache/guacamole/net/auth/AbstractIdentifiable.html#hashCode--">hashCode</a>, <a href="../../../../../../org/apache/guacamole/net/auth/AbstractIdentifiable.html#setIdentifier-java.lang.String-">setIdentifier</a></code></li> +</ul> +<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/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#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.ht ml?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> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.guacamole.net.auth.Identifiable"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.guacamole.net.auth.<a href="../../../../../../org/apache/guacamole/net/auth/Identifiable.html" title="interface in org.apache.guacamole.net.auth">Identifiable</a></h3> +<code><a href="../../../../../../org/apache/guacamole/net/auth/Identifiable.html#getIdentifier--">getIdentifier</a>, <a href="../../../../../../org/apache/guacamole/net/auth/Identifiable.html#setIdentifier-java.lang.String-">setIdentifier</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="SimpleUser--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SimpleUser</h4> +<pre>public SimpleUser()</pre> +<div class="block">Creates a completely uninitialized SimpleUser.</div> +</li> +</ul> +<a name="SimpleUser-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SimpleUser</h4> +<pre>public SimpleUser(<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> username)</pre> +<div class="block">Creates a new SimpleUser having the given username and no permissions.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>username</code> - The username to assign to this SimpleUser.</dd> +</dl> +</li> +</ul> +<a name="SimpleUser-java.lang.String-java.util.Collection-java.util.Collection-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SimpleUser</h4> +<pre>public SimpleUser(<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> username, + <a href="http://docs.oracle.com/javase/6/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/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> connectionIdentifiers, + <a href="http://docs.oracle.com/javase/6/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/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> connectionGroupIdentifiers)</pre> +<div class="block">Creates a new SimpleUser having the given username and READ access to + the connections and groups having the given identifiers.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>username</code> - The username to assign to this SimpleUser.</dd> +<dd><code>connectionIdentifiers</code> - The identifiers of all connections this user has READ access to.</dd> +<dd><code>connectionGroupIdentifiers</code> - The identifiers of all connection groups this user has READ access + to.</dd> +</dl> +</li> +</ul> +<a name="SimpleUser-java.lang.String-java.util.Collection-java.util.Collection-java.util.Collection-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SimpleUser</h4> +<pre>public SimpleUser(<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> username, + <a href="http://docs.oracle.com/javase/6/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/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> userIdentifiers, + <a href="http://docs.oracle.com/javase/6/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/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> connectionIdentifiers, + <a href="http://docs.oracle.com/javase/6/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/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> connectionGroupIdentifiers)</pre> +<div class="block">Creates a new SimpleUser having the given username and READ access to + the users, connections, and groups having the given identifiers.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>username</code> - The username to assign to this SimpleUser.</dd> +<dd><code>userIdentifiers</code> - The identifiers of all users this user has READ access to.</dd> +<dd><code>connectionIdentifiers</code> - The identifiers of all connections this user has READ access to.</dd> +<dd><code>connectionGroupIdentifiers</code> - The identifiers of all connection groups this user has READ access + to.</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="getAttributes--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAttributes</h4> +<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<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>,<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>> getAttributes()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/User.html#getAttributes--">User</a></code></span></div> +<div class="block">Returns all attributes associated with this user. The returned map may + not be modifiable.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A map of all attribute identifiers to their corresponding values, + for all attributes associated with this user, which may not be + modifiable.</dd> +</dl> +</li> +</ul> +<a name="setAttributes-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAttributes</h4> +<pre>public void setAttributes(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<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>,<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>> attributes)</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/User.html#setAttributes-java.util.Map-">User</a></code></span></div> +<div class="block">Sets the given attributes. If an attribute within the map is not + supported, it will simply be dropped. Any attributes not within the + given map will be left untouched.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>attributes</code> - A map of all attribute identifiers to their corresponding values.</dd> +</dl> +</li> +</ul> +<a name="getSystemPermissions--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSystemPermissions</h4> +<pre>public <a href="../../../../../../org/apache/guacamole/net/auth/permission/SystemPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">SystemPermissionSet</a> getSystemPermissions() + throws org.apache.guacamole.GuacamoleException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/User.html#getSystemPermissions--">User</a></code></span></div> +<div class="block">Returns all system-level permissions given to this user.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A SystemPermissionSet of all system-level permissions granted to + this user.</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>public <a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a> getConnectionPermissions() + throws org.apache.guacamole.GuacamoleException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/User.html#getConnectionPermissions--">User</a></code></span></div> +<div class="block">Returns all connection permissions given to this user.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>An ObjectPermissionSet of all connection permissions granted to this + user.</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>public <a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a> getConnectionGroupPermissions() + throws org.apache.guacamole.GuacamoleException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/User.html#getConnectionGroupPermissions--">User</a></code></span></div> +<div class="block">Returns all connection group permissions given to this user.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>An ObjectPermissionSet of all connection group permissions granted + to this user.</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>public <a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a> getUserPermissions() + throws org.apache.guacamole.GuacamoleException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/User.html#getUserPermissions--">User</a></code></span></div> +<div class="block">Returns all user permissions given to this user.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>An ObjectPermissionSet of all user permissions granted to this user.</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="getActiveConnectionPermissions--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getActiveConnectionPermissions</h4> +<pre>public <a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a> getActiveConnectionPermissions() + throws org.apache.guacamole.GuacamoleException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/User.html#getActiveConnectionPermissions--">User</a></code></span></div> +<div class="block">Returns all permissions given to this user regarding currently-active + connections.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>An ObjectPermissionSet of all active connection permissions granted + to this user.</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="blockListLast"> +<li class="blockList"> +<h4>getSharingProfilePermissions</h4> +<pre>public <a href="../../../../../../org/apache/guacamole/net/auth/permission/ObjectPermissionSet.html" title="interface in org.apache.guacamole.net.auth.permission">ObjectPermissionSet</a> getSharingProfilePermissions()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/User.html#getSharingProfilePermissions--">User</a></code></span></div> +<div class="block">Returns all sharing profile permissions given to this user.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>An ObjectPermissionSet of all sharing profile permissions granted to + this user.</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/SimpleUser.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/SimpleSystemPermissionSet.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/SimpleUserContext.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/SimpleUser.html" target="_top">Frames</a></li> +<li><a href="SimpleUser.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 © 2017. All rights reserved.</small></p> + <!-- Google Analytics --> + <script type="text/javascript"> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + ga('create', 'UA-75289145-1', 'auto'); + ga('send', 'pageview'); + </script> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/2441fd18/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/simple/SimpleUserContext.html ---------------------------------------------------------------------- diff --git a/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/simple/SimpleUserContext.html b/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/simple/SimpleUserContext.html new file mode 100644 index 0000000..fb299d0 --- /dev/null +++ b/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/simple/SimpleUserContext.html @@ -0,0 +1,700 @@ +<!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_111) on Sun Jan 22 20:31:53 PST 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>SimpleUserContext (guacamole-ext 0.9.11-incubating API)</title> +<meta name="date" content="2017-01-22"> +<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="SimpleUserContext (guacamole-ext 0.9.11-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":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/SimpleUserContext.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/SimpleUser.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/SimpleUserDirectory.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/SimpleUserContext.html" target="_top">Frames</a></li> +<li><a href="SimpleUserContext.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 SimpleUserContext" class="title">Class SimpleUserContext</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>org.apache.guacamole.net.auth.simple.SimpleUserContext</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/UserContext.html" title="interface in org.apache.guacamole.net.auth">UserContext</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">SimpleUserContext</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="../../../../../../org/apache/guacamole/net/auth/UserContext.html" title="interface in org.apache.guacamole.net.auth">UserContext</a></pre> +<div class="block">An extremely simple UserContext implementation which provides access to + a defined and restricted set of GuacamoleConfigurations. Access to + querying or modifying either users or permissions is denied.</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Michael Jumper</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </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/SimpleUserContext.html#SimpleUserContext-org.apache.guacamole.net.auth.AuthenticationProvider-java.util.Map-">SimpleUserContext</a></span>(<a href="../../../../../../org/apache/guacamole/net/auth/AuthenticationProvider.html" title="interface in org.apache.guacamole.net.auth">AuthenticationProvider</a> authProvider, + <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<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>,org.apache.guacamole.protocol.GuacamoleConfiguration> configs)</code> +<div class="block">Creates a new SimpleUserContext which provides access to only those + configurations within the given Map.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleUserContext.html#SimpleUserContext-org.apache.guacamole.net.auth.AuthenticationProvider-java.lang.String-java.util.Map-">SimpleUserContext</a></span>(<a href="../../../../../../org/apache/guacamole/net/auth/AuthenticationProvider.html" title="interface in org.apache.guacamole.net.auth">AuthenticationProvider</a> authProvider, + <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> username, + <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<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>,org.apache.guacamole.protocol.GuacamoleConfiguration> configs)</code> +<div class="block">Creates a new SimpleUserContext for the user with the given username + which provides access to only those configurations within the given Map.</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><a href="../../../../../../org/apache/guacamole/net/auth/Directory.html" title="interface in org.apache.guacamole.net.auth">Directory</a><<a href="../../../../../../org/apache/guacamole/net/auth/ActiveConnection.html" title="interface in org.apache.guacamole.net.auth">ActiveConnection</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleUserContext.html#getActiveConnectionDirectory--">getActiveConnectionDirectory</a></span>()</code> +<div class="block">Retrieves a Directory which can be used to view and manipulate + active connections, but only as allowed by the permissions given to the + user.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/guacamole/net/auth/AuthenticationProvider.html" title="interface in org.apache.guacamole.net.auth">AuthenticationProvider</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleUserContext.html#getAuthenticationProvider--">getAuthenticationProvider</a></span>()</code> +<div class="block">Returns the AuthenticationProvider which created this UserContext, which + may not be the same AuthenticationProvider that authenticated the user + associated with this UserContext.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/guacamole/form/Form.html" title="class in org.apache.guacamole.form">Form</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleUserContext.html#getConnectionAttributes--">getConnectionAttributes</a></span>()</code> +<div class="block">Retrieves a collection of all attributes applicable to connections.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/guacamole/net/auth/Directory.html" title="interface in org.apache.guacamole.net.auth">Directory</a><<a href="../../../../../../org/apache/guacamole/net/auth/Connection.html" title="interface in org.apache.guacamole.net.auth">Connection</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleUserContext.html#getConnectionDirectory--">getConnectionDirectory</a></span>()</code> +<div class="block">Retrieves a Directory which can be used to view and manipulate + connections and their configurations, but only as allowed by the + permissions given to the user.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/guacamole/form/Form.html" title="class in org.apache.guacamole.form">Form</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleUserContext.html#getConnectionGroupAttributes--">getConnectionGroupAttributes</a></span>()</code> +<div class="block">Retrieves a collection of all attributes applicable to connection + groups.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/guacamole/net/auth/Directory.html" title="interface in org.apache.guacamole.net.auth">Directory</a><<a href="../../../../../../org/apache/guacamole/net/auth/ConnectionGroup.html" title="interface in org.apache.guacamole.net.auth">ConnectionGroup</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleUserContext.html#getConnectionGroupDirectory--">getConnectionGroupDirectory</a></span>()</code> +<div class="block">Retrieves a Directory which can be used to view and manipulate + connection groups and their members, but only as allowed by the + permissions given to the user.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.html" title="interface in org.apache.guacamole.net.auth">ConnectionRecordSet</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleUserContext.html#getConnectionHistory--">getConnectionHistory</a></span>()</code> +<div class="block">Retrieves all connection records visible to current user.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/guacamole/net/auth/ConnectionGroup.html" title="interface in org.apache.guacamole.net.auth">ConnectionGroup</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleUserContext.html#getRootConnectionGroup--">getRootConnectionGroup</a></span>()</code> +<div class="block">Retrieves a connection group which can be used to view and manipulate + connections, but only as allowed by the permissions given to the user of + this UserContext.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/guacamole/form/Form.html" title="class in org.apache.guacamole.form">Form</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleUserContext.html#getSharingProfileAttributes--">getSharingProfileAttributes</a></span>()</code> +<div class="block">Retrieves a collection of all attributes applicable to sharing profiles.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/guacamole/net/auth/Directory.html" title="interface in org.apache.guacamole.net.auth">Directory</a><<a href="../../../../../../org/apache/guacamole/net/auth/SharingProfile.html" title="interface in org.apache.guacamole.net.auth">SharingProfile</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleUserContext.html#getSharingProfileDirectory--">getSharingProfileDirectory</a></span>()</code> +<div class="block">Retrieves a Directory which can be used to view and manipulate + sharing profiles and their configurations, but only as allowed by the + permissions given to the user.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/guacamole/form/Form.html" title="class in org.apache.guacamole.form">Form</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleUserContext.html#getUserAttributes--">getUserAttributes</a></span>()</code> +<div class="block">Retrieves a collection of all attributes applicable to users.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/guacamole/net/auth/Directory.html" title="interface in org.apache.guacamole.net.auth">Directory</a><<a href="../../../../../../org/apache/guacamole/net/auth/User.html" title="interface in org.apache.guacamole.net.auth">User</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleUserContext.html#getUserDirectory--">getUserDirectory</a></span>()</code> +<div class="block">Retrieves a Directory which can be used to view and manipulate other + users, but only as allowed by the permissions given to the user of this + UserContext.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/guacamole/net/auth/User.html" title="interface in org.apache.guacamole.net.auth">User</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleUserContext.html#self--">self</a></span>()</code> +<div class="block">Returns the User whose access rights control the operations of this + UserContext.</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/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="SimpleUserContext-org.apache.guacamole.net.auth.AuthenticationProvider-java.util.Map-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SimpleUserContext</h4> +<pre>public SimpleUserContext(<a href="../../../../../../org/apache/guacamole/net/auth/AuthenticationProvider.html" title="interface in org.apache.guacamole.net.auth">AuthenticationProvider</a> authProvider, + <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<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>,org.apache.guacamole.protocol.GuacamoleConfiguration> configs)</pre> +<div class="block">Creates a new SimpleUserContext which provides access to only those + configurations within the given Map. The username is assigned + arbitrarily.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>authProvider</code> - The AuthenticationProvider creating this UserContext.</dd> +<dd><code>configs</code> - A Map of all configurations for which the user associated with this + UserContext has read access.</dd> +</dl> +</li> +</ul> +<a name="SimpleUserContext-org.apache.guacamole.net.auth.AuthenticationProvider-java.lang.String-java.util.Map-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SimpleUserContext</h4> +<pre>public SimpleUserContext(<a href="../../../../../../org/apache/guacamole/net/auth/AuthenticationProvider.html" title="interface in org.apache.guacamole.net.auth">AuthenticationProvider</a> authProvider, + <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> username, + <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<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>,org.apache.guacamole.protocol.GuacamoleConfiguration> configs)</pre> +<div class="block">Creates a new SimpleUserContext for the user with the given username + which provides access to only those configurations within the given Map.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>authProvider</code> - The AuthenticationProvider creating this UserContext.</dd> +<dd><code>username</code> - The username of the user associated with this UserContext.</dd> +<dd><code>configs</code> - A Map of all configurations for which the user associated with + this UserContext has read access.</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="self--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>self</h4> +<pre>public <a href="../../../../../../org/apache/guacamole/net/auth/User.html" title="interface in org.apache.guacamole.net.auth">User</a> self()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#self--">UserContext</a></code></span></div> +<div class="block">Returns the User whose access rights control the operations of this + UserContext.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#self--">self</a></code> in interface <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html" title="interface in org.apache.guacamole.net.auth">UserContext</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The User whose access rights control the operations of this + UserContext.</dd> +</dl> +</li> +</ul> +<a name="getAuthenticationProvider--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAuthenticationProvider</h4> +<pre>public <a href="../../../../../../org/apache/guacamole/net/auth/AuthenticationProvider.html" title="interface in org.apache.guacamole.net.auth">AuthenticationProvider</a> getAuthenticationProvider()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#getAuthenticationProvider--">UserContext</a></code></span></div> +<div class="block">Returns the AuthenticationProvider which created this UserContext, which + may not be the same AuthenticationProvider that authenticated the user + associated with this UserContext.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#getAuthenticationProvider--">getAuthenticationProvider</a></code> in interface <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html" title="interface in org.apache.guacamole.net.auth">UserContext</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The AuthenticationProvider that created this UserContext.</dd> +</dl> +</li> +</ul> +<a name="getUserDirectory--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUserDirectory</h4> +<pre>public <a href="../../../../../../org/apache/guacamole/net/auth/Directory.html" title="interface in org.apache.guacamole.net.auth">Directory</a><<a href="../../../../../../org/apache/guacamole/net/auth/User.html" title="interface in org.apache.guacamole.net.auth">User</a>> getUserDirectory() + throws org.apache.guacamole.GuacamoleException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#getUserDirectory--">UserContext</a></code></span></div> +<div class="block">Retrieves a Directory which can be used to view and manipulate other + users, but only as allowed by the permissions given to the user of this + UserContext.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#getUserDirectory--">getUserDirectory</a></code> in interface <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html" title="interface in org.apache.guacamole.net.auth">UserContext</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A Directory whose operations are bound by the restrictions + of this UserContext.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while creating the + Directory.</dd> +</dl> +</li> +</ul> +<a name="getConnectionDirectory--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConnectionDirectory</h4> +<pre>public <a href="../../../../../../org/apache/guacamole/net/auth/Directory.html" title="interface in org.apache.guacamole.net.auth">Directory</a><<a href="../../../../../../org/apache/guacamole/net/auth/Connection.html" title="interface in org.apache.guacamole.net.auth">Connection</a>> getConnectionDirectory() + throws org.apache.guacamole.GuacamoleException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#getConnectionDirectory--">UserContext</a></code></span></div> +<div class="block">Retrieves a Directory which can be used to view and manipulate + connections and their configurations, but only as allowed by the + permissions given to the user.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#getConnectionDirectory--">getConnectionDirectory</a></code> in interface <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html" title="interface in org.apache.guacamole.net.auth">UserContext</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A Directory whose operations are bound by the permissions of + the user.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while creating the + Directory.</dd> +</dl> +</li> +</ul> +<a name="getConnectionGroupDirectory--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConnectionGroupDirectory</h4> +<pre>public <a href="../../../../../../org/apache/guacamole/net/auth/Directory.html" title="interface in org.apache.guacamole.net.auth">Directory</a><<a href="../../../../../../org/apache/guacamole/net/auth/ConnectionGroup.html" title="interface in org.apache.guacamole.net.auth">ConnectionGroup</a>> getConnectionGroupDirectory() + throws org.apache.guacamole.GuacamoleException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#getConnectionGroupDirectory--">UserContext</a></code></span></div> +<div class="block">Retrieves a Directory which can be used to view and manipulate + connection groups and their members, but only as allowed by the + permissions given to the user.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#getConnectionGroupDirectory--">getConnectionGroupDirectory</a></code> in interface <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html" title="interface in org.apache.guacamole.net.auth">UserContext</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A Directory whose operations are bound by the permissions of + the user.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while creating the + Directory.</dd> +</dl> +</li> +</ul> +<a name="getRootConnectionGroup--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRootConnectionGroup</h4> +<pre>public <a href="../../../../../../org/apache/guacamole/net/auth/ConnectionGroup.html" title="interface in org.apache.guacamole.net.auth">ConnectionGroup</a> getRootConnectionGroup() + throws org.apache.guacamole.GuacamoleException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#getRootConnectionGroup--">UserContext</a></code></span></div> +<div class="block">Retrieves a connection group which can be used to view and manipulate + connections, but only as allowed by the permissions given to the user of + this UserContext.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#getRootConnectionGroup--">getRootConnectionGroup</a></code> in interface <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html" title="interface in org.apache.guacamole.net.auth">UserContext</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A connection group whose operations are bound by the restrictions + of this UserContext.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while creating the + Directory.</dd> +</dl> +</li> +</ul> +<a name="getSharingProfileDirectory--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSharingProfileDirectory</h4> +<pre>public <a href="../../../../../../org/apache/guacamole/net/auth/Directory.html" title="interface in org.apache.guacamole.net.auth">Directory</a><<a href="../../../../../../org/apache/guacamole/net/auth/SharingProfile.html" title="interface in org.apache.guacamole.net.auth">SharingProfile</a>> getSharingProfileDirectory() + throws org.apache.guacamole.GuacamoleException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#getSharingProfileDirectory--">UserContext</a></code></span></div> +<div class="block">Retrieves a Directory which can be used to view and manipulate + sharing profiles and their configurations, but only as allowed by the + permissions given to the user.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#getSharingProfileDirectory--">getSharingProfileDirectory</a></code> in interface <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html" title="interface in org.apache.guacamole.net.auth">UserContext</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A Directory whose operations are bound by the permissions of the + user.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while creating the Directory.</dd> +</dl> +</li> +</ul> +<a name="getActiveConnectionDirectory--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getActiveConnectionDirectory</h4> +<pre>public <a href="../../../../../../org/apache/guacamole/net/auth/Directory.html" title="interface in org.apache.guacamole.net.auth">Directory</a><<a href="../../../../../../org/apache/guacamole/net/auth/ActiveConnection.html" title="interface in org.apache.guacamole.net.auth">ActiveConnection</a>> getActiveConnectionDirectory() + throws org.apache.guacamole.GuacamoleException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#getActiveConnectionDirectory--">UserContext</a></code></span></div> +<div class="block">Retrieves a Directory which can be used to view and manipulate + active connections, but only as allowed by the permissions given to the + user.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#getActiveConnectionDirectory--">getActiveConnectionDirectory</a></code> in interface <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html" title="interface in org.apache.guacamole.net.auth">UserContext</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A Directory whose operations are bound by the permissions of the + user.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while creating the Directory.</dd> +</dl> +</li> +</ul> +<a name="getConnectionHistory--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConnectionHistory</h4> +<pre>public <a href="../../../../../../org/apache/guacamole/net/auth/ConnectionRecordSet.html" title="interface in org.apache.guacamole.net.auth">ConnectionRecordSet</a> getConnectionHistory() + throws org.apache.guacamole.GuacamoleException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#getConnectionHistory--">UserContext</a></code></span></div> +<div class="block">Retrieves all connection records visible to current user. The resulting + set of connection records can be further filtered and ordered using the + methods defined on ConnectionRecordSet.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#getConnectionHistory--">getConnectionHistory</a></code> in interface <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html" title="interface in org.apache.guacamole.net.auth">UserContext</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A set of all connection records visible to the current user.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while retrieving the connection records.</dd> +</dl> +</li> +</ul> +<a name="getUserAttributes--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUserAttributes</h4> +<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/guacamole/form/Form.html" title="class in org.apache.guacamole.form">Form</a>> getUserAttributes()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#getUserAttributes--">UserContext</a></code></span></div> +<div class="block">Retrieves a collection of all attributes applicable to users. This + collection will contain only those attributes which the current user has + general permission to view or modify. If there are no such attributes, + this collection will be empty.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#getUserAttributes--">getUserAttributes</a></code> in interface <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html" title="interface in org.apache.guacamole.net.auth">UserContext</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A collection of all attributes applicable to users.</dd> +</dl> +</li> +</ul> +<a name="getConnectionAttributes--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConnectionAttributes</h4> +<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/guacamole/form/Form.html" title="class in org.apache.guacamole.form">Form</a>> getConnectionAttributes()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#getConnectionAttributes--">UserContext</a></code></span></div> +<div class="block">Retrieves a collection of all attributes applicable to connections. This + collection will contain only those attributes which the current user has + general permission to view or modify. If there are no such attributes, + this collection will be empty.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#getConnectionAttributes--">getConnectionAttributes</a></code> in interface <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html" title="interface in org.apache.guacamole.net.auth">UserContext</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A collection of all attributes applicable to connections.</dd> +</dl> +</li> +</ul> +<a name="getConnectionGroupAttributes--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConnectionGroupAttributes</h4> +<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/guacamole/form/Form.html" title="class in org.apache.guacamole.form">Form</a>> getConnectionGroupAttributes()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#getConnectionGroupAttributes--">UserContext</a></code></span></div> +<div class="block">Retrieves a collection of all attributes applicable to connection + groups. This collection will contain only those attributes which the + current user has general permission to view or modify. If there are no + such attributes, this collection will be empty.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#getConnectionGroupAttributes--">getConnectionGroupAttributes</a></code> in interface <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html" title="interface in org.apache.guacamole.net.auth">UserContext</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A collection of all attributes applicable to connection groups.</dd> +</dl> +</li> +</ul> +<a name="getSharingProfileAttributes--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getSharingProfileAttributes</h4> +<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../../org/apache/guacamole/form/Form.html" title="class in org.apache.guacamole.form">Form</a>> getSharingProfileAttributes()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#getSharingProfileAttributes--">UserContext</a></code></span></div> +<div class="block">Retrieves a collection of all attributes applicable to sharing profiles. + This collection will contain only those attributes which the current user + has general permission to view or modify. If there are no such + attributes, this collection will be empty.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html#getSharingProfileAttributes--">getSharingProfileAttributes</a></code> in interface <code><a href="../../../../../../org/apache/guacamole/net/auth/UserContext.html" title="interface in org.apache.guacamole.net.auth">UserContext</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A collection of all attributes applicable to sharing profile.</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/SimpleUserContext.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/SimpleUser.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/SimpleUserDirectory.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/SimpleUserContext.html" target="_top">Frames</a></li> +<li><a href="SimpleUserContext.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 © 2017. All rights reserved.</small></p> + <!-- Google Analytics --> + <script type="text/javascript"> + (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ + (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), + m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) + })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); + + ga('create', 'UA-75289145-1', 'auto'); + ga('send', 'pageview'); + </script> +</body> +</html>
