Package org.apache.sshd.sftp.client.impl
Class SimpleSftpClientImpl
- java.lang.Object
-
- org.apache.sshd.common.util.logging.AbstractLoggingBean
-
- org.apache.sshd.sftp.client.impl.SimpleSftpClientImpl
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Channel
,SimpleSftpClient
public class SimpleSftpClientImpl extends AbstractLoggingBean implements SimpleSftpClient
- Author:
- Apache MINA SSHD Project
-
-
Field Summary
-
Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
log
-
-
Constructor Summary
Constructors Constructor Description SimpleSftpClientImpl()
SimpleSftpClientImpl(SimpleClient client)
SimpleSftpClientImpl(SimpleClient client, SftpClientFactory sftpClientFactory)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
protected SftpClient
createSftpClient(ClientSession session)
protected SftpClient
createSftpClient(IOFunction<? super SimpleClient,? extends ClientSession> sessionProvider)
SimpleClient
getClient()
SftpClientFactory
getSftpClientFactory()
boolean
isOpen()
void
setClient(SimpleClient client)
void
setSftpClientFactory(SftpClientFactory sftpClientFactory)
SftpClient
sftpLogin(SocketAddress target, String username, String password)
Creates an SFTP session using the provided credentialsSftpClient
sftpLogin(SocketAddress target, String username, KeyPair identity)
Creates an SFTP session using the provided credentials-
Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn
-
-
-
-
Constructor Detail
-
SimpleSftpClientImpl
public SimpleSftpClientImpl()
-
SimpleSftpClientImpl
public SimpleSftpClientImpl(SimpleClient client)
-
SimpleSftpClientImpl
public SimpleSftpClientImpl(SimpleClient client, SftpClientFactory sftpClientFactory)
-
-
Method Detail
-
getClient
public SimpleClient getClient()
-
setClient
public void setClient(SimpleClient client)
-
getSftpClientFactory
public SftpClientFactory getSftpClientFactory()
-
setSftpClientFactory
public void setSftpClientFactory(SftpClientFactory sftpClientFactory)
-
sftpLogin
public SftpClient sftpLogin(SocketAddress target, String username, String password) throws IOException
Description copied from interface:SimpleSftpClient
Creates an SFTP session using the provided credentials- Specified by:
sftpLogin
in interfaceSimpleSftpClient
- Parameters:
target
- The targetSocketAddress
username
- Usernamepassword
- Password- Returns:
- Created
SftpClient
- Note: closing the client also closes its underlying session - Throws:
IOException
- If failed to login or authenticate
-
sftpLogin
public SftpClient sftpLogin(SocketAddress target, String username, KeyPair identity) throws IOException
Description copied from interface:SimpleSftpClient
Creates an SFTP session using the provided credentials- Specified by:
sftpLogin
in interfaceSimpleSftpClient
- Parameters:
target
- The targetSocketAddress
username
- Usernameidentity
- TheKeyPair
identity- Returns:
- Created
SftpClient
- Note: closing the client also closes its underlying session - Throws:
IOException
- If failed to login or authenticate
-
createSftpClient
protected SftpClient createSftpClient(IOFunction<? super SimpleClient,? extends ClientSession> sessionProvider) throws IOException
- Throws:
IOException
-
createSftpClient
protected SftpClient createSftpClient(ClientSession session) throws IOException
- Throws:
IOException
-
close
public void close() throws IOException
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceChannel
- Specified by:
close
in interfaceCloseable
- Throws:
IOException
-
-