Package org.opencms.security

Class CmsUserLog

java.lang.Object

org.opencms.security.CmsUserLog

public class CmsUserLog
extends java.lang.Object

Class with static methods for logging user-related operations in a centralized manner.

Constructor Summary

Constructors

Constructor	Description
CmsUserLog()

Method Summary

Modifier and Type	Method	Description
static void	logLogin(CmsObject cms, java.lang.String user)	Logs a successful login.
static void	logLoginFailure(CmsObject cms, java.lang.String user)	Logs a login failure.
static void	logLogout(CmsObject cms)	Logs a successful logout.
static void	logPasswordChange(CmsObject cms, java.lang.String user)	Logs a password change.
static void	logPasswordChangeForRequestedReset(CmsObject cms, java.lang.String user)	Logs a password change originally requested through the 'reset password' button.
static void	logPasswordResetRequest(CmsObject cms, java.lang.String user)	Logs a password reset request.
static void	logSecondFactorAdded(CmsRequestContext requestContext, java.lang.String name)	Logs when a second factor was added.
static void	logSecondFactorInfoModified(CmsRequestContext requestContext, java.lang.String name)	Logs when a second factor was modified.
static void	logSecondFactorReset(CmsRequestContext requestContext, java.lang.String name)	Logs when a second factor was removed.
static void	logSetForceResetPassword(CmsObject cms, java.lang.String user)	Logs that the 'force reset password' status was set on a user.
static void	logSwitchUser(CmsObject cms, java.lang.String name)	Logs a user switch.

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsUserLog

public CmsUserLog()

Method Detail

logLogin

public static void logLogin(CmsObject cms,
                            java.lang.String user)

Logs a successful login.

Parameters:

cms - the CMS context

user - the name of the user

logLoginFailure

public static void logLoginFailure(CmsObject cms,
                                   java.lang.String user)

Logs a login failure.

Parameters:

cms - the CMS context

user - the name of the user

logLogout

public static void logLogout(CmsObject cms)

Logs a successful logout.

Parameters:

cms - the CMS context

logPasswordChange

public static void logPasswordChange(CmsObject cms,
                                     java.lang.String user)

Logs a password change.

Parameters:

cms - the CMS context

user - the user name

logPasswordChangeForRequestedReset

public static void logPasswordChangeForRequestedReset(CmsObject cms,
                                                      java.lang.String user)

Logs a password change originally requested through the 'reset password' button.

Parameters:

cms - the CMS context

user - the user name

logPasswordResetRequest

public static void logPasswordResetRequest(CmsObject cms,
                                           java.lang.String user)

Logs a password reset request.

Parameters:

cms - the CMS context

user - the user name

logSecondFactorAdded

public static void logSecondFactorAdded(CmsRequestContext requestContext,
                                        java.lang.String name)

Logs when a second factor was added.

Parameters:

requestContext - the request context

name - the user name

logSecondFactorInfoModified

public static void logSecondFactorInfoModified(CmsRequestContext requestContext,
                                               java.lang.String name)

Logs when a second factor was modified.

Parameters:

requestContext - the request context

name - the user name

logSecondFactorReset

public static void logSecondFactorReset(CmsRequestContext requestContext,
                                        java.lang.String name)

Logs when a second factor was removed.

Parameters:

requestContext - the request context

name - the user name

logSetForceResetPassword

public static void logSetForceResetPassword(CmsObject cms,
                                            java.lang.String user)

Logs that the 'force reset password' status was set on a user.

Parameters:

cms - the CMS context

user - the user name

logSwitchUser

public static void logSwitchUser(CmsObject cms,
                                 java.lang.String name)

Logs a user switch.

Parameters:

cms - the current CMS context

name - the name of the user to switch to