| <!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_66) on Fri Jan 15 14:33:43 CET 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>StandardEnvironment (Apache Mina SSHD :: Core 1.1.0 API)</title> |
| <meta name="date" content="2016-01-15"> |
| <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="StandardEnvironment (Apache Mina SSHD :: Core 1.1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":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/StandardEnvironment.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/sshd/server/SshServer.html" title="class in org.apache.sshd.server"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/sshd/server/StandardEnvironment.html" target="_top">Frames</a></li> |
| <li><a href="StandardEnvironment.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><a href="#fields.inherited.from.class.org.apache.sshd.common.util.logging.AbstractLoggingBean">Field</a> | </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.sshd.server</div> |
| <h2 title="Class StandardEnvironment" class="title">Class StandardEnvironment</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/7/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><a href="../../../../org/apache/sshd/common/util/logging/AbstractLoggingBean.html" title="class in org.apache.sshd.common.util.logging">org.apache.sshd.common.util.logging.AbstractLoggingBean</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.sshd.server.StandardEnvironment</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../org/apache/sshd/server/Environment.html" title="interface in org.apache.sshd.server">Environment</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">StandardEnvironment</span> |
| extends <a href="../../../../org/apache/sshd/common/util/logging/AbstractLoggingBean.html" title="class in org.apache.sshd.common.util.logging">AbstractLoggingBean</a> |
| implements <a href="../../../../org/apache/sshd/server/Environment.html" title="interface in org.apache.sshd.server">Environment</a></pre> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd><a href="mailto:dev@mina.apache.org">Apache MINA SSHD Project</a></dd> |
| </dl> |
| </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.sshd.common.util.logging.AbstractLoggingBean"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.sshd.common.util.logging.<a href="../../../../org/apache/sshd/common/util/logging/AbstractLoggingBean.html" title="class in org.apache.sshd.common.util.logging">AbstractLoggingBean</a></h3> |
| <code><a href="../../../../org/apache/sshd/common/util/logging/AbstractLoggingBean.html#log">log</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.sshd.server.Environment"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.sshd.server.<a href="../../../../org/apache/sshd/server/Environment.html" title="interface in org.apache.sshd.server">Environment</a></h3> |
| <code><a href="../../../../org/apache/sshd/server/Environment.html#ENV_COLUMNS">ENV_COLUMNS</a>, <a href="../../../../org/apache/sshd/server/Environment.html#ENV_LINES">ENV_LINES</a>, <a href="../../../../org/apache/sshd/server/Environment.html#ENV_TERM">ENV_TERM</a>, <a href="../../../../org/apache/sshd/server/Environment.html#ENV_USER">ENV_USER</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/sshd/server/StandardEnvironment.html#StandardEnvironment--">StandardEnvironment</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="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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sshd/server/StandardEnvironment.html#addSignalListener-org.apache.sshd.server.SignalListener-">addSignalListener</a></span>(<a href="../../../../org/apache/sshd/server/SignalListener.html" title="interface in org.apache.sshd.server">SignalListener</a> listener)</code> |
| <div class="block">Add a global listener for all signals</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/sshd/server/StandardEnvironment.html#addSignalListener-org.apache.sshd.server.SignalListener-java.util.Collection-">addSignalListener</a></span>(<a href="../../../../org/apache/sshd/server/SignalListener.html" title="interface in org.apache.sshd.server">SignalListener</a> listener, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/sshd/server/Signal.html" title="enum in org.apache.sshd.server">Signal</a>> signals)</code> |
| <div class="block">Add a qualified listener for the specific signals</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sshd/server/StandardEnvironment.html#addSignalListener-org.apache.sshd.server.SignalListener-org.apache.sshd.server.Signal...-">addSignalListener</a></span>(<a href="../../../../org/apache/sshd/server/SignalListener.html" title="interface in org.apache.sshd.server">SignalListener</a> listener, |
| <a href="../../../../org/apache/sshd/server/Signal.html" title="enum in org.apache.sshd.server">Signal</a>... signals)</code> |
| <div class="block">Add a qualified listener for the specific signals</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sshd/server/StandardEnvironment.html#getEnv--">getEnv</a></span>()</code> |
| <div class="block">Retrieve the environment map</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../org/apache/sshd/common/channel/PtyMode.html" title="enum in org.apache.sshd.common.channel">PtyMode</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sshd/server/StandardEnvironment.html#getPtyModes--">getPtyModes</a></span>()</code> |
| <div class="block">Retrieve the PTY modes settings</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../org/apache/sshd/server/SignalListener.html" title="interface in org.apache.sshd.server">SignalListener</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sshd/server/StandardEnvironment.html#getSignalListeners-org.apache.sshd.server.Signal-boolean-">getSignalListeners</a></span>(<a href="../../../../org/apache/sshd/server/Signal.html" title="enum in org.apache.sshd.server">Signal</a> signal, |
| boolean create)</code> |
| <div class="block">Retrieves the set of listeners registered for a signal</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sshd/server/StandardEnvironment.html#removeSignalListener-org.apache.sshd.server.SignalListener-">removeSignalListener</a></span>(<a href="../../../../org/apache/sshd/server/SignalListener.html" title="interface in org.apache.sshd.server">SignalListener</a> listener)</code> |
| <div class="block">Remove a previously registered listener for all the signals it was registered</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sshd/server/StandardEnvironment.html#set-java.lang.String-java.lang.String-">set</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value)</code> |
| <div class="block">Adds a variable to the environment.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sshd/server/StandardEnvironment.html#signal-org.apache.sshd.server.Signal-">signal</a></span>(<a href="../../../../org/apache/sshd/server/Signal.html" title="enum in org.apache.sshd.server">Signal</a> signal)</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sshd/server/StandardEnvironment.html#toString--">toString</a></span>()</code> </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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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="StandardEnvironment--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>StandardEnvironment</h4> |
| <pre>public StandardEnvironment()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="addSignalListener-org.apache.sshd.server.SignalListener-org.apache.sshd.server.Signal...-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addSignalListener</h4> |
| <pre>public void addSignalListener(<a href="../../../../org/apache/sshd/server/SignalListener.html" title="interface in org.apache.sshd.server">SignalListener</a> listener, |
| <a href="../../../../org/apache/sshd/server/Signal.html" title="enum in org.apache.sshd.server">Signal</a>... signals)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/sshd/server/Environment.html#addSignalListener-org.apache.sshd.server.SignalListener-org.apache.sshd.server.Signal...-">Environment</a></code></span></div> |
| <div class="block">Add a qualified listener for the specific signals</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/sshd/server/Environment.html#addSignalListener-org.apache.sshd.server.SignalListener-org.apache.sshd.server.Signal...-">addSignalListener</a></code> in interface <code><a href="../../../../org/apache/sshd/server/Environment.html" title="interface in org.apache.sshd.server">Environment</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - the <a href="../../../../org/apache/sshd/server/SignalListener.html" title="interface in org.apache.sshd.server"><code>SignalListener</code></a> to register</dd> |
| <dd><code>signals</code> - the <a href="../../../../org/apache/sshd/server/Signal.html" title="enum in org.apache.sshd.server"><code>Signal</code></a>s the listener is interested in</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addSignalListener-org.apache.sshd.server.SignalListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addSignalListener</h4> |
| <pre>public void addSignalListener(<a href="../../../../org/apache/sshd/server/SignalListener.html" title="interface in org.apache.sshd.server">SignalListener</a> listener)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/sshd/server/Environment.html#addSignalListener-org.apache.sshd.server.SignalListener-">Environment</a></code></span></div> |
| <div class="block">Add a global listener for all signals</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/sshd/server/Environment.html#addSignalListener-org.apache.sshd.server.SignalListener-">addSignalListener</a></code> in interface <code><a href="../../../../org/apache/sshd/server/Environment.html" title="interface in org.apache.sshd.server">Environment</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - the <a href="../../../../org/apache/sshd/server/SignalListener.html" title="interface in org.apache.sshd.server"><code>SignalListener</code></a> to register</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="addSignalListener-org.apache.sshd.server.SignalListener-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addSignalListener</h4> |
| <pre>public void addSignalListener(<a href="../../../../org/apache/sshd/server/SignalListener.html" title="interface in org.apache.sshd.server">SignalListener</a> listener, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/sshd/server/Signal.html" title="enum in org.apache.sshd.server">Signal</a>> signals)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/sshd/server/Environment.html#addSignalListener-org.apache.sshd.server.SignalListener-java.util.Collection-">Environment</a></code></span></div> |
| <div class="block">Add a qualified listener for the specific signals</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/sshd/server/Environment.html#addSignalListener-org.apache.sshd.server.SignalListener-java.util.Collection-">addSignalListener</a></code> in interface <code><a href="../../../../org/apache/sshd/server/Environment.html" title="interface in org.apache.sshd.server">Environment</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - the <a href="../../../../org/apache/sshd/server/SignalListener.html" title="interface in org.apache.sshd.server"><code>SignalListener</code></a> to register</dd> |
| <dd><code>signals</code> - the <a href="../../../../org/apache/sshd/server/Signal.html" title="enum in org.apache.sshd.server"><code>Signal</code></a>s the listener is interested in</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEnv--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEnv</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/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/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getEnv()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/sshd/server/Environment.html#getEnv--">Environment</a></code></span></div> |
| <div class="block">Retrieve the environment map</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/sshd/server/Environment.html#getEnv--">getEnv</a></code> in interface <code><a href="../../../../org/apache/sshd/server/Environment.html" title="interface in org.apache.sshd.server">Environment</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the environment <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> - never <code>null</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPtyModes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPtyModes</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../org/apache/sshd/common/channel/PtyMode.html" title="enum in org.apache.sshd.common.channel">PtyMode</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> getPtyModes()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/sshd/server/Environment.html#getPtyModes--">Environment</a></code></span></div> |
| <div class="block">Retrieve the PTY modes settings</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/sshd/server/Environment.html#getPtyModes--">getPtyModes</a></code> in interface <code><a href="../../../../org/apache/sshd/server/Environment.html" title="interface in org.apache.sshd.server">Environment</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> of <a href="../../../../org/apache/sshd/common/channel/PtyMode.html" title="enum in org.apache.sshd.common.channel"><code>PtyMode</code></a>s - never <code>null</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeSignalListener-org.apache.sshd.server.SignalListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeSignalListener</h4> |
| <pre>public void removeSignalListener(<a href="../../../../org/apache/sshd/server/SignalListener.html" title="interface in org.apache.sshd.server">SignalListener</a> listener)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../org/apache/sshd/server/Environment.html#removeSignalListener-org.apache.sshd.server.SignalListener-">Environment</a></code></span></div> |
| <div class="block">Remove a previously registered listener for all the signals it was registered</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/sshd/server/Environment.html#removeSignalListener-org.apache.sshd.server.SignalListener-">removeSignalListener</a></code> in interface <code><a href="../../../../org/apache/sshd/server/Environment.html" title="interface in org.apache.sshd.server">Environment</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>listener</code> - the <a href="../../../../org/apache/sshd/server/SignalListener.html" title="interface in org.apache.sshd.server"><code>SignalListener</code></a> to remove</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="signal-org.apache.sshd.server.Signal-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>signal</h4> |
| <pre>public void signal(<a href="../../../../org/apache/sshd/server/Signal.html" title="enum in org.apache.sshd.server">Signal</a> signal)</pre> |
| </li> |
| </ul> |
| <a name="set-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>set</h4> |
| <pre>public void set(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value)</pre> |
| <div class="block">Adds a variable to the environment. This method is called <code>set</code> |
| according to the name of the appropriate posix command <code>set</code></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - environment variable name - never <code>null</code>/empty</dd> |
| <dd><code>value</code> - environment variable value</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSignalListeners-org.apache.sshd.server.Signal-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSignalListeners</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../org/apache/sshd/server/SignalListener.html" title="interface in org.apache.sshd.server">SignalListener</a>> getSignalListeners(<a href="../../../../org/apache/sshd/server/Signal.html" title="enum in org.apache.sshd.server">Signal</a> signal, |
| boolean create)</pre> |
| <div class="block">Retrieves the set of listeners registered for a signal</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>signal</code> - The specified <a href="../../../../org/apache/sshd/server/Signal.html" title="enum in org.apache.sshd.server"><code>Signal</code></a></dd> |
| <dd><code>create</code> - If <code>true</code> and no current listeners are mapped then |
| creates a new <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util"><code>Set</code></a></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util"><code>Set</code></a> of listeners registered for the signal - may be |
| <code>null</code> in case <tt>create</tt> is <code>false</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></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/StandardEnvironment.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/sshd/server/SshServer.html" title="class in org.apache.sshd.server"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/sshd/server/StandardEnvironment.html" target="_top">Frames</a></li> |
| <li><a href="StandardEnvironment.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><a href="#fields.inherited.from.class.org.apache.sshd.common.util.logging.AbstractLoggingBean">Field</a> | </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 © 2008–2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |