Google Git
Sign in
apache / mina-site / refs/heads/sshd-apidocs / . / org / apache / sshd / client / simple / SimpleClient.html
blob: a32c690a4104c2c1d63e68c4f8e692454ef31a47 [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:41 CET 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SimpleClient (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="SimpleClient (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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SimpleClient.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/simple/AbstractSimpleClientSessionCreator.html" title="class in org.apache.sshd.client.simple"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/sshd/client/simple/SimpleClientConfigurator.html" title="interface in org.apache.sshd.client.simple"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/sshd/client/simple/SimpleClient.html" target="_top">Frames</a></li>
<li><a href="SimpleClient.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</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.client.simple</div>
<h2 title="Interface SimpleClient" class="title">Interface SimpleClient</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/Channel.html?is-external=true" title="class or interface in java.nio.channels">Channel</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleClientConfigurator.html" title="interface in org.apache.sshd.client.simple">SimpleClientConfigurator</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleScpClient.html" title="interface in org.apache.sshd.client.simple">SimpleScpClient</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleSessionClient.html" title="interface in org.apache.sshd.client.simple">SimpleSessionClient</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleSftpClient.html" title="interface in org.apache.sshd.client.simple">SimpleSftpClient</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../../org/apache/sshd/client/simple/AbstractSimpleClient.html" title="class in org.apache.sshd.client.simple">AbstractSimpleClient</a>, <a href="../../../../../org/apache/sshd/client/simple/AbstractSimpleClientSessionCreator.html" title="class in org.apache.sshd.client.simple">AbstractSimpleClientSessionCreator</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">SimpleClient</span>
extends <a href="../../../../../org/apache/sshd/client/simple/SimpleClientConfigurator.html" title="interface in org.apache.sshd.client.simple">SimpleClientConfigurator</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleSessionClient.html" title="interface in org.apache.sshd.client.simple">SimpleSessionClient</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleScpClient.html" title="interface in org.apache.sshd.client.simple">SimpleScpClient</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleSftpClient.html" title="interface in org.apache.sshd.client.simple">SimpleSftpClient</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/Channel.html?is-external=true" title="class or interface in java.nio.channels">Channel</a></pre>
<div class="block">Provides a simplified and <U>synchronous</U> view of the available SSH client
functionality. If more fine-grained control and configuration of the SSH client
behavior and features is required then the <a href="../../../../../org/apache/sshd/client/SshClient.html" title="class in org.apache.sshd.client"><code>SshClient</code></a> object should be used</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">
<!-- =========== 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.client.simple.SimpleClientConfigurator">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.sshd.client.simple.<a href="../../../../../org/apache/sshd/client/simple/SimpleClientConfigurator.html" title="interface in org.apache.sshd.client.simple">SimpleClientConfigurator</a></h3>
<code><a href="../../../../../org/apache/sshd/client/simple/SimpleClientConfigurator.html#DEFAULT_AUTHENTICATION_TIMEOUT">DEFAULT_AUTHENTICATION_TIMEOUT</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleClientConfigurator.html#DEFAULT_CONNECT_TIMEOUT">DEFAULT_CONNECT_TIMEOUT</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleClientConfigurator.html#DEFAULT_PORT">DEFAULT_PORT</a></code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.client.simple.SimpleSessionClient">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.sshd.client.simple.<a href="../../../../../org/apache/sshd/client/simple/SimpleSessionClient.html" title="interface in org.apache.sshd.client.simple">SimpleSessionClient</a></h3>
<code><a href="../../../../../org/apache/sshd/client/simple/SimpleSessionClient.html#sessionLogin-java.net.InetAddress-int-java.lang.String-java.security.KeyPair-">sessionLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleSessionClient.html#sessionLogin-java.net.InetAddress-int-java.lang.String-java.lang.String-">sessionLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleSessionClient.html#sessionLogin-java.net.InetAddress-java.lang.String-java.security.KeyPair-">sessionLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleSessionClient.html#sessionLogin-java.net.InetAddress-java.lang.String-java.lang.String-">sessionLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleSessionClient.html#sessionLogin-java.net.SocketAddress-java.lang.String-java.security.KeyPair-">sessionLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleSessionClient.html#sessionLogin-java.net.SocketAddress-java.lang.String-java.lang.String-">sessionLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleSessionClient.html#sessionLogin-java.lang.String-int-java.lang.String-java.security.KeyPair-">sessionLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleSessionClient.html#sessionLogin-java.lang.String-int-java.lang.String-java.lang.String-">sessionLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleSessionClient.html#sessionLogin-java.lang.String-java.lang.String-java.security.KeyPair-">sessionLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleSessionClient.html#sessionLogin-java.lang.String-java.lang.String-java.lang.String-">sessionLogin</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.client.simple.SimpleScpClient">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.sshd.client.simple.<a href="../../../../../org/apache/sshd/client/simple/SimpleScpClient.html" title="interface in org.apache.sshd.client.simple">SimpleScpClient</a></h3>
<code><a href="../../../../../org/apache/sshd/client/simple/SimpleScpClient.html#scpLogin-java.net.InetAddress-int-java.lang.String-java.security.KeyPair-">scpLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleScpClient.html#scpLogin-java.net.InetAddress-int-java.lang.String-java.lang.String-">scpLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleScpClient.html#scpLogin-java.net.InetAddress-java.lang.String-java.security.KeyPair-">scpLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleScpClient.html#scpLogin-java.net.InetAddress-java.lang.String-java.lang.String-">scpLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleScpClient.html#scpLogin-java.net.SocketAddress-java.lang.String-java.security.KeyPair-">scpLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleScpClient.html#scpLogin-java.net.SocketAddress-java.lang.String-java.lang.String-">scpLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleScpClient.html#scpLogin-java.lang.String-int-java.lang.String-java.security.KeyPair-">scpLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleScpClient.html#scpLogin-java.lang.String-int-java.lang.String-java.lang.String-">scpLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleScpClient.html#scpLogin-java.lang.String-java.lang.String-java.security.KeyPair-">scpLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleScpClient.html#scpLogin-java.lang.String-java.lang.String-java.lang.String-">scpLogin</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.client.simple.SimpleSftpClient">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.sshd.client.simple.<a href="../../../../../org/apache/sshd/client/simple/SimpleSftpClient.html" title="interface in org.apache.sshd.client.simple">SimpleSftpClient</a></h3>
<code><a href="../../../../../org/apache/sshd/client/simple/SimpleSftpClient.html#sftpLogin-java.net.InetAddress-int-java.lang.String-java.security.KeyPair-">sftpLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleSftpClient.html#sftpLogin-java.net.InetAddress-int-java.lang.String-java.lang.String-">sftpLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleSftpClient.html#sftpLogin-java.net.InetAddress-java.lang.String-java.security.KeyPair-">sftpLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleSftpClient.html#sftpLogin-java.net.InetAddress-java.lang.String-java.lang.String-">sftpLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleSftpClient.html#sftpLogin-java.net.SocketAddress-java.lang.String-java.security.KeyPair-">sftpLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleSftpClient.html#sftpLogin-java.net.SocketAddress-java.lang.String-java.lang.String-">sftpLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleSftpClient.html#sftpLogin-java.lang.String-int-java.lang.String-java.security.KeyPair-">sftpLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleSftpClient.html#sftpLogin-java.lang.String-int-java.lang.String-java.lang.String-">sftpLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleSftpClient.html#sftpLogin-java.lang.String-java.lang.String-java.security.KeyPair-">sftpLogin</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleSftpClient.html#sftpLogin-java.lang.String-java.lang.String-java.lang.String-">sftpLogin</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.sshd.client.simple.SimpleClientConfigurator">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.sshd.client.simple.<a href="../../../../../org/apache/sshd/client/simple/SimpleClientConfigurator.html" title="interface in org.apache.sshd.client.simple">SimpleClientConfigurator</a></h3>
<code><a href="../../../../../org/apache/sshd/client/simple/SimpleClientConfigurator.html#getAuthenticationTimeout--">getAuthenticationTimeout</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleClientConfigurator.html#getConnectTimeout--">getConnectTimeout</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleClientConfigurator.html#setAuthenticationTimeout-long-">setAuthenticationTimeout</a>, <a href="../../../../../org/apache/sshd/client/simple/SimpleClientConfigurator.html#setConnectTimeout-long-">setConnectTimeout</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.nio.channels.Channel">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.nio.channels.<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/Channel.html?is-external=true" title="class or interface in java.nio.channels">Channel</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/Channel.html?is-external=true#close--" title="class or interface in java.nio.channels">close</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/Channel.html?is-external=true#isOpen--" title="class or interface in java.nio.channels">isOpen</a></code></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/SimpleClient.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/simple/AbstractSimpleClientSessionCreator.html" title="class in org.apache.sshd.client.simple"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/sshd/client/simple/SimpleClientConfigurator.html" title="interface in org.apache.sshd.client.simple"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/sshd/client/simple/SimpleClient.html" target="_top">Frames</a></li>
<li><a href="SimpleClient.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</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>