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/SimpleConnection.html ---------------------------------------------------------------------- diff --git a/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/simple/SimpleConnection.html b/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/simple/SimpleConnection.html new file mode 100644 index 0000000..ae201b4 --- /dev/null +++ b/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/simple/SimpleConnection.html @@ -0,0 +1,472 @@ +<!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>SimpleConnection (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="SimpleConnection (guacamole-ext 0.9.11-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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/SimpleConnection.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/SimpleAuthenticationProvider.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/SimpleConnectionDirectory.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/SimpleConnection.html" target="_top">Frames</a></li> +<li><a href="SimpleConnection.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 SimpleConnection" class="title">Class SimpleConnection</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/AbstractConnection.html" title="class in org.apache.guacamole.net.auth">org.apache.guacamole.net.auth.AbstractConnection</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.guacamole.net.auth.simple.SimpleConnection</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/Connectable.html" title="interface in org.apache.guacamole.net.auth">Connectable</a>, <a href="../../../../../../org/apache/guacamole/net/auth/Connection.html" title="interface in org.apache.guacamole.net.auth">Connection</a>, <a href="../../../../../../org/apache/guacamole/net/auth/Identifiable.html" title="interface in org.apache.guacamole.net.auth">Identifiable</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">SimpleConnection</span> +extends <a href="../../../../../../org/apache/guacamole/net/auth/AbstractConnection.html" title="class in org.apache.guacamole.net.auth">AbstractConnection</a></pre> +<div class="block">An extremely basic Connection 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/SimpleConnection.html#SimpleConnection--">SimpleConnection</a></span>()</code> +<div class="block">Creates a completely uninitialized SimpleConnection.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleConnection.html#SimpleConnection-java.lang.String-java.lang.String-org.apache.guacamole.protocol.GuacamoleConfiguration-">SimpleConnection</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> name, + <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> identifier, + org.apache.guacamole.protocol.GuacamoleConfiguration config)</code> +<div class="block">Creates a new SimpleConnection having the given identifier and + GuacamoleConfiguration.</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>org.apache.guacamole.net.GuacamoleTunnel</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleConnection.html#connect-org.apache.guacamole.protocol.GuacamoleClientInformation-">connect</a></span>(org.apache.guacamole.protocol.GuacamoleClientInformation info)</code> +<div class="block">Establishes a connection to guacd using the information associated with + this object.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleConnection.html#getActiveConnections--">getActiveConnections</a></span>()</code> +<div class="block">Returns the number of active connections associated with this object.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<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/SimpleConnection.html#getAttributes--">getAttributes</a></span>()</code> +<div class="block">Returns all attributes associated with this connection.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/guacamole/net/auth/ConnectionRecord.html" title="interface in org.apache.guacamole.net.auth">ConnectionRecord</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleConnection.html#getHistory--">getHistory</a></span>()</code> +<div class="block">Returns a list of ConnectionRecords representing the usage history + of this Connection, including any active users.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleConnection.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.AbstractConnection"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.guacamole.net.auth.<a href="../../../../../../org/apache/guacamole/net/auth/AbstractConnection.html" title="class in org.apache.guacamole.net.auth">AbstractConnection</a></h3> +<code><a href="../../../../../../org/apache/guacamole/net/auth/AbstractConnection.html#getConfiguration--">getConfiguration</a>, <a href="../../../../../../org/apache/guacamole/net/auth/AbstractConnection.html#getName--">getName</a>, <a href="../../../../../../org/apache/guacamole/net/auth/AbstractConnection.html#getParentIdentifier--">getParentIdentifier</a>, <a href="../../../../../../org/apache/guacamole/net/auth/AbstractConnection.html#getSharingProfileIdentifiers--">getSharingProfileIdentifiers</a>, <a href="../../../../../../org/apache/guacamole/net/auth/AbstractConnection.html#setConfiguration-org.apache.guacamole.protocol.GuacamoleConfiguration-">setConfiguration</a>, <a href="../../../../../../org/apache/guacamole/net/auth/AbstractConnection.html#setName-java.lang.String-">setName</a>, <a href="../../../../../../org/apache/guacamole/net/auth/AbstractConnection.html#setParentIdentifier-java.lang.String-">setParentIdentifier</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="SimpleConnection--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SimpleConnection</h4> +<pre>public SimpleConnection()</pre> +<div class="block">Creates a completely uninitialized SimpleConnection.</div> +</li> +</ul> +<a name="SimpleConnection-java.lang.String-java.lang.String-org.apache.guacamole.protocol.GuacamoleConfiguration-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SimpleConnection</h4> +<pre>public SimpleConnection(<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> name, + <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> identifier, + org.apache.guacamole.protocol.GuacamoleConfiguration config)</pre> +<div class="block">Creates a new SimpleConnection having the given identifier and + GuacamoleConfiguration.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - The name to associate with this connection.</dd> +<dd><code>identifier</code> - The identifier to associate with this connection.</dd> +<dd><code>config</code> - The configuration describing how to connect to this + connection.</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="getActiveConnections--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getActiveConnections</h4> +<pre>public int getActiveConnections()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/Connectable.html#getActiveConnections--">Connectable</a></code></span></div> +<div class="block">Returns the number of active connections associated with this object. + Implementations may simply return 0 if this value is not tracked.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The number of active connections associated with this object.</dd> +</dl> +</li> +</ul> +<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/Connection.html#getAttributes--">Connection</a></code></span></div> +<div class="block">Returns all attributes associated with this connection. 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 connection, 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/Connection.html#setAttributes-java.util.Map-">Connection</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="connect-org.apache.guacamole.protocol.GuacamoleClientInformation-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>connect</h4> +<pre>public org.apache.guacamole.net.GuacamoleTunnel connect(org.apache.guacamole.protocol.GuacamoleClientInformation info) + throws org.apache.guacamole.GuacamoleException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/Connectable.html#connect-org.apache.guacamole.protocol.GuacamoleClientInformation-">Connectable</a></code></span></div> +<div class="block">Establishes a connection to guacd using the information associated with + this object. The connection will be provided the given client + information.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>info</code> - Information associated with the connecting client.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A fully-established GuacamoleTunnel.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while connecting to guacd, or if permission to + connect is denied.</dd> +</dl> +</li> +</ul> +<a name="getHistory--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getHistory</h4> +<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/guacamole/net/auth/ConnectionRecord.html" title="interface in org.apache.guacamole.net.auth">ConnectionRecord</a>> getHistory() + throws org.apache.guacamole.GuacamoleException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/Connection.html#getHistory--">Connection</a></code></span></div> +<div class="block">Returns a list of ConnectionRecords representing the usage history + of this Connection, including any active users. ConnectionRecords + in this list will be sorted in descending order of end time (active + connections are first), and then in descending order of start time + (newer connections are first).</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A list of ConnectionRecrods representing the usage history + of this Connection.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while reading the history + of this connection, or if permission 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/SimpleConnection.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/SimpleAuthenticationProvider.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/SimpleConnectionDirectory.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/SimpleConnection.html" target="_top">Frames</a></li> +<li><a href="SimpleConnection.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/SimpleConnectionDirectory.html ---------------------------------------------------------------------- diff --git a/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/simple/SimpleConnectionDirectory.html b/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/simple/SimpleConnectionDirectory.html new file mode 100644 index 0000000..62d581a --- /dev/null +++ b/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/simple/SimpleConnectionDirectory.html @@ -0,0 +1,348 @@ +<!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>SimpleConnectionDirectory (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="SimpleConnectionDirectory (guacamole-ext 0.9.11-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":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/SimpleConnectionDirectory.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/SimpleConnection.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/SimpleConnectionGroup.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/SimpleConnectionDirectory.html" target="_top">Frames</a></li> +<li><a href="SimpleConnectionDirectory.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 SimpleConnectionDirectory" class="title">Class SimpleConnectionDirectory</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/simple/SimpleDirectory.html" title="class in org.apache.guacamole.net.auth.simple">org.apache.guacamole.net.auth.simple.SimpleDirectory</a><<a href="../../../../../../org/apache/guacamole/net/auth/Connection.html" title="interface in org.apache.guacamole.net.auth">Connection</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.guacamole.net.auth.simple.SimpleConnectionDirectory</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/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>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">SimpleConnectionDirectory</span> +extends <a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleDirectory.html" title="class in org.apache.guacamole.net.auth.simple">SimpleDirectory</a><<a href="../../../../../../org/apache/guacamole/net/auth/Connection.html" title="interface in org.apache.guacamole.net.auth">Connection</a>></pre> +<div class="block">An extremely simple read-only implementation of a Directory of + GuacamoleConfigurations which provides access to a pre-defined Map of + GuacamoleConfigurations.</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/SimpleConnectionDirectory.html#SimpleConnectionDirectory-java.util.Collection-">SimpleConnectionDirectory</a></span>(<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/net/auth/Connection.html" title="interface in org.apache.guacamole.net.auth">Connection</a>> connections)</code> +<div class="block">Creates a new SimpleConnectionDirectory which provides access to the + connections contained 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/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/SimpleConnectionDirectory.html#putConnection-org.apache.guacamole.net.auth.Connection-">putConnection</a></span>(<a href="../../../../../../org/apache/guacamole/net/auth/Connection.html" title="interface in org.apache.guacamole.net.auth">Connection</a> connection)</code> +<div class="block">An internal method for modifying the Connections in this Directory.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><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/SimpleConnectionDirectory.html#removeConnection-java.lang.String-">removeConnection</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> identifier)</code> +<div class="block">An internal method for removing a Connection from this Directory.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.guacamole.net.auth.simple.SimpleDirectory"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.guacamole.net.auth.simple.<a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleDirectory.html" title="class in org.apache.guacamole.net.auth.simple">SimpleDirectory</a></h3> +<code><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleDirectory.html#add-ObjectType-">add</a>, <a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleDirectory.html#get-java.lang.String-">get</a>, <a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleDirectory.html#getAll-java.util.Collection-">getAll</a>, <a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleDirectory.html#getIdentifiers--">getIdentifiers</a>, <a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleDirectory.html#getObjects--">getObjects</a>, <a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleDirectory.html#remove-java.lang.String-">remove</a>, <a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleDirectory.html#setObjects-java.util.Map-">setObjects</a>, <a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleDirectory.html#update-ObjectType-">update</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#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="SimpleConnectionDirectory-java.util.Collection-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SimpleConnectionDirectory</h4> +<pre>public SimpleConnectionDirectory(<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/net/auth/Connection.html" title="interface in org.apache.guacamole.net.auth">Connection</a>> connections)</pre> +<div class="block">Creates a new SimpleConnectionDirectory which provides access to the + connections contained within the given Map.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>connections</code> - A Collection of all connections that should be present in this + connection directory.</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="putConnection-org.apache.guacamole.net.auth.Connection-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>putConnection</h4> +<pre>public <a href="../../../../../../org/apache/guacamole/net/auth/Connection.html" title="interface in org.apache.guacamole.net.auth">Connection</a> putConnection(<a href="../../../../../../org/apache/guacamole/net/auth/Connection.html" title="interface in org.apache.guacamole.net.auth">Connection</a> connection)</pre> +<div class="block">An internal method for modifying the Connections in this Directory. + Returns the previous connection for the given identifier, if found.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>connection</code> - The connection to add or update the Directory with.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The previous connection for the connection identifier, if found.</dd> +</dl> +</li> +</ul> +<a name="removeConnection-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>removeConnection</h4> +<pre>public <a href="../../../../../../org/apache/guacamole/net/auth/Connection.html" title="interface in org.apache.guacamole.net.auth">Connection</a> removeConnection(<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> identifier)</pre> +<div class="block">An internal method for removing a Connection from this Directory.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>identifier</code> - The identifier of the Connection to remove.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The previous connection for the given identifier, if found.</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/SimpleConnectionDirectory.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/SimpleConnection.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/SimpleConnectionGroup.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/SimpleConnectionDirectory.html" target="_top">Frames</a></li> +<li><a href="SimpleConnectionDirectory.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/SimpleConnectionGroup.html ---------------------------------------------------------------------- diff --git a/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/simple/SimpleConnectionGroup.html b/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/simple/SimpleConnectionGroup.html new file mode 100644 index 0000000..dc39833 --- /dev/null +++ b/doc/0.9.11-incubating/guacamole-ext/org/apache/guacamole/net/auth/simple/SimpleConnectionGroup.html @@ -0,0 +1,492 @@ +<!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>SimpleConnectionGroup (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="SimpleConnectionGroup (guacamole-ext 0.9.11-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":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/SimpleConnectionGroup.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/SimpleConnectionDirectory.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/SimpleConnectionGroupDirectory.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/SimpleConnectionGroup.html" target="_top">Frames</a></li> +<li><a href="SimpleConnectionGroup.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 SimpleConnectionGroup" class="title">Class SimpleConnectionGroup</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/AbstractConnectionGroup.html" title="class in org.apache.guacamole.net.auth">org.apache.guacamole.net.auth.AbstractConnectionGroup</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.guacamole.net.auth.simple.SimpleConnectionGroup</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/Connectable.html" title="interface in org.apache.guacamole.net.auth">Connectable</a>, <a href="../../../../../../org/apache/guacamole/net/auth/ConnectionGroup.html" title="interface in org.apache.guacamole.net.auth">ConnectionGroup</a>, <a href="../../../../../../org/apache/guacamole/net/auth/Identifiable.html" title="interface in org.apache.guacamole.net.auth">Identifiable</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">SimpleConnectionGroup</span> +extends <a href="../../../../../../org/apache/guacamole/net/auth/AbstractConnectionGroup.html" title="class in org.apache.guacamole.net.auth">AbstractConnectionGroup</a></pre> +<div class="block">An extremely simple read-only implementation of a ConnectionGroup which + returns the connection and connection group identifiers it was constructed + with. Load balancing across this connection group is not allowed.</div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>James Muehlner</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.guacamole.net.auth.ConnectionGroup"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface org.apache.guacamole.net.auth.<a href="../../../../../../org/apache/guacamole/net/auth/ConnectionGroup.html" title="interface in org.apache.guacamole.net.auth">ConnectionGroup</a></h3> +<code><a href="../../../../../../org/apache/guacamole/net/auth/ConnectionGroup.Type.html" title="enum in org.apache.guacamole.net.auth">ConnectionGroup.Type</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/SimpleConnectionGroup.html#SimpleConnectionGroup-java.lang.String-java.lang.String-java.util.Collection-java.util.Collection-">SimpleConnectionGroup</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> name, + <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> identifier, + <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 SimpleConnectionGroup having the given name and identifier + which will expose the given contents.</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>org.apache.guacamole.net.GuacamoleTunnel</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleConnectionGroup.html#connect-org.apache.guacamole.protocol.GuacamoleClientInformation-">connect</a></span>(org.apache.guacamole.protocol.GuacamoleClientInformation info)</code> +<div class="block">Establishes a connection to guacd using the information associated with + this object.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/guacamole/net/auth/simple/SimpleConnectionGroup.html#getActiveConnections--">getActiveConnections</a></span>()</code> +<div class="block">Returns the number of active connections associated with this object.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<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/SimpleConnectionGroup.html#getAttributes--">getAttributes</a></span>()</code> +<div class="block">Returns all attributes associated with this connection group.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</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/SimpleConnectionGroup.html#getConnectionGroupIdentifiers--">getConnectionGroupIdentifiers</a></span>()</code> +<div class="block">Returns the identifiers of all readable connection groups that are + children of this connection group.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</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/SimpleConnectionGroup.html#getConnectionIdentifiers--">getConnectionIdentifiers</a></span>()</code> +<div class="block">Returns the identifiers of all readable connections that are children + of this connection group.</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/SimpleConnectionGroup.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.AbstractConnectionGroup"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.guacamole.net.auth.<a href="../../../../../../org/apache/guacamole/net/auth/AbstractConnectionGroup.html" title="class in org.apache.guacamole.net.auth">AbstractConnectionGroup</a></h3> +<code><a href="../../../../../../org/apache/guacamole/net/auth/AbstractConnectionGroup.html#getName--">getName</a>, <a href="../../../../../../org/apache/guacamole/net/auth/AbstractConnectionGroup.html#getParentIdentifier--">getParentIdentifier</a>, <a href="../../../../../../org/apache/guacamole/net/auth/AbstractConnectionGroup.html#getType--">getType</a>, <a href="../../../../../../org/apache/guacamole/net/auth/AbstractConnectionGroup.html#setName-java.lang.String-">setName</a>, <a href="../../../../../../org/apache/guacamole/net/auth/AbstractConnectionGroup.html#setParentIdentifier-java.lang.String-">setParentIdentifier</a>, <a href="../../../../../../org/apache/guacamole/net/auth/AbstractConnectionGroup.html#setType-org.apache.guacamole.net.auth.ConnectionGroup.Type-">setType</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="SimpleConnectionGroup-java.lang.String-java.lang.String-java.util.Collection-java.util.Collection-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SimpleConnectionGroup</h4> +<pre>public SimpleConnectionGroup(<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> name, + <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> identifier, + <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 SimpleConnectionGroup having the given name and identifier + which will expose the given contents.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - The name to associate with this connection group.</dd> +<dd><code>identifier</code> - The identifier to associate with this connection group.</dd> +<dd><code>connectionIdentifiers</code> - The connection identifiers to expose when requested.</dd> +<dd><code>connectionGroupIdentifiers</code> - The connection group identifiers to expose when requested.</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="getActiveConnections--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getActiveConnections</h4> +<pre>public int getActiveConnections()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/Connectable.html#getActiveConnections--">Connectable</a></code></span></div> +<div class="block">Returns the number of active connections associated with this object. + Implementations may simply return 0 if this value is not tracked.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The number of active connections associated with this object.</dd> +</dl> +</li> +</ul> +<a name="getConnectionIdentifiers--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConnectionIdentifiers</h4> +<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</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>> getConnectionIdentifiers()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/ConnectionGroup.html#getConnectionIdentifiers--">ConnectionGroup</a></code></span></div> +<div class="block">Returns the identifiers of all readable connections that are children + of this connection group.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The set of identifiers of all readable connections that are children + of this connection group.</dd> +</dl> +</li> +</ul> +<a name="getConnectionGroupIdentifiers--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConnectionGroupIdentifiers</h4> +<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</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>> getConnectionGroupIdentifiers()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/ConnectionGroup.html#getConnectionGroupIdentifiers--">ConnectionGroup</a></code></span></div> +<div class="block">Returns the identifiers of all readable connection groups that are + children of this connection group.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The set of identifiers of all readable connection groups that are + children of this connection group.</dd> +</dl> +</li> +</ul> +<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/ConnectionGroup.html#getAttributes--">ConnectionGroup</a></code></span></div> +<div class="block">Returns all attributes associated with this connection group. 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 connection group, 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/ConnectionGroup.html#setAttributes-java.util.Map-">ConnectionGroup</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="connect-org.apache.guacamole.protocol.GuacamoleClientInformation-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>connect</h4> +<pre>public org.apache.guacamole.net.GuacamoleTunnel connect(org.apache.guacamole.protocol.GuacamoleClientInformation info) + throws org.apache.guacamole.GuacamoleException</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/guacamole/net/auth/Connectable.html#connect-org.apache.guacamole.protocol.GuacamoleClientInformation-">Connectable</a></code></span></div> +<div class="block">Establishes a connection to guacd using the information associated with + this object. The connection will be provided the given client + information.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>info</code> - Information associated with the connecting client.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A fully-established GuacamoleTunnel.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while connecting to guacd, or if permission to + connect 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/SimpleConnectionGroup.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/SimpleConnectionDirectory.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/SimpleConnectionGroupDirectory.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/SimpleConnectionGroup.html" target="_top">Frames</a></li> +<li><a href="SimpleConnectionGroup.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>
