CmsLoginManager

java.lang.Object
- org.opencms.db.CmsLoginManager

```
public class CmsLoginManager
extends java.lang.Object
```
Provides functions used to check the validity of a user login.
Stores invalid login attempts and disables a user account temporarily in case the configured threshold of invalid logins is reached.
The invalid login attempt storage operates on a combination of user name, login remote IP address and user type. This means that a user can be disabled for one remote IP, but still be enabled for another remote IP.
Also allows to temporarily disallow logins (for example in case of maintenance work on the system).

从以下版本开始:

6.0.0

字段概要

字段
限定符和类型	字段和说明
`static int`	`DISABLE_MINUTES_DEFAULT` Default lock time if treshold for bad login attempts is reached.
`static boolean`	`ENABLE_SECURITY_DEFAULT` Default setting for the security option.
`static java.lang.String`	`KEY_SEPARATOR` Separator used for storage keys.
`protected int`	`m_disableMillis` The milliseconds to disable an account if the threshold is reached.
`protected int`	`m_disableMinutes` The minutes to disable an account if the threshold is reached.
`protected boolean`	`m_enableSecurity` The flag to determine if the security option ahould be enabled on the login dialog.
`protected int`	`m_maxBadAttempts` The number of bad login attempts allowed before an account is temporarily disabled.
`protected java.util.Map<java.lang.String,org.opencms.db.CmsLoginManager.CmsUserData>`	`m_storage` The storage for the bad login attempts.
`static int`	`MAX_BAD_ATTEMPTS_DEFAULT` Default for bad login attempts.

构造器概要

构造器
构造器和说明

CmsLoginManager(int disableMinutes, int maxBadAttempts, boolean enableSecurity)
Creates a new storage for invalid logins.

构造器
构造器和说明
`CmsLoginManager(int disableMinutes, int maxBadAttempts, boolean enableSecurity)` Creates a new storage for invalid logins.

方法概要

方法
限定符和类型	方法和说明
`protected void`	`addInvalidLogin(java.lang.String userName, java.lang.String remoteAddress)` Adds an invalid attempt to login for the given user / IP to the storage.
`void`	`checkInvalidLogins(java.lang.String userName, java.lang.String remoteAddress)` Checks if the threshold for the invalid logins has been reached for the given user.
`void`	`checkLoginAllowed()` Checks if a login is currently allowed.
`int`	`getDisableMinutes()` Returns the minutes an account gets disabled after too many failed login attempts.
`CmsLoginMessage`	`getLoginMessage()` Returns the current login message that is displayed if a user logs in.
`int`	`getMaxBadAttempts()` Returns the number of bad login attempts allowed before an account is temporarily disabled.
`boolean`	`isEnableSecurity()` Returns if the security option ahould be enabled on the login dialog.
`boolean`	`isUserLocked(CmsUser user)` Checks if a user is locked due to too many failed logins.
`protected void`	`removeInvalidLogins(java.lang.String userName, java.lang.String remoteAddress)` Removes all invalid attempts to login for the given user / IP.
`void`	`removeLoginMessage(CmsObject cms)` Removes the current login message.
`void`	`setLoginMessage(CmsObject cms, CmsLoginMessage message)` Sets the login message to display if a user logs in.
`void`	`unlockUser(CmsObject cms, CmsUser user)` Unlocks a user who has exceeded his number of failed login attempts so that he can try to log in again.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - DISABLE_MINUTES_DEFAULT
```
public static final int DISABLE_MINUTES_DEFAULT
```
    Default lock time if treshold for bad login attempts is reached.
    
    另请参阅:
    常量字段值
  - ENABLE_SECURITY_DEFAULT
```
public static final boolean ENABLE_SECURITY_DEFAULT
```
    Default setting for the security option.
    
    另请参阅:
    常量字段值
  - KEY_SEPARATOR
```
public static final java.lang.String KEY_SEPARATOR
```
    Separator used for storage keys.
    
    另请参阅:
    常量字段值
  - MAX_BAD_ATTEMPTS_DEFAULT
```
public static final int MAX_BAD_ATTEMPTS_DEFAULT
```
    Default for bad login attempts.
    
    另请参阅:
    常量字段值
  - m_disableMillis
```
protected int m_disableMillis
```
    The milliseconds to disable an account if the threshold is reached.
  - m_disableMinutes
```
protected int m_disableMinutes
```
    The minutes to disable an account if the threshold is reached.
  - m_enableSecurity
```
protected boolean m_enableSecurity
```
    The flag to determine if the security option ahould be enabled on the login dialog.
  - m_maxBadAttempts
```
protected int m_maxBadAttempts
```
    The number of bad login attempts allowed before an account is temporarily disabled.
  - m_storage
```
protected java.util.Map<java.lang.String,org.opencms.db.CmsLoginManager.CmsUserData> m_storage
```
    The storage for the bad login attempts.
- 构造器详细资料
  - CmsLoginManager
```
public CmsLoginManager(int disableMinutes,
               int maxBadAttempts,
               boolean enableSecurity)
```
    Creates a new storage for invalid logins.
    
    参数:
    disableMinutes - the minutes to disable an account if the threshold is reached
    maxBadAttempts - the number of bad login attempts allowed before an account is temporarily disabled
    enableSecurity - flag to determine if the security option should be enabled on the login dialog
- 方法详细资料
  - checkInvalidLogins
```
public void checkInvalidLogins(java.lang.String userName,
                      java.lang.String remoteAddress)
                        throws CmsAuthentificationException
```
    Checks if the threshold for the invalid logins has been reached for the given user.
    In case the configured threshold is reached, an Exception is thrown.
    
    参数:
    userName - the name of the user
    remoteAddress - the remote address (IP) from which the login attempt was made
    
    抛出:
    
    CmsAuthentificationException - in case the threshold of invalid login attempts has been reached
  - checkLoginAllowed
```
public void checkLoginAllowed()
                       throws CmsAuthentificationException
```
    Checks if a login is currently allowed.
    In case no logins are allowed, an Exception is thrown.
    
    抛出:
    
    CmsAuthentificationException - in case no logins are allowed
  - getDisableMinutes
```
public int getDisableMinutes()
```
    Returns the minutes an account gets disabled after too many failed login attempts.
    
    返回:
    the minutes an account gets disabled after too many failed login attempts
  - getLoginMessage
```
public CmsLoginMessage getLoginMessage()
```
    Returns the current login message that is displayed if a user logs in.
    if null is returned, no login message has been currently set.
    
    返回:
    the current login message that is displayed if a user logs in
  - getMaxBadAttempts
```
public int getMaxBadAttempts()
```
    Returns the number of bad login attempts allowed before an account is temporarily disabled.
    
    返回:
    the number of bad login attempts allowed before an account is temporarily disabled
  - isEnableSecurity
```
public boolean isEnableSecurity()
```
    Returns if the security option ahould be enabled on the login dialog.
    
    返回:
    true if the security option ahould be enabled on the login dialog, otherwise false
  - isUserLocked
```
public boolean isUserLocked(CmsUser user)
```
    Checks if a user is locked due to too many failed logins.
    
    参数:
    user - the user to check
    
    返回:
    true if the user is locked
  - removeLoginMessage
```
public void removeLoginMessage(CmsObject cms)
                        throws CmsRoleViolationException
```
    Removes the current login message.
    This operation requires that the current user has role permissions of CmsRole.ROOT_ADMIN.
    
    参数:
    cms - the current OpenCms user context
    
    抛出:
    
    CmsRoleViolationException - in case the current user does not have the required role permissions
  - setLoginMessage
```
public void setLoginMessage(CmsObject cms,
                   CmsLoginMessage message)
                     throws CmsRoleViolationException
```
    Sets the login message to display if a user logs in.
    This operation requires that the current user has role permissions of CmsRole.ROOT_ADMIN.
    
    参数:
    cms - the current OpenCms user context
    message - the message to set
    
    抛出:
    
    CmsRoleViolationException - in case the current user does not have the required role permissions
  - unlockUser
```
public void unlockUser(CmsObject cms,
              CmsUser user)
                throws CmsRoleViolationException
```
    Unlocks a user who has exceeded his number of failed login attempts so that he can try to log in again.
    This requires the "account manager" role.
    
    参数:
    cms - the current CMS context
    user - the user to unlock
    
    抛出:
    
    CmsRoleViolationException - if the permission check fails
  - addInvalidLogin
```
protected void addInvalidLogin(java.lang.String userName,
                   java.lang.String remoteAddress)
```
    Adds an invalid attempt to login for the given user / IP to the storage.
    In case the configured threshold is reached, the user is disabled for the configured time.
    
    参数:
    userName - the name of the user
    remoteAddress - the remore address (IP) from which the login attempt was made
  - removeInvalidLogins
```
protected void removeInvalidLogins(java.lang.String userName,
                       java.lang.String remoteAddress)
```
    Removes all invalid attempts to login for the given user / IP.
    
    参数:
    userName - the name of the user
    remoteAddress - the remore address (IP) from which the login attempt was made

类 CmsLoginManager

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

DISABLE_MINUTES_DEFAULT

ENABLE_SECURITY_DEFAULT

KEY_SEPARATOR

MAX_BAD_ATTEMPTS_DEFAULT

m_disableMillis

m_disableMinutes

m_enableSecurity

m_maxBadAttempts

m_storage

构造器详细资料

CmsLoginManager

方法详细资料

checkInvalidLogins

checkLoginAllowed

getDisableMinutes

getLoginMessage

getMaxBadAttempts

isEnableSecurity

isUserLocked

removeLoginMessage

setLoginMessage

unlockUser

addInvalidLogin

removeInvalidLogins