com.haulmont.cuba.core.global

Interface UserSessionSource

All Known Implementing Classes:

AbstractUserSessionSource, PortalUserSessionSource, TestUserSessionSource, TestUserSessionSource, UserSessionSourceImpl, WebUserSessionSource

public interface UserSessionSource

Central infrastructure interface to provide access to a current user session.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
boolean	checkCurrentUserSession()
java.util.UUID	currentOrSubstitutedUserId()
java.util.Locale	getLocale()
UserSession	getUserSession()

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

checkCurrentUserSession

boolean checkCurrentUserSession()

Returns:

true if the current user session is valid and calling getUserSession() is safe

getUserSession

UserSession getUserSession()

Returns:

current user session

Throws:

java.lang.RuntimeException - if there is no active user session

currentOrSubstitutedUserId

java.util.UUID currentOrSubstitutedUserId()

Returns:

effective user ID. This is either the logged in user, or substituted user if a substitution was performed in this user session.

Throws:

java.lang.RuntimeException - if there is no active user session

getLocale

java.util.Locale getLocale()

Returns:

current user session locale

Throws:

java.lang.RuntimeException - if there is no active user session