Package ch.astorm.smtp4j.auth

Class XOAuth2AuthenticationHandler

java.lang.Object

ch.astorm.smtp4j.auth.XOAuth2AuthenticationHandler

All Implemented Interfaces:

SmtpAuthenticatorHandler

public class XOAuth2AuthenticationHandler
extends Object
implements SmtpAuthenticatorHandler

Handles XOAUTH2 authentication scheme. See here.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
XOAuth2AuthenticationHandler()

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.
void	setSessionProperties(Properties properties, SmtpServerOptions options)	Callback to allow this authenticator to inject properties for the Session if needed.

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE

public static XOAuth2AuthenticationHandler INSTANCE

Singleton instance of this handler.

Constructor Details

XOAuth2AuthenticationHandler

public XOAuth2AuthenticationHandler()

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

setSessionProperties

public void setSessionProperties(Properties properties,
 SmtpServerOptions options)

Description copied from interface: SmtpAuthenticatorHandler

Callback to allow this authenticator to inject properties for the Session if needed.

Specified by:

setSessionProperties in interface SmtpAuthenticatorHandler

Parameters:

properties - The session properties.

options - The options.