All Superinterfaces:

AutoCloseable, Channel, Closeable, SimpleClientConfigurator

All Known Subinterfaces:

SimpleClient

All Known Implementing Classes:

AbstractSimpleClient, AbstractSimpleClientSessionCreator
```
public interface SimpleSessionClient
extends SimpleClientConfigurator, Channel
```
A simplified synchronous API for creating client sessions

Author:

Apache MINA SSHD Project

Field Summary
- Fields inherited from interface org.apache.sshd.client.simple.SimpleClientConfigurator
  DEFAULT_AUTHENTICATION_TIMEOUT, DEFAULT_CONNECT_TIMEOUT, DEFAULT_PORT

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default ClientSession`	`sessionLogin(String host, int port, String username, String password)`	Creates a session and logs in using the provided credentials
`default ClientSession`	`sessionLogin(String host, int port, String username, KeyPair identity)`	Creates a session and logs in using the provided credentials
`ClientSession`	`sessionLogin(String uri, String password)`	Creates a session and logs in using the provided credentials
`default ClientSession`	`sessionLogin(String host, String username, String password)`	Creates a session on the default port and logs in using the provided credentials
`default ClientSession`	`sessionLogin(String host, String username, KeyPair identity)`	Creates a session on the default port and logs in using the provided credentials
`ClientSession`	`sessionLogin(String uri, KeyPair identity)`	Creates a session and logs in using the provided credentials
`default ClientSession`	`sessionLogin(InetAddress host, int port, String username, String password)`	Creates a session and logs in using the provided credentials
`default ClientSession`	`sessionLogin(InetAddress host, int port, String username, KeyPair identity)`	Creates a session and logs in using the provided credentials
`default ClientSession`	`sessionLogin(InetAddress host, String username, String password)`	Creates a session on the default port and logs in using the provided credentials
`default ClientSession`	`sessionLogin(InetAddress host, String username, KeyPair identity)`	Creates a session on the default port and logs in using the provided credentials
`ClientSession`	`sessionLogin(SocketAddress target, String username, String password)`	Creates a session and logs in using the provided credentials
`ClientSession`	`sessionLogin(SocketAddress target, String username, KeyPair identity)`	Creates a session and logs in using the provided credentials

Methods inherited from interface java.nio.channels.Channel
close, isOpen

Methods inherited from interface org.apache.sshd.client.simple.SimpleClientConfigurator
getAuthenticationTimeout, getConnectTimeout, setAuthenticationTimeout, setConnectTimeout

Method Detail

sessionLogin

default ClientSession sessionLogin(String host,
                                   String username,
                                   String password)
                            throws IOException

Creates a session on the default port and logs in using the provided credentials

Parameters:: host - The target host name or address; username - Username; password - Password
Returns:: Created ClientSession
Throws:: IOException - If failed to login or authenticate

sessionLogin

default ClientSession sessionLogin(String host,
                                   int port,
                                   String username,
                                   String password)
                            throws IOException

Creates a session and logs in using the provided credentials

Parameters:: host - The target host name or address; port - The target port; username - Username; password - Password
Returns:: Created ClientSession
Throws:: IOException - If failed to login or authenticate

sessionLogin

default ClientSession sessionLogin(String host,
                                   String username,
                                   KeyPair identity)
                            throws IOException

Creates a session on the default port and logs in using the provided credentials

Parameters:: host - The target host name or address; username - Username; identity - The KeyPair identity
Returns:: Created ClientSession
Throws:: IOException - If failed to login or authenticate

sessionLogin

default ClientSession sessionLogin(String host,
                                   int port,
                                   String username,
                                   KeyPair identity)
                            throws IOException

Creates a session and logs in using the provided credentials

Parameters:: host - The target host name or address; port - The target port; username - Username; identity - The KeyPair identity
Returns:: Created ClientSession
Throws:: IOException - If failed to login or authenticate

sessionLogin

default ClientSession sessionLogin(InetAddress host,
                                   String username,
                                   String password)
                            throws IOException

Creates a session on the default port and logs in using the provided credentials

Parameters:: host - The target host InetAddress; username - Username; password - Password
Returns:: Created ClientSession
Throws:: IOException - If failed to login or authenticate

sessionLogin

default ClientSession sessionLogin(InetAddress host,
                                   int port,
                                   String username,
                                   String password)
                            throws IOException

Creates a session and logs in using the provided credentials

Parameters:: host - The target host InetAddress; port - The target port; username - Username; password - Password
Returns:: Created ClientSession
Throws:: IOException - If failed to login or authenticate

sessionLogin

default ClientSession sessionLogin(InetAddress host,
                                   String username,
                                   KeyPair identity)
                            throws IOException

Creates a session on the default port and logs in using the provided credentials

Parameters:: host - The target host InetAddress; username - Username; identity - The KeyPair identity
Returns:: Created ClientSession
Throws:: IOException - If failed to login or authenticate

sessionLogin

default ClientSession sessionLogin(InetAddress host,
                                   int port,
                                   String username,
                                   KeyPair identity)
                            throws IOException

Creates a session and logs in using the provided credentials

Parameters:: host - The target host InetAddress; port - The target port; username - Username; identity - The KeyPair identity
Returns:: Created ClientSession
Throws:: IOException - If failed to login or authenticate

sessionLogin

ClientSession sessionLogin(SocketAddress target,
                           String username,
                           String password)
                    throws IOException

Creates a session and logs in using the provided credentials

Parameters:: target - The target SocketAddress; username - Username; password - Password
Returns:: Created ClientSession
Throws:: IOException - If failed to login or authenticate

sessionLogin

ClientSession sessionLogin(SocketAddress target,
                           String username,
                           KeyPair identity)
                    throws IOException

Creates a session and logs in using the provided credentials

Parameters:: target - The target SocketAddress; username - Username; identity - The KeyPair identity
Returns:: Created ClientSession
Throws:: IOException - If failed to login or authenticate

sessionLogin
```
ClientSession sessionLogin(String uri,
                           String password)
                    throws IOException
```
Creates a session and logs in using the provided credentials

Parameters:

uri - The target uri

password - Password

Returns:

Created ClientSession

Throws:

IOException - If failed to login or authenticate

sessionLogin
```
ClientSession sessionLogin(String uri,
                           KeyPair identity)
                    throws IOException
```
Creates a session and logs in using the provided credentials

Parameters:

uri - The target uri

identity - The KeyPair identity

Returns:

Created ClientSession

Throws:

IOException - If failed to login or authenticate

Interface SimpleSessionClient

Field Summary

Fields inherited from interface org.apache.sshd.client.simple.SimpleClientConfigurator

Method Summary

Methods inherited from interface java.nio.channels.Channel

Methods inherited from interface org.apache.sshd.client.simple.SimpleClientConfigurator

Method Detail

sessionLogin

sessionLogin

sessionLogin

sessionLogin

sessionLogin

sessionLogin

sessionLogin

sessionLogin

sessionLogin

sessionLogin

sessionLogin

sessionLogin