| <!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:10 PST 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>org.apache.guacamole (guacamole-common 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="org.apache.guacamole (guacamole-common 1.1.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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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>Prev Package</li> |
| <li><a href="../../../org/apache/guacamole/io/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/guacamole/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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="header"> |
| <h1 title="Package" class="title">Package org.apache.guacamole</h1> |
| <div class="docSummary"> |
| <div class="block">All classes which apply generally across the Guacamole web application |
| and all other web applications which use the API provided by the |
| Guacamole project.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/guacamole/GuacamoleClientBadTypeException.html" title="class in org.apache.guacamole">GuacamoleClientBadTypeException</a></td> |
| <td class="colLast"> |
| <div class="block">An exception which is thrown when data has been submitted with an unsupported |
| mimetype.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/guacamole/GuacamoleClientException.html" title="class in org.apache.guacamole">GuacamoleClientException</a></td> |
| <td class="colLast"> |
| <div class="block">A generic exception thrown when part of the Guacamole API encounters |
| an error in the client's request.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/guacamole/GuacamoleClientOverrunException.html" title="class in org.apache.guacamole">GuacamoleClientOverrunException</a></td> |
| <td class="colLast"> |
| <div class="block">An exception which is thrown when the client has sent too much data.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/guacamole/GuacamoleClientTimeoutException.html" title="class in org.apache.guacamole">GuacamoleClientTimeoutException</a></td> |
| <td class="colLast"> |
| <div class="block">An exception which is thrown when the client is taking too long to respond.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/guacamole/GuacamoleClientTooManyException.html" title="class in org.apache.guacamole">GuacamoleClientTooManyException</a></td> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/guacamole/GuacamoleConnectionClosedException.html" title="class in org.apache.guacamole">GuacamoleConnectionClosedException</a></td> |
| <td class="colLast"> |
| <div class="block">An exception which is thrown when an operation cannot be performed because |
| its corresponding connection is closed.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/guacamole/GuacamoleException.html" title="class in org.apache.guacamole">GuacamoleException</a></td> |
| <td class="colLast"> |
| <div class="block">A generic exception thrown when parts of the Guacamole API encounter |
| errors.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/guacamole/GuacamoleResourceClosedException.html" title="class in org.apache.guacamole">GuacamoleResourceClosedException</a></td> |
| <td class="colLast"> |
| <div class="block">An exception which is thrown when a resource is no longer available because |
| it is closed.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/guacamole/GuacamoleResourceConflictException.html" title="class in org.apache.guacamole">GuacamoleResourceConflictException</a></td> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/guacamole/GuacamoleResourceNotFoundException.html" title="class in org.apache.guacamole">GuacamoleResourceNotFoundException</a></td> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/guacamole/GuacamoleSecurityException.html" title="class in org.apache.guacamole">GuacamoleSecurityException</a></td> |
| <td class="colLast"> |
| <div class="block">A security-related exception thrown when parts of the Guacamole API is |
| denying access to a resource.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/guacamole/GuacamoleServerBusyException.html" title="class in org.apache.guacamole">GuacamoleServerBusyException</a></td> |
| <td class="colLast"> |
| <div class="block">An exception which is thrown when the server is too busy to service the |
| request.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/guacamole/GuacamoleServerException.html" title="class in org.apache.guacamole">GuacamoleServerException</a></td> |
| <td class="colLast"> |
| <div class="block">A generic exception thrown when part of the Guacamole API encounters |
| an unexpected, internal error.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/guacamole/GuacamoleSessionClosedException.html" title="class in org.apache.guacamole">GuacamoleSessionClosedException</a></td> |
| <td class="colLast"> |
| <div class="block">An exception which indicates that a session within an upstream server (such |
| as the remote desktop) has been forcibly terminated.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/guacamole/GuacamoleSessionConflictException.html" title="class in org.apache.guacamole">GuacamoleSessionConflictException</a></td> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/guacamole/GuacamoleSessionTimeoutException.html" title="class in org.apache.guacamole">GuacamoleSessionTimeoutException</a></td> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/guacamole/GuacamoleUnauthorizedException.html" title="class in org.apache.guacamole">GuacamoleUnauthorizedException</a></td> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/guacamole/GuacamoleUnsupportedException.html" title="class in org.apache.guacamole">GuacamoleUnsupportedException</a></td> |
| <td class="colLast"> |
| <div class="block">An exception which is thrown when the requested operation is unsupported |
| or unimplemented.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/guacamole/GuacamoleUpstreamException.html" title="class in org.apache.guacamole">GuacamoleUpstreamException</a></td> |
| <td class="colLast"> |
| <div class="block">An exception which indicates than an upstream server (such as the remote |
| desktop) is returning an error or is otherwise unreachable.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/guacamole/GuacamoleUpstreamNotFoundException.html" title="class in org.apache.guacamole">GuacamoleUpstreamNotFoundException</a></td> |
| <td class="colLast"> |
| <div class="block">An exception which indicates that an upstream server (such as the remote |
| desktop) does not appear to exist.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../org/apache/guacamole/GuacamoleUpstreamTimeoutException.html" title="class in org.apache.guacamole">GuacamoleUpstreamTimeoutException</a></td> |
| <td class="colLast"> |
| <div class="block">An exception which indicates than an upstream server (such as the remote |
| desktop) is taking too long to respond.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../org/apache/guacamole/GuacamoleUpstreamUnavailableException.html" title="class in org.apache.guacamole">GuacamoleUpstreamUnavailableException</a></td> |
| <td class="colLast"> |
| <div class="block">An exception which indicates that an upstream server (such as the remote |
| desktop) is not available to service the request.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package org.apache.guacamole Description">Package org.apache.guacamole Description</h2> |
| <div class="block">All classes which apply generally across the Guacamole web application |
| and all other web applications which use the API provided by the |
| Guacamole project.</div> |
| </div> |
| <!-- ======= 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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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>Prev Package</li> |
| <li><a href="../../../org/apache/guacamole/io/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/guacamole/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2020. All rights reserved.</small></p> |
| </body> |
| </html> |
