| <!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_151) on Tue Jan 09 15:44:11 PST 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>GuacamoleHTTPTunnelServlet (guacamole-common 0.9.14 API)</title> |
| <meta name="date" content="2018-01-09"> |
| <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="GuacamoleHTTPTunnelServlet (guacamole-common 0.9.14 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":6,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/GuacamoleHTTPTunnelServlet.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 Class</li> |
| <li><a href="../../../../org/apache/guacamole/servlet/GuacamoleSession.html" title="class in org.apache.guacamole.servlet"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html" target="_top">Frames</a></li> |
| <li><a href="GuacamoleHTTPTunnelServlet.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.guacamole.servlet</div> |
| <h2 title="Class GuacamoleHTTPTunnelServlet" class="title">Class GuacamoleHTTPTunnelServlet</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>javax.servlet.GenericServlet</li> |
| <li> |
| <ul class="inheritance"> |
| <li>javax.servlet.http.HttpServlet</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.guacamole.servlet.GuacamoleHTTPTunnelServlet</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="http://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, javax.servlet.Servlet, javax.servlet.ServletConfig</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">GuacamoleHTTPTunnelServlet</span> |
| extends javax.servlet.http.HttpServlet</pre> |
| <div class="block">A HttpServlet implementing and abstracting the operations required by the |
| HTTP implementation of the JavaScript Guacamole client's tunnel.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../serialized-form.html#org.apache.guacamole.servlet.GuacamoleHTTPTunnelServlet">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html#GuacamoleHTTPTunnelServlet--">GuacamoleHTTPTunnelServlet</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html#deregisterTunnel-org.apache.guacamole.net.GuacamoleTunnel-">deregisterTunnel</a></span>(<a href="../../../../org/apache/guacamole/net/GuacamoleTunnel.html" title="interface in org.apache.guacamole.net">GuacamoleTunnel</a> tunnel)</code> |
| <div class="block">Deregisters the given tunnel such that future read/write requests to |
| that tunnel will be rejected.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html#destroy--">destroy</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected abstract <a href="../../../../org/apache/guacamole/net/GuacamoleTunnel.html" title="interface in org.apache.guacamole.net">GuacamoleTunnel</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html#doConnect-javax.servlet.http.HttpServletRequest-">doConnect</a></span>(javax.servlet.http.HttpServletRequest request)</code> |
| <div class="block">Called whenever the JavaScript Guacamole client makes a connection |
| request via HTTP.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html#doGet-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">doGet</a></span>(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html#doPost-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">doPost</a></span>(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html#doRead-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-java.lang.String-">doRead</a></span>(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tunnelUUID)</code> |
| <div class="block">Called whenever the JavaScript Guacamole client makes a read request.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html#doWrite-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-java.lang.String-">doWrite</a></span>(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tunnelUUID)</code> |
| <div class="block">Called whenever the JavaScript Guacamole client makes a write request.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/guacamole/net/GuacamoleTunnel.html" title="interface in org.apache.guacamole.net">GuacamoleTunnel</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html#getTunnel-java.lang.String-">getTunnel</a></span>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tunnelUUID)</code> |
| <div class="block">Returns the tunnel with the given UUID, if it has been registered with |
| registerTunnel() and not yet deregistered with deregisterTunnel().</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html#handleTunnelRequest-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">handleTunnelRequest</a></span>(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response)</code> |
| <div class="block">Dispatches every HTTP GET and POST request to the appropriate handler |
| function based on the query string.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html#registerTunnel-org.apache.guacamole.net.GuacamoleTunnel-">registerTunnel</a></span>(<a href="../../../../org/apache/guacamole/net/GuacamoleTunnel.html" title="interface in org.apache.guacamole.net">GuacamoleTunnel</a> tunnel)</code> |
| <div class="block">Registers the given tunnel such that future read/write requests to that |
| tunnel will be properly directed.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html#sendError-javax.servlet.http.HttpServletResponse-org.apache.guacamole.protocol.GuacamoleStatus-java.lang.String-">sendError</a></span>(javax.servlet.http.HttpServletResponse response, |
| <a href="../../../../org/apache/guacamole/protocol/GuacamoleStatus.html" title="enum in org.apache.guacamole.protocol">GuacamoleStatus</a> guacStatus, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message)</code> |
| <div class="block">Sends an error on the given HTTP response using the information within |
| the given GuacamoleStatus.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.javax.servlet.http.HttpServlet"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class javax.servlet.http.HttpServlet</h3> |
| <code>doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.javax.servlet.GenericServlet"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class javax.servlet.GenericServlet</h3> |
| <code>getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="GuacamoleHTTPTunnelServlet--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>GuacamoleHTTPTunnelServlet</h4> |
| <pre>public GuacamoleHTTPTunnelServlet()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="registerTunnel-org.apache.guacamole.net.GuacamoleTunnel-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerTunnel</h4> |
| <pre>protected void registerTunnel(<a href="../../../../org/apache/guacamole/net/GuacamoleTunnel.html" title="interface in org.apache.guacamole.net">GuacamoleTunnel</a> tunnel)</pre> |
| <div class="block">Registers the given tunnel such that future read/write requests to that |
| tunnel will be properly directed.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tunnel</code> - The tunnel to register.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deregisterTunnel-org.apache.guacamole.net.GuacamoleTunnel-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deregisterTunnel</h4> |
| <pre>protected void deregisterTunnel(<a href="../../../../org/apache/guacamole/net/GuacamoleTunnel.html" title="interface in org.apache.guacamole.net">GuacamoleTunnel</a> tunnel)</pre> |
| <div class="block">Deregisters the given tunnel such that future read/write requests to |
| that tunnel will be rejected.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tunnel</code> - The tunnel to deregister.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTunnel-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTunnel</h4> |
| <pre>protected <a href="../../../../org/apache/guacamole/net/GuacamoleTunnel.html" title="interface in org.apache.guacamole.net">GuacamoleTunnel</a> getTunnel(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tunnelUUID) |
| throws <a href="../../../../org/apache/guacamole/GuacamoleException.html" title="class in org.apache.guacamole">GuacamoleException</a></pre> |
| <div class="block">Returns the tunnel with the given UUID, if it has been registered with |
| registerTunnel() and not yet deregistered with deregisterTunnel().</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tunnelUUID</code> - The UUID of registered tunnel.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The tunnel corresponding to the given UUID.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/guacamole/GuacamoleException.html" title="class in org.apache.guacamole">GuacamoleException</a></code> - If the requested tunnel does not exist because it has not yet been |
| registered or it has been deregistered.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="doGet-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doGet</h4> |
| <pre>protected void doGet(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response) |
| throws javax.servlet.ServletException</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>doGet</code> in class <code>javax.servlet.http.HttpServlet</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>javax.servlet.ServletException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="doPost-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doPost</h4> |
| <pre>protected void doPost(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response) |
| throws javax.servlet.ServletException</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>doPost</code> in class <code>javax.servlet.http.HttpServlet</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>javax.servlet.ServletException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="sendError-javax.servlet.http.HttpServletResponse-org.apache.guacamole.protocol.GuacamoleStatus-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sendError</h4> |
| <pre>protected void sendError(javax.servlet.http.HttpServletResponse response, |
| <a href="../../../../org/apache/guacamole/protocol/GuacamoleStatus.html" title="enum in org.apache.guacamole.protocol">GuacamoleStatus</a> guacStatus, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> message) |
| throws javax.servlet.ServletException</pre> |
| <div class="block">Sends an error on the given HTTP response using the information within |
| the given GuacamoleStatus.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>response</code> - The HTTP response to use to send the error.</dd> |
| <dd><code>guacStatus</code> - The status to send</dd> |
| <dd><code>message</code> - A human-readable message that can be presented to the user.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>javax.servlet.ServletException</code> - If an error prevents sending of the error code.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="handleTunnelRequest-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>handleTunnelRequest</h4> |
| <pre>protected void handleTunnelRequest(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response) |
| throws javax.servlet.ServletException</pre> |
| <div class="block">Dispatches every HTTP GET and POST request to the appropriate handler |
| function based on the query string.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The HttpServletRequest associated with the GET or POST request |
| received.</dd> |
| <dd><code>response</code> - The HttpServletResponse associated with the GET or POST request |
| received.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>javax.servlet.ServletException</code> - If an error occurs while servicing the request.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="doConnect-javax.servlet.http.HttpServletRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doConnect</h4> |
| <pre>protected abstract <a href="../../../../org/apache/guacamole/net/GuacamoleTunnel.html" title="interface in org.apache.guacamole.net">GuacamoleTunnel</a> doConnect(javax.servlet.http.HttpServletRequest request) |
| throws <a href="../../../../org/apache/guacamole/GuacamoleException.html" title="class in org.apache.guacamole">GuacamoleException</a></pre> |
| <div class="block">Called whenever the JavaScript Guacamole client makes a connection |
| request via HTTP. It it up to the implementor of this function to define |
| what conditions must be met for a tunnel to be configured and returned |
| as a result of this connection request (whether some sort of credentials |
| must be specified, for example).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The HttpServletRequest associated with the connection request |
| received. Any parameters specified along with the connection request |
| can be read from this object.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A newly constructed GuacamoleTunnel if successful, null otherwise.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/guacamole/GuacamoleException.html" title="class in org.apache.guacamole">GuacamoleException</a></code> - If an error occurs while constructing the GuacamoleTunnel, or if the |
| conditions required for connection are not met.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="doRead-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doRead</h4> |
| <pre>protected void doRead(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tunnelUUID) |
| throws <a href="../../../../org/apache/guacamole/GuacamoleException.html" title="class in org.apache.guacamole">GuacamoleException</a></pre> |
| <div class="block">Called whenever the JavaScript Guacamole client makes a read request. |
| This function should in general not be overridden, as it already |
| contains a proper implementation of the read operation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The HttpServletRequest associated with the read request received.</dd> |
| <dd><code>response</code> - The HttpServletResponse associated with the write request received. |
| Any data to be sent to the client in response to the write request |
| should be written to the response body of this HttpServletResponse.</dd> |
| <dd><code>tunnelUUID</code> - The UUID of the tunnel to read from, as specified in the write |
| request. This tunnel must have been created by a previous call to |
| doConnect().</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/guacamole/GuacamoleException.html" title="class in org.apache.guacamole">GuacamoleException</a></code> - If an error occurs while handling the read request.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="doWrite-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doWrite</h4> |
| <pre>protected void doWrite(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response, |
| <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tunnelUUID) |
| throws <a href="../../../../org/apache/guacamole/GuacamoleException.html" title="class in org.apache.guacamole">GuacamoleException</a></pre> |
| <div class="block">Called whenever the JavaScript Guacamole client makes a write request. |
| This function should in general not be overridden, as it already |
| contains a proper implementation of the write operation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>request</code> - The HttpServletRequest associated with the write request received. |
| Any data to be written will be specified within the body of this |
| request.</dd> |
| <dd><code>response</code> - The HttpServletResponse associated with the write request received.</dd> |
| <dd><code>tunnelUUID</code> - The UUID of the tunnel to write to, as specified in the write |
| request. This tunnel must have been created by a previous call to |
| doConnect().</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/guacamole/GuacamoleException.html" title="class in org.apache.guacamole">GuacamoleException</a></code> - If an error occurs while handling the write request.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="destroy--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>destroy</h4> |
| <pre>public void destroy()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>destroy</code> in interface <code>javax.servlet.Servlet</code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>destroy</code> in class <code>javax.servlet.GenericServlet</code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/GuacamoleHTTPTunnelServlet.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 Class</li> |
| <li><a href="../../../../org/apache/guacamole/servlet/GuacamoleSession.html" title="class in org.apache.guacamole.servlet"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/guacamole/servlet/GuacamoleHTTPTunnelServlet.html" target="_top">Frames</a></li> |
| <li><a href="GuacamoleHTTPTunnelServlet.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2018. All rights reserved.</small></p> |
| </body> |
| </html> |
