Package org.apache.sshd.client.simple

Class AbstractSimpleClientSessionCreator

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.client.simple.AbstractSimpleClient

org.apache.sshd.client.simple.AbstractSimpleClientSessionCreator

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, ClientSessionCreator, SimpleClient, SimpleClientConfigurator, SimpleSessionClient

public abstract class AbstractSimpleClientSessionCreator
extends AbstractSimpleClient
implements ClientSessionCreator

Author:

Apache MINA SSHD Project

Field Summary

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Fields inherited from interface org.apache.sshd.client.session.ClientSessionCreator

TARGET_SERVER

Fields inherited from interface org.apache.sshd.client.simple.SimpleClientConfigurator

DEFAULT_AUTHENTICATION_TIMEOUT, DEFAULT_CONNECT_TIMEOUT, DEFAULT_PORT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSimpleClientSessionCreator()
protected	AbstractSimpleClientSessionCreator(long connTimeout, long authTimeout)

Method Summary

Modifier and Type	Method	Description
protected ClientSession	authSession(ConnectFuture future, String password)
protected ClientSession	authSession(ConnectFuture future, KeyPair identity)
protected ClientSession	authSession(ClientSession clientSession)
long	getAuthenticationTimeout()
long	getConnectTimeout()
protected ClientSession	loginSession(ConnectFuture future, String password)
protected ClientSession	loginSession(ConnectFuture future, KeyPair identity)
ClientSession	sessionLogin(String uri, String password)	Creates a session and logs in using the provided credentials
ClientSession	sessionLogin(String uri, KeyPair identity)	Creates a session and logs in using the provided credentials
ClientSession	sessionLogin(SocketAddress target, String username, String password)	Creates a session and logs in using the provided credentials
ClientSession	sessionLogin(SocketAddress target, String username, KeyPair identity)	Creates a session and logs in using the provided credentials
void	setAuthenticationTimeout(long timeout)
void	setConnectTimeout(long timeout)
static SimpleClient	wrap(ClientSessionCreator creator, Channel channel)	Wraps an existing ClientSessionCreator into a SimpleClient

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Methods inherited from interface org.apache.sshd.client.session.ClientSessionCreator

connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect, connect

Methods inherited from interface org.apache.sshd.client.simple.SimpleSessionClient

sessionLogin, sessionLogin, sessionLogin, sessionLogin, sessionLogin, sessionLogin, sessionLogin, sessionLogin

Constructor Detail

AbstractSimpleClientSessionCreator

protected AbstractSimpleClientSessionCreator()

AbstractSimpleClientSessionCreator

protected AbstractSimpleClientSessionCreator(long connTimeout,
                                             long authTimeout)

Method Detail

getConnectTimeout

public long getConnectTimeout()

Specified by:

getConnectTimeout in interface SimpleClientConfigurator

Returns:

Current connect timeout (msec.) - always positive

setConnectTimeout

public void setConnectTimeout(long timeout)

Specified by:

setConnectTimeout in interface SimpleClientConfigurator

Parameters:

timeout - Requested connect timeout (msec.) - always positive

getAuthenticationTimeout

public long getAuthenticationTimeout()

Specified by:

getAuthenticationTimeout in interface SimpleClientConfigurator

Returns:

Current authentication timeout (msec.) - always positive

setAuthenticationTimeout

public void setAuthenticationTimeout(long timeout)

Specified by:

setAuthenticationTimeout in interface SimpleClientConfigurator

Parameters:

timeout - Requested authentication timeout (msec.) - always positive

sessionLogin

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

Description copied from interface: SimpleSessionClient

Creates a session and logs in using the provided credentials

Specified by:

sessionLogin in interface SimpleSessionClient

Parameters:

target - The target SocketAddress

username - Username

password - Password

Returns:

Created ClientSession

Throws:

IOException - If failed to login or authenticate

sessionLogin

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

Description copied from interface: SimpleSessionClient

Creates a session and logs in using the provided credentials

Specified by:

sessionLogin in interface SimpleSessionClient

Parameters:

target - The target SocketAddress

username - Username

identity - The KeyPair identity

Returns:

Created ClientSession

Throws:

IOException - If failed to login or authenticate

sessionLogin

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

Description copied from interface: SimpleSessionClient

Creates a session and logs in using the provided credentials

Specified by:

sessionLogin in interface SimpleSessionClient

Parameters:

uri - The target uri

password - Password

Returns:

Created ClientSession

Throws:

IOException - If failed to login or authenticate

sessionLogin

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

Description copied from interface: SimpleSessionClient

Creates a session and logs in using the provided credentials

Specified by:

sessionLogin in interface SimpleSessionClient

Parameters:

uri - The target uri

identity - The KeyPair identity

Returns:

Created ClientSession

Throws:

IOException - If failed to login or authenticate

loginSession

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

Throws:

IOException

loginSession

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

Throws:

IOException

authSession

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

Throws:

IOException

authSession

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

Throws:

IOException

authSession

protected ClientSession authSession(ClientSession clientSession)
                             throws IOException

Throws:

IOException

wrap

public static SimpleClient wrap(ClientSessionCreator creator,
                                Channel channel)

Wraps an existing ClientSessionCreator into a SimpleClient

Parameters:

creator - The ClientSessionCreator - never null

channel - The Channel representing the creator for relaying Channel.isOpen() and Channel.close() calls

Returns:

The SimpleClient wrapper. Note: closing the wrapper also closes the underlying sessions creator.