| <!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:42 CET 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>PropertyResolver (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="PropertyResolver (Apache Mina SSHD :: Core 1.1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/PropertyResolver.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/common/OptionalFeature.Utils.html" title="class in org.apache.sshd.common"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/sshd/common/PropertyResolverUtils.html" title="class in org.apache.sshd.common"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/sshd/common/PropertyResolver.html" target="_top">Frames</a></li> |
| <li><a href="PropertyResolver.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.common</div> |
| <h2 title="Interface PropertyResolver" class="title">Interface PropertyResolver</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../org/apache/sshd/common/channel/Channel.html" title="interface in org.apache.sshd.common.channel">Channel</a>, <a href="../../../../org/apache/sshd/client/channel/ClientChannel.html" title="interface in org.apache.sshd.client.channel">ClientChannel</a>, <a href="../../../../org/apache/sshd/client/ClientFactoryManager.html" title="interface in org.apache.sshd.client">ClientFactoryManager</a>, <a href="../../../../org/apache/sshd/client/session/ClientSession.html" title="interface in org.apache.sshd.client.session">ClientSession</a>, <a href="../../../../org/apache/sshd/common/FactoryManager.html" title="interface in org.apache.sshd.common">FactoryManager</a>, <a href="../../../../org/apache/sshd/server/channel/ServerChannel.html" title="interface in org.apache.sshd.server.channel">ServerChannel</a>, <a href="../../../../org/apache/sshd/server/ServerFactoryManager.html" title="interface in org.apache.sshd.server">ServerFactoryManager</a>, <a href="../../../../org/apache/sshd/server/session/ServerSession.html" title="interface in org.apache.sshd.server.session">ServerSession</a>, <a href="../../../../org/apache/sshd/common/session/Session.html" title="interface in org.apache.sshd.common.session">Session</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/sshd/common/channel/AbstractChannel.html" title="class in org.apache.sshd.common.channel">AbstractChannel</a>, <a href="../../../../org/apache/sshd/client/channel/AbstractClientChannel.html" title="class in org.apache.sshd.client.channel">AbstractClientChannel</a>, <a href="../../../../org/apache/sshd/client/session/AbstractClientSession.html" title="class in org.apache.sshd.client.session">AbstractClientSession</a>, <a href="../../../../org/apache/sshd/common/AbstractFactoryManager.html" title="class in org.apache.sshd.common">AbstractFactoryManager</a>, <a href="../../../../org/apache/sshd/server/channel/AbstractServerChannel.html" title="class in org.apache.sshd.server.channel">AbstractServerChannel</a>, <a href="../../../../org/apache/sshd/server/session/AbstractServerSession.html" title="class in org.apache.sshd.server.session">AbstractServerSession</a>, <a href="../../../../org/apache/sshd/common/session/AbstractSession.html" title="class in org.apache.sshd.common.session">AbstractSession</a>, <a href="../../../../org/apache/sshd/agent/local/AgentForwardedChannel.html" title="class in org.apache.sshd.agent.local">AgentForwardedChannel</a>, <a href="../../../../org/apache/sshd/agent/unix/AgentForwardedChannel.html" title="class in org.apache.sshd.agent.unix">AgentForwardedChannel</a>, <a href="../../../../org/apache/sshd/agent/local/ChannelAgentForwarding.html" title="class in org.apache.sshd.agent.local">ChannelAgentForwarding</a>, <a href="../../../../org/apache/sshd/agent/unix/ChannelAgentForwarding.html" title="class in org.apache.sshd.agent.unix">ChannelAgentForwarding</a>, <a href="../../../../org/apache/sshd/client/channel/ChannelDirectTcpip.html" title="class in org.apache.sshd.client.channel">ChannelDirectTcpip</a>, <a href="../../../../org/apache/sshd/client/channel/ChannelExec.html" title="class in org.apache.sshd.client.channel">ChannelExec</a>, <a href="../../../../org/apache/sshd/client/channel/ChannelSession.html" title="class in org.apache.sshd.client.channel">ChannelSession</a>, <a href="../../../../org/apache/sshd/server/channel/ChannelSession.html" title="class in org.apache.sshd.server.channel">ChannelSession</a>, <a href="../../../../org/apache/sshd/client/channel/ChannelShell.html" title="class in org.apache.sshd.client.channel">ChannelShell</a>, <a href="../../../../org/apache/sshd/client/channel/ChannelSubsystem.html" title="class in org.apache.sshd.client.channel">ChannelSubsystem</a>, <a href="../../../../org/apache/sshd/client/session/ClientSessionImpl.html" title="class in org.apache.sshd.client.session">ClientSessionImpl</a>, <a href="../../../../org/apache/sshd/client/channel/PtyCapableChannelSession.html" title="class in org.apache.sshd.client.channel">PtyCapableChannelSession</a>, <a href="../../../../org/apache/sshd/server/session/ServerSessionImpl.html" title="class in org.apache.sshd.server.session">ServerSessionImpl</a>, <a href="../../../../org/apache/sshd/client/SshClient.html" title="class in org.apache.sshd.client">SshClient</a>, <a href="../../../../org/apache/sshd/server/SshServer.html" title="class in org.apache.sshd.server">SshServer</a>, <a href="../../../../org/apache/sshd/common/forward/TcpipClientChannel.html" title="class in org.apache.sshd.common.forward">TcpipClientChannel</a>, <a href="../../../../org/apache/sshd/server/forward/TcpipServerChannel.html" title="class in org.apache.sshd.server.forward">TcpipServerChannel</a>, <a href="../../../../org/apache/sshd/common/channel/Window.html" title="class in org.apache.sshd.common.channel">Window</a>, <a href="../../../../org/apache/sshd/server/x11/X11ForwardSupport.ChannelForwardedX11.html" title="class in org.apache.sshd.server.x11">X11ForwardSupport.ChannelForwardedX11</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">PropertyResolver</span></pre> |
| <div class="block">Indicates an entity that can be configured using properties. The properties |
| are simple name-value pairs where the actual value type depends on the |
| property. Some automatic conversions may be available - e.g., from a string |
| to a numeric or <code>boolean</code> value, or from <code>int</code> to <code>long</code>, |
| etc.. <B>Note:</B> implementations may decide to use case <U>insensitive</U> |
| property names, therefore it is <U><B>highly discouraged</B></U> to use names |
| that differ from each other only in case sensitivity. Also, implementations may |
| choose to trim whitespaces, thus such are also highly discouraged.</div> |
| <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"> |
| <!-- ========== 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></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/sshd/common/PropertyResolver.html" title="interface in org.apache.sshd.common">PropertyResolver</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sshd/common/PropertyResolver.html#getParentPropertyResolver--">getParentPropertyResolver</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" 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/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sshd/common/PropertyResolver.html#getProperties--">getProperties</a></span>()</code> |
| <div class="block">A map of properties that can be used to configure the SSH server |
| or client.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getParentPropertyResolver--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getParentPropertyResolver</h4> |
| <pre><a href="../../../../org/apache/sshd/common/PropertyResolver.html" title="interface in org.apache.sshd.common">PropertyResolver</a> getParentPropertyResolver()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The parent resolver that can be used to query for missing |
| properties - <code>null</code> if no parent</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getProperties--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getProperties</h4> |
| <pre><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/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> getProperties()</pre> |
| <div class="block"><P>A map of properties that can be used to configure the SSH server |
| or client. This map will never be changed by either the server or |
| client and is not supposed to be changed at runtime (changes are not |
| bound to have any effect on a running client or server), though it may |
| affect the creation of sessions later as these values are usually not |
| cached.</P> |
| |
| <P><B>Note:</B> the <U>type</U> of the mapped property should match the |
| expected configuration value type - <code>Long, Integer, Boolean, |
| String</code>, etc.... If it doesn't, the <code>toString()</code> result of the |
| mapped value is used to convert it to the required type. E.g., if |
| the mapped value is the <U>string</U> "1234" and the expected |
| value is a <code>long</code> then it will be parsed into one. Also, if |
| the mapped value is an <code>Integer</code> but a <code>long</code> is expected, |
| then it will be converted into one.</P></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a valid <code>Map</code> containing configuration values, never <code>null</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/PropertyResolver.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/common/OptionalFeature.Utils.html" title="class in org.apache.sshd.common"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/sshd/common/PropertyResolverUtils.html" title="class in org.apache.sshd.common"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/sshd/common/PropertyResolver.html" target="_top">Frames</a></li> |
| <li><a href="PropertyResolver.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> |
