com.communote.server.core.security

Class AuthenticationManagementBase

java.lang.Object

com.communote.server.core.security.AuthenticationManagementBase

All Implemented Interfaces:

AuthenticationManagement

Direct Known Subclasses:

AuthenticationManagementImpl

@Transactional(propagation=REQUIRED)
public abstract class AuthenticationManagementBase
extends Object
implements AuthenticationManagement

Spring Service base class for com.communote.server.core.api.security.AuthenticationManagement, provides access to all services and entities referenced by this service.

Author:

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

See Also:

AuthenticationManagement

Constructor Summary

Constructors

Constructor and Description
AuthenticationManagementBase()

Method Summary

Modifier and Type	Method and Description
protected abstract User	handleOnSuccessfulAuthentication(org.springframework.security.core.Authentication authentication) Performs the core logic for onSuccessfulAuthentication(Authentication)
protected abstract void	handleOnSuccessfulAuthentication(Long userId)
protected abstract void	handleValidateUserLogin(Long userId)
User	onSuccessfulAuthentication(org.springframework.security.core.Authentication authentication) This method finalizes the login process of a user.
void	onSuccessfulAuthentication(Long userId) This method finalizes the login process of a user.
void	validateUserLogin(Long userId) Does additional login checks.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.communote.server.core.security.AuthenticationManagement

checkLocalUserPasswordOnLogin, onUsernamePasswordAuthenticationFailed, onUsernamePasswordAuthenticationFailed

Constructor Detail

AuthenticationManagementBase

public AuthenticationManagementBase()

Method Detail

handleOnSuccessfulAuthentication

protected abstract User handleOnSuccessfulAuthentication(org.springframework.security.core.Authentication authentication)

Performs the core logic for onSuccessfulAuthentication(Authentication)

handleOnSuccessfulAuthentication

protected abstract void handleOnSuccessfulAuthentication(Long userId)
                                                  throws UserNotFoundException

Throws:

UserNotFoundException

handleValidateUserLogin

protected abstract void handleValidateUserLogin(Long userId)
                                         throws AccountPermanentlyLockedException,
                                                AccountTemporarilyLockedException,
                                                AccountNotActivatedException,
                                                TermsNotAcceptedException,
                                                UserNotFoundException,
                                                AccountPermanentlyDisabledException,
                                                AccountTemporarilyDisabledException

Throws:

AccountPermanentlyLockedException

AccountTemporarilyLockedException

AccountNotActivatedException

TermsNotAcceptedException

UserNotFoundException

AccountPermanentlyDisabledException

AccountTemporarilyDisabledException

onSuccessfulAuthentication

@Transactional(propagation=NEVER)
public User onSuccessfulAuthentication(org.springframework.security.core.Authentication authentication)

Description copied from interface: AuthenticationManagement

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!

Specified by:

onSuccessfulAuthentication in interface AuthenticationManagement

Parameters:

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

Returns:

the user authenticated

onSuccessfulAuthentication

public void onSuccessfulAuthentication(Long userId)
                                throws UserNotFoundException

Description copied from interface: AuthenticationManagement

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!

Specified by:

onSuccessfulAuthentication in interface AuthenticationManagement

Parameters:

userId - ID of the user

Throws:

UserNotFoundException - if the user does not exist

validateUserLogin

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

Description copied from interface: AuthenticationManagement

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.

Specified by:

validateUserLogin in interface AuthenticationManagement

Parameters:

userId - the Id of the user

Throws:

AccountPermanentlyLockedException

AccountTemporarilyLockedException

AccountNotActivatedException

TermsNotAcceptedException

UserNotFoundException

AccountPermanentlyDisabledException

AccountTemporarilyDisabledException