Apache Mina SSHD 2.15.0 · org.apache.sshd.sftp.client.impl.SimpleSftpClientImpl

Modifier and Type	Field and Description
private SimpleClient	clientInstance
private SftpClientFactory	sftpClientFactory

Modifier and Type

Field and Description

private SimpleClient

clientInstance

private SftpClientFactory

sftpClientFactory

Access	Constructor and Description
public	SimpleSftpClientImpl()
public	SimpleSftpClientImpl(SimpleClient client)
public	SimpleSftpClientImpl(SimpleClient client, SftpClientFactory sftpClientFactory)

Access

Constructor and Description

public

SimpleSftpClientImpl()

public

SimpleSftpClientImpl(SimpleClient client)

public

SimpleSftpClientImpl(SimpleClient client, SftpClientFactory sftpClientFactory)

Modifier and Type	Method and Description
public void	close() Implements java.nio.channels.Channel.close. Closes this channel.
protected SftpClient	createSftpClient(IOFunction<? super SimpleClient, ? extends ClientSession> sessionProvider)
protected SftpClient	createSftpClient(ClientSession session)
public SimpleClient	getClient()
public SftpClientFactory	getSftpClientFactory()
public boolean	isOpen() Implements java.nio.channels.Channel.isOpen. Tells whether or not this channel is open.
public void	setClient(SimpleClient client)
public void	setSftpClientFactory(SftpClientFactory sftpClientFactory)
public SftpClient	sftpLogin(SocketAddress The target `SocketAddress` target, String Username username, String Password password) Implements org.apache.sshd.sftp.client.SimpleSftpClient.sftpLogin. Creates an SFTP session using the provided credentials
public SftpClient	sftpLogin(SocketAddress The target `SocketAddress` target, String Username username, KeyPair The `KeyPair` identity identity) Implements org.apache.sshd.sftp.client.SimpleSftpClient.sftpLogin. Creates an SFTP session using the provided credentials

Modifier and Type

Method and Description

public void

close()

Implements java.nio.channels.Channel.close.

Closes this channel.

protected SftpClient

createSftpClient(IOFunction<? super SimpleClient, ? extends ClientSession> sessionProvider)

protected SftpClient

createSftpClient(ClientSession session)

public SimpleClient

getClient()

public SftpClientFactory

getSftpClientFactory()

public boolean

isOpen()

Implements java.nio.channels.Channel.isOpen.

Tells whether or not this channel is open.

public void

setClient(SimpleClient client)

public void

setSftpClientFactory(SftpClientFactory sftpClientFactory)

public SftpClient

sftpLogin(SocketAddress

The target SocketAddress

target, String

Username

username, String

Password

password)

Implements org.apache.sshd.sftp.client.SimpleSftpClient.sftpLogin.

Creates an SFTP session using the provided credentials

public SftpClient

sftpLogin(SocketAddress

The target SocketAddress

target, String

Username

username, KeyPair

The KeyPair identity

identity)

Implements org.apache.sshd.sftp.client.SimpleSftpClient.sftpLogin.

Creates an SFTP session using the provided credentials

clientInstance	back to summary
private SimpleClient clientInstance

clientInstance

back to summary

private SimpleClient clientInstance

sftpClientFactory	back to summary
private SftpClientFactory sftpClientFactory

sftpClientFactory

back to summary

private SftpClientFactory sftpClientFactory

SimpleSftpClientImpl	back to summary
public SimpleSftpClientImpl()

SimpleSftpClientImpl

back to summary

public SimpleSftpClientImpl()

SimpleSftpClientImpl	back to summary
public SimpleSftpClientImpl(SimpleClient client)

SimpleSftpClientImpl

back to summary

public SimpleSftpClientImpl(SimpleClient client)

SimpleSftpClientImpl	back to summary
public SimpleSftpClientImpl(SimpleClient client, SftpClientFactory sftpClientFactory)

SimpleSftpClientImpl

back to summary

public SimpleSftpClientImpl(SimpleClient client, SftpClientFactory sftpClientFactory)

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Implements java.nio.channels.Channel.close. Doc from java.nio.channels.Channel.close. Closes this channel. After a channel is closed, any further attempt to invoke I/O operations upon it will cause a `ClosedChannelException` to be thrown. If this channel is already closed then invoking this method has no effect. This method may be invoked at any time. If some other thread has already invoked it, however, then another invocation will block until the first invocation is complete, after which it will return without effect. Annotations @Override Exceptions IOException: If an I/O error occurs

public void close() throws IOException

Implements java.nio.channels.Channel.close.

Doc from java.nio.channels.Channel.close.

Closes this channel.

After a channel is closed, any further attempt to invoke I/O operations upon it will cause a ClosedChannelException to be thrown.

If this channel is already closed then invoking this method has no effect.

This method may be invoked at any time. If some other thread has already invoked it, however, then another invocation will block until the first invocation is complete, after which it will return without effect.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

createSftpClient	back to summary
protected SftpClient createSftpClient(IOFunction<? super SimpleClient, ? extends ClientSession> sessionProvider) throws IOException

createSftpClient	back to summary
protected SftpClient createSftpClient(ClientSession session) throws IOException

getClient	back to summary
public SimpleClient getClient()

getSftpClientFactory	back to summary
public SftpClientFactory getSftpClientFactory()

isOpen back to summary

isOpen	back to summary
public boolean isOpen() Implements java.nio.channels.Channel.isOpen. Doc from java.nio.channels.Channel.isOpen. Tells whether or not this channel is open. Returns:boolean `true` if, and only if, this channel is open Annotations @Override

public boolean isOpen()

Implements java.nio.channels.Channel.isOpen.

Doc from java.nio.channels.Channel.isOpen.

Tells whether or not this channel is open.

Returns:boolean

true if, and only if, this channel is open

Annotations

@Override

setClient	back to summary
public void setClient(SimpleClient client)

setSftpClientFactory	back to summary
public void setSftpClientFactory(SftpClientFactory sftpClientFactory)

sftpLogin back to summary

sftpLogin	back to summary
public SftpClient sftpLogin(SocketAddress target, String username, String password) throws IOException Implements org.apache.sshd.sftp.client.SimpleSftpClient.sftpLogin. Doc from org.apache.sshd.sftp.client.SimpleSftpClient.sftpLogin. 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 Annotations @Override Exceptions IOException: If failed to login or authenticate

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

Implements org.apache.sshd.sftp.client.SimpleSftpClient.sftpLogin.

Doc from org.apache.sshd.sftp.client.SimpleSftpClient.sftpLogin.

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

Annotations

@Override

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 Implements org.apache.sshd.sftp.client.SimpleSftpClient.sftpLogin. Doc from org.apache.sshd.sftp.client.SimpleSftpClient.sftpLogin. 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 Annotations @Override Exceptions IOException: If failed to login or authenticate