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(org.outerj.daisy.repository.Credentials credentials)
           
 void clearCaches()
          Clear caches maintained by this authentication scheme, if any.
 org.outerj.daisy.repository.user.User createUser(org.outerj.daisy.repository.Credentials crendentials, org.outerj.daisy.repository.user.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).
 java.lang.String getDescription()
           
 java.lang.String getName()
          A unique name for this authentication scheme (max.
 

Method Detail

getName

public java.lang.String getName()
A unique name for this authentication scheme (max. 50 chars).


getDescription

public java.lang.String getDescription()

check

public boolean check(org.outerj.daisy.repository.Credentials credentials)
              throws AuthenticationException
Returns:
true if authentication successful, false otherwise
Throws:
AuthenticationException - if an error occured while authenticating

clearCaches

public void clearCaches()
Clear caches maintained by this authentication scheme, if any.


createUser

public org.outerj.daisy.repository.user.User createUser(org.outerj.daisy.repository.Credentials crendentials,
                                                        org.outerj.daisy.repository.user.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


Copyright © -2005 . All Rights Reserved.