org.apache.geronimo.javamail.authentication
Class LoginAuthenticator

java.lang.Object
  org.apache.geronimo.javamail.authentication.LoginAuthenticator

All Implemented Interfaces:

ClientAuthenticator

public class LoginAuthenticator
extends Object
implements ClientAuthenticator

Field Summary

protected static int	COMPLETE
protected String	password
protected static int	PASSWORD
protected int	stage
protected String	username
protected static int	USERNAME

Constructor Summary

LoginAuthenticator(String username, String password)
Main constructor.

Method Summary

byte[]	evaluateChallenge(byte[] challenge) Evaluate a PLAIN login challenge, returning the a result string that should satisfy the clallenge.
String	getMechanismName() Retrieve the authenticator mechanism name.
boolean	hasInitialResponse() Respond to the hasInitialResponse query.
boolean	isComplete() Indicate whether the challenge/response process is complete.

Methods inherited from class java.lang.Object

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

Field Detail

USERNAME

protected static final int USERNAME

See Also:

Constant Field Values

PASSWORD

protected static final int PASSWORD

See Also:

Constant Field Values

COMPLETE

protected static final int COMPLETE

See Also:

Constant Field Values

username

protected String username

password

protected String password

stage

protected int stage

Constructor Detail

LoginAuthenticator

public LoginAuthenticator(String username,
                          String password)

Main constructor.

Parameters:

username - The login user name.

password - The login password.

Method Detail

hasInitialResponse

public boolean hasInitialResponse()

Respond to the hasInitialResponse query. This mechanism does not have an initial response.

Specified by:

hasInitialResponse in interface ClientAuthenticator

Returns:

Always returns false;

isComplete

public boolean isComplete()

Indicate whether the challenge/response process is complete.

Specified by:

isComplete in interface ClientAuthenticator

Returns:

True if the last challenge has been processed, false otherwise.

getMechanismName

public String getMechanismName()

Retrieve the authenticator mechanism name.

Specified by:

getMechanismName in interface ClientAuthenticator

Returns:

Always returns the string "LOGIN"

evaluateChallenge

public byte[] evaluateChallenge(byte[] challenge)
                         throws MessagingException

Evaluate a PLAIN login challenge, returning the a result string that should satisfy the clallenge.

Specified by:

evaluateChallenge in interface ClientAuthenticator

Parameters:

challenge - The decoded challenge data, as a byte array

Returns:

A formatted challege response, as an array of bytes.

Throws:

MessagingException