| <!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:40 CET 2016 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>SshAgentFactory (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="SshAgentFactory (Apache Mina SSHD :: Core 1.1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":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/SshAgentFactory.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/agent/SshAgentConstants.html" title="class in org.apache.sshd.agent"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/sshd/agent/SshAgentServer.html" title="interface in org.apache.sshd.agent"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/sshd/agent/SshAgentFactory.html" target="_top">Frames</a></li> |
| <li><a href="SshAgentFactory.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.agent</div> |
| <h2 title="Interface SshAgentFactory" class="title">Interface SshAgentFactory</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/sshd/agent/local/LocalAgentFactory.html" title="class in org.apache.sshd.agent.local">LocalAgentFactory</a>, <a href="../../../../org/apache/sshd/agent/local/ProxyAgentFactory.html" title="class in org.apache.sshd.agent.local">ProxyAgentFactory</a>, <a href="../../../../org/apache/sshd/agent/unix/UnixAgentFactory.html" title="class in org.apache.sshd.agent.unix">UnixAgentFactory</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">SshAgentFactory</span></pre> |
| <div class="block">The <code>SshAgentFactory</code> is used to communicate with an SshAgent.</div> |
| </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/agent/SshAgent.html" title="interface in org.apache.sshd.agent">SshAgent</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sshd/agent/SshAgentFactory.html#createClient-org.apache.sshd.common.FactoryManager-">createClient</a></span>(<a href="../../../../org/apache/sshd/common/FactoryManager.html" title="interface in org.apache.sshd.common">FactoryManager</a> manager)</code> |
| <div class="block">Create an SshAgent that can be used on the client side by the authentication |
| process to send possible keys.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/sshd/agent/SshAgentServer.html" title="interface in org.apache.sshd.agent">SshAgentServer</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sshd/agent/SshAgentFactory.html#createServer-org.apache.sshd.common.session.ConnectionService-">createServer</a></span>(<a href="../../../../org/apache/sshd/common/session/ConnectionService.html" title="interface in org.apache.sshd.common.session">ConnectionService</a> service)</code> |
| <div class="block">Create the server side that will be used by other SSH clients.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/sshd/common/NamedFactory.html" title="interface in org.apache.sshd.common">NamedFactory</a><<a href="../../../../org/apache/sshd/common/channel/Channel.html" title="interface in org.apache.sshd.common.channel">Channel</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/sshd/agent/SshAgentFactory.html#getChannelForwardingFactory--">getChannelForwardingFactory</a></span>()</code> |
| <div class="block">The channels are requested by the ssh server when forwarding a client request.</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="getChannelForwardingFactory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getChannelForwardingFactory</h4> |
| <pre><a href="../../../../org/apache/sshd/common/NamedFactory.html" title="interface in org.apache.sshd.common">NamedFactory</a><<a href="../../../../org/apache/sshd/common/channel/Channel.html" title="interface in org.apache.sshd.common.channel">Channel</a>> getChannelForwardingFactory()</pre> |
| <div class="block">The channels are requested by the ssh server when forwarding a client request. |
| The channel will receive agent requests and need to forward them to the agent, |
| either local or through another proxy.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The (named) channel factory used to create channels on the client side</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createClient-org.apache.sshd.common.FactoryManager-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createClient</h4> |
| <pre><a href="../../../../org/apache/sshd/agent/SshAgent.html" title="interface in org.apache.sshd.agent">SshAgent</a> createClient(<a href="../../../../org/apache/sshd/common/FactoryManager.html" title="interface in org.apache.sshd.common">FactoryManager</a> manager) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Create an SshAgent that can be used on the client side by the authentication |
| process to send possible keys.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>manager</code> - The <a href="../../../../org/apache/sshd/common/FactoryManager.html" title="interface in org.apache.sshd.common"><code>FactoryManager</code></a> instance</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The <a href="../../../../org/apache/sshd/agent/SshAgent.html" title="interface in org.apache.sshd.agent"><code>SshAgent</code></a> instance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If failed to create the client</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createServer-org.apache.sshd.common.session.ConnectionService-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>createServer</h4> |
| <pre><a href="../../../../org/apache/sshd/agent/SshAgentServer.html" title="interface in org.apache.sshd.agent">SshAgentServer</a> createServer(<a href="../../../../org/apache/sshd/common/session/ConnectionService.html" title="interface in org.apache.sshd.common.session">ConnectionService</a> service) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Create the server side that will be used by other SSH clients. |
| It will usually create a channel that will forward the requests |
| to the original client.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>service</code> - The <a href="../../../../org/apache/sshd/common/session/ConnectionService.html" title="interface in org.apache.sshd.common.session"><code>ConnectionService</code></a> to use</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The <a href="../../../../org/apache/sshd/agent/SshAgentServer.html" title="interface in org.apache.sshd.agent"><code>SshAgentServer</code></a> instance</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If failed to create the server</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/SshAgentFactory.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/agent/SshAgentConstants.html" title="class in org.apache.sshd.agent"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/sshd/agent/SshAgentServer.html" title="interface in org.apache.sshd.agent"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/sshd/agent/SshAgentFactory.html" target="_top">Frames</a></li> |
| <li><a href="SshAgentFactory.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> |