Apache Mina SSHD 2.15.0 · org.apache.sshd.client.simple.AbstractSimpleClientSessionCreator

Modifier and Type	Field and Description
private long	authenticateTimeout
private long	connectTimeout

Access	Constructor and Description
protected	AbstractSimpleClientSessionCreator()
protected	AbstractSimpleClientSessionCreator(long connTimeout, long authTimeout)

Method Summary

Modifier and Type	Method and Description
protected ClientSession	authSession(ConnectFuture future, String password)
protected ClientSession	authSession(ConnectFuture future, KeyPair identity)
protected ClientSession	authSession(ClientSession clientSession)
public long	getAuthenticationTimeout() Implements org.apache.sshd.client.simple.SimpleClientConfigurator.getAuthenticationTimeout.
public long	getConnectTimeout() Implements org.apache.sshd.client.simple.SimpleClientConfigurator.getConnectTimeout.
protected ClientSession	loginSession(ConnectFuture future, String password)
protected ClientSession	loginSession(ConnectFuture future, KeyPair identity)
public ClientSession	sessionLogin(SocketAddress The target `SocketAddress` target, String Username username, String Password password) Implements org.apache.sshd.client.simple.SimpleSessionClient.sessionLogin. Creates a session and logs in using the provided credentials
public ClientSession	sessionLogin(SocketAddress The target `SocketAddress` target, String Username username, KeyPair The `KeyPair` identity identity) Implements org.apache.sshd.client.simple.SimpleSessionClient.sessionLogin. Creates a session and logs in using the provided credentials
public ClientSession	sessionLogin(String The target uri uri, String Password password) Implements org.apache.sshd.client.simple.SimpleSessionClient.sessionLogin. Creates a session and logs in using the provided credentials
public ClientSession	sessionLogin(String The target uri uri, KeyPair The `KeyPair` identity identity) Implements org.apache.sshd.client.simple.SimpleSessionClient.sessionLogin. Creates a session and logs in using the provided credentials
public void	setAuthenticationTimeout(long Requested authentication timeout (msec.) - always positive timeout) Implements org.apache.sshd.client.simple.SimpleClientConfigurator.setAuthenticationTimeout.
public void	setConnectTimeout(long Requested connect timeout (msec.) - always positive timeout) Implements org.apache.sshd.client.simple.SimpleClientConfigurator.setConnectTimeout.
public static SimpleClient	Returns: The `SimpleClient` wrapper Note closing the wrapper also closes the underlying sessions creator. wrap(ClientSessionCreator The `ClientSessionCreator` - never `null` creator, Channel The `Channel` representing the creator for relaying `isOpen()` and `close()` calls channel) Wraps an existing `ClientSessionCreator` into a `SimpleClient`

authenticateTimeout	back to summary
private long authenticateTimeout

connectTimeout	back to summary
private long connectTimeout

AbstractSimpleClientSessionCreator	back to summary
protected AbstractSimpleClientSessionCreator()

AbstractSimpleClientSessionCreator	back to summary
protected AbstractSimpleClientSessionCreator(long connTimeout, long authTimeout)

Method Detail

authSession	back to summary
protected ClientSession authSession(ConnectFuture future, String password) throws IOException

authSession	back to summary
protected ClientSession authSession(ConnectFuture future, KeyPair identity) throws IOException

authSession	back to summary
protected ClientSession authSession(ClientSession clientSession) throws IOException

getAuthenticationTimeout	back to summary
public long getAuthenticationTimeout() Implements org.apache.sshd.client.simple.SimpleClientConfigurator.getAuthenticationTimeout. Returns:long Doc from org.apache.sshd.client.simple.SimpleClientConfigurator.getAuthenticationTimeout. Current authentication timeout (msec.) - always positive Annotations @Override

getAuthenticationTimeout

back to summary

public long getAuthenticationTimeout()

Implements org.apache.sshd.client.simple.SimpleClientConfigurator.getAuthenticationTimeout.

Returns:long

Doc from org.apache.sshd.client.simple.SimpleClientConfigurator.getAuthenticationTimeout.

Current authentication timeout (msec.) - always positive

Annotations

@Override

getConnectTimeout	back to summary
public long getConnectTimeout() Implements org.apache.sshd.client.simple.SimpleClientConfigurator.getConnectTimeout. Returns:long Doc from org.apache.sshd.client.simple.SimpleClientConfigurator.getConnectTimeout. Current connect timeout (msec.) - always positive Annotations @Override

getConnectTimeout

back to summary

public long getConnectTimeout()

Implements org.apache.sshd.client.simple.SimpleClientConfigurator.getConnectTimeout.

Returns:long

Doc from org.apache.sshd.client.simple.SimpleClientConfigurator.getConnectTimeout.

Current connect timeout (msec.) - always positive

Annotations

@Override

loginSession	back to summary
protected ClientSession loginSession(ConnectFuture future, String password) throws IOException

loginSession	back to summary
protected ClientSession loginSession(ConnectFuture future, KeyPair identity) throws IOException

sessionLogin back to summary

sessionLogin	back to summary
public ClientSession sessionLogin(SocketAddress target, String username, String password) throws IOException Implements org.apache.sshd.client.simple.SimpleSessionClient.sessionLogin. Doc from org.apache.sshd.client.simple.SimpleSessionClient.sessionLogin. Creates a session and logs in using the provided credentials Parameters target:SocketAddress The target `SocketAddress` username:String Username password:String Password Returns:ClientSession Created `ClientSession` Annotations @Override Exceptions IOException: If failed to login or authenticate

public ClientSession sessionLogin(SocketAddress target, String username, String password) throws IOException

Implements org.apache.sshd.client.simple.SimpleSessionClient.sessionLogin.

Doc from org.apache.sshd.client.simple.SimpleSessionClient.sessionLogin.

Creates a session and logs in using the provided credentials

Parameters

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

Returns:ClientSession

Created ClientSession

Annotations

@Override

Exceptions

IOException:: If failed to login or authenticate

sessionLogin back to summary

sessionLogin	back to summary
public ClientSession sessionLogin(SocketAddress target, String username, KeyPair identity) throws IOException Implements org.apache.sshd.client.simple.SimpleSessionClient.sessionLogin. Doc from org.apache.sshd.client.simple.SimpleSessionClient.sessionLogin. Creates a session and logs in using the provided credentials Parameters target:SocketAddress The target `SocketAddress` username:String Username identity:KeyPair The `KeyPair` identity Returns:ClientSession Created `ClientSession` Annotations @Override Exceptions IOException: If failed to login or authenticate

public ClientSession sessionLogin(SocketAddress target, String username, KeyPair identity) throws IOException

Implements org.apache.sshd.client.simple.SimpleSessionClient.sessionLogin.

Doc from org.apache.sshd.client.simple.SimpleSessionClient.sessionLogin.

Creates a session and logs in using the provided credentials

Parameters

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

Returns:ClientSession

Created ClientSession

Annotations

@Override

Exceptions

IOException:: If failed to login or authenticate

sessionLogin back to summary

sessionLogin	back to summary
public ClientSession sessionLogin(String uri, String password) throws IOException Implements org.apache.sshd.client.simple.SimpleSessionClient.sessionLogin. Doc from org.apache.sshd.client.simple.SimpleSessionClient.sessionLogin. Creates a session and logs in using the provided credentials Parameters uri:String The target uri password:String Password Returns:ClientSession Created `ClientSession` Annotations @Override Exceptions IOException: If failed to login or authenticate

public ClientSession sessionLogin(String uri, String password) throws IOException

Implements org.apache.sshd.client.simple.SimpleSessionClient.sessionLogin.

Doc from org.apache.sshd.client.simple.SimpleSessionClient.sessionLogin.

Creates a session and logs in using the provided credentials

Parameters

uri:String: The target uri
password:String: Password

Returns:ClientSession

Created ClientSession

Annotations

@Override

Exceptions

IOException:: If failed to login or authenticate

sessionLogin back to summary

sessionLogin	back to summary
public ClientSession sessionLogin(String uri, KeyPair identity) throws IOException Implements org.apache.sshd.client.simple.SimpleSessionClient.sessionLogin. Doc from org.apache.sshd.client.simple.SimpleSessionClient.sessionLogin. Creates a session and logs in using the provided credentials Parameters uri:String The target uri identity:KeyPair The `KeyPair` identity Returns:ClientSession Created `ClientSession` Annotations @Override Exceptions IOException: If failed to login or authenticate

public ClientSession sessionLogin(String uri, KeyPair identity) throws IOException

Implements org.apache.sshd.client.simple.SimpleSessionClient.sessionLogin.

Doc from org.apache.sshd.client.simple.SimpleSessionClient.sessionLogin.

Creates a session and logs in using the provided credentials

Parameters

uri:String: The target uri
identity:KeyPair: The KeyPair identity

Returns:ClientSession

Created ClientSession

Annotations

@Override

Exceptions

IOException:: If failed to login or authenticate

setAuthenticationTimeout	back to summary
public void setAuthenticationTimeout(long timeout) Implements org.apache.sshd.client.simple.SimpleClientConfigurator.setAuthenticationTimeout. Parameters timeout:long Doc from org.apache.sshd.client.simple.SimpleClientConfigurator.setAuthenticationTimeout. Requested authentication timeout (msec.) - always positive Annotations @Override

setAuthenticationTimeout

back to summary

public void setAuthenticationTimeout(long timeout)

Implements org.apache.sshd.client.simple.SimpleClientConfigurator.setAuthenticationTimeout.

Parameters

timeout:long

Doc from org.apache.sshd.client.simple.SimpleClientConfigurator.setAuthenticationTimeout.

Requested authentication timeout (msec.) - always positive

Annotations

@Override

setConnectTimeout	back to summary
public void setConnectTimeout(long timeout) Implements org.apache.sshd.client.simple.SimpleClientConfigurator.setConnectTimeout. Parameters timeout:long Doc from org.apache.sshd.client.simple.SimpleClientConfigurator.setConnectTimeout. Requested connect timeout (msec.) - always positive Annotations @Override

setConnectTimeout

back to summary

public void setConnectTimeout(long timeout)

Implements org.apache.sshd.client.simple.SimpleClientConfigurator.setConnectTimeout.

Parameters

timeout:long

Doc from org.apache.sshd.client.simple.SimpleClientConfigurator.setConnectTimeout.

Requested connect timeout (msec.) - always positive

Annotations

@Override

wrap back to summary

wrap	back to summary
public static SimpleClient wrap(ClientSessionCreator creator, Channel channel) Wraps an existing `ClientSessionCreator` into a `SimpleClient` Parameters creator:ClientSessionCreator The `ClientSessionCreator` - never `null` channel:Channel The `Channel` representing the creator for relaying `isOpen()` and `close()` calls Returns:SimpleClient The `SimpleClient` wrapper Note closing the wrapper also closes the underlying sessions creator. Annotations @SuppressWarnings:checkstyle:anoninnerlength

public static SimpleClient wrap(ClientSessionCreator creator, Channel channel)

Wraps an existing ClientSessionCreator into a SimpleClient

Parameters

creator:ClientSessionCreator: The ClientSessionCreator - never null
channel:Channel: The Channel representing the creator for relaying isOpen() and close() calls

Returns:SimpleClient

The SimpleClient wrapper

Note

closing the wrapper also closes the underlying sessions creator.

Annotations

@SuppressWarnings:checkstyle:anoninnerlength

public abstract Class AbstractSimpleClientSessionCreator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail