Package org.apache.sshd.client.auth

Class AbstractUserAuth

java.lang.Object

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

org.apache.sshd.client.auth.AbstractUserAuth

All Implemented Interfaces:

UserAuth, ClientSessionHolder, UserAuthInstance<ClientSession>, NamedResource

Direct Known Subclasses:

UserAuthHostBased, UserAuthKeyboardInteractive, UserAuthPassword, UserAuthPublicKey

public abstract class AbstractUserAuth
extends AbstractLoggingBean
implements UserAuth

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	cancellable
private ClientSession	clientSession
private java.lang.String	name
private java.lang.String	service

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

log

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

BY_NAME_COMPARATOR, NAME_EXTRACTOR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractUserAuth(java.lang.String name)

Method Summary

Modifier and Type	Method	Description
void	destroy()	Called to release any allocated resources
ClientSession	getClientSession()
java.lang.String	getName()
java.lang.String	getService()
ClientSession	getSession()
void	init(ClientSession session, java.lang.String service)
boolean	isCancellable()	Tells whether the authentication protocol is cancellable currently.
boolean	process(Buffer buffer)
protected abstract boolean	processAuthDataRequest(ClientSession session, java.lang.String service, Buffer buffer)
protected abstract boolean	sendAuthDataRequest(ClientSession session, java.lang.String service)
protected void	setCancellable(boolean cancellable)	Sets whether the authentication protocol is currently cancellable.
java.lang.String	toString()

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, wait, wait, wait

Methods inherited from interface org.apache.sshd.client.auth.UserAuth

signalAuthMethodFailure, signalAuthMethodSuccess

Field Detail

name

private final java.lang.String name

clientSession

private ClientSession clientSession

service

private java.lang.String service

cancellable

private boolean cancellable

Constructor Detail

AbstractUserAuth

protected AbstractUserAuth(java.lang.String name)

Method Detail

getClientSession

public ClientSession getClientSession()

Specified by:

getClientSession in interface ClientSessionHolder

Returns:

The underlying ClientSession used

getSession

public ClientSession getSession()

Specified by:

getSession in interface UserAuthInstance<ClientSession>

Returns:

The current session for which the authentication is being tracked. Note: may be null if the instance has not been initialized yet

getName

public final java.lang.String getName()

Specified by:

getName in interface NamedResource

Returns:

The resource name

getService

public java.lang.String getService()

isCancellable

public boolean isCancellable()

Description copied from interface: UserAuth

Tells whether the authentication protocol is cancellable currently.

Specified by:

isCancellable in interface UserAuth

Returns:

true if the protocol can be canceled at its current state; false if not.

setCancellable

protected void setCancellable(boolean cancellable)

Sets whether the authentication protocol is currently cancellable.

Parameters:

cancellable - true if the protocol may be canceled in its current state; false if not

init

public void init(ClientSession session,
                 java.lang.String service)
          throws java.lang.Exception

Specified by:

init in interface UserAuth

Parameters:

session - The ClientSession

service - The requesting service name

Throws:

java.lang.Exception - If failed to initialize the mechanism

process

public boolean process(Buffer buffer)
                throws java.lang.Exception

Specified by:

process in interface UserAuth

Parameters:

buffer - The Buffer to process - null if not a response buffer, i.e., the underlying authentication mechanism should initiate whatever challenge/response mechanism is required

Returns:

true if request handled - false if the next authentication mechanism should be used

Throws:

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

sendAuthDataRequest

protected abstract boolean sendAuthDataRequest(ClientSession session,
                                               java.lang.String service)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

processAuthDataRequest

protected abstract boolean processAuthDataRequest(ClientSession session,
                                                  java.lang.String service,
                                                  Buffer buffer)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

destroy

public void destroy()

Description copied from interface: UserAuth

Called to release any allocated resources

Specified by:

destroy in interface UserAuth

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object