com.communote.server.core.security

Interface AuthenticationManagement

All Known Implementing Classes:

AuthenticationManagementBase, AuthenticationManagementImpl

public interface AuthenticationManagement

Service methods for user authentication.

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
UserDetails	checkLocalUserPasswordOnLogin(String username, String password) Check the password of a local user for a match with a given clear text password.
User	onSuccessfulAuthentication(org.springframework.security.core.Authentication successAuthentication) This method finalizes the login process of a user.
void	onSuccessfulAuthentication(Long userId) This method finalizes the login process of a user.
void	onUsernamePasswordAuthenticationFailed(String username) Should be called if a username and password authentication for a user failed because of a wrong password.
void	onUsernamePasswordAuthenticationFailed(String externalUserId, String externalSystemId) Should be called if a username and password authentication for a user failed because of a wrong password.
void	validateUserLogin(Long userId) Does additional login checks.

Method Detail

checkLocalUserPasswordOnLogin

UserDetails checkLocalUserPasswordOnLogin(String username,
                                          String password)
                                   throws UserNotFoundException,
                                          AccountNotActivatedException,
                                          AuthAgainstInternalDBWhileExternalUserAccountException

Check the password of a local user for a match with a given clear text password. This method should be called as part of the login process of a local user to validate the password and do some additional tests. A local user is a user who wasn't provided by the active primary external user repository.

Parameters:

username - the login name which can be the alias or the email address of the user

password - the clear text password to test against

Returns:

the user details of the user or null if the password check failed

Throws:

UserNotFoundException - in case the user does not exist

AccountNotActivatedException - in case the user account is not active

AuthAgainstInternalDBWhileExternalUserAccountException - in case the user was provided by the active primary external user repository

Since:

3.5

onSuccessfulAuthentication

User onSuccessfulAuthentication(org.springframework.security.core.Authentication successAuthentication)

This method finalizes the login process of a user. It uses the given user to create the authentication and logs the user in by setting the security context. This method assumes that the user is valid and authenticated.

Note: This method assumes that there is NO existing transaction. If there is a current transaction it will fail!

Parameters:

successAuthentication - the authentication to be used. it should contain UserDetails in most of the cases

Returns:

the user authenticated

onSuccessfulAuthentication

void onSuccessfulAuthentication(Long userId)
                         throws UserNotFoundException

This method finalizes the login process of a user. It uses the given user to create the authentication and logs the user in by setting the security context. This method assumes that the user is valid and authenticated.

Note: This method assumes that there is NO existing transaction. If there is a current transaction it will fail!

Parameters:

userId - ID of the user

Throws:

UserNotFoundException - if the user does not exist

onUsernamePasswordAuthenticationFailed

void onUsernamePasswordAuthenticationFailed(String username)

Should be called if a username and password authentication for a user failed because of a wrong password.

Parameters:

username - the internal login name (e-mail or alias) of the user whose authentication failed

onUsernamePasswordAuthenticationFailed

void onUsernamePasswordAuthenticationFailed(String externalUserId,
                                            String externalSystemId)

Should be called if a username and password authentication for a user failed because of a wrong password.

Parameters:

externalUserId - the login name of the user in the external system whose authentication failed

externalSystemId - the ID of the external system

validateUserLogin

void validateUserLogin(Long userId)
                throws AccountPermanentlyLockedException,
                       AccountTemporarilyLockedException,
                       AccountNotActivatedException,
                       TermsNotAcceptedException,
                       UserNotFoundException,
                       AccountPermanentlyDisabledException,
                       AccountTemporarilyDisabledException

Does additional login checks. This includes testing whether the account is locked, the user is active and has accepted the terms of use. If one of the login checks fails an appropriate exception will be thrown.

Parameters:

userId - the Id of the user

Throws:

AccountPermanentlyLockedException

AccountTemporarilyLockedException

AccountNotActivatedException

TermsNotAcceptedException

UserNotFoundException

AccountPermanentlyDisabledException

AccountTemporarilyDisabledException