Package ch.astorm.smtp4j.auth

Class PlainAuthenticationHandler

java.lang.Object

ch.astorm.smtp4j.auth.PlainAuthenticationHandler

All Implemented Interfaces:

SmtpAuthenticatorHandler

public class PlainAuthenticationHandler
extends Object
implements SmtpAuthenticatorHandler

Handles PLAIN authentication scheme. See here.

Field Summary

Fields

Modifier and Type	Field	Description
static PlainAuthenticationHandler	INSTANCE	Singleton instance of this handler.

Method Summary

Modifier and Type	Method	Description
boolean	authenticate(SmtpCommand command, SmtpExchangeHandler exchangeHandler, SmtpServerOptions options)	Authenticates the client.
String	getName()	Returns the name of the SMTP authentication protocol.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.astorm.smtp4j.auth.SmtpAuthenticatorHandler

setSessionProperties

Field Details

INSTANCE

public static PlainAuthenticationHandler INSTANCE

Singleton instance of this handler.

Method Details

getName

public String getName()

Description copied from interface: SmtpAuthenticatorHandler

Returns the name of the SMTP authentication protocol.

Specified by:

getName in interface SmtpAuthenticatorHandler

Returns:

The protocol name, for instance PLAIN.

authenticate

public boolean authenticate(SmtpCommand command,
 SmtpExchangeHandler exchangeHandler,
 SmtpServerOptions options)
                     throws SmtpProtocolException

Description copied from interface: SmtpAuthenticatorHandler

Authenticates the client.

Specified by:

authenticate in interface SmtpAuthenticatorHandler

Parameters:

command - The initial AUTH command with its parameters.

exchangeHandler - The exchange handler if challenge responses from the client is needed.

options - The options.

Returns:

true if the user has been authenticated, false otherwise (invalid credentials).

Throws:

SmtpProtocolException