Apache Mina SSHD 2.15.0 · org.apache.sshd.scp.client.SimpleScpClientImpl

Modifier and Type	Field and Description
private SimpleClient	clientInstance
private ScpClientCreator	scpClientCreator

Modifier and Type

Field and Description

private SimpleClient

clientInstance

private ScpClientCreator

scpClientCreator

Access	Constructor and Description
public	SimpleScpClientImpl()
public	SimpleScpClientImpl(SimpleClient client)
public	SimpleScpClientImpl(SimpleClient client, ScpClientCreator scpClientCreator)

Access

Constructor and Description

public

SimpleScpClientImpl()

public

SimpleScpClientImpl(SimpleClient client)

public

SimpleScpClientImpl(SimpleClient client, ScpClientCreator scpClientCreator)

Modifier and Type	Method and Description
public void	close() Implements java.nio.channels.Channel.close. Closes this channel.
protected CloseableScpClient	createScpClient(IOFunction<? super SimpleClient, ? extends ClientSession> sessionProvider)
protected CloseableScpClient	createScpClient(ClientSession session)
public SimpleClient	getClient()
public ScpClientCreator	getScpClientCreator()
public boolean	isOpen() Implements java.nio.channels.Channel.isOpen. Tells whether or not this channel is open.
public CloseableScpClient	scpLogin(SocketAddress The target `SocketAddress` target, String Username username, String Password password) Implements org.apache.sshd.scp.client.SimpleScpClient.scpLogin. Creates an SCP session using the provided credentials
public CloseableScpClient	scpLogin(SocketAddress The target `SocketAddress` target, String Username username, KeyPair The `KeyPair` identity identity) Implements org.apache.sshd.scp.client.SimpleScpClient.scpLogin. Creates an SCP session using the provided credentials
public void	setClient(SimpleClient client)
public void	setScpClientCreator(ScpClientCreator scpClientCreator)

Modifier and Type

Method and Description

public void

close()

Implements java.nio.channels.Channel.close.

Closes this channel.

protected CloseableScpClient

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

protected CloseableScpClient

createScpClient(ClientSession session)

public SimpleClient

getClient()

public ScpClientCreator

getScpClientCreator()

public boolean

isOpen()

Implements java.nio.channels.Channel.isOpen.

Tells whether or not this channel is open.

public CloseableScpClient

scpLogin(SocketAddress

The target SocketAddress

target, String

Username

username, String

Password

password)

Implements org.apache.sshd.scp.client.SimpleScpClient.scpLogin.

Creates an SCP session using the provided credentials

public CloseableScpClient

scpLogin(SocketAddress

The target SocketAddress

target, String

Username

username, KeyPair

The KeyPair identity

identity)

Implements org.apache.sshd.scp.client.SimpleScpClient.scpLogin.

Creates an SCP session using the provided credentials

public void

setClient(SimpleClient client)

public void

setScpClientCreator(ScpClientCreator scpClientCreator)

clientInstance	back to summary
private SimpleClient clientInstance

clientInstance

back to summary

private SimpleClient clientInstance

scpClientCreator	back to summary
private ScpClientCreator scpClientCreator

scpClientCreator

back to summary

private ScpClientCreator scpClientCreator

SimpleScpClientImpl	back to summary
public SimpleScpClientImpl()

SimpleScpClientImpl

back to summary

public SimpleScpClientImpl()

SimpleScpClientImpl	back to summary
public SimpleScpClientImpl(SimpleClient client)

SimpleScpClientImpl

back to summary

public SimpleScpClientImpl(SimpleClient client)

SimpleScpClientImpl	back to summary
public SimpleScpClientImpl(SimpleClient client, ScpClientCreator scpClientCreator)

SimpleScpClientImpl

back to summary

public SimpleScpClientImpl(SimpleClient client, ScpClientCreator scpClientCreator)

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

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

createScpClient	back to summary
protected CloseableScpClient createScpClient(ClientSession session) throws IOException

getClient	back to summary
public SimpleClient getClient()

getScpClientCreator	back to summary
public ScpClientCreator getScpClientCreator()

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

scpLogin back to summary

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

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

Implements org.apache.sshd.scp.client.SimpleScpClient.scpLogin.

Doc from org.apache.sshd.scp.client.SimpleScpClient.scpLogin.

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

Annotations

@Override

Exceptions

IOException:: If failed to login or authenticate

scpLogin back to summary

scpLogin	back to summary
public CloseableScpClient scpLogin(SocketAddress target, String username, KeyPair identity) throws IOException Implements org.apache.sshd.scp.client.SimpleScpClient.scpLogin. Doc from org.apache.sshd.scp.client.SimpleScpClient.scpLogin. 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 Annotations @Override Exceptions IOException: If failed to login or authenticate

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

Implements org.apache.sshd.scp.client.SimpleScpClient.scpLogin.

Doc from org.apache.sshd.scp.client.SimpleScpClient.scpLogin.

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

Annotations

@Override

Exceptions

IOException:: If failed to login or authenticate

setClient	back to summary
public void setClient(SimpleClient client)

setScpClientCreator	back to summary
public void setScpClientCreator(ScpClientCreator scpClientCreator)

public Class SimpleScpClientImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail