io.jmix.core.security

Interface CurrentAuthentication

All Known Implementing Classes:

CurrentAuthenticationImpl

public interface CurrentAuthentication

Provides information about the currently authenticated user.

Method Summary

Modifier and Type	Method and Description
org.springframework.security.core.Authentication	getAuthentication() Returns current authentication object.
java.util.Locale	getLocale()
java.util.TimeZone	getTimeZone()
org.springframework.security.core.userdetails.UserDetails	getUser() Returns the authenticated user.
boolean	isSet()

Method Detail

getAuthentication

org.springframework.security.core.Authentication getAuthentication()

Returns current authentication object.

Throws:

java.lang.IllegalStateException - if Authentication is not set to SecurityContext

getUser

org.springframework.security.core.userdetails.UserDetails getUser()

Returns the authenticated user. If you need to get the user substitution information use the CurrentUserSubstitution.

Returns:

currently authenticated user

Throws:

java.lang.RuntimeException - if Authentication is not set to SecurityContext or user information cannot be extracted from current authentication

getLocale

java.util.Locale getLocale()

Returns:

locale of the current authentication or default locale if current authentication doesn't contain locale information

Throws:

java.lang.RuntimeException - if Authentication is not set to SecurityContext

getTimeZone

java.util.TimeZone getTimeZone()

Returns:

time zone of the current authentication or default time zone if current authentication doesn't contain time zone information

Throws:

java.lang.RuntimeException - if Authentication is not set to SecurityContext

isSet

boolean isSet()

Returns:

true if authentication is set to SecurityContext