| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_212) on Sun Jan 26 10:16:16 PST 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>LocalEnvironment (guacamole-ext 1.1.0 API)</title> |
| <meta name="date" content="2020-01-26"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="LocalEnvironment (guacamole-ext 1.1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/LocalEnvironment.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/guacamole/environment/Environment.html" title="interface in org.apache.guacamole.environment"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/guacamole/environment/LocalEnvironment.html" target="_top">Frames</a></li> |
| <li><a href="LocalEnvironment.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.environment</div> |
| <h2 title="Class LocalEnvironment" class="title">Class LocalEnvironment</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/8/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>org.apache.guacamole.environment.LocalEnvironment</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../org/apache/guacamole/environment/Environment.html" title="interface in org.apache.guacamole.environment">Environment</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">LocalEnvironment</span> |
| extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../org/apache/guacamole/environment/Environment.html" title="interface in org.apache.guacamole.environment">Environment</a></pre> |
| <div class="block">The environment of the locally-running Guacamole instance, describing |
| available protocols, configuration parameters, and the GUACAMOLE_HOME |
| directory.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.guacamole.environment.Environment"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.guacamole.environment.<a href="../../../../org/apache/guacamole/environment/Environment.html" title="interface in org.apache.guacamole.environment">Environment</a></h3> |
| <code><a href="../../../../org/apache/guacamole/environment/Environment.html#GUACD_HOSTNAME">GUACD_HOSTNAME</a>, <a href="../../../../org/apache/guacamole/environment/Environment.html#GUACD_PORT">GUACD_PORT</a>, <a href="../../../../org/apache/guacamole/environment/Environment.html#GUACD_SSL">GUACD_SSL</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/guacamole/environment/LocalEnvironment.html#LocalEnvironment--">LocalEnvironment</a></span>()</code> |
| <div class="block">Creates a new Environment, initializing that environment based on the |
| location of GUACAMOLE_HOME and the contents of guacamole.properties.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/guacamole/net/auth/GuacamoleProxyConfiguration.html" title="class in org.apache.guacamole.net.auth">GuacamoleProxyConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/guacamole/environment/LocalEnvironment.html#getDefaultGuacamoleProxyConfiguration--">getDefaultGuacamoleProxyConfiguration</a></span>()</code> |
| <div class="block">Returns the connection information which should be used, by default, to |
| connect to guacd when establishing a remote desktop connection.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/guacamole/environment/LocalEnvironment.html#getGuacamoleHome--">getGuacamoleHome</a></span>()</code> |
| <div class="block">Returns the Guacamole home directory as determined when this Environment |
| object was created.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><Type> Type</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/guacamole/environment/LocalEnvironment.html#getProperty-org.apache.guacamole.properties.GuacamoleProperty-">getProperty</a></span>(<a href="../../../../org/apache/guacamole/properties/GuacamoleProperty.html" title="interface in org.apache.guacamole.properties">GuacamoleProperty</a><Type> property)</code> |
| <div class="block">Given a GuacamoleProperty, parses and returns the value set for that |
| property in guacamole.properties, if any.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><Type> Type</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/guacamole/environment/LocalEnvironment.html#getProperty-org.apache.guacamole.properties.GuacamoleProperty-Type-">getProperty</a></span>(<a href="../../../../org/apache/guacamole/properties/GuacamoleProperty.html" title="interface in org.apache.guacamole.properties">GuacamoleProperty</a><Type> property, |
| Type defaultValue)</code> |
| <div class="block">Given a GuacamoleProperty, parses and returns the value set for that |
| property in guacamole.properties, if any.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/guacamole/protocols/ProtocolInfo.html" title="class in org.apache.guacamole.protocols">ProtocolInfo</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/guacamole/environment/LocalEnvironment.html#getProtocol-java.lang.String-">getProtocol</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Returns the protocol having the given name.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/guacamole/protocols/ProtocolInfo.html" title="class in org.apache.guacamole.protocols">ProtocolInfo</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/guacamole/environment/LocalEnvironment.html#getProtocols--">getProtocols</a></span>()</code> |
| <div class="block">Returns a map of all available protocols, where each key is the name of |
| that protocol as would be passed to guacd during connection.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><Type> Type</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/guacamole/environment/LocalEnvironment.html#getRequiredProperty-org.apache.guacamole.properties.GuacamoleProperty-">getRequiredProperty</a></span>(<a href="../../../../org/apache/guacamole/properties/GuacamoleProperty.html" title="interface in org.apache.guacamole.properties">GuacamoleProperty</a><Type> property)</code> |
| <div class="block">Given a GuacamoleProperty, parses and returns the value set for that |
| property in guacamole.properties.</div> |
| </td> |
| </tr> |
| </table> |
| <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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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="LocalEnvironment--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>LocalEnvironment</h4> |
| <pre>public LocalEnvironment() |
| throws org.apache.guacamole.GuacamoleException</pre> |
| <div class="block">Creates a new Environment, initializing that environment based on the |
| location of GUACAMOLE_HOME and the contents of guacamole.properties.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while determining the |
| environment of this Guacamole instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getGuacamoleHome--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getGuacamoleHome</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> getGuacamoleHome()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/guacamole/environment/Environment.html#getGuacamoleHome--">Environment</a></code></span></div> |
| <div class="block">Returns the Guacamole home directory as determined when this Environment |
| object was created. The Guacamole home directory is found by checking, in |
| order: the guacamole.home system property, the GUACAMOLE_HOME environment |
| variable, and finally the .guacamole directory in the home directory of |
| the user running the servlet container.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/guacamole/environment/Environment.html#getGuacamoleHome--">getGuacamoleHome</a></code> in interface <code><a href="../../../../org/apache/guacamole/environment/Environment.html" title="interface in org.apache.guacamole.environment">Environment</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The File representing the Guacamole home directory, which may |
| or may not exist, and may turn out to not be a directory.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProperty-org.apache.guacamole.properties.GuacamoleProperty-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperty</h4> |
| <pre>public <Type> Type getProperty(<a href="../../../../org/apache/guacamole/properties/GuacamoleProperty.html" title="interface in org.apache.guacamole.properties">GuacamoleProperty</a><Type> property) |
| throws org.apache.guacamole.GuacamoleException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/guacamole/environment/Environment.html#getProperty-org.apache.guacamole.properties.GuacamoleProperty-">Environment</a></code></span></div> |
| <div class="block">Given a GuacamoleProperty, parses and returns the value set for that |
| property in guacamole.properties, if any.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/guacamole/environment/Environment.html#getProperty-org.apache.guacamole.properties.GuacamoleProperty-">getProperty</a></code> in interface <code><a href="../../../../org/apache/guacamole/environment/Environment.html" title="interface in org.apache.guacamole.environment">Environment</a></code></dd> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>Type</code> - The type that the given property is parsed into.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>property</code> - The property to read from guacamole.properties.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The parsed value of the property as read from |
| guacamole.properties.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while parsing the value |
| for the given property in |
| guacamole.properties.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProperty-org.apache.guacamole.properties.GuacamoleProperty-java.lang.Object-"> |
| <!-- --> |
| </a><a name="getProperty-org.apache.guacamole.properties.GuacamoleProperty-Type-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProperty</h4> |
| <pre>public <Type> Type getProperty(<a href="../../../../org/apache/guacamole/properties/GuacamoleProperty.html" title="interface in org.apache.guacamole.properties">GuacamoleProperty</a><Type> property, |
| Type defaultValue) |
| throws org.apache.guacamole.GuacamoleException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/guacamole/environment/Environment.html#getProperty-org.apache.guacamole.properties.GuacamoleProperty-Type-">Environment</a></code></span></div> |
| <div class="block">Given a GuacamoleProperty, parses and returns the value set for that |
| property in guacamole.properties, if any. If no value is found, the |
| provided default value is returned.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/guacamole/environment/Environment.html#getProperty-org.apache.guacamole.properties.GuacamoleProperty-Type-">getProperty</a></code> in interface <code><a href="../../../../org/apache/guacamole/environment/Environment.html" title="interface in org.apache.guacamole.environment">Environment</a></code></dd> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>Type</code> - The type that the given property is parsed into.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>property</code> - The property to read from guacamole.properties.</dd> |
| <dd><code>defaultValue</code> - The value to return if no value was given in |
| guacamole.properties.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The parsed value of the property as read from |
| guacamole.properties, or the provided default value if no value |
| was found.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while parsing the value |
| for the given property in |
| guacamole.properties.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRequiredProperty-org.apache.guacamole.properties.GuacamoleProperty-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRequiredProperty</h4> |
| <pre>public <Type> Type getRequiredProperty(<a href="../../../../org/apache/guacamole/properties/GuacamoleProperty.html" title="interface in org.apache.guacamole.properties">GuacamoleProperty</a><Type> property) |
| throws org.apache.guacamole.GuacamoleException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/guacamole/environment/Environment.html#getRequiredProperty-org.apache.guacamole.properties.GuacamoleProperty-">Environment</a></code></span></div> |
| <div class="block">Given a GuacamoleProperty, parses and returns the value set for that |
| property in guacamole.properties. An exception is thrown if the value |
| is not provided.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/guacamole/environment/Environment.html#getRequiredProperty-org.apache.guacamole.properties.GuacamoleProperty-">getRequiredProperty</a></code> in interface <code><a href="../../../../org/apache/guacamole/environment/Environment.html" title="interface in org.apache.guacamole.environment">Environment</a></code></dd> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>Type</code> - The type that the given property is parsed into.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>property</code> - The property to read from guacamole.properties.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The parsed value of the property as read from |
| guacamole.properties.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.guacamole.GuacamoleException</code> - If an error occurs while parsing the value |
| for the given property in |
| guacamole.properties, or if the property is |
| not specified.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProtocols--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProtocols</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/guacamole/protocols/ProtocolInfo.html" title="class in org.apache.guacamole.protocols">ProtocolInfo</a>> getProtocols()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/guacamole/environment/Environment.html#getProtocols--">Environment</a></code></span></div> |
| <div class="block">Returns a map of all available protocols, where each key is the name of |
| that protocol as would be passed to guacd during connection.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/guacamole/environment/Environment.html#getProtocols--">getProtocols</a></code> in interface <code><a href="../../../../org/apache/guacamole/environment/Environment.html" title="interface in org.apache.guacamole.environment">Environment</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A map of all available protocols.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProtocol-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getProtocol</h4> |
| <pre>public <a href="../../../../org/apache/guacamole/protocols/ProtocolInfo.html" title="class in org.apache.guacamole.protocols">ProtocolInfo</a> getProtocol(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/guacamole/environment/Environment.html#getProtocol-java.lang.String-">Environment</a></code></span></div> |
| <div class="block">Returns the protocol having the given name. The name must be the |
| protocol name as would be passed to guacd during connection.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/guacamole/environment/Environment.html#getProtocol-java.lang.String-">getProtocol</a></code> in interface <code><a href="../../../../org/apache/guacamole/environment/Environment.html" title="interface in org.apache.guacamole.environment">Environment</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The name of the protocol.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The protocol having the given name, or null if no such |
| protocol is registered.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDefaultGuacamoleProxyConfiguration--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getDefaultGuacamoleProxyConfiguration</h4> |
| <pre>public <a href="../../../../org/apache/guacamole/net/auth/GuacamoleProxyConfiguration.html" title="class in org.apache.guacamole.net.auth">GuacamoleProxyConfiguration</a> getDefaultGuacamoleProxyConfiguration() |
| throws org.apache.guacamole.GuacamoleException</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/guacamole/environment/Environment.html#getDefaultGuacamoleProxyConfiguration--">Environment</a></code></span></div> |
| <div class="block">Returns the connection information which should be used, by default, to |
| connect to guacd when establishing a remote desktop connection.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/guacamole/environment/Environment.html#getDefaultGuacamoleProxyConfiguration--">getDefaultGuacamoleProxyConfiguration</a></code> in interface <code><a href="../../../../org/apache/guacamole/environment/Environment.html" title="interface in org.apache.guacamole.environment">Environment</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The connection information which should be used, by default, to |
| connect to guacd.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>org.apache.guacamole.GuacamoleException</code> - If the the connection information for guacd cannot be |
| retrieved.</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/LocalEnvironment.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/guacamole/environment/Environment.html" title="interface in org.apache.guacamole.environment"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/guacamole/environment/LocalEnvironment.html" target="_top">Frames</a></li> |
| <li><a href="LocalEnvironment.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 © 2020. All rights reserved.</small></p> |
| </body> |
| </html> |
