com.haulmont.cuba.security.app

Class UserSessionLogBean

java.lang.Object

com.haulmont.cuba.security.app.UserSessionLogBean

All Implemented Interfaces:

UserSessionLog

@Component(value="cuba_SessionHistory")
public class UserSessionLogBean
extends java.lang.Object
implements UserSessionLog

Field Summary

Fields inherited from interface com.haulmont.cuba.security.app.UserSessionLog

NAME

Constructor Summary

Constructors

Constructor and Description
UserSessionLogBean()

Method Summary

Modifier and Type	Method and Description
SessionLogEntry	createSessionLogRecord(UserSession userSession, SessionAction action, java.util.Map<java.lang.String,java.lang.Object> params) Create log entry for session with custom params.
SessionLogEntry	createSessionLogRecord(UserSession userSession, SessionAction action, UserSession substitutedSession, java.util.Map<java.lang.String,java.lang.Object> params) Create log entry for session with custom params.
java.util.List<SessionLogEntry>	getAllSessionLogRecords(java.util.UUID userSessionId) Get all session log records.
SessionLogEntry	getLastSessionLogRecord(java.util.UUID userSessionId) Get latest session log record.
SessionLogEntry	updateSessionLogRecord(UserSession userSession, SessionAction action) Updates params on provided session log record.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserSessionLogBean

public UserSessionLogBean()

Method Detail

createSessionLogRecord

@Nullable
public SessionLogEntry createSessionLogRecord(UserSession userSession,
                                                        SessionAction action,
                                                        java.util.Map<java.lang.String,java.lang.Object> params)

Description copied from interface: UserSessionLog

Create log entry for session with custom params.

Specified by:

createSessionLogRecord in interface UserSessionLog

Parameters:

userSession - log entry is created for this session

action - session action, like login, logout, etc

params - additional params for log entry, like client's address and other info. Use id property of SessionParams entry to pass in params map.

Returns:

created log entry or null if session is not logged

See Also:

SessionParams

createSessionLogRecord

@Nullable
public SessionLogEntry createSessionLogRecord(UserSession userSession,
                                                        SessionAction action,
                                                        @Nullable
                                                        UserSession substitutedSession,
                                                        @Nullable
                                                        java.util.Map<java.lang.String,java.lang.Object> params)

Description copied from interface: UserSessionLog

Create log entry for session with custom params.

Specified by:

createSessionLogRecord in interface UserSessionLog

Parameters:

userSession - log entry is created for this session

action - session action, like login, logout, etc

substitutedSession - session that was substituted by new session from userSession param

params - additional params for log entry, like client's address and other info. Use id property of SessionParams entry to pass in params map

Returns:

created log entry or null if session is not logged

See Also:

SessionParams

updateSessionLogRecord

@Nullable
public SessionLogEntry updateSessionLogRecord(UserSession userSession,
                                                        @Nullable
                                                        SessionAction action)

Description copied from interface: UserSessionLog

Updates params on provided session log record.

Specified by:

updateSessionLogRecord in interface UserSessionLog

Parameters:

userSession - update log record for this session

action - last session action

Returns:

null in case of session is not logged

getLastSessionLogRecord

public SessionLogEntry getLastSessionLogRecord(java.util.UUID userSessionId)

Description copied from interface: UserSessionLog

Get latest session log record. Session could have multiple log records in case of user substitution.

Specified by:

getLastSessionLogRecord in interface UserSessionLog

Parameters:

userSessionId - id of user session

Returns:

latest log record

getAllSessionLogRecords

public java.util.List<SessionLogEntry> getAllSessionLogRecords(java.util.UUID userSessionId)

Description copied from interface: UserSessionLog

Get all session log records. Session could have multiple log records in case of user substitution.

Specified by:

getAllSessionLogRecords in interface UserSessionLog

Parameters:

userSessionId - id of user session

Returns:

list of log records sorted by startedTs asc