doc/1.1.0/guacamole-ext/org/apache/guacamole/net/auth/ActiveConnection.html - guacamole-website - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc (1.8.0_212) on Sun Jan 26 10:16:16 PST 2020 -->
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <title>ActiveConnection (guacamole-ext 1.1.0 API)</title>
 <meta name="date" content="2020-01-26">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="ActiveConnection (guacamole-ext 1.1.0 API)";
         }
     }
     catch(err) {
     }
 //-->
 var methods = {"i0":18,"i1":18,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":18,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/ActiveConnection.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/AbstractUserGroup.html" title="class in org.apache.guacamole.net.auth"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../org/apache/guacamole/net/auth/ActivityRecord.html" title="interface in org.apache.guacamole.net.auth"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../index.html?org/apache/guacamole/net/auth/ActiveConnection.html" target="_top">Frames</a></li>
 <li><a href="ActiveConnection.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_top");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a name="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="subTitle">org.apache.guacamole.net.auth</div>
 <h2 title="Interface ActiveConnection" class="title">Interface ActiveConnection</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>All Superinterfaces:</dt>
 <dd><a href="../../../../../org/apache/guacamole/net/auth/Connectable.html" title="interface in org.apache.guacamole.net.auth">Connectable</a>, <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/Shareable.html" title="interface in org.apache.guacamole.net.auth">Shareable</a>&lt;<a href="../../../../../org/apache/guacamole/net/auth/SharingProfile.html" title="interface in org.apache.guacamole.net.auth">SharingProfile</a>&gt;</dd>
 </dl>
 <dl>
 <dt>All Known Implementing Classes:</dt>
 <dd><a href="../../../../../org/apache/guacamole/net/auth/AbstractActiveConnection.html" title="class in org.apache.guacamole.net.auth">AbstractActiveConnection</a></dd>
 </dl>
 <hr>
 <br>
 <pre>public interface <span class="typeNameLabel">ActiveConnection</span>
 extends <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/Connectable.html" title="interface in org.apache.guacamole.net.auth">Connectable</a>, <a href="../../../../../org/apache/guacamole/net/auth/Shareable.html" title="interface in org.apache.guacamole.net.auth">Shareable</a>&lt;<a href="../../../../../org/apache/guacamole/net/auth/SharingProfile.html" title="interface in org.apache.guacamole.net.auth">SharingProfile</a>&gt;</pre>
 <div class="block">A pairing of username and GuacamoleTunnel representing an active usage of a
  particular connection.</div>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- ========== METHOD SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.summary">
 <!--   -->
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Method and Description</th>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>default org.apache.guacamole.net.GuacamoleTunnel</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ActiveConnection.html#connect-org.apache.guacamole.protocol.GuacamoleClientInformation-java.util.Map-">connect</a></span>(org.apache.guacamole.protocol.GuacamoleClientInformation&nbsp;info,
        <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;tokens)</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>default int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ActiveConnection.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/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ActiveConnection.html#getConnectionIdentifier--">getConnectionIdentifier</a></span>()</code>
 <div class="block">Returns the identifier of the connection being actively used.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ActiveConnection.html#getRemoteHost--">getRemoteHost</a></span>()</code>
 <div class="block">Returns the hostname or IP address of the remote host that initiated the
  connection, if known.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ActiveConnection.html#getSharingProfileIdentifier--">getSharingProfileIdentifier</a></span>()</code>
 <div class="block">Returns the identifier of the sharing profile being actively used.</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ActiveConnection.html#getStartDate--">getStartDate</a></span>()</code>
 <div class="block">Returns the date and time the connection began.</div>
 </td>
 </tr>
 <tr id="i6" 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/ActiveConnection.html#getTunnel--">getTunnel</a></span>()</code>
 <div class="block">Returns the connected GuacamoleTunnel being used.</div>
 </td>
 </tr>
 <tr id="i7" class="rowColor">
 <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ActiveConnection.html#getUsername--">getUsername</a></span>()</code>
 <div class="block">Returns the name of the user who is using this connection.</div>
 </td>
 </tr>
 <tr id="i8" class="altColor">
 <td class="colFirst"><code>default boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ActiveConnection.html#isConnectable--">isConnectable</a></span>()</code>
 <div class="block">Returns whether this ActiveConnection may be joined through a call to
  <a href="../../../../../org/apache/guacamole/net/auth/ActiveConnection.html#connect-org.apache.guacamole.protocol.GuacamoleClientInformation-java.util.Map-"><code>connect(org.apache.guacamole.protocol.GuacamoleClientInformation, java.util.Map)</code></a>
  by the user that retrieved this ActiveConnection.</div>
 </td>
 </tr>
 <tr id="i9" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ActiveConnection.html#setConnectionIdentifier-java.lang.String-">setConnectionIdentifier</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;connnectionIdentifier)</code>
 <div class="block">Sets the identifier of the connection being actively used.</div>
 </td>
 </tr>
 <tr id="i10" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ActiveConnection.html#setRemoteHost-java.lang.String-">setRemoteHost</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;remoteHost)</code>
 <div class="block">Sets the hostname or IP address of the remote host that initiated the
  connection.</div>
 </td>
 </tr>
 <tr id="i11" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ActiveConnection.html#setSharingProfileIdentifier-java.lang.String-">setSharingProfileIdentifier</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;sharingProfileIdentifier)</code>
 <div class="block">Sets the identifier of the sharing profile being actively used.</div>
 </td>
 </tr>
 <tr id="i12" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ActiveConnection.html#setStartDate-java.util.Date-">setStartDate</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;startDate)</code>
 <div class="block">Sets the date and time the connection began.</div>
 </td>
 </tr>
 <tr id="i13" class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ActiveConnection.html#setTunnel-org.apache.guacamole.net.GuacamoleTunnel-">setTunnel</a></span>(org.apache.guacamole.net.GuacamoleTunnel&nbsp;tunnel)</code>
 <div class="block">Sets the connected GuacamoleTunnel being used.</div>
 </td>
 </tr>
 <tr id="i14" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/guacamole/net/auth/ActiveConnection.html#setUsername-java.lang.String-">setUsername</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;username)</code>
 <div class="block">Sets the name of the user who is using this connection.</div>
 </td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a name="methods.inherited.from.class.org.apache.guacamole.net.auth.Identifiable">
 <!--   -->
 </a>
 <h3>Methods inherited from interface&nbsp;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>
 <ul class="blockList">
 <li class="blockList"><a name="methods.inherited.from.class.org.apache.guacamole.net.auth.Connectable">
 <!--   -->
 </a>
 <h3>Methods inherited from interface&nbsp;org.apache.guacamole.net.auth.<a href="../../../../../org/apache/guacamole/net/auth/Connectable.html" title="interface in org.apache.guacamole.net.auth">Connectable</a></h3>
 <code><a href="../../../../../org/apache/guacamole/net/auth/Connectable.html#connect-org.apache.guacamole.protocol.GuacamoleClientInformation-">connect</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="methods.inherited.from.class.org.apache.guacamole.net.auth.Shareable">
 <!--   -->
 </a>
 <h3>Methods inherited from interface&nbsp;org.apache.guacamole.net.auth.<a href="../../../../../org/apache/guacamole/net/auth/Shareable.html" title="interface in org.apache.guacamole.net.auth">Shareable</a></h3>
 <code><a href="../../../../../org/apache/guacamole/net/auth/Shareable.html#getSharingCredentials-java.lang.String-">getSharingCredentials</a></code></li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ METHOD DETAIL ========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a name="getConnectionIdentifier--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getConnectionIdentifier</h4>
 <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getConnectionIdentifier()</pre>
 <div class="block">Returns the identifier of the connection being actively used. Unlike the
  other information stored in this object, the connection identifier must
  be present and MAY NOT be null.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The identifier of the connection being actively used.</dd>
 </dl>
 </li>
 </ul>
 <a name="setConnectionIdentifier-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setConnectionIdentifier</h4>
 <pre>void&nbsp;setConnectionIdentifier(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;connnectionIdentifier)</pre>
 <div class="block">Sets the identifier of the connection being actively used.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>connnectionIdentifier</code> - The identifier of the connection being actively used.</dd>
 </dl>
 </li>
 </ul>
 <a name="getSharingProfileIdentifier--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getSharingProfileIdentifier</h4>
 <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getSharingProfileIdentifier()</pre>
 <div class="block">Returns the identifier of the sharing profile being actively used. If
  the connection is being accessed directly, this will be null.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The identifier of the sharing profile being actively used.</dd>
 </dl>
 </li>
 </ul>
 <a name="setSharingProfileIdentifier-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setSharingProfileIdentifier</h4>
 <pre>void&nbsp;setSharingProfileIdentifier(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;sharingProfileIdentifier)</pre>
 <div class="block">Sets the identifier of the sharing profile being actively used.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>sharingProfileIdentifier</code> - The identifier of the sharing profile being actively used.</dd>
 </dl>
 </li>
 </ul>
 <a name="getStartDate--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getStartDate</h4>
 <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;getStartDate()</pre>
 <div class="block">Returns the date and time the connection began.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The date and time the connection began, or null if this
      information is not available.</dd>
 </dl>
 </li>
 </ul>
 <a name="setStartDate-java.util.Date-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setStartDate</h4>
 <pre>void&nbsp;setStartDate(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a>&nbsp;startDate)</pre>
 <div class="block">Sets the date and time the connection began.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>startDate</code> - The date and time the connection began, or null if this
      information is not available.</dd>
 </dl>
 </li>
 </ul>
 <a name="getRemoteHost--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getRemoteHost</h4>
 <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getRemoteHost()</pre>
 <div class="block">Returns the hostname or IP address of the remote host that initiated the
  connection, if known. If the hostname or IP address is not known, null
  is returned.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The hostname or IP address of the remote host, or null if this
      information is not available.</dd>
 </dl>
 </li>
 </ul>
 <a name="setRemoteHost-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setRemoteHost</h4>
 <pre>void&nbsp;setRemoteHost(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;remoteHost)</pre>
 <div class="block">Sets the hostname or IP address of the remote host that initiated the
  connection.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>remoteHost</code> - The hostname or IP address of the remote host, or null if this
      information is not available.</dd>
 </dl>
 </li>
 </ul>
 <a name="getUsername--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getUsername</h4>
 <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getUsername()</pre>
 <div class="block">Returns the name of the user who is using this connection.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The name of the user who is using this connection, or null if this
      information is not available.</dd>
 </dl>
 </li>
 </ul>
 <a name="setUsername-java.lang.String-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setUsername</h4>
 <pre>void&nbsp;setUsername(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;username)</pre>
 <div class="block">Sets the name of the user who is using this connection.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>username</code> - The name of the user who is using this connection, or null if this
      information is not available.</dd>
 </dl>
 </li>
 </ul>
 <a name="getTunnel--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getTunnel</h4>
 <pre>org.apache.guacamole.net.GuacamoleTunnel&nbsp;getTunnel()</pre>
 <div class="block">Returns the connected GuacamoleTunnel being used. This may be null if
  access to the underlying tunnel is denied.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The connected GuacamoleTunnel, or null if permission is denied.</dd>
 </dl>
 </li>
 </ul>
 <a name="setTunnel-org.apache.guacamole.net.GuacamoleTunnel-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setTunnel</h4>
 <pre>void&nbsp;setTunnel(org.apache.guacamole.net.GuacamoleTunnel&nbsp;tunnel)</pre>
 <div class="block">Sets the connected GuacamoleTunnel being used.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>tunnel</code> - The connected GuacamoleTunnel, or null if permission is denied.</dd>
 </dl>
 </li>
 </ul>
 <a name="isConnectable--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isConnectable</h4>
 <pre>default&nbsp;boolean&nbsp;isConnectable()</pre>
 <div class="block">Returns whether this ActiveConnection may be joined through a call to
  <a href="../../../../../org/apache/guacamole/net/auth/ActiveConnection.html#connect-org.apache.guacamole.protocol.GuacamoleClientInformation-java.util.Map-"><code>connect(org.apache.guacamole.protocol.GuacamoleClientInformation, java.util.Map)</code></a>
  by the user that retrieved this ActiveConnection.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>true if the user that retrieved this ActiveConnection may join the
      ActiveConnection through a call to
      <a href="../../../../../org/apache/guacamole/net/auth/ActiveConnection.html#connect-org.apache.guacamole.protocol.GuacamoleClientInformation-java.util.Map-"><code>connect(org.apache.guacamole.protocol.GuacamoleClientInformation, java.util.Map)</code></a>,
      false otherwise.</dd>
 </dl>
 </li>
 </ul>
 <a name="connect-org.apache.guacamole.protocol.GuacamoleClientInformation-java.util.Map-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>connect</h4>
 <pre>default&nbsp;org.apache.guacamole.net.GuacamoleTunnel&nbsp;connect(org.apache.guacamole.protocol.GuacamoleClientInformation&nbsp;info,
                                                          <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&gt;&nbsp;tokens)
                                                   throws org.apache.guacamole.GuacamoleException</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/guacamole/net/auth/Connectable.html#connect-org.apache.guacamole.protocol.GuacamoleClientInformation-java.util.Map-">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. Implementations which support parameter tokens should
  apply the given tokens when configuring the connection, such as with a
  <a href="../../../../../org/apache/guacamole/token/TokenFilter.html" title="class in org.apache.guacamole.token"><code>TokenFilter</code></a>.</div>
 <dl>
 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="../../../../../org/apache/guacamole/net/auth/Connectable.html#connect-org.apache.guacamole.protocol.GuacamoleClientInformation-java.util.Map-">connect</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/guacamole/net/auth/Connectable.html" title="interface in org.apache.guacamole.net.auth">Connectable</a></code></dd>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>info</code> - Information associated with the connecting client.</dd>
 <dd><code>tokens</code> - A Map containing the token names and corresponding values to be
      applied as parameter tokens when establishing the connection. If the
      implementation does not support parameter tokens, this Map may be
      ignored.</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>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="http://guacamole.apache.org/doc/gug/configuring-guacamole.html#parameter-tokens">Parameter Tokens</a></dd>
 </dl>
 </li>
 </ul>
 <a name="getActiveConnections--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>getActiveConnections</h4>
 <pre>default&nbsp;int&nbsp;getActiveConnections()</pre>
 <div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<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="overrideSpecifyLabel">Specified by:</span></dt>
 <dd><code><a href="../../../../../org/apache/guacamole/net/auth/Connectable.html#getActiveConnections--">getActiveConnections</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/guacamole/net/auth/Connectable.html" title="interface in org.apache.guacamole.net.auth">Connectable</a></code></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The number of active connections associated with this object.</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/ActiveConnection.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/AbstractUserGroup.html" title="class in org.apache.guacamole.net.auth"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../../org/apache/guacamole/net/auth/ActivityRecord.html" title="interface in org.apache.guacamole.net.auth"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../index.html?org/apache/guacamole/net/auth/ActiveConnection.html" target="_top">Frames</a></li>
 <li><a href="ActiveConnection.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_bottom");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a name="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 <p class="legalCopy"><small>Copyright &#169; 2020. All rights reserved.</small></p>
 </body>
 </html>