Top Description Methods
org.apache.sshd.scp.client

public Interface SimpleScpClient

extends Channel
Known Direct Implementers
org.apache.sshd.scp.client.SimpleScpClientImpl
Imports
java.io.IOException, java.net.InetAddress, .InetSocketAddress, .SocketAddress, java.nio.channels.Channel, java.security.KeyPair, java.util.Objects, org.apache.sshd.client.simple.SimpleClientConfigurator, org.apache.sshd.common.util.ValidateUtils

A simplified synchronous API for obtaining SCP sessions.
Author
Apache MINA SSHD Project

Method Summary

Modifier and TypeMethod and Description
public default CloseableScpClient

Returns:

Created CloseableScpClient - Note: closing the client also closes its underlying session
scpLogin
(String
The target host name or address
host
,
String
Username
username
,
String
Password
password
)

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

public default CloseableScpClient

Returns:

Created CloseableScpClient - Note: closing the client also closes its underlying session
scpLogin
(String
The target host name or address
host
,
int
The target port
port
,
String
Username
username
,
String
Password
password
)

Creates an SCP session using the provided credentials

public default CloseableScpClient

Returns:

Created CloseableScpClient - Note: closing the client also closes its underlying session
scpLogin
(String
The target host name or address
host
,
String
Username
username
,
KeyPair
The KeyPair identity
identity
)

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

public default CloseableScpClient

Returns:

Created CloseableScpClient - Note: closing the client also closes its underlying session
scpLogin
(String
The target host name or address
host
,
int
The target port
port
,
String
Username
username
,
KeyPair
The KeyPair identity
identity
)

Creates an SCP session using the provided credentials

public default CloseableScpClient

Returns:

Created CloseableScpClient - Note: closing the client also closes its underlying session
scpLogin
(InetAddress
The target host InetAddress
host
,
String
Username
username
,
String
Password
password
)

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

public default CloseableScpClient

Returns:

Created CloseableScpClient - Note: closing the client also closes its underlying session
scpLogin
(InetAddress
The target host InetAddress
host
,
int
The target port
port
,
String
Username
username
,
String
Password
password
)

Creates an SCP session using the provided credentials

public default CloseableScpClient

Returns:

Created CloseableScpClient - Note: closing the client also closes its underlying session
scpLogin
(InetAddress
The target host InetAddress
host
,
String
Username
username
,
KeyPair
The KeyPair identity
identity
)

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

public default CloseableScpClient

Returns:

Created CloseableScpClient - Note: closing the client also closes its underlying session
scpLogin
(InetAddress
The target host InetAddress
host
,
int
The target port
port
,
String
Username
username
,
KeyPair
The KeyPair identity
identity
)

Creates an SCP session using the provided credentials

public CloseableScpClient

Returns:

Created CloseableScpClient - Note: closing the client also closes its underlying session
scpLogin
(SocketAddress
The target SocketAddress
target
,
String
Username
username
,
String
Password
password
)

Creates an SCP session using the provided credentials

public CloseableScpClient

Returns:

Created CloseableScpClient - Note: closing the client also closes its underlying session
scpLogin
(SocketAddress
The target SocketAddress
target
,
String
Username
username
,
KeyPair
The KeyPair identity
identity
)

Creates an SCP session using the provided credentials

Inherited from java.nio.channels.Channel:
closeisOpen

Method Detail

scpLoginback to summary
public 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:String

The target host name or address

username:String

Username

password:String

Password

Returns:CloseableScpClient

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

Exceptions
IOException:
If failed to login or authenticate
scpLoginback to summary
public default CloseableScpClient scpLogin(String host, int port, String username, String password) throws IOException

Creates an SCP 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:CloseableScpClient

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

Exceptions
IOException:
If failed to login or authenticate
scpLoginback to summary
public 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:String

The target host name or address

username:String

Username

identity:KeyPair

The KeyPair identity

Returns:CloseableScpClient

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

Exceptions
IOException:
If failed to login or authenticate
scpLoginback to summary
public default CloseableScpClient scpLogin(String host, int port, String username, KeyPair identity) throws IOException

Creates an SCP 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:CloseableScpClient

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

Exceptions
IOException:
If failed to login or authenticate
scpLoginback to summary
public 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:InetAddress

The target host InetAddress

username:String

Username

password:String

Password

Returns:CloseableScpClient

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

Exceptions
IOException:
If failed to login or authenticate
scpLoginback to summary
public default CloseableScpClient scpLogin(InetAddress host, int port, String username, String password) throws IOException

Creates an SCP session using the provided credentials

Parameters
host:InetAddress

The target host InetAddress

port:int

The target port

username:String

Username

password:String

Password

Returns:CloseableScpClient

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

Exceptions
IOException:
If failed to login or authenticate
scpLoginback to summary
public 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:InetAddress

The target host InetAddress

username:String

Username

identity:KeyPair

The KeyPair identity

Returns:CloseableScpClient

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

Exceptions
IOException:
If failed to login or authenticate
scpLoginback to summary
public default CloseableScpClient scpLogin(InetAddress host, int port, String username, KeyPair identity) throws IOException

Creates an SCP 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:CloseableScpClient

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

Exceptions
IOException:
If failed to login or authenticate
scpLoginback to summary
public CloseableScpClient scpLogin(SocketAddress target, String username, String password) throws IOException

Creates an SCP session using the provided credentials

Parameters
target:SocketAddress

The target SocketAddress

username:String

Username

password:String

Password

Returns:CloseableScpClient

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

Exceptions
IOException:
If failed to login or authenticate
scpLoginback to summary
public CloseableScpClient scpLogin(SocketAddress target, String username, KeyPair identity) throws IOException

Creates an SCP session using the provided credentials

Parameters
target:SocketAddress

The target SocketAddress

username:String

Username

identity:KeyPair

The KeyPair identity

Returns:CloseableScpClient

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

Exceptions
IOException:
If failed to login or authenticate