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:

java.io.Closeable, java.lang.AutoCloseable, java.nio.channels.Channel, ClientSessionHolder, PropertyResolver, Service, SessionContextHolder, SessionHolder<Session>

public class ClientUserAuthService
extends AbstractCloseable
implements Service, ClientSessionHolder

Client side ssh-auth service.

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 java.util.List<UserAuthFactory>	authFactories
protected java.util.concurrent.atomic.AtomicReference<AuthFuture>	authFutureHolder The AuthFuture that is being used by the current auth request.
protected java.util.List<java.lang.String>	clientMethods
protected ClientSessionImpl	clientSession
private int	currentMethod
private java.lang.Runnable	initialRequestSender
private java.lang.Object	initLock
private java.util.Map<java.lang.String,java.lang.Object>	properties
protected java.util.List<java.lang.String>	serverMethods
private java.lang.String	service
private boolean	started
private UserAuth	userAuth

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(java.lang.String service)
protected AuthFuture	createAuthFuture(ClientSession session, java.lang.String service)
ClientSession	getClientSession()
java.lang.String	getCurrentServiceName()
java.util.Map<java.lang.String,java.lang.Object>	getProperties() A map of properties that can be used to configure the SSH server or client.
ClientSession	getSession()
protected void	preClose() preClose is guaranteed to be called before doCloseGracefully or doCloseImmediately.
void	process(int cmd, Buffer buffer) Service the request.
protected void	processUserAuth(Buffer buffer) Execute one step in user authentication.
protected IoWriteFuture	sendInitialAuthRequest(ClientSession session, java.lang.String service)
void	start()
protected void	tryNext(int cmd)
protected AuthFuture	updateCurrentAuthFuture(ClientSession session, java.lang.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 java.util.concurrent.atomic.AtomicReference<AuthFuture> authFutureHolder

The AuthFuture that is being used by the current auth request. This encodes the state. isSuccess -> authenticated, else if isDone -> server waiting for user auth, else authenticating.

clientSession

protected final ClientSessionImpl clientSession

authFactories

protected final java.util.List<UserAuthFactory> authFactories

clientMethods

protected final java.util.List<java.lang.String> clientMethods

serverMethods

protected java.util.List<java.lang.String> serverMethods

properties

private final java.util.Map<java.lang.String,java.lang.Object> properties

service

private java.lang.String service

userAuth

private UserAuth userAuth

currentMethod

private int currentMethod

initLock

private final java.lang.Object initLock

started

private boolean started

initialRequestSender

private java.lang.Runnable initialRequestSender

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 java.util.Map<java.lang.String,java.lang.Object> getProperties()

Description copied from interface: PropertyResolver

A map of properties that can be used to configure the SSH server or client. This map will never be changed by either the server or client and is not supposed to be changed at runtime (changes are not bound to have any effect on a running client or server), though it may affect the creation of sessions later as these values are usually not cached.

Note: the type of the mapped property should match the expected configuration value type - Long, Integer, Boolean, String, etc.... If it doesn't, the toString() result of the mapped value is used to convert it to the required type. E.g., if the mapped value is the string "1234" and the expected value is a long then it will be parsed into one. Also, if the mapped value is an Integer but a long is expected, then it will be converted into one.

Specified by:

getProperties in interface PropertyResolver

Returns:

a valid Map containing configuration values, never null. Note: may be immutable.

start

public void start()

Specified by:

start in interface Service

getCurrentServiceName

public java.lang.String getCurrentServiceName()

auth

public AuthFuture auth(java.lang.String service)
                throws java.io.IOException

Throws:

java.io.IOException

updateCurrentAuthFuture

protected AuthFuture updateCurrentAuthFuture(ClientSession session,
                                             java.lang.String service)
                                      throws java.io.IOException

Throws:

java.io.IOException

createAuthFuture

protected AuthFuture createAuthFuture(ClientSession session,
                                      java.lang.String service)
                               throws java.io.IOException

Throws:

java.io.IOException

sendInitialAuthRequest

protected IoWriteFuture sendInitialAuthRequest(ClientSession session,
                                               java.lang.String service)
                                        throws java.io.IOException

Throws:

java.io.IOException

process

public void process(int cmd,
                    Buffer buffer)
             throws java.lang.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:

java.lang.Exception - If failed to process the command

processUserAuth

protected void processUserAuth(Buffer buffer)
                        throws java.lang.Exception

Execute one step in user authentication.

Parameters:

buffer - The input Buffer

Throws:

java.lang.Exception - If failed to process

tryNext

protected void tryNext(int cmd)
                throws java.lang.Exception

Throws:

java.lang.Exception

preClose

protected void preClose()

Description copied from class: AbstractCloseable

preClose is guaranteed to be called before doCloseGracefully or doCloseImmediately. When preClose() is called, isClosing() == true

Overrides:

preClose in class AbstractCloseable