Class BasicAuthentication<P,T>

java.lang.Object

org.apache.sshd.client.session.proxy.AbstractAuthenticationHandler<P,T>

org.apache.sshd.client.session.proxy.BasicAuthentication<P,T>

Type Parameters:

P - defining the parameter type for the authentication

T - defining the token type for the authentication

All Implemented Interfaces:

Closeable, AutoCloseable, AuthenticationHandler<P,T>

public abstract class BasicAuthentication<P,T>
extends AbstractAuthenticationHandler<P,T>

An abstract implementation of a username-password authentication. It can be given an initial known username-password pair; if so, this will be tried first. Subsequent rounds will then try to obtain a user name and password via the global Authenticator.

Field Summary

Fields

Modifier and Type	Field	Description
protected byte[]	password	The current password.
protected String	user	The current user name.

Fields inherited from class AbstractAuthenticationHandler

done, params, proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BasicAuthentication(InetSocketAddress proxy, String initialUser, char[] initialPassword)	Creates a new BasicAuthentication to authenticate with the given proxy.

Method Summary

Modifier and Type	Method	Description
protected void	askCredentials()	Asks for credentials via the global Authenticator.
protected void	clearPassword()	Clears the password.
final void	close()
protected abstract PasswordAuthentication	getCredentials()
void	process()	Produces the next authentication token, if any.
final void	start()	Produces the initial authentication token that can be then retrieved via AuthenticationHandler.getToken().

Methods inherited from class AbstractAuthenticationHandler

isDone, setParams

Methods inherited from class Object

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

Methods inherited from interface AuthenticationHandler

getToken

Field Details

user

protected String user

The current user name.

password

protected byte[] password

The current password.

Constructor Details

BasicAuthentication

protected BasicAuthentication(InetSocketAddress proxy,
 String initialUser,
 char[] initialPassword)

Creates a new BasicAuthentication to authenticate with the given proxy.

Parameters:

proxy - InetSocketAddress of the proxy to connect to

initialUser - initial user name to try; may be null

initialPassword - initial password to try, may be null

Method Details

clearPassword

protected void clearPassword()

Clears the password.

close

public final void close()

start

public final void start()
                 throws IOException

Description copied from interface: AuthenticationHandler

Produces the initial authentication token that can be then retrieved via AuthenticationHandler.getToken().

Throws:

IOException

process

public void process()
             throws Exception

Description copied from interface: AuthenticationHandler

Produces the next authentication token, if any.

Throws:

Exception - if an error occurs

askCredentials

protected void askCredentials()

Asks for credentials via the global Authenticator.

getCredentials

protected abstract PasswordAuthentication getCredentials()