org.columba.ristretto.auth

Class AuthenticationFactory

java.lang.Object

org.columba.ristretto.auth.AuthenticationFactory

public class AuthenticationFactory
extends java.lang.Object

Factory for the AuthentictionMechanism of the SASL authentication process. New AuthenticationMechanisms can be implemented and registered with this Factory.
Ristretto supports PLAIN, LOGIN and DIGEST-MD5.
RFC(s) 2222

Author:

Timo Stich

Method Summary

Modifier and Type	Method and Description
void	addAuthentication(java.lang.String name, java.lang.Class<? extends AuthenticationMechanism> auth) Adds a new AuthenticationMechanism to the Factory.
AuthenticationMechanism	getAuthentication(java.lang.String name) Gets a new instance of the AuthenticationMechanism which implements the specified SASL mechanism.
static AuthenticationFactory	getInstance() Gets the singleton instance of the AuthenticationFactory.
java.lang.String	getSecurestMethod(java.lang.String authCapability) Gets the securest supported SASL mechanism of the specified.
java.util.List<java.lang.String>	getSupportedMechanisms() Gets a List of the supported Mechanisms.
java.util.List<java.lang.String>	getSupportedMechanisms(java.lang.String authCapa) Gets a List of the supported Mechanisms from server and client.
boolean	isSupported(java.lang.String mechanism) Checks if the specified mechanism is supported by the Factory.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static AuthenticationFactory getInstance()

Gets the singleton instance of the AuthenticationFactory.

Returns:

the singleton instance

addAuthentication

public void addAuthentication(java.lang.String name,
                              java.lang.Class<? extends AuthenticationMechanism> auth)

Adds a new AuthenticationMechanism to the Factory.

Parameters:

name - the SASL registered name of the mechanism

auth - the implementation of the SASL mechanism

getAuthentication

public AuthenticationMechanism getAuthentication(java.lang.String name)
                                          throws NoSuchAuthenticationException

Gets a new instance of the AuthenticationMechanism which implements the specified SASL mechanism.

Parameters:

name - the SASL registered name of the mechanism

Returns:

a new instance of an AuthenticationMechanism

Throws:

NoSuchAuthenticationException - if no implementation of the specified mechanism can be found

isSupported

public boolean isSupported(java.lang.String mechanism)

Checks if the specified mechanism is supported by the Factory.

Parameters:

mechanism - the SASL name of the mechanism

Returns:

true if an implementation of the mechanism is registered with this Factory.

getSupportedMechanisms

public java.util.List<java.lang.String> getSupportedMechanisms()

Gets a List of the supported Mechanisms.

Returns:

a list of the SASL registered names of the supported mechanisms.

getSupportedMechanisms

public java.util.List<java.lang.String> getSupportedMechanisms(java.lang.String authCapa)

Gets a List of the supported Mechanisms from server and client.

Parameters:

authCapa - the CAPA response from a server.

Returns:

a list of the SASL registered names of the supported mechanisms.

getSecurestMethod

public java.lang.String getSecurestMethod(java.lang.String authCapability)
                                   throws NoSuchAuthenticationException

Gets the securest supported SASL mechanism of the specified. The assumption hereby is that the given SASL mechanims are sorted securest first.

Note: This method can be convieniently used with the capability reponses from a POP3, IMAP or SMTP server.

Example:
getSecurestMethod("DIGEST-MD5 LOGIN PLAIN")
returns "DIGEST-MD5".

Parameters:

authCapability - a whitespace separated list of SASL mechanisms

Returns:

the first supported SASL mechanism

Throws:

NoSuchAuthenticationException