blob: 491d016d3e78d628978caedfe4f4027347899351 [file] [log] [blame]
<!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:44 CET 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.sshd.common (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="org.apache.sshd.common (Apache Mina SSHD :: Core 1.1.0 API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/client/subsystem/sftp/extensions/openssh/impl/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/sshd/common/auth/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/sshd/common/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.sshd.common</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/sshd/common/BuiltinFactory.html" title="interface in org.apache.sshd.common">BuiltinFactory</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A named optional factory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/sshd/common/Closeable.html" title="interface in org.apache.sshd.common">Closeable</a></td>
<td class="colLast">
<div class="block">A <code>Closeable</code> is a resource that can be closed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/sshd/common/Factory.html" title="interface in org.apache.sshd.common">Factory</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Fatory is a simple interface that is used to create other objects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/sshd/common/FactoryManager.html" title="interface in org.apache.sshd.common">FactoryManager</a></td>
<td class="colLast">
<div class="block">This interface allows retrieving all the <code>NamedFactory</code> used
in the SSH protocol.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/sshd/common/NamedFactory.html" title="interface in org.apache.sshd.common">NamedFactory</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">A named factory is a factory identified by a name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/sshd/common/NamedResource.html" title="interface in org.apache.sshd.common">NamedResource</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/sshd/common/OptionalFeature.html" title="interface in org.apache.sshd.common">OptionalFeature</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/sshd/common/PropertyResolver.html" title="interface in org.apache.sshd.common">PropertyResolver</a></td>
<td class="colLast">
<div class="block">Indicates an entity that can be configured using properties.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/sshd/common/Service.html" title="interface in org.apache.sshd.common">Service</a></td>
<td class="colLast">
<div class="block">See RFC 4253 [SSH-TRANS] and the SSH_MSG_SERVICE_REQUEST packet.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/sshd/common/ServiceFactory.html" title="interface in org.apache.sshd.common">ServiceFactory</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/sshd/common/AbstractFactoryManager.html" title="class in org.apache.sshd.common">AbstractFactoryManager</a></td>
<td class="colLast">
<div class="block">TODO Add javadoc</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/sshd/common/BaseBuilder.html" title="class in org.apache.sshd.common">BaseBuilder</a>&lt;T extends <a href="../../../../org/apache/sshd/common/AbstractFactoryManager.html" title="class in org.apache.sshd.common">AbstractFactoryManager</a>,S extends <a href="../../../../org/apache/sshd/common/BaseBuilder.html" title="class in org.apache.sshd.common">BaseBuilder</a>&lt;T,S&gt;&gt;</td>
<td class="colLast">
<div class="block">Base class for dedicated client/server instance builders</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/sshd/common/BuiltinFactory.Utils.html" title="class in org.apache.sshd.common">BuiltinFactory.Utils</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/sshd/common/NamedFactory.Utils.html" title="class in org.apache.sshd.common">NamedFactory.Utils</a></td>
<td class="colLast">
<div class="block">Utility class to help using NamedFactories</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/sshd/common/NamedResource.Utils.html" title="class in org.apache.sshd.common">NamedResource.Utils</a></td>
<td class="colLast">
<div class="block">Utility class to help using <a href="../../../../org/apache/sshd/common/NamedResource.html" title="interface in org.apache.sshd.common"><code>NamedResource</code></a>s</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/sshd/common/OptionalFeature.Utils.html" title="class in org.apache.sshd.common">OptionalFeature.Utils</a></td>
<td class="colLast">
<div class="block">Utility class to help using <a href="../../../../org/apache/sshd/common/OptionalFeature.html" title="interface in org.apache.sshd.common"><code>OptionalFeature</code></a>s</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/sshd/common/PropertyResolverUtils.html" title="class in org.apache.sshd.common">PropertyResolverUtils</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/sshd/common/ServiceFactory.Utils.html" title="class in org.apache.sshd.common">ServiceFactory.Utils</a></td>
<td class="colLast">
<div class="block">Utility class to help using NamedFactories</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/sshd/common/SshConstants.html" title="class in org.apache.sshd.common">SshConstants</a></td>
<td class="colLast">
<div class="block">This interface defines constants for the SSH protocol.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/sshd/common/SshdSocketAddress.html" title="class in org.apache.sshd.common">SshdSocketAddress</a></td>
<td class="colLast">
<div class="block">A simple socket address holding the host name and port number.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Exception</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/sshd/common/RuntimeSshException.html" title="class in org.apache.sshd.common">RuntimeSshException</a></td>
<td class="colLast">
<div class="block">Exception used in the SSH client or server.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/sshd/common/SshException.html" title="class in org.apache.sshd.common">SshException</a></td>
<td class="colLast">
<div class="block">Represents an SSH related exception</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/client/subsystem/sftp/extensions/openssh/impl/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../org/apache/sshd/common/auth/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/sshd/common/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>