io.jmix.securityui.authentication

Class AuthDetails

java.lang.Object

io.jmix.securityui.authentication.AuthDetails

public class AuthDetails
extends java.lang.Object

Class contains authentication information.

Example usage:

 @Autowired
 private LoginScreenAuthenticator authenticator;

 private void doLogin(String username, String password) {
     Authentication authentication = authenticationSupport.authenticate(
             AuthDetails.of(username, password)
                     .withLocale(localesField.getValue())
                     .withRememberMe(rememberMeCheckBox.isChecked()), this);
 }
 

See Also:

LoginScreenSupport

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Locale	locale
protected java.lang.String	password
protected boolean	rememberMe
protected java.util.TimeZone	timeZone
protected java.lang.String	username

Method Summary

Modifier and Type	Method and Description
java.util.Locale	getLocale()
java.lang.String	getPassword()
java.util.TimeZone	getTimeZone()
java.lang.String	getUsername()
boolean	isRememberMe()
static AuthDetails	of(java.lang.String username, java.lang.String password) Creates a new instance with authentication credentials.
AuthDetails	withLocale(java.util.Locale locale) Sets user locale to be used in application.
AuthDetails	withRememberMe(boolean rememberMe) Sets rememberMe enabled.
AuthDetails	withTimeZone(java.util.TimeZone timeZone) Sets user timezone to be used in application.

Methods inherited from class java.lang.Object

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

Field Detail

username

protected java.lang.String username

password

protected java.lang.String password

locale

protected java.util.Locale locale

timeZone

protected java.util.TimeZone timeZone

rememberMe

protected boolean rememberMe

Method Detail

of

public static AuthDetails of(java.lang.String username,
                             java.lang.String password)

Creates a new instance with authentication credentials.

Parameters:

username - user login

password - user password

Returns:

new instance

getUsername

public java.lang.String getUsername()

Returns:

user login

getPassword

public java.lang.String getPassword()

Returns:

user password

isRememberMe

public boolean isRememberMe()

Returns:

true if rememberMe is enabled, false otherwise

withRememberMe

public AuthDetails withRememberMe(boolean rememberMe)

Sets rememberMe enabled. If rememberMe is enabled, the user can pass authentication without entering credentials.

Parameters:

rememberMe - whether rememberMe should be used

Returns:

current instance

getLocale

@Nullable
public java.util.Locale getLocale()

Returns:

a locale or null if not set

withLocale

public AuthDetails withLocale(@Nullable
                              java.util.Locale locale)

Sets user locale to be used in application.

Parameters:

locale - a locale

Returns:

current instance

getTimeZone

@Nullable
public java.util.TimeZone getTimeZone()

Returns:

a timezone or null if not set

withTimeZone

public AuthDetails withTimeZone(@Nullable
                                java.util.TimeZone timeZone)

Sets user timezone to be used in application.

Parameters:

timeZone - a timezone

Returns:

current instance