com.atlassian.jira.security.login

Class RecoveryLoginStore

java.lang.Object

com.atlassian.jira.security.login.RecoveryLoginStore

All Implemented Interfaces:

LoginStore

public class RecoveryLoginStore
extends Object
implements LoginStore

A login LoginStore for the 'recovery admin'. The login information for other users is passed to a delegate to handle.

Since:

7.0

See Also:

RecoveryMode

Constructor Summary

Constructors

Constructor and Description
RecoveryLoginStore(RecoveryMode mode, LoginStore delegate, com.atlassian.core.util.Clock clock)

Method Summary

Modifier and Type	Method and Description
LoginInfo	getLoginInfo(ApplicationUser user) Called to get the login information about a user
long	getMaxAuthenticationAttemptsAllowed() This returns the maximum failed authentications attempts that the user can perform after which they will be asked for extra elevated security information
LoginInfo	recordLoginAttempt(ApplicationUser user, boolean authenticated) This will record that fact the user authenticated or not
void	resetFailedLoginCount(ApplicationUser user) This can be called to reset the failed login count of a user

Methods inherited from class java.lang.Object

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

Constructor Detail

RecoveryLoginStore

public RecoveryLoginStore(RecoveryMode mode,
                          LoginStore delegate,
                          com.atlassian.core.util.Clock clock)

Method Detail

getLoginInfo

public LoginInfo getLoginInfo(ApplicationUser user)

Description copied from interface: LoginStore

Called to get the login information about a user

Specified by:

getLoginInfo in interface LoginStore

Parameters:

user - the user in play. This MUST not be null.

Returns:

a non null LoginInfo object

recordLoginAttempt

public LoginInfo recordLoginAttempt(ApplicationUser user,
                                    boolean authenticated)

Description copied from interface: LoginStore

This will record that fact the user authenticated or not

Specified by:

recordLoginAttempt in interface LoginStore

Parameters:

user - the user in play. This MUST not be null.

authenticated - set to true if they authenticated ok or false otherwise

Returns:

a non null LoginInfo object

getMaxAuthenticationAttemptsAllowed

public long getMaxAuthenticationAttemptsAllowed()

Description copied from interface: LoginStore

This returns the maximum failed authentications attempts that the user can perform after which they will be asked for extra elevated security information

Specified by:

getMaxAuthenticationAttemptsAllowed in interface LoginStore

Returns:

the maximum authentication attempts allowed.

resetFailedLoginCount

public void resetFailedLoginCount(ApplicationUser user)

Description copied from interface: LoginStore

This can be called to reset the failed login count of a user

Specified by:

resetFailedLoginCount in interface LoginStore

Parameters:

user - the user to authorise. This MUST not be null.