http://git-wip-us.apache.org/repos/asf/guacamole-website/blob/044692cf/doc/1.0.0/guacamole-common/index-all.html ---------------------------------------------------------------------- diff --git a/doc/1.0.0/guacamole-common/index-all.html b/doc/1.0.0/guacamole-common/index-all.html new file mode 100644 index 0000000..bb951b1 --- /dev/null +++ b/doc/1.0.0/guacamole-common/index-all.html @@ -0,0 +1,1339 @@ +<!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_191) on Fri Dec 21 13:21:29 PST 2018 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Index (guacamole-common 1.0.0 API)</title> +<meta name="date" content="2018-12-21"> +<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="Index (guacamole-common 1.0.0 API)"; + } + } + catch(err) { + } +//--> +</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>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="overview-tree.html">Tree</a></li> +<li><a href="deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="index.html?index-all.html" target="_top">Frames</a></li> +<li><a href="index-all.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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="contentContainer"><a href="#I:A">A</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a href="#I:I">I</a> <a href="#I:N">N</a> <a href="#I:O">O</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a href="#I:U">U</a> <a href="#I:V">V</a> <a href="#I:W">W</a> <a name="I:A"> +<!-- --> +</a> +<h2 class="title">A</h2> +<dl> +<dt><a href="org/apache/guacamole/net/AbstractGuacamoleTunnel.html" title="class in org.apache.guacamole.net"><span class="typeNameLink">AbstractGuacamoleTunnel</span></a> - Class in <a href="org/apache/guacamole/net/package-summary.html">org.apache.guacamole.net</a></dt> +<dd> +<div class="block">Base GuacamoleTunnel implementation which synchronizes access to the + underlying reader and writer with reentrant locks.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/AbstractGuacamoleTunnel.html#AbstractGuacamoleTunnel--">AbstractGuacamoleTunnel()</a></span> - Constructor for class org.apache.guacamole.net.<a href="org/apache/guacamole/net/AbstractGuacamoleTunnel.html" title="class in org.apache.guacamole.net">AbstractGuacamoleTunnel</a></dt> +<dd> +<div class="block">Creates a new GuacamoleTunnel which synchronizes access to the + Guacamole instruction stream associated with the underlying + GuacamoleSocket.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/AbstractGuacamoleTunnel.html#acquireReader--">acquireReader()</a></span> - Method in class org.apache.guacamole.net.<a href="org/apache/guacamole/net/AbstractGuacamoleTunnel.html" title="class in org.apache.guacamole.net">AbstractGuacamoleTunnel</a></dt> +<dd> +<div class="block">Acquires exclusive read access to the Guacamole instruction stream + and returns a GuacamoleReader for reading from that stream.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/DelegatingGuacamoleTunnel.html#acquireReader--">acquireReader()</a></span> - Method in class org.apache.guacamole.net.<a href="org/apache/guacamole/net/DelegatingGuacamoleTunnel.html" title="class in org.apache.guacamole.net">DelegatingGuacamoleTunnel</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/GuacamoleTunnel.html#acquireReader--">acquireReader()</a></span> - Method in interface org.apache.guacamole.net.<a href="org/apache/guacamole/net/GuacamoleTunnel.html" title="interface in org.apache.guacamole.net">GuacamoleTunnel</a></dt> +<dd> +<div class="block">Acquires exclusive read access to the Guacamole instruction stream + and returns a GuacamoleReader for reading from that stream.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/AbstractGuacamoleTunnel.html#acquireWriter--">acquireWriter()</a></span> - Method in class org.apache.guacamole.net.<a href="org/apache/guacamole/net/AbstractGuacamoleTunnel.html" title="class in org.apache.guacamole.net">AbstractGuacamoleTunnel</a></dt> +<dd> +<div class="block">Acquires exclusive write access to the Guacamole instruction stream + and returns a GuacamoleWriter for writing to that stream.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/DelegatingGuacamoleTunnel.html#acquireWriter--">acquireWriter()</a></span> - Method in class org.apache.guacamole.net.<a href="org/apache/guacamole/net/DelegatingGuacamoleTunnel.html" title="class in org.apache.guacamole.net">DelegatingGuacamoleTunnel</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/GuacamoleTunnel.html#acquireWriter--">acquireWriter()</a></span> - Method in interface org.apache.guacamole.net.<a href="org/apache/guacamole/net/GuacamoleTunnel.html" title="interface in org.apache.guacamole.net">GuacamoleTunnel</a></dt> +<dd> +<div class="block">Acquires exclusive write access to the Guacamole instruction stream + and returns a GuacamoleWriter for writing to that stream.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleParser.html#append-char:A-int-int-">append(char[], int, int)</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleParser.html" title="class in org.apache.guacamole.protocol">GuacamoleParser</a></dt> +<dd> +<div class="block">Appends data from the given buffer to the current instruction.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleParser.html#append-char:A-">append(char[])</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleParser.html" title="class in org.apache.guacamole.protocol">GuacamoleParser</a></dt> +<dd> +<div class="block">Appends data from the given buffer to the current instruction.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/io/GuacamoleReader.html#available--">available()</a></span> - Method in interface org.apache.guacamole.io.<a href="org/apache/guacamole/io/GuacamoleReader.html" title="interface in org.apache.guacamole.io">GuacamoleReader</a></dt> +<dd> +<div class="block">Returns whether instruction data is available for reading.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/io/ReaderGuacamoleReader.html#available--">available()</a></span> - Method in class org.apache.guacamole.io.<a href="org/apache/guacamole/io/ReaderGuacamoleReader.html" title="class in org.apache.guacamole.io">ReaderGuacamoleReader</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/FilteredGuacamoleReader.html#available--">available()</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/FilteredGuacamoleReader.html" title="class in org.apache.guacamole.protocol">FilteredGuacamoleReader</a></dt> +<dd> </dd> +</dl> +<a name="I:C"> +<!-- --> +</a> +<h2 class="title">C</h2> +<dl> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/AbstractGuacamoleTunnel.html#close--">close()</a></span> - Method in class org.apache.guacamole.net.<a href="org/apache/guacamole/net/AbstractGuacamoleTunnel.html" title="class in org.apache.guacamole.net">AbstractGuacamoleTunnel</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/DelegatingGuacamoleTunnel.html#close--">close()</a></span> - Method in class org.apache.guacamole.net.<a href="org/apache/guacamole/net/DelegatingGuacamoleTunnel.html" title="class in org.apache.guacamole.net">DelegatingGuacamoleTunnel</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/GuacamoleSocket.html#close--">close()</a></span> - Method in interface org.apache.guacamole.net.<a href="org/apache/guacamole/net/GuacamoleSocket.html" title="interface in org.apache.guacamole.net">GuacamoleSocket</a></dt> +<dd> +<div class="block">Releases all resources in use by the connection represented by this + GuacamoleSocket.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/GuacamoleTunnel.html#close--">close()</a></span> - Method in interface org.apache.guacamole.net.<a href="org/apache/guacamole/net/GuacamoleTunnel.html" title="interface in org.apache.guacamole.net">GuacamoleTunnel</a></dt> +<dd> +<div class="block">Release all resources allocated to this GuacamoleTunnel.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/InetGuacamoleSocket.html#close--">close()</a></span> - Method in class org.apache.guacamole.net.<a href="org/apache/guacamole/net/InetGuacamoleSocket.html" title="class in org.apache.guacamole.net">InetGuacamoleSocket</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/SSLGuacamoleSocket.html#close--">close()</a></span> - Method in class org.apache.guacamole.net.<a href="org/apache/guacamole/net/SSLGuacamoleSocket.html" title="class in org.apache.guacamole.net">SSLGuacamoleSocket</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/ConfiguredGuacamoleSocket.html#close--">close()</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/ConfiguredGuacamoleSocket.html" title="class in org.apache.guacamole.protocol">ConfiguredGuacamoleSocket</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/FailoverGuacamoleSocket.html#close--">close()</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/FailoverGuacamoleSocket.html" title="class in org.apache.guacamole.protocol">FailoverGuacamoleSocket</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/FilteredGuacamoleSocket.html#close--">close()</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/FilteredGuacamoleSocket.html" title="class in org.apache.guacamole.protocol">FilteredGuacamoleSocket</a></dt> +<dd> </dd> +<dt><a href="org/apache/guacamole/protocol/ConfiguredGuacamoleSocket.html" title="class in org.apache.guacamole.protocol"><span class="typeNameLink">ConfiguredGuacamoleSocket</span></a> - Class in <a href="org/apache/guacamole/protocol/package-summary.html">org.apache.guacamole.protocol</a></dt> +<dd> +<div class="block">A GuacamoleSocket which pre-configures the connection based on a given + GuacamoleConfiguration, completing the initial protocol handshake before + accepting data for read or write.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/ConfiguredGuacamoleSocket.html#ConfiguredGuacamoleSocket-org.apache.guacamole.net.GuacamoleSocket-org.apache.guacamole.protocol.GuacamoleConfiguration-">ConfiguredGuacamoleSocket(GuacamoleSocket, GuacamoleConfiguration)</a></span> - Constructor for class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/ConfiguredGuacamoleSocket.html" title="class in org.apache.guacamole.protocol">ConfiguredGuacamoleSocket</a></dt> +<dd> +<div class="block">Creates a new ConfiguredGuacamoleSocket which uses the given + GuacamoleConfiguration to complete the initial protocol handshake over + the given GuacamoleSocket.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/ConfiguredGuacamoleSocket.html#ConfiguredGuacamoleSocket-org.apache.guacamole.net.GuacamoleSocket-org.apache.guacamole.protocol.GuacamoleConfiguration-org.apache.guacamole.protocol.GuacamoleClientInformation-">ConfiguredGuacamoleSocket(GuacamoleSocket, GuacamoleConfiguration, GuacamoleClientInformation)</a></span> - Constructor for class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/ConfiguredGuacamoleSocket.html" title="class in org.apache.guacamole.protocol">ConfiguredGuacamoleSocket</a></dt> +<dd> +<div class="block">Creates a new ConfiguredGuacamoleSocket which uses the given + GuacamoleConfiguration and GuacamoleClientInformation to complete the + initial protocol handshake over the given GuacamoleSocket.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/websocket/GuacamoleWebSocketTunnelEndpoint.html#createTunnel-javax.websocket.Session-javax.websocket.EndpointConfig-">createTunnel(Session, EndpointConfig)</a></span> - Method in class org.apache.guacamole.websocket.<a href="org/apache/guacamole/websocket/GuacamoleWebSocketTunnelEndpoint.html" title="class in org.apache.guacamole.websocket">GuacamoleWebSocketTunnelEndpoint</a></dt> +<dd> +<div class="block">Returns a new tunnel for the given session.</div> +</dd> +</dl> +<a name="I:D"> +<!-- --> +</a> +<h2 class="title">D</h2> +<dl> +<dt><a href="org/apache/guacamole/net/DelegatingGuacamoleTunnel.html" title="class in org.apache.guacamole.net"><span class="typeNameLink">DelegatingGuacamoleTunnel</span></a> - Class in <a href="org/apache/guacamole/net/package-summary.html">org.apache.guacamole.net</a></dt> +<dd> +<div class="block">GuacamoleTunnel implementation which simply delegates all function calls to + an underlying GuacamoleTunnel.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/DelegatingGuacamoleTunnel.html#DelegatingGuacamoleTunnel-org.apache.guacamole.net.GuacamoleTunnel-">DelegatingGuacamoleTunnel(GuacamoleTunnel)</a></span> - Constructor for class org.apache.guacamole.net.<a href="org/apache/guacamole/net/DelegatingGuacamoleTunnel.html" title="class in org.apache.guacamole.net">DelegatingGuacamoleTunnel</a></dt> +<dd> +<div class="block">Wraps the given tunnel such that all function calls against this tunnel + will be delegated to it.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html#deregisterTunnel-org.apache.guacamole.net.GuacamoleTunnel-">deregisterTunnel(GuacamoleTunnel)</a></span> - Method in class org.apache.guacamole.servlet.<a href="org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html" title="class in org.apache.guacamole.servlet">GuacamoleHTTPTunnelServlet</a></dt> +<dd> +<div class="block">Deregisters the given tunnel such that future read/write requests to + that tunnel will be rejected.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html#destroy--">destroy()</a></span> - Method in class org.apache.guacamole.servlet.<a href="org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html" title="class in org.apache.guacamole.servlet">GuacamoleHTTPTunnelServlet</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html#doConnect-javax.servlet.http.HttpServletRequest-">doConnect(HttpServletRequest)</a></span> - Method in class org.apache.guacamole.servlet.<a href="org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html" title="class in org.apache.guacamole.servlet">GuacamoleHTTPTunnelServlet</a></dt> +<dd> +<div class="block">Called whenever the JavaScript Guacamole client makes a connection + request via HTTP.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html#doGet-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">doGet(HttpServletRequest, HttpServletResponse)</a></span> - Method in class org.apache.guacamole.servlet.<a href="org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html" title="class in org.apache.guacamole.servlet">GuacamoleHTTPTunnelServlet</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html#doPost-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">doPost(HttpServletRequest, HttpServletResponse)</a></span> - Method in class org.apache.guacamole.servlet.<a href="org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html" title="class in org.apache.guacamole.servlet">GuacamoleHTTPTunnelServlet</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html#doRead-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-java.lang.String-">doRead(HttpServletRequest, HttpServletResponse, String)</a></span> - Method in class org.apache.guacamole.servlet.<a href="org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html" title="class in org.apache.guacamole.servlet">GuacamoleHTTPTunnelServlet</a></dt> +<dd> +<div class="block">Called whenever the JavaScript Guacamole client makes a read request.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html#doWrite-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-java.lang.String-">doWrite(HttpServletRequest, HttpServletResponse, String)</a></span> - Method in class org.apache.guacamole.servlet.<a href="org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html" title="class in org.apache.guacamole.servlet">GuacamoleHTTPTunnelServlet</a></dt> +<dd> +<div class="block">Called whenever the JavaScript Guacamole client makes a write request.</div> +</dd> +</dl> +<a name="I:F"> +<!-- --> +</a> +<h2 class="title">F</h2> +<dl> +<dt><a href="org/apache/guacamole/protocol/FailoverGuacamoleSocket.html" title="class in org.apache.guacamole.protocol"><span class="typeNameLink">FailoverGuacamoleSocket</span></a> - Class in <a href="org/apache/guacamole/protocol/package-summary.html">org.apache.guacamole.protocol</a></dt> +<dd> +<div class="block">GuacamoleSocket which intercepts errors received early in the Guacamole + session.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/FailoverGuacamoleSocket.html#FailoverGuacamoleSocket-org.apache.guacamole.net.GuacamoleSocket-">FailoverGuacamoleSocket(GuacamoleSocket)</a></span> - Constructor for class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/FailoverGuacamoleSocket.html" title="class in org.apache.guacamole.protocol">FailoverGuacamoleSocket</a></dt> +<dd> +<div class="block">Creates a new FailoverGuacamoleSocket which reads Guacamole instructions + from the given socket, searching for errors from the upstream remote + desktop.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleFilter.html#filter-org.apache.guacamole.protocol.GuacamoleInstruction-">filter(GuacamoleInstruction)</a></span> - Method in interface org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleFilter.html" title="interface in org.apache.guacamole.protocol">GuacamoleFilter</a></dt> +<dd> +<div class="block">Applies the filter to the given instruction, returning the original + instruction, a modified version of the original, or null, depending + on the implementation.</div> +</dd> +<dt><a href="org/apache/guacamole/protocol/FilteredGuacamoleReader.html" title="class in org.apache.guacamole.protocol"><span class="typeNameLink">FilteredGuacamoleReader</span></a> - Class in <a href="org/apache/guacamole/protocol/package-summary.html">org.apache.guacamole.protocol</a></dt> +<dd> +<div class="block">GuacamoleReader which applies a given GuacamoleFilter to observe or alter all + read instructions.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/FilteredGuacamoleReader.html#FilteredGuacamoleReader-org.apache.guacamole.io.GuacamoleReader-org.apache.guacamole.protocol.GuacamoleFilter-">FilteredGuacamoleReader(GuacamoleReader, GuacamoleFilter)</a></span> - Constructor for class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/FilteredGuacamoleReader.html" title="class in org.apache.guacamole.protocol">FilteredGuacamoleReader</a></dt> +<dd> +<div class="block">Wraps the given GuacamoleReader, applying the given filter to all read + instructions.</div> +</dd> +<dt><a href="org/apache/guacamole/protocol/FilteredGuacamoleSocket.html" title="class in org.apache.guacamole.protocol"><span class="typeNameLink">FilteredGuacamoleSocket</span></a> - Class in <a href="org/apache/guacamole/protocol/package-summary.html">org.apache.guacamole.protocol</a></dt> +<dd> +<div class="block">Implementation of GuacamoleSocket which allows individual instructions to be + intercepted, overridden, etc.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/FilteredGuacamoleSocket.html#FilteredGuacamoleSocket-org.apache.guacamole.net.GuacamoleSocket-org.apache.guacamole.protocol.GuacamoleFilter-org.apache.guacamole.protocol.GuacamoleFilter-">FilteredGuacamoleSocket(GuacamoleSocket, GuacamoleFilter, GuacamoleFilter)</a></span> - Constructor for class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/FilteredGuacamoleSocket.html" title="class in org.apache.guacamole.protocol">FilteredGuacamoleSocket</a></dt> +<dd> +<div class="block">Creates a new FilteredGuacamoleSocket which uses the given filters to + determine whether instructions read/written are allowed through, + modified, etc.</div> +</dd> +<dt><a href="org/apache/guacamole/protocol/FilteredGuacamoleWriter.html" title="class in org.apache.guacamole.protocol"><span class="typeNameLink">FilteredGuacamoleWriter</span></a> - Class in <a href="org/apache/guacamole/protocol/package-summary.html">org.apache.guacamole.protocol</a></dt> +<dd> +<div class="block">GuacamoleWriter which applies a given GuacamoleFilter to observe or alter + all written instructions.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/FilteredGuacamoleWriter.html#FilteredGuacamoleWriter-org.apache.guacamole.io.GuacamoleWriter-org.apache.guacamole.protocol.GuacamoleFilter-">FilteredGuacamoleWriter(GuacamoleWriter, GuacamoleFilter)</a></span> - Constructor for class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/FilteredGuacamoleWriter.html" title="class in org.apache.guacamole.protocol">FilteredGuacamoleWriter</a></dt> +<dd> +<div class="block">Wraps the given GuacamoleWriter, applying the given filter to all written + instructions.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleStatus.html#fromGuacamoleStatusCode-int-">fromGuacamoleStatusCode(int)</a></span> - Static method in enum org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleStatus.html" title="enum in org.apache.guacamole.protocol">GuacamoleStatus</a></dt> +<dd> +<div class="block">Returns the GuacamoleStatus corresponding to the given Guacamole + protocol status code.</div> +</dd> +</dl> +<a name="I:G"> +<!-- --> +</a> +<h2 class="title">G</h2> +<dl> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleInstruction.html#getArgs--">getArgs()</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleInstruction.html" title="class in org.apache.guacamole.protocol">GuacamoleInstruction</a></dt> +<dd> +<div class="block">Returns a List of all argument values specified for this + GuacamoleInstruction.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleClientInformation.html#getAudioMimetypes--">getAudioMimetypes()</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleClientInformation.html" title="class in org.apache.guacamole.protocol">GuacamoleClientInformation</a></dt> +<dd> +<div class="block">Returns the list of audio mimetypes supported by the client.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/ConfiguredGuacamoleSocket.html#getConfiguration--">getConfiguration()</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/ConfiguredGuacamoleSocket.html" title="class in org.apache.guacamole.protocol">ConfiguredGuacamoleSocket</a></dt> +<dd> +<div class="block">Returns the GuacamoleConfiguration used to configure this + ConfiguredGuacamoleSocket.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/ConfiguredGuacamoleSocket.html#getConnectionID--">getConnectionID()</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/ConfiguredGuacamoleSocket.html" title="class in org.apache.guacamole.protocol">ConfiguredGuacamoleSocket</a></dt> +<dd> +<div class="block">Returns the unique ID associated with the Guacamole connection + negotiated by this ConfiguredGuacamoleSocket.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleConfiguration.html#getConnectionID--">getConnectionID()</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleConfiguration.html" title="class in org.apache.guacamole.protocol">GuacamoleConfiguration</a></dt> +<dd> +<div class="block">Returns the ID of the connection being joined, if any.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleStatus.html#getGuacamoleStatusCode--">getGuacamoleStatusCode()</a></span> - Method in enum org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleStatus.html" title="enum in org.apache.guacamole.protocol">GuacamoleStatus</a></dt> +<dd> +<div class="block">Returns the corresponding Guacamole protocol status code.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleException.html#getHttpStatusCode--">getHttpStatusCode()</a></span> - Method in exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleException.html" title="class in org.apache.guacamole">GuacamoleException</a></dt> +<dd> +<div class="block">Returns the most applicable HTTP status code that can be associated + with this exception.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleStatus.html#getHttpStatusCode--">getHttpStatusCode()</a></span> - Method in enum org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleStatus.html" title="enum in org.apache.guacamole.protocol">GuacamoleStatus</a></dt> +<dd> +<div class="block">Returns the most applicable HTTP error code.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleClientInformation.html#getImageMimetypes--">getImageMimetypes()</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleClientInformation.html" title="class in org.apache.guacamole.protocol">GuacamoleClientInformation</a></dt> +<dd> +<div class="block">Returns the list of image mimetypes supported by the client.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleInstruction.html#getOpcode--">getOpcode()</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleInstruction.html" title="class in org.apache.guacamole.protocol">GuacamoleInstruction</a></dt> +<dd> +<div class="block">Returns the opcode associated with this GuacamoleInstruction.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleClientInformation.html#getOptimalResolution--">getOptimalResolution()</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleClientInformation.html" title="class in org.apache.guacamole.protocol">GuacamoleClientInformation</a></dt> +<dd> +<div class="block">Returns the resolution of the screen if the optimal width and height are + used, in DPI.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleClientInformation.html#getOptimalScreenHeight--">getOptimalScreenHeight()</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleClientInformation.html" title="class in org.apache.guacamole.protocol">GuacamoleClientInformation</a></dt> +<dd> +<div class="block">Returns the optimal screen height requested by the client, in pixels.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleClientInformation.html#getOptimalScreenWidth--">getOptimalScreenWidth()</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleClientInformation.html" title="class in org.apache.guacamole.protocol">GuacamoleClientInformation</a></dt> +<dd> +<div class="block">Returns the optimal screen width requested by the client, in pixels.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleConfiguration.html#getParameter-java.lang.String-">getParameter(String)</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleConfiguration.html" title="class in org.apache.guacamole.protocol">GuacamoleConfiguration</a></dt> +<dd> +<div class="block">Returns the value set for the parameter with the given name, if any.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleConfiguration.html#getParameterNames--">getParameterNames()</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleConfiguration.html" title="class in org.apache.guacamole.protocol">GuacamoleConfiguration</a></dt> +<dd> +<div class="block">Returns a set of all currently defined parameter names.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleConfiguration.html#getParameters--">getParameters()</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleConfiguration.html" title="class in org.apache.guacamole.protocol">GuacamoleConfiguration</a></dt> +<dd> +<div class="block">Returns a map which contains parameter name/value pairs as key/value + pairs.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleConfiguration.html#getProtocol--">getProtocol()</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleConfiguration.html" title="class in org.apache.guacamole.protocol">GuacamoleConfiguration</a></dt> +<dd> +<div class="block">Returns the name of the protocol to be used.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/GuacamoleSocket.html#getReader--">getReader()</a></span> - Method in interface org.apache.guacamole.net.<a href="org/apache/guacamole/net/GuacamoleSocket.html" title="interface in org.apache.guacamole.net">GuacamoleSocket</a></dt> +<dd> +<div class="block">Returns a GuacamoleReader which can be used to read from the + Guacamole instruction stream associated with the connection + represented by this GuacamoleSocket.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/InetGuacamoleSocket.html#getReader--">getReader()</a></span> - Method in class org.apache.guacamole.net.<a href="org/apache/guacamole/net/InetGuacamoleSocket.html" title="class in org.apache.guacamole.net">InetGuacamoleSocket</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/SSLGuacamoleSocket.html#getReader--">getReader()</a></span> - Method in class org.apache.guacamole.net.<a href="org/apache/guacamole/net/SSLGuacamoleSocket.html" title="class in org.apache.guacamole.net">SSLGuacamoleSocket</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/ConfiguredGuacamoleSocket.html#getReader--">getReader()</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/ConfiguredGuacamoleSocket.html" title="class in org.apache.guacamole.protocol">ConfiguredGuacamoleSocket</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/FailoverGuacamoleSocket.html#getReader--">getReader()</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/FailoverGuacamoleSocket.html" title="class in org.apache.guacamole.protocol">FailoverGuacamoleSocket</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/FilteredGuacamoleSocket.html#getReader--">getReader()</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/FilteredGuacamoleSocket.html" title="class in org.apache.guacamole.protocol">FilteredGuacamoleSocket</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/DelegatingGuacamoleTunnel.html#getSocket--">getSocket()</a></span> - Method in class org.apache.guacamole.net.<a href="org/apache/guacamole/net/DelegatingGuacamoleTunnel.html" title="class in org.apache.guacamole.net">DelegatingGuacamoleTunnel</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/GuacamoleTunnel.html#getSocket--">getSocket()</a></span> - Method in interface org.apache.guacamole.net.<a href="org/apache/guacamole/net/GuacamoleTunnel.html" title="interface in org.apache.guacamole.net">GuacamoleTunnel</a></dt> +<dd> +<div class="block">Returns the GuacamoleSocket used by this GuacamoleTunnel for reading + and writing.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/SimpleGuacamoleTunnel.html#getSocket--">getSocket()</a></span> - Method in class org.apache.guacamole.net.<a href="org/apache/guacamole/net/SimpleGuacamoleTunnel.html" title="class in org.apache.guacamole.net">SimpleGuacamoleTunnel</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleClientBadTypeException.html#getStatus--">getStatus()</a></span> - Method in exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleClientBadTypeException.html" title="class in org.apache.guacamole">GuacamoleClientBadTypeException</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleClientException.html#getStatus--">getStatus()</a></span> - Method in exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleClientException.html" title="class in org.apache.guacamole">GuacamoleClientException</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleClientOverrunException.html#getStatus--">getStatus()</a></span> - Method in exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleClientOverrunException.html" title="class in org.apache.guacamole">GuacamoleClientOverrunException</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleClientTimeoutException.html#getStatus--">getStatus()</a></span> - Method in exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleClientTimeoutException.html" title="class in org.apache.guacamole">GuacamoleClientTimeoutException</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleClientTooManyException.html#getStatus--">getStatus()</a></span> - Method in exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleClientTooManyException.html" title="class in org.apache.guacamole">GuacamoleClientTooManyException</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleConnectionClosedException.html#getStatus--">getStatus()</a></span> - Method in exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleConnectionClosedException.html" title="class in org.apache.guacamole">GuacamoleConnectionClosedException</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleException.html#getStatus--">getStatus()</a></span> - Method in exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleException.html" title="class in org.apache.guacamole">GuacamoleException</a></dt> +<dd> +<div class="block">Returns the Guacamole status associated with this exception.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleResourceClosedException.html#getStatus--">getStatus()</a></span> - Method in exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleResourceClosedException.html" title="class in org.apache.guacamole">GuacamoleResourceClosedException</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleResourceConflictException.html#getStatus--">getStatus()</a></span> - Method in exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleResourceConflictException.html" title="class in org.apache.guacamole">GuacamoleResourceConflictException</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleResourceNotFoundException.html#getStatus--">getStatus()</a></span> - Method in exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleResourceNotFoundException.html" title="class in org.apache.guacamole">GuacamoleResourceNotFoundException</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleSecurityException.html#getStatus--">getStatus()</a></span> - Method in exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleSecurityException.html" title="class in org.apache.guacamole">GuacamoleSecurityException</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleServerBusyException.html#getStatus--">getStatus()</a></span> - Method in exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleServerBusyException.html" title="class in org.apache.guacamole">GuacamoleServerBusyException</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleServerException.html#getStatus--">getStatus()</a></span> - Method in exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleServerException.html" title="class in org.apache.guacamole">GuacamoleServerException</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleSessionClosedException.html#getStatus--">getStatus()</a></span> - Method in exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleSessionClosedException.html" title="class in org.apache.guacamole">GuacamoleSessionClosedException</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleSessionConflictException.html#getStatus--">getStatus()</a></span> - Method in exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleSessionConflictException.html" title="class in org.apache.guacamole">GuacamoleSessionConflictException</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleSessionTimeoutException.html#getStatus--">getStatus()</a></span> - Method in exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleSessionTimeoutException.html" title="class in org.apache.guacamole">GuacamoleSessionTimeoutException</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleUnauthorizedException.html#getStatus--">getStatus()</a></span> - Method in exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleUnauthorizedException.html" title="class in org.apache.guacamole">GuacamoleUnauthorizedException</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleUnsupportedException.html#getStatus--">getStatus()</a></span> - Method in exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleUnsupportedException.html" title="class in org.apache.guacamole">GuacamoleUnsupportedException</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleUpstreamException.html#getStatus--">getStatus()</a></span> - Method in exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleUpstreamException.html" title="class in org.apache.guacamole">GuacamoleUpstreamException</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleUpstreamNotFoundException.html#getStatus--">getStatus()</a></span> - Method in exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleUpstreamNotFoundException.html" title="class in org.apache.guacamole">GuacamoleUpstreamNotFoundException</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleUpstreamTimeoutException.html#getStatus--">getStatus()</a></span> - Method in exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleUpstreamTimeoutException.html" title="class in org.apache.guacamole">GuacamoleUpstreamTimeoutException</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleUpstreamUnavailableException.html#getStatus--">getStatus()</a></span> - Method in exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleUpstreamUnavailableException.html" title="class in org.apache.guacamole">GuacamoleUpstreamUnavailableException</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html#getTunnel-java.lang.String-">getTunnel(String)</a></span> - Method in class org.apache.guacamole.servlet.<a href="org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html" title="class in org.apache.guacamole.servlet">GuacamoleHTTPTunnelServlet</a></dt> +<dd> +<div class="block">Returns the tunnel with the given UUID, if it has been registered with + registerTunnel() and not yet deregistered with deregisterTunnel().</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/DelegatingGuacamoleTunnel.html#getUUID--">getUUID()</a></span> - Method in class org.apache.guacamole.net.<a href="org/apache/guacamole/net/DelegatingGuacamoleTunnel.html" title="class in org.apache.guacamole.net">DelegatingGuacamoleTunnel</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/GuacamoleTunnel.html#getUUID--">getUUID()</a></span> - Method in interface org.apache.guacamole.net.<a href="org/apache/guacamole/net/GuacamoleTunnel.html" title="interface in org.apache.guacamole.net">GuacamoleTunnel</a></dt> +<dd> +<div class="block">Returns the unique identifier associated with this GuacamoleTunnel.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/SimpleGuacamoleTunnel.html#getUUID--">getUUID()</a></span> - Method in class org.apache.guacamole.net.<a href="org/apache/guacamole/net/SimpleGuacamoleTunnel.html" title="class in org.apache.guacamole.net">SimpleGuacamoleTunnel</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleClientInformation.html#getVideoMimetypes--">getVideoMimetypes()</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleClientInformation.html" title="class in org.apache.guacamole.protocol">GuacamoleClientInformation</a></dt> +<dd> +<div class="block">Returns the list of video mimetypes supported by the client.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleException.html#getWebSocketCode--">getWebSocketCode()</a></span> - Method in exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleException.html" title="class in org.apache.guacamole">GuacamoleException</a></dt> +<dd> +<div class="block">Returns the most applicable WebSocket status code that can be + associated with this exception.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleStatus.html#getWebSocketCode--">getWebSocketCode()</a></span> - Method in enum org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleStatus.html" title="enum in org.apache.guacamole.protocol">GuacamoleStatus</a></dt> +<dd> +<div class="block">Returns the most applicable HTTP error code.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/GuacamoleSocket.html#getWriter--">getWriter()</a></span> - Method in interface org.apache.guacamole.net.<a href="org/apache/guacamole/net/GuacamoleSocket.html" title="interface in org.apache.guacamole.net">GuacamoleSocket</a></dt> +<dd> +<div class="block">Returns a GuacamoleWriter which can be used to write to the + Guacamole instruction stream associated with the connection + represented by this GuacamoleSocket.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/InetGuacamoleSocket.html#getWriter--">getWriter()</a></span> - Method in class org.apache.guacamole.net.<a href="org/apache/guacamole/net/InetGuacamoleSocket.html" title="class in org.apache.guacamole.net">InetGuacamoleSocket</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/net/SSLGuacamoleSocket.html#getWriter--">getWriter()</a></span> - Method in class org.apache.guacamole.net.<a href="org/apache/guacamole/net/SSLGuacamoleSocket.html" title="class in org.apache.guacamole.net">SSLGuacamoleSocket</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/ConfiguredGuacamoleSocket.html#getWriter--">getWriter()</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/ConfiguredGuacamoleSocket.html" title="class in org.apache.guacamole.protocol">ConfiguredGuacamoleSocket</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/FailoverGuacamoleSocket.html#getWriter--">getWriter()</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/FailoverGuacamoleSocket.html" title="class in org.apache.guacamole.protocol">FailoverGuacamoleSocket</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/FilteredGuacamoleSocket.html#getWriter--">getWriter()</a></span> - Method in class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/FilteredGuacamoleSocket.html" title="class in org.apache.guacamole.protocol">FilteredGuacamoleSocket</a></dt> +<dd> </dd> +<dt><a href="org/apache/guacamole/GuacamoleClientBadTypeException.html" title="class in org.apache.guacamole"><span class="typeNameLink">GuacamoleClientBadTypeException</span></a> - Exception in <a href="org/apache/guacamole/package-summary.html">org.apache.guacamole</a></dt> +<dd> +<div class="block">An exception which is thrown when data has been submitted with an unsupported + mimetype.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleClientBadTypeException.html#GuacamoleClientBadTypeException-java.lang.String-java.lang.Throwable-">GuacamoleClientBadTypeException(String, Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleClientBadTypeException.html" title="class in org.apache.guacamole">GuacamoleClientBadTypeException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleClientBadTypeException with the given message and cause.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleClientBadTypeException.html#GuacamoleClientBadTypeException-java.lang.String-">GuacamoleClientBadTypeException(String)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleClientBadTypeException.html" title="class in org.apache.guacamole">GuacamoleClientBadTypeException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleClientBadTypeException with the given message.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleClientBadTypeException.html#GuacamoleClientBadTypeException-java.lang.Throwable-">GuacamoleClientBadTypeException(Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleClientBadTypeException.html" title="class in org.apache.guacamole">GuacamoleClientBadTypeException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleClientBadTypeException with the given cause.</div> +</dd> +<dt><a href="org/apache/guacamole/GuacamoleClientException.html" title="class in org.apache.guacamole"><span class="typeNameLink">GuacamoleClientException</span></a> - Exception in <a href="org/apache/guacamole/package-summary.html">org.apache.guacamole</a></dt> +<dd> +<div class="block">A generic exception thrown when part of the Guacamole API encounters + an error in the client's request.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleClientException.html#GuacamoleClientException-java.lang.String-java.lang.Throwable-">GuacamoleClientException(String, Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleClientException.html" title="class in org.apache.guacamole">GuacamoleClientException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleException with the given message and cause.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleClientException.html#GuacamoleClientException-java.lang.String-">GuacamoleClientException(String)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleClientException.html" title="class in org.apache.guacamole">GuacamoleClientException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleException with the given message.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleClientException.html#GuacamoleClientException-java.lang.Throwable-">GuacamoleClientException(Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleClientException.html" title="class in org.apache.guacamole">GuacamoleClientException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleException with the given cause.</div> +</dd> +<dt><a href="org/apache/guacamole/protocol/GuacamoleClientInformation.html" title="class in org.apache.guacamole.protocol"><span class="typeNameLink">GuacamoleClientInformation</span></a> - Class in <a href="org/apache/guacamole/protocol/package-summary.html">org.apache.guacamole.protocol</a></dt> +<dd> +<div class="block">An abstract representation of Guacamole client information, including all + information required by the Guacamole protocol during the preamble.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleClientInformation.html#GuacamoleClientInformation--">GuacamoleClientInformation()</a></span> - Constructor for class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleClientInformation.html" title="class in org.apache.guacamole.protocol">GuacamoleClientInformation</a></dt> +<dd> </dd> +<dt><a href="org/apache/guacamole/GuacamoleClientOverrunException.html" title="class in org.apache.guacamole"><span class="typeNameLink">GuacamoleClientOverrunException</span></a> - Exception in <a href="org/apache/guacamole/package-summary.html">org.apache.guacamole</a></dt> +<dd> +<div class="block">An exception which is thrown when the client has sent too much data.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleClientOverrunException.html#GuacamoleClientOverrunException-java.lang.String-java.lang.Throwable-">GuacamoleClientOverrunException(String, Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleClientOverrunException.html" title="class in org.apache.guacamole">GuacamoleClientOverrunException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleClientOverrunException with the given message and cause.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleClientOverrunException.html#GuacamoleClientOverrunException-java.lang.String-">GuacamoleClientOverrunException(String)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleClientOverrunException.html" title="class in org.apache.guacamole">GuacamoleClientOverrunException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleClientOverrunException with the given message.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleClientOverrunException.html#GuacamoleClientOverrunException-java.lang.Throwable-">GuacamoleClientOverrunException(Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleClientOverrunException.html" title="class in org.apache.guacamole">GuacamoleClientOverrunException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleClientOverrunException with the given cause.</div> +</dd> +<dt><a href="org/apache/guacamole/GuacamoleClientTimeoutException.html" title="class in org.apache.guacamole"><span class="typeNameLink">GuacamoleClientTimeoutException</span></a> - Exception in <a href="org/apache/guacamole/package-summary.html">org.apache.guacamole</a></dt> +<dd> +<div class="block">An exception which is thrown when the client is taking too long to respond.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleClientTimeoutException.html#GuacamoleClientTimeoutException-java.lang.String-java.lang.Throwable-">GuacamoleClientTimeoutException(String, Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleClientTimeoutException.html" title="class in org.apache.guacamole">GuacamoleClientTimeoutException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleClientTimeoutException with the given message and cause.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleClientTimeoutException.html#GuacamoleClientTimeoutException-java.lang.String-">GuacamoleClientTimeoutException(String)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleClientTimeoutException.html" title="class in org.apache.guacamole">GuacamoleClientTimeoutException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleClientTimeoutException with the given message.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleClientTimeoutException.html#GuacamoleClientTimeoutException-java.lang.Throwable-">GuacamoleClientTimeoutException(Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleClientTimeoutException.html" title="class in org.apache.guacamole">GuacamoleClientTimeoutException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleClientTimeoutException with the given cause.</div> +</dd> +<dt><a href="org/apache/guacamole/GuacamoleClientTooManyException.html" title="class in org.apache.guacamole"><span class="typeNameLink">GuacamoleClientTooManyException</span></a> - Exception in <a href="org/apache/guacamole/package-summary.html">org.apache.guacamole</a></dt> +<dd> +<div class="block">An exception which is thrown when too many requests have been received + by the current client, and further requests are being rejected, either + temporarily or permanently.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleClientTooManyException.html#GuacamoleClientTooManyException-java.lang.String-java.lang.Throwable-">GuacamoleClientTooManyException(String, Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleClientTooManyException.html" title="class in org.apache.guacamole">GuacamoleClientTooManyException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleClientTooManyException with the given message and cause.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleClientTooManyException.html#GuacamoleClientTooManyException-java.lang.String-">GuacamoleClientTooManyException(String)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleClientTooManyException.html" title="class in org.apache.guacamole">GuacamoleClientTooManyException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleClientTooManyException with the given message.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleClientTooManyException.html#GuacamoleClientTooManyException-java.lang.Throwable-">GuacamoleClientTooManyException(Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleClientTooManyException.html" title="class in org.apache.guacamole">GuacamoleClientTooManyException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleClientTooManyException with the given cause.</div> +</dd> +<dt><a href="org/apache/guacamole/protocol/GuacamoleConfiguration.html" title="class in org.apache.guacamole.protocol"><span class="typeNameLink">GuacamoleConfiguration</span></a> - Class in <a href="org/apache/guacamole/protocol/package-summary.html">org.apache.guacamole.protocol</a></dt> +<dd> +<div class="block">All information necessary to complete the initial protocol handshake of a + Guacamole session.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleConfiguration.html#GuacamoleConfiguration--">GuacamoleConfiguration()</a></span> - Constructor for class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleConfiguration.html" title="class in org.apache.guacamole.protocol">GuacamoleConfiguration</a></dt> +<dd> +<div class="block">Creates a new, blank GuacamoleConfiguration with its protocol, connection + ID, and parameters unset.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleConfiguration.html#GuacamoleConfiguration-org.apache.guacamole.protocol.GuacamoleConfiguration-">GuacamoleConfiguration(GuacamoleConfiguration)</a></span> - Constructor for class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleConfiguration.html" title="class in org.apache.guacamole.protocol">GuacamoleConfiguration</a></dt> +<dd> +<div class="block">Copies the given GuacamoleConfiguration, creating a new, indepedent + GuacamoleConfiguration containing the same protocol, connection ID, + and parameter values, if any.</div> +</dd> +<dt><a href="org/apache/guacamole/GuacamoleConnectionClosedException.html" title="class in org.apache.guacamole"><span class="typeNameLink">GuacamoleConnectionClosedException</span></a> - Exception in <a href="org/apache/guacamole/package-summary.html">org.apache.guacamole</a></dt> +<dd> +<div class="block">An exception which is thrown when an operation cannot be performed because + its corresponding connection is closed.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleConnectionClosedException.html#GuacamoleConnectionClosedException-java.lang.String-java.lang.Throwable-">GuacamoleConnectionClosedException(String, Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleConnectionClosedException.html" title="class in org.apache.guacamole">GuacamoleConnectionClosedException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleConnectionClosedException with the given message + and cause.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleConnectionClosedException.html#GuacamoleConnectionClosedException-java.lang.String-">GuacamoleConnectionClosedException(String)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleConnectionClosedException.html" title="class in org.apache.guacamole">GuacamoleConnectionClosedException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleConnectionClosedException with the given message.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleConnectionClosedException.html#GuacamoleConnectionClosedException-java.lang.Throwable-">GuacamoleConnectionClosedException(Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleConnectionClosedException.html" title="class in org.apache.guacamole">GuacamoleConnectionClosedException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleConnectionClosedException with the given cause.</div> +</dd> +<dt><a href="org/apache/guacamole/GuacamoleException.html" title="class in org.apache.guacamole"><span class="typeNameLink">GuacamoleException</span></a> - Exception in <a href="org/apache/guacamole/package-summary.html">org.apache.guacamole</a></dt> +<dd> +<div class="block">A generic exception thrown when parts of the Guacamole API encounter + errors.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleException.html#GuacamoleException-java.lang.String-java.lang.Throwable-">GuacamoleException(String, Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleException.html" title="class in org.apache.guacamole">GuacamoleException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleException with the given message and cause.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleException.html#GuacamoleException-java.lang.String-">GuacamoleException(String)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleException.html" title="class in org.apache.guacamole">GuacamoleException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleException with the given message.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleException.html#GuacamoleException-java.lang.Throwable-">GuacamoleException(Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleException.html" title="class in org.apache.guacamole">GuacamoleException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleException with the given cause.</div> +</dd> +<dt><a href="org/apache/guacamole/protocol/GuacamoleFilter.html" title="interface in org.apache.guacamole.protocol"><span class="typeNameLink">GuacamoleFilter</span></a> - Interface in <a href="org/apache/guacamole/protocol/package-summary.html">org.apache.guacamole.protocol</a></dt> +<dd> +<div class="block">Interface which provides for the filtering of individual instructions.</div> +</dd> +<dt><a href="org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html" title="class in org.apache.guacamole.servlet"><span class="typeNameLink">GuacamoleHTTPTunnelServlet</span></a> - Class in <a href="org/apache/guacamole/servlet/package-summary.html">org.apache.guacamole.servlet</a></dt> +<dd> +<div class="block">A HttpServlet implementing and abstracting the operations required by the + HTTP implementation of the JavaScript Guacamole client's tunnel.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html#GuacamoleHTTPTunnelServlet--">GuacamoleHTTPTunnelServlet()</a></span> - Constructor for class org.apache.guacamole.servlet.<a href="org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html" title="class in org.apache.guacamole.servlet">GuacamoleHTTPTunnelServlet</a></dt> +<dd> </dd> +<dt><a href="org/apache/guacamole/protocol/GuacamoleInstruction.html" title="class in org.apache.guacamole.protocol"><span class="typeNameLink">GuacamoleInstruction</span></a> - Class in <a href="org/apache/guacamole/protocol/package-summary.html">org.apache.guacamole.protocol</a></dt> +<dd> +<div class="block">An abstract representation of a Guacamole instruction, as defined by the + Guacamole protocol.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleInstruction.html#GuacamoleInstruction-java.lang.String-java.lang.String...-">GuacamoleInstruction(String, String...)</a></span> - Constructor for class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleInstruction.html" title="class in org.apache.guacamole.protocol">GuacamoleInstruction</a></dt> +<dd> +<div class="block">Creates a new GuacamoleInstruction having the given Operation and + list of arguments values.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleInstruction.html#GuacamoleInstruction-java.lang.String-java.util.List-">GuacamoleInstruction(String, List<String>)</a></span> - Constructor for class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleInstruction.html" title="class in org.apache.guacamole.protocol">GuacamoleInstruction</a></dt> +<dd> +<div class="block">Creates a new GuacamoleInstruction having the given Operation and + list of arguments values.</div> +</dd> +<dt><a href="org/apache/guacamole/protocol/GuacamoleParser.html" title="class in org.apache.guacamole.protocol"><span class="typeNameLink">GuacamoleParser</span></a> - Class in <a href="org/apache/guacamole/protocol/package-summary.html">org.apache.guacamole.protocol</a></dt> +<dd> +<div class="block">Parser for the Guacamole protocol.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/protocol/GuacamoleParser.html#GuacamoleParser--">GuacamoleParser()</a></span> - Constructor for class org.apache.guacamole.protocol.<a href="org/apache/guacamole/protocol/GuacamoleParser.html" title="class in org.apache.guacamole.protocol">GuacamoleParser</a></dt> +<dd> </dd> +<dt><a href="org/apache/guacamole/io/GuacamoleReader.html" title="interface in org.apache.guacamole.io"><span class="typeNameLink">GuacamoleReader</span></a> - Interface in <a href="org/apache/guacamole/io/package-summary.html">org.apache.guacamole.io</a></dt> +<dd> +<div class="block">Provides abstract and raw character read access to a stream of Guacamole + instructions.</div> +</dd> +<dt><a href="org/apache/guacamole/GuacamoleResourceClosedException.html" title="class in org.apache.guacamole"><span class="typeNameLink">GuacamoleResourceClosedException</span></a> - Exception in <a href="org/apache/guacamole/package-summary.html">org.apache.guacamole</a></dt> +<dd> +<div class="block">An exception which is thrown when a resource is no longer available because + it is closed.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleResourceClosedException.html#GuacamoleResourceClosedException-java.lang.String-java.lang.Throwable-">GuacamoleResourceClosedException(String, Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleResourceClosedException.html" title="class in org.apache.guacamole">GuacamoleResourceClosedException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleResourceClosedException with the given message + and cause.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleResourceClosedException.html#GuacamoleResourceClosedException-java.lang.String-">GuacamoleResourceClosedException(String)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleResourceClosedException.html" title="class in org.apache.guacamole">GuacamoleResourceClosedException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleResourceClosedException with the given message.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleResourceClosedException.html#GuacamoleResourceClosedException-java.lang.Throwable-">GuacamoleResourceClosedException(Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleResourceClosedException.html" title="class in org.apache.guacamole">GuacamoleResourceClosedException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleResourceClosedException with the given cause.</div> +</dd> +<dt><a href="org/apache/guacamole/GuacamoleResourceConflictException.html" title="class in org.apache.guacamole"><span class="typeNameLink">GuacamoleResourceConflictException</span></a> - Exception in <a href="org/apache/guacamole/package-summary.html">org.apache.guacamole</a></dt> +<dd> +<div class="block">An exception which is thrown when a resource has been requested, but that + resource is locked or currently in use, and cannot be accessed by the + current user.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleResourceConflictException.html#GuacamoleResourceConflictException-java.lang.String-java.lang.Throwable-">GuacamoleResourceConflictException(String, Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleResourceConflictException.html" title="class in org.apache.guacamole">GuacamoleResourceConflictException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleResourceConflictException with the given message and cause.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleResourceConflictException.html#GuacamoleResourceConflictException-java.lang.String-">GuacamoleResourceConflictException(String)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleResourceConflictException.html" title="class in org.apache.guacamole">GuacamoleResourceConflictException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleResourceConflictException with the given message.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleResourceConflictException.html#GuacamoleResourceConflictException-java.lang.Throwable-">GuacamoleResourceConflictException(Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleResourceConflictException.html" title="class in org.apache.guacamole">GuacamoleResourceConflictException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleResourceConflictException with the given cause.</div> +</dd> +<dt><a href="org/apache/guacamole/GuacamoleResourceNotFoundException.html" title="class in org.apache.guacamole"><span class="typeNameLink">GuacamoleResourceNotFoundException</span></a> - Exception in <a href="org/apache/guacamole/package-summary.html">org.apache.guacamole</a></dt> +<dd> +<div class="block">A generic exception thrown when part of the Guacamole API fails to find + a requested resource, such as a configuration or tunnel.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleResourceNotFoundException.html#GuacamoleResourceNotFoundException-java.lang.String-java.lang.Throwable-">GuacamoleResourceNotFoundException(String, Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleResourceNotFoundException.html" title="class in org.apache.guacamole">GuacamoleResourceNotFoundException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleResourceNotFoundException with the given message + and cause.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleResourceNotFoundException.html#GuacamoleResourceNotFoundException-java.lang.String-">GuacamoleResourceNotFoundException(String)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleResourceNotFoundException.html" title="class in org.apache.guacamole">GuacamoleResourceNotFoundException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleResourceNotFoundException with the given message.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleResourceNotFoundException.html#GuacamoleResourceNotFoundException-java.lang.Throwable-">GuacamoleResourceNotFoundException(Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleResourceNotFoundException.html" title="class in org.apache.guacamole">GuacamoleResourceNotFoundException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleResourceNotFoundException with the given cause.</div> +</dd> +<dt><a href="org/apache/guacamole/GuacamoleSecurityException.html" title="class in org.apache.guacamole"><span class="typeNameLink">GuacamoleSecurityException</span></a> - Exception in <a href="org/apache/guacamole/package-summary.html">org.apache.guacamole</a></dt> +<dd> +<div class="block">A security-related exception thrown when parts of the Guacamole API is + denying access to a resource.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleSecurityException.html#GuacamoleSecurityException-java.lang.String-java.lang.Throwable-">GuacamoleSecurityException(String, Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleSecurityException.html" title="class in org.apache.guacamole">GuacamoleSecurityException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleSecurityException with the given message and cause.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleSecurityException.html#GuacamoleSecurityException-java.lang.String-">GuacamoleSecurityException(String)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleSecurityException.html" title="class in org.apache.guacamole">GuacamoleSecurityException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleSecurityException with the given message.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleSecurityException.html#GuacamoleSecurityException-java.lang.Throwable-">GuacamoleSecurityException(Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleSecurityException.html" title="class in org.apache.guacamole">GuacamoleSecurityException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleSecurityException with the given cause.</div> +</dd> +<dt><a href="org/apache/guacamole/GuacamoleServerBusyException.html" title="class in org.apache.guacamole"><span class="typeNameLink">GuacamoleServerBusyException</span></a> - Exception in <a href="org/apache/guacamole/package-summary.html">org.apache.guacamole</a></dt> +<dd> +<div class="block">An exception which is thrown when the server is too busy to service the + request.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleServerBusyException.html#GuacamoleServerBusyException-java.lang.String-java.lang.Throwable-">GuacamoleServerBusyException(String, Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleServerBusyException.html" title="class in org.apache.guacamole">GuacamoleServerBusyException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleServerBusyException with the given message and cause.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleServerBusyException.html#GuacamoleServerBusyException-java.lang.String-">GuacamoleServerBusyException(String)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleServerBusyException.html" title="class in org.apache.guacamole">GuacamoleServerBusyException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleServerBusyException with the given message.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleServerBusyException.html#GuacamoleServerBusyException-java.lang.Throwable-">GuacamoleServerBusyException(Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleServerBusyException.html" title="class in org.apache.guacamole">GuacamoleServerBusyException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleServerBusyException with the given cause.</div> +</dd> +<dt><a href="org/apache/guacamole/GuacamoleServerException.html" title="class in org.apache.guacamole"><span class="typeNameLink">GuacamoleServerException</span></a> - Exception in <a href="org/apache/guacamole/package-summary.html">org.apache.guacamole</a></dt> +<dd> +<div class="block">A generic exception thrown when part of the Guacamole API encounters + an unexpected, internal error.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleServerException.html#GuacamoleServerException-java.lang.String-java.lang.Throwable-">GuacamoleServerException(String, Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleServerException.html" title="class in org.apache.guacamole">GuacamoleServerException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleServerException with the given message and cause.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleServerException.html#GuacamoleServerException-java.lang.String-">GuacamoleServerException(String)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleServerException.html" title="class in org.apache.guacamole">GuacamoleServerException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleServerException with the given message.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleServerException.html#GuacamoleServerException-java.lang.Throwable-">GuacamoleServerException(Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleServerException.html" title="class in org.apache.guacamole">GuacamoleServerException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleServerException with the given cause.</div> +</dd> +<dt><a href="org/apache/guacamole/GuacamoleSessionClosedException.html" title="class in org.apache.guacamole"><span class="typeNameLink">GuacamoleSessionClosedException</span></a> - Exception in <a href="org/apache/guacamole/package-summary.html">org.apache.guacamole</a></dt> +<dd> +<div class="block">An exception which indicates that a session within an upstream server (such + as the remote desktop) has been forcibly terminated.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleSessionClosedException.html#GuacamoleSessionClosedException-java.lang.String-java.lang.Throwable-">GuacamoleSessionClosedException(String, Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleSessionClosedException.html" title="class in org.apache.guacamole">GuacamoleSessionClosedException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleSessionClosedException with the given message and + cause.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleSessionClosedException.html#GuacamoleSessionClosedException-java.lang.String-">GuacamoleSessionClosedException(String)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleSessionClosedException.html" title="class in org.apache.guacamole">GuacamoleSessionClosedException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleSessionClosedException with the given message.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleSessionClosedException.html#GuacamoleSessionClosedException-java.lang.Throwable-">GuacamoleSessionClosedException(Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleSessionClosedException.html" title="class in org.apache.guacamole">GuacamoleSessionClosedException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleSessionClosedException with the given cause.</div> +</dd> +<dt><a href="org/apache/guacamole/GuacamoleSessionConflictException.html" title="class in org.apache.guacamole"><span class="typeNameLink">GuacamoleSessionConflictException</span></a> - Exception in <a href="org/apache/guacamole/package-summary.html">org.apache.guacamole</a></dt> +<dd> +<div class="block">An exception which indicates that a session within an upstream server (such + as the remote desktop) has ended because it conflicted with another session.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleSessionConflictException.html#GuacamoleSessionConflictException-java.lang.String-java.lang.Throwable-">GuacamoleSessionConflictException(String, Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleSessionConflictException.html" title="class in org.apache.guacamole">GuacamoleSessionConflictException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleSessionConflictException with the given message + and cause.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleSessionConflictException.html#GuacamoleSessionConflictException-java.lang.String-">GuacamoleSessionConflictException(String)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleSessionConflictException.html" title="class in org.apache.guacamole">GuacamoleSessionConflictException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleSessionConflictException with the given message.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleSessionConflictException.html#GuacamoleSessionConflictException-java.lang.Throwable-">GuacamoleSessionConflictException(Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleSessionConflictException.html" title="class in org.apache.guacamole">GuacamoleSessionConflictException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleSessionConflictException with the given cause.</div> +</dd> +<dt><a href="org/apache/guacamole/GuacamoleSessionTimeoutException.html" title="class in org.apache.guacamole"><span class="typeNameLink">GuacamoleSessionTimeoutException</span></a> - Exception in <a href="org/apache/guacamole/package-summary.html">org.apache.guacamole</a></dt> +<dd> +<div class="block">An exception which indicates that a session within an upstream server (such + as the remote desktop) has ended because it appeared to be inactive.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleSessionTimeoutException.html#GuacamoleSessionTimeoutException-java.lang.String-java.lang.Throwable-">GuacamoleSessionTimeoutException(String, Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleSessionTimeoutException.html" title="class in org.apache.guacamole">GuacamoleSessionTimeoutException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleSessionTimeoutException with the given message + and cause.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleSessionTimeoutException.html#GuacamoleSessionTimeoutException-java.lang.String-">GuacamoleSessionTimeoutException(String)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleSessionTimeoutException.html" title="class in org.apache.guacamole">GuacamoleSessionTimeoutException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleSessionTimeoutException with the given message.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleSessionTimeoutException.html#GuacamoleSessionTimeoutException-java.lang.Throwable-">GuacamoleSessionTimeoutException(Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleSessionTimeoutException.html" title="class in org.apache.guacamole">GuacamoleSessionTimeoutException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleSessionTimeoutException with the given cause.</div> +</dd> +<dt><a href="org/apache/guacamole/net/GuacamoleSocket.html" title="interface in org.apache.guacamole.net"><span class="typeNameLink">GuacamoleSocket</span></a> - Interface in <a href="org/apache/guacamole/net/package-summary.html">org.apache.guacamole.net</a></dt> +<dd> +<div class="block">Provides abstract socket-like access to a Guacamole connection.</div> +</dd> +<dt><a href="org/apache/guacamole/protocol/GuacamoleStatus.html" title="enum in org.apache.guacamole.protocol"><span class="typeNameLink">GuacamoleStatus</span></a> - Enum in <a href="org/apache/guacamole/protocol/package-summary.html">org.apache.guacamole.protocol</a></dt> +<dd> +<div class="block">All possible statuses returned by various Guacamole instructions, each having + a corresponding code.</div> +</dd> +<dt><a href="org/apache/guacamole/net/GuacamoleTunnel.html" title="interface in org.apache.guacamole.net"><span class="typeNameLink">GuacamoleTunnel</span></a> - Interface in <a href="org/apache/guacamole/net/package-summary.html">org.apache.guacamole.net</a></dt> +<dd> +<div class="block">Provides a unique identifier and synchronized access to the GuacamoleReader + and GuacamoleWriter associated with a GuacamoleSocket.</div> +</dd> +<dt><a href="org/apache/guacamole/GuacamoleUnauthorizedException.html" title="class in org.apache.guacamole"><span class="typeNameLink">GuacamoleUnauthorizedException</span></a> - Exception in <a href="org/apache/guacamole/package-summary.html">org.apache.guacamole</a></dt> +<dd> +<div class="block">A security-related exception thrown when parts of the Guacamole API is + denying access to a resource, but access MAY be granted were the user + authorized (logged in).</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleUnauthorizedException.html#GuacamoleUnauthorizedException-java.lang.String-java.lang.Throwable-">GuacamoleUnauthorizedException(String, Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleUnauthorizedException.html" title="class in org.apache.guacamole">GuacamoleUnauthorizedException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleUnauthorizedException with the given message and cause.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleUnauthorizedException.html#GuacamoleUnauthorizedException-java.lang.String-">GuacamoleUnauthorizedException(String)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleUnauthorizedException.html" title="class in org.apache.guacamole">GuacamoleUnauthorizedException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleUnauthorizedException with the given message.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/guacamole/GuacamoleUnauthorizedException.html#GuacamoleUnauthorizedException-java.lang.Throwable-">GuacamoleUnauthorizedException(Throwable)</a></span> - Constructor for exception org.apache.guacamole.<a href="org/apache/guacamole/GuacamoleUnauthorizedException.html" title="class in org.apache.guacamole">GuacamoleUnauthorizedException</a></dt> +<dd> +<div class="block">Creates a new GuacamoleUnauthorizedException with the given cause.</div> +</dd> +<dt><a href="org/apache/guacamole/GuacamoleUnsupportedException.html" title="class in org.apache.guacamole"><span class="typeNameLink">GuacamoleUnsupport
<TRUNCATED>
