org.apache.sshd.client.session

Class ClientUserAuthService

java.lang.Object

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

org.apache.sshd.common.util.closeable.IoBaseCloseable

org.apache.sshd.common.util.closeable.AbstractCloseable

org.apache.sshd.client.session.ClientUserAuthService

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, ClientSessionHolder, PropertyResolver, Service, SessionContextHolder, SessionHolder<Session>

public class ClientUserAuthService
extends AbstractCloseable
implements Service, ClientSessionHolder

Client side ssh-auth service.

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

AbstractCloseable.State

Field Summary

Fields

Modifier and Type	Field and Description
protected List<UserAuthFactory>	authFactories
protected AtomicReference<AuthFuture>	authFutureHolder The AuthFuture that is being used by the current auth request.
protected List<String>	clientMethods
protected ClientSessionImpl	clientSession
protected List<String>	serverMethods

Fields inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

closeFuture, futureLock, state

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

log

Fields inherited from interface org.apache.sshd.common.PropertyResolver

EMPTY

Constructor Summary

Constructors

Constructor and Description
ClientUserAuthService(Session s)

Method Summary

Modifier and Type	Method and Description
AuthFuture	auth(String service)
protected AuthFuture	createAuthFuture(ClientSession session, String service)
ClientSession	getClientSession()
String	getCurrentServiceName()
Map<String,Object>	getProperties()
ClientSession	getSession()
protected void	preClose()
void	process(int cmd, Buffer buffer) Service the request.
protected void	processUserAuth(int cmd, Buffer buffer, AuthFuture authFuture) Execute one step in user authentication.
protected IoWriteFuture	sendInitialAuthRequest(ClientSession session, String service)
void	start()
protected void	tryNext(int cmd, AuthFuture authFuture)
protected AuthFuture	updateCurrentAuthFuture(ClientSession session, String service)

Methods inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable

addCloseFutureListener, builder, close, doCloseGracefully, doCloseImmediately, getFutureLock, isClosed, isClosing, removeCloseFutureListener

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 org.apache.sshd.common.Service

getParentPropertyResolver

Methods inherited from interface org.apache.sshd.common.session.SessionHolder

getSessionContext

Methods inherited from interface org.apache.sshd.common.PropertyResolver

getBoolean, getBooleanProperty, getCharset, getInteger, getIntProperty, getLong, getLongProperty, getObject, getString, getStringProperty, isEmpty, isEmpty

Methods inherited from interface org.apache.sshd.common.Closeable

addCloseFutureListener, close, close, close, getMaxCloseWaitTime, isClosed, isClosing, isOpen, removeCloseFutureListener

Field Detail

authFutureHolder

protected final AtomicReference<AuthFuture> authFutureHolder

The AuthFuture that is being used by the current auth request. It is set while an authentication is ongoing.

clientSession

protected final ClientSessionImpl clientSession

authFactories

protected final List<UserAuthFactory> authFactories

clientMethods

protected final List<String> clientMethods

serverMethods

protected List<String> serverMethods

Constructor Detail

ClientUserAuthService

public ClientUserAuthService(Session s)

Method Detail

getSession

public ClientSession getSession()

Specified by:

getSession in interface SessionHolder<Session>

getClientSession

public ClientSession getClientSession()

Specified by:

getClientSession in interface ClientSessionHolder

Returns:

The underlying ClientSession used

getProperties

public Map<String,Object> getProperties()

Specified by:

getProperties in interface PropertyResolver

start

public void start()

Specified by:

start in interface Service

getCurrentServiceName

public String getCurrentServiceName()

auth

public AuthFuture auth(String service)
                throws IOException

Throws:

IOException

updateCurrentAuthFuture

protected AuthFuture updateCurrentAuthFuture(ClientSession session,
                                             String service)
                                      throws IOException

Throws:

IOException

createAuthFuture

protected AuthFuture createAuthFuture(ClientSession session,
                                      String service)
                               throws IOException

Throws:

IOException

sendInitialAuthRequest

protected IoWriteFuture sendInitialAuthRequest(ClientSession session,
                                               String service)
                                        throws IOException

Throws:

IOException

process

public void process(int cmd,
                    Buffer buffer)
             throws Exception

Description copied from interface: Service

Service the request.

Specified by:

process in interface Service

Parameters:

cmd - The incoming command type

buffer - The Buffer containing optional command parameters

Throws:

Exception - If failed to process the command

processUserAuth

protected void processUserAuth(int cmd,
                               Buffer buffer,
                               AuthFuture authFuture)
                        throws Exception

Execute one step in user authentication.

Parameters:

cmd - the command

buffer - the input Buffer, with the reading position after the command byte

authFuture - the AuthFuture

Throws:

Exception - If failed to process

tryNext

protected void tryNext(int cmd,
                       AuthFuture authFuture)
                throws Exception

Throws:

Exception

preClose

protected void preClose()

Overrides:

preClose in class AbstractCloseable