org.apache.sshd.scp.client

Interface SimpleScpClient

All Superinterfaces:

AutoCloseable, Channel, Closeable

All Known Implementing Classes:

SimpleScpClientImpl

public interface SimpleScpClient
extends Channel

A simplified synchronous API for obtaining SCP sessions.

Author:

Apache MINA SSHD Project

Method Summary

Modifier and Type	Method and Description
default CloseableScpClient	scpLogin(InetAddress host, int port, String username, KeyPair identity) Creates an SCP session using the provided credentials
default CloseableScpClient	scpLogin(InetAddress host, int port, String username, String password) Creates an SCP session using the provided credentials
default CloseableScpClient	scpLogin(InetAddress host, String username, KeyPair identity) Creates an SCP session on the default port and logs in using the provided credentials
default 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
default CloseableScpClient	scpLogin(String host, int port, String username, KeyPair identity) Creates an SCP session using the provided credentials
default CloseableScpClient	scpLogin(String host, int port, String username, String password) Creates an SCP session using the provided credentials
default CloseableScpClient	scpLogin(String host, String username, KeyPair identity) Creates an SCP session on the default port and logs in using the provided credentials
default CloseableScpClient	scpLogin(String host, String username, String password) Creates an SCP session on the default port and logs in using the provided credentials

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Method Detail

scpLogin

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

Creates an SCP 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 CloseableScpClient - Note: closing the client also closes its underlying session

Throws:

IOException - If failed to login or authenticate

scpLogin

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

Creates an SCP session using the provided credentials

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

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

Creates an SCP 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 CloseableScpClient - Note: closing the client also closes its underlying session

Throws:

IOException - If failed to login or authenticate

scpLogin

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

Creates an SCP session using the provided credentials

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

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

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

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

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

Creates an SCP session using the provided credentials

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

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

Creates an SCP 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 CloseableScpClient - Note: closing the client also closes its underlying session

Throws:

IOException - If failed to login or authenticate

scpLogin

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

Creates an SCP session using the provided credentials

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

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

Creates an SCP session using the provided credentials

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

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

Creates an SCP session using the provided credentials

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