org.outerj.daisy.authentication
Interface AuthenticationScheme

All Known Implementing Classes:

CachingAuthenticationScheme

public interface AuthenticationScheme

A means to do password-based authentication.

Method Summary

boolean	check(Credentials credentials)
void	clearCaches() Clear caches maintained by this authentication scheme, if any.
User	createUser(Credentials crendentials, UserManager userManager) If a user does not exist, the authentication scheme can be offered the possibility to create the user (this is defined in the configuration of the UserAuthenticator).
String	getDescription()
String	getName() A unique name for this authentication scheme (max.

Method Detail

getName

String getName()

A unique name for this authentication scheme (max. 50 chars).

getDescription

String getDescription()

check

boolean check(Credentials credentials)
              throws AuthenticationException

Returns:

true if authentication successful, false otherwise

Throws:

AuthenticationException - if an error occured while authenticating

clearCaches

void clearCaches()

Clear caches maintained by this authentication scheme, if any.

createUser

User createUser(Credentials crendentials,
                UserManager userManager)
                throws AuthenticationException

If a user does not exist, the authentication scheme can be offered the possibility to create the user (this is defined in the configuration of the UserAuthenticator). It is up to the implementation of this method to check the credentials are ok.

Throws:

AuthenticationException