Apache Mina SSHD 2.15.0 · org.apache.sshd.sftp.client.SimpleSftpClient

Method Summary

Modifier and Type	Method and Description
public default SftpClient	Returns: Created `SftpClient` - Note: closing the client also closes its underlying session sftpLogin(String The target host name or address host, String Username username, String Password password) Creates an SFTP session on the default port and logs in using the provided credentials
public default SftpClient	Returns: Created `SftpClient` - Note: closing the client also closes its underlying session sftpLogin(String The target host name or address host, int The target port port, String Username username, String Password password) Creates an SFTP session using the provided credentials
public default SftpClient	Returns: Created `SftpClient` - Note: closing the client also closes its underlying session sftpLogin(String The target host name or address host, String Username username, KeyPair The `KeyPair` identity identity) Creates an SFTP session on the default port and logs in using the provided credentials
public default SftpClient	Returns: Created `SftpClient` - Note: closing the client also closes its underlying session sftpLogin(String The target host name or address host, int The target port port, String Username username, KeyPair The `KeyPair` identity identity) Creates an SFTP session using the provided credentials
public default SftpClient	Returns: Created `SftpClient` - Note: closing the client also closes its underlying session sftpLogin(InetAddress The target host `InetAddress` host, String Username username, String Password password) Creates an SFTP session on the default port and logs in using the provided credentials
public default SftpClient	Returns: Created `SftpClient` - Note: closing the client also closes its underlying session sftpLogin(InetAddress The target host `InetAddress` host, int The target port port, String Username username, String Password password) Creates an SFTP session using the provided credentials
public default SftpClient	Returns: Created `SftpClient` - Note: closing the client also closes its underlying session sftpLogin(InetAddress The target host `InetAddress` host, String Username username, KeyPair The `KeyPair` identity identity) Creates an SFTP session on the default port and logs in using the provided credentials
public default SftpClient	Returns: Created `SftpClient` - Note: closing the client also closes its underlying session sftpLogin(InetAddress The target host `InetAddress` host, int The target port port, String Username username, KeyPair The `KeyPair` identity identity) Creates an SFTP session using the provided credentials
public SftpClient	Returns: Created `SftpClient` - Note: closing the client also closes its underlying session sftpLogin(SocketAddress The target `SocketAddress` target, String Username username, String Password password) Creates an SFTP session using the provided credentials
public SftpClient	Returns: Created `SftpClient` - Note: closing the client also closes its underlying session sftpLogin(SocketAddress The target `SocketAddress` target, String Username username, KeyPair The `KeyPair` identity identity) Creates an SFTP session using the provided credentials

Inherited from java.nio.channels.Channel:: close isOpen

Method Detail

sftpLogin back to summary

sftpLogin	back to summary
public default SftpClient sftpLogin(String host, String username, String password) throws IOException Creates an SFTP session on the default port and logs in using the provided credentials Parameters host:String The target host name or address username:String Username password:String Password Returns:SftpClient Created `SftpClient` - Note: closing the client also closes its underlying session Exceptions IOException: If failed to login or authenticate

public default SftpClient sftpLogin(String host, String username, String password) throws IOException

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

Parameters

host:String: The target host name or address
username:String: Username
password:String: Password

Returns:SftpClient

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

Exceptions

IOException:: If failed to login or authenticate

sftpLogin back to summary

sftpLogin	back to summary
public default SftpClient sftpLogin(String host, int port, String username, String password) throws IOException Creates an SFTP session using the provided credentials Parameters host:String The target host name or address port:int The target port username:String Username password:String Password Returns:SftpClient Created `SftpClient` - Note: closing the client also closes its underlying session Exceptions IOException: If failed to login or authenticate

public default SftpClient sftpLogin(String host, int port, String username, String password) throws IOException

Creates an SFTP session using the provided credentials

Parameters

host:String: The target host name or address
port:int: The target port
username:String: Username
password:String: Password

Returns:SftpClient

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

Exceptions

IOException:: If failed to login or authenticate

sftpLogin back to summary

sftpLogin	back to summary
public default SftpClient sftpLogin(String host, String username, KeyPair identity) throws IOException Creates an SFTP session on the default port and logs in using the provided credentials Parameters host:String The target host name or address username:String Username identity:KeyPair The `KeyPair` identity Returns:SftpClient Created `SftpClient` - Note: closing the client also closes its underlying session Exceptions IOException: If failed to login or authenticate

public default SftpClient sftpLogin(String host, String username, KeyPair identity) throws IOException

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

Parameters

host:String: The target host name or address
username:String: Username
identity:KeyPair: The KeyPair identity

Returns:SftpClient

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

Exceptions

IOException:: If failed to login or authenticate

sftpLogin back to summary

sftpLogin	back to summary
public default SftpClient sftpLogin(String host, int port, String username, KeyPair identity) throws IOException Creates an SFTP session using the provided credentials Parameters host:String The target host name or address port:int The target port username:String Username identity:KeyPair The `KeyPair` identity Returns:SftpClient Created `SftpClient` - Note: closing the client also closes its underlying session Exceptions IOException: If failed to login or authenticate

public default SftpClient sftpLogin(String host, int port, String username, KeyPair identity) throws IOException

Creates an SFTP session using the provided credentials

Parameters

host:String: The target host name or address
port:int: The target port
username:String: Username
identity:KeyPair: The KeyPair identity

Returns:SftpClient

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

Exceptions

IOException:: If failed to login or authenticate

sftpLogin back to summary

sftpLogin	back to summary
public default SftpClient sftpLogin(InetAddress host, String username, String password) throws IOException Creates an SFTP session on the default port and logs in using the provided credentials Parameters host:InetAddress The target host `InetAddress` username:String Username password:String Password Returns:SftpClient Created `SftpClient` - Note: closing the client also closes its underlying session Exceptions IOException: If failed to login or authenticate

public default SftpClient sftpLogin(InetAddress host, String username, String password) throws IOException

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

Parameters

host:InetAddress: The target host InetAddress
username:String: Username
password:String: Password

Returns:SftpClient

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

Exceptions

IOException:: If failed to login or authenticate

sftpLogin back to summary

sftpLogin	back to summary
public default SftpClient sftpLogin(InetAddress host, int port, String username, String password) throws IOException Creates an SFTP session using the provided credentials Parameters host:InetAddress The target host `InetAddress` port:int The target port username:String Username password:String Password Returns:SftpClient Created `SftpClient` - Note: closing the client also closes its underlying session Exceptions IOException: If failed to login or authenticate

public default SftpClient sftpLogin(InetAddress host, int port, String username, String password) throws IOException

Creates an SFTP session using the provided credentials

Parameters

host:InetAddress: The target host InetAddress
port:int: The target port
username:String: Username
password:String: Password

Returns:SftpClient

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

Exceptions

IOException:: If failed to login or authenticate

sftpLogin back to summary

sftpLogin	back to summary
public default SftpClient sftpLogin(InetAddress host, String username, KeyPair identity) throws IOException Creates an SFTP session on the default port and logs in using the provided credentials Parameters host:InetAddress The target host `InetAddress` username:String Username identity:KeyPair The `KeyPair` identity Returns:SftpClient Created `SftpClient` - Note: closing the client also closes its underlying session Exceptions IOException: If failed to login or authenticate

public default SftpClient sftpLogin(InetAddress host, String username, KeyPair identity) throws IOException

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

Parameters

host:InetAddress: The target host InetAddress
username:String: Username
identity:KeyPair: The KeyPair identity

Returns:SftpClient

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

Exceptions

IOException:: If failed to login or authenticate

sftpLogin back to summary

sftpLogin	back to summary
public default SftpClient sftpLogin(InetAddress host, int port, String username, KeyPair identity) throws IOException Creates an SFTP session using the provided credentials Parameters host:InetAddress The target host `InetAddress` port:int The target port username:String Username identity:KeyPair The `KeyPair` identity Returns:SftpClient Created `SftpClient` - Note: closing the client also closes its underlying session Exceptions IOException: If failed to login or authenticate

public default SftpClient sftpLogin(InetAddress host, int port, String username, KeyPair identity) throws IOException

Creates an SFTP session using the provided credentials

Parameters

host:InetAddress: The target host InetAddress
port:int: The target port
username:String: Username
identity:KeyPair: The KeyPair identity

Returns:SftpClient

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

Exceptions

IOException:: If failed to login or authenticate

sftpLogin back to summary

sftpLogin	back to summary
public SftpClient sftpLogin(SocketAddress target, String username, String password) throws IOException Creates an SFTP session using the provided credentials Parameters target:SocketAddress The target `SocketAddress` username:String Username password:String Password Returns:SftpClient Created `SftpClient` - Note: closing the client also closes its underlying session Exceptions IOException: If failed to login or authenticate

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

Creates an SFTP session using the provided credentials

Parameters

target:SocketAddress: The target SocketAddress
username:String: Username
password:String: Password

Returns:SftpClient

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

Exceptions

IOException:: If failed to login or authenticate

sftpLogin back to summary

sftpLogin	back to summary
public SftpClient sftpLogin(SocketAddress target, String username, KeyPair identity) throws IOException Creates an SFTP session using the provided credentials Parameters target:SocketAddress The target `SocketAddress` username:String Username identity:KeyPair The `KeyPair` identity Returns:SftpClient Created `SftpClient` - Note: closing the client also closes its underlying session Exceptions IOException: If failed to login or authenticate

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

Creates an SFTP session using the provided credentials

Parameters

target:SocketAddress: The target SocketAddress
username:String: Username
identity:KeyPair: The KeyPair identity

Returns:SftpClient

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

Exceptions

IOException:: If failed to login or authenticate

public Interface SimpleSftpClient

Method Summary

Method Detail