org.apache.sshd.client.simple

Class AbstractSimpleClient

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.client.simple.AbstractSimpleClient

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, SimpleClient, SimpleClientConfigurator, SimpleScpClient, SimpleSessionClient, SimpleSftpClient

Direct Known Subclasses:

AbstractSimpleClientSessionCreator

public abstract class AbstractSimpleClient
extends AbstractLoggingBean
implements SimpleClient

Author:

Apache MINA SSHD Project

Field Summary

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

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

DEFAULT_AUTHENTICATION_TIMEOUT, DEFAULT_CONNECT_TIMEOUT, DEFAULT_PORT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSimpleClient()

Method Summary

Modifier and Type	Method and Description
protected CloseableScpClient	createScpClient(ClientSession session)
protected SftpClient	createSftpClient(ClientSession session)
protected SftpClient	createSftpClient(ClientSession session, SftpClient client)
CloseableScpClient	scpLogin(InetAddress host, int port, String username, KeyPair identity) Creates an SCP session using the provided credentials
CloseableScpClient	scpLogin(InetAddress host, int port, String username, String password) Creates an SCP session using the provided credentials
CloseableScpClient	scpLogin(InetAddress host, String username, KeyPair identity) Creates an SCP session on the default port and logs in using the provided credentials
CloseableScpClient	scpLogin(InetAddress host, String username, String password) Creates an SCP session on the default port and logs in using the provided credentials
CloseableScpClient	scpLogin(SocketAddress target, String username, KeyPair identity) Creates an SCP session using the provided credentials
CloseableScpClient	scpLogin(SocketAddress target, String username, String password) Creates an SCP session using the provided credentials
CloseableScpClient	scpLogin(String host, int port, String username, KeyPair identity) Creates an SCP session using the provided credentials
CloseableScpClient	scpLogin(String host, int port, String username, String password) Creates an SCP session using the provided credentials
CloseableScpClient	scpLogin(String host, String username, KeyPair identity) Creates an SCP session on the default port and logs in using the provided credentials
CloseableScpClient	scpLogin(String host, String username, String password) Creates an SCP session on the default port and logs in using the provided credentials
SftpClient	sftpLogin(SocketAddress target, String username, KeyPair identity) Creates an SFTP session using the provided credentials
SftpClient	sftpLogin(SocketAddress target, String username, String password) Creates an SFTP session using the provided credentials

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

getSimplifiedLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

sessionLogin, sessionLogin, sessionLogin, sessionLogin, sessionLogin, sessionLogin, sessionLogin, sessionLogin, sessionLogin, sessionLogin

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

sftpLogin, sftpLogin, sftpLogin, sftpLogin, sftpLogin, sftpLogin, sftpLogin, sftpLogin

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

getAuthenticationTimeout, getConnectTimeout, setAuthenticationTimeout, setConnectTimeout

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Constructor Detail

AbstractSimpleClient

protected AbstractSimpleClient()

Method Detail

sftpLogin

public SftpClient sftpLogin(SocketAddress target,
                            String username,
                            String password)
                     throws IOException

Description copied from interface: SimpleSftpClient

Creates an SFTP session using the provided credentials

Specified by:

sftpLogin in interface SimpleSftpClient

Parameters:

target - The target SocketAddress

username - Username

password - Password

Returns:

Created SftpClient - Note: closing the client also closes its underlying session

Throws:

IOException - If failed to login or authenticate

sftpLogin

public SftpClient sftpLogin(SocketAddress target,
                            String username,
                            KeyPair identity)
                     throws IOException

Description copied from interface: SimpleSftpClient

Creates an SFTP session using the provided credentials

Specified by:

sftpLogin in interface SimpleSftpClient

Parameters:

target - The target SocketAddress

username - Username

identity - The KeyPair identity

Returns:

Created SftpClient - Note: closing the client also closes its underlying session

Throws:

IOException - If failed to login or authenticate

createSftpClient

protected SftpClient createSftpClient(ClientSession session)
                               throws IOException

Throws:

IOException

createSftpClient

protected SftpClient createSftpClient(ClientSession session,
                                      SftpClient client)
                               throws IOException

Throws:

IOException

scpLogin

public CloseableScpClient scpLogin(String host,
                                   String username,
                                   String password)
                            throws IOException

Description copied from interface: SimpleScpClient

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

Specified by:

scpLogin in interface SimpleScpClient

Parameters:

host - The target host name or address

username - Username

password - Password

Returns:

Created CloseableScpClient - Note: closing the client also closes its underlying session

Throws:

IOException - If failed to login or authenticate

scpLogin

public CloseableScpClient scpLogin(String host,
                                   int port,
                                   String username,
                                   String password)
                            throws IOException

Description copied from interface: SimpleScpClient

Creates an SCP session using the provided credentials

Specified by:

scpLogin in interface SimpleScpClient

Parameters:

host - The target host name or address

port - The target port

username - Username

password - Password

Returns:

Created CloseableScpClient - Note: closing the client also closes its underlying session

Throws:

IOException - If failed to login or authenticate

scpLogin

public CloseableScpClient scpLogin(String host,
                                   String username,
                                   KeyPair identity)
                            throws IOException

Description copied from interface: SimpleScpClient

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

Specified by:

scpLogin in interface SimpleScpClient

Parameters:

host - The target host name or address

username - Username

identity - The KeyPair identity

Returns:

Created CloseableScpClient - Note: closing the client also closes its underlying session

Throws:

IOException - If failed to login or authenticate

scpLogin

public CloseableScpClient scpLogin(String host,
                                   int port,
                                   String username,
                                   KeyPair identity)
                            throws IOException

Description copied from interface: SimpleScpClient

Creates an SCP session using the provided credentials

Specified by:

scpLogin in interface SimpleScpClient

Parameters:

host - The target host name or address

port - The target port

username - Username

identity - The KeyPair identity

Returns:

Created CloseableScpClient - Note: closing the client also closes its underlying session

Throws:

IOException - If failed to login or authenticate

scpLogin

public CloseableScpClient scpLogin(InetAddress host,
                                   String username,
                                   String password)
                            throws IOException

Description copied from interface: SimpleScpClient

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

Specified by:

scpLogin in interface SimpleScpClient

Parameters:

host - The target host InetAddress

username - Username

password - Password

Returns:

Created CloseableScpClient - Note: closing the client also closes its underlying session

Throws:

IOException - If failed to login or authenticate

scpLogin

public CloseableScpClient scpLogin(InetAddress host,
                                   int port,
                                   String username,
                                   String password)
                            throws IOException

Description copied from interface: SimpleScpClient

Creates an SCP session using the provided credentials

Specified by:

scpLogin in interface SimpleScpClient

Parameters:

host - The target host InetAddress

port - The target port

username - Username

password - Password

Returns:

Created CloseableScpClient - Note: closing the client also closes its underlying session

Throws:

IOException - If failed to login or authenticate

scpLogin

public CloseableScpClient scpLogin(InetAddress host,
                                   String username,
                                   KeyPair identity)
                            throws IOException

Description copied from interface: SimpleScpClient

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

Specified by:

scpLogin in interface SimpleScpClient

Parameters:

host - The target host InetAddress

username - Username

identity - The KeyPair identity

Returns:

Created CloseableScpClient - Note: closing the client also closes its underlying session

Throws:

IOException - If failed to login or authenticate

scpLogin

public CloseableScpClient scpLogin(InetAddress host,
                                   int port,
                                   String username,
                                   KeyPair identity)
                            throws IOException

Description copied from interface: SimpleScpClient

Creates an SCP session using the provided credentials

Specified by:

scpLogin in interface SimpleScpClient

Parameters:

host - The target host InetAddress

port - The target port

username - Username

identity - The KeyPair identity

Returns:

Created CloseableScpClient - Note: closing the client also closes its underlying session

Throws:

IOException - If failed to login or authenticate

scpLogin

public CloseableScpClient scpLogin(SocketAddress target,
                                   String username,
                                   String password)
                            throws IOException

Description copied from interface: SimpleScpClient

Creates an SCP session using the provided credentials

Specified by:

scpLogin in interface SimpleScpClient

Parameters:

target - The target SocketAddress

username - Username

password - Password

Returns:

Created CloseableScpClient - Note: closing the client also closes its underlying session

Throws:

IOException - If failed to login or authenticate

scpLogin

public CloseableScpClient scpLogin(SocketAddress target,
                                   String username,
                                   KeyPair identity)
                            throws IOException

Description copied from interface: SimpleScpClient

Creates an SCP session using the provided credentials

Specified by:

scpLogin in interface SimpleScpClient

Parameters:

target - The target SocketAddress

username - Username

identity - The KeyPair identity

Returns:

Created CloseableScpClient - Note: closing the client also closes its underlying session

Throws:

IOException - If failed to login or authenticate

createScpClient

protected CloseableScpClient createScpClient(ClientSession session)
                                      throws IOException

Throws:

IOException