com.haulmont.cuba.security.app

Interface UserSessionLog

All Known Implementing Classes:

UserSessionLogBean

public interface UserSessionLog

API for user sessions logging.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

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.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

createSessionLogRecord

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

Create log entry for session with custom params.

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
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.

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
SessionLogEntry updateSessionLogRecord(UserSession userSession,
                                                 SessionAction action)

Updates params on provided session log record.

Parameters:

userSession - update log record for this session

action - last session action

Returns:

null in case of session is not logged

getLastSessionLogRecord

SessionLogEntry getLastSessionLogRecord(java.util.UUID userSessionId)

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

Parameters:

userSessionId - id of user session

Returns:

latest log record

getAllSessionLogRecords

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

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

Parameters:

userSessionId - id of user session

Returns:

list of log records sorted by startedTs asc