io.jmix.securityui.authentication

Class LoginScreenSupport

java.lang.Object

io.jmix.securityui.authentication.LoginScreenSupport

@Component(value="ui_LoginScreenSupport")
public class LoginScreenSupport
extends java.lang.Object

Class that provides authentication via AuthenticationManager. It is intended to use from login screen.

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:

AuthDetails

Field Summary

Fields

Modifier and Type	Field and Description
protected io.jmix.core.AccessManager	accessManager
protected org.springframework.context.ApplicationEventPublisher	applicationEventPublisher
protected org.springframework.security.authentication.AuthenticationManager	authenticationManager
protected io.jmix.ui.sys.AppCookies	cookies
protected io.jmix.core.CoreProperties	coreProperties
protected io.jmix.ui.deviceinfo.DeviceInfoProvider	deviceInfoProvider
protected io.jmix.core.Messages	messages
protected org.springframework.security.web.authentication.RememberMeServices	rememberMeServices
protected io.jmix.ui.ScreenBuilders	screenBuilders
protected io.jmix.ui.UiProperties	uiProperties

Constructor Summary

Constructors

Constructor and Description
LoginScreenSupport()

Method Summary

Modifier and Type	Method and Description
org.springframework.security.core.Authentication	authenticate(AuthDetails authDetails, io.jmix.ui.screen.FrameOwner frameOwner) Performs authentication via AuthenticationManager and uses UsernamePasswordAuthenticationToken with credentials from AuthDetails.
protected void	checkLoginToUi(AuthDetails authDetails, org.springframework.security.core.Authentication authentication)
protected org.springframework.security.core.Authentication	createAuthenticationToken(java.lang.String username, java.lang.String password, java.util.Locale locale, java.util.TimeZone timeZone)
protected io.jmix.ui.sys.AppCookies	getCookies()
protected java.util.Locale	getDefaultLocale()
protected java.util.TimeZone	getDeviceTimeZone()
protected void	onSuccessfulAuthentication(org.springframework.security.core.Authentication authentication, AuthDetails authDetails, io.jmix.ui.screen.FrameOwner frameOwner)
protected void	saveCookies(AuthDetails authDetails)
void	setAccessManager(io.jmix.core.AccessManager accessManager)
void	setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)
void	setAuthenticationManager(org.springframework.security.authentication.AuthenticationManager authenticationManager)
void	setAuthenticationStrategy(org.springframework.security.web.authentication.session.SessionAuthenticationStrategy authenticationStrategy)
void	setCoreProperties(io.jmix.core.CoreProperties coreProperties)
void	setDeviceInfoProvider(io.jmix.ui.deviceinfo.DeviceInfoProvider deviceInfoProvider)
void	setMessages(io.jmix.core.Messages messages)
void	setRememberMeServices(org.springframework.security.web.authentication.RememberMeServices rememberMeServices)
void	setScreenBuilders(io.jmix.ui.ScreenBuilders screenBuilders)
void	setUiProperties(io.jmix.ui.UiProperties uiProperties)
protected void	showMainScreen(io.jmix.ui.screen.FrameOwner frameOwner)

Methods inherited from class java.lang.Object

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

Field Detail

authenticationManager

protected org.springframework.security.authentication.AuthenticationManager authenticationManager

uiProperties

protected io.jmix.ui.UiProperties uiProperties

coreProperties

protected io.jmix.core.CoreProperties coreProperties

screenBuilders

protected io.jmix.ui.ScreenBuilders screenBuilders

accessManager

protected io.jmix.core.AccessManager accessManager

messages

protected io.jmix.core.Messages messages

deviceInfoProvider

protected io.jmix.ui.deviceinfo.DeviceInfoProvider deviceInfoProvider

rememberMeServices

protected org.springframework.security.web.authentication.RememberMeServices rememberMeServices

applicationEventPublisher

protected org.springframework.context.ApplicationEventPublisher applicationEventPublisher

cookies

protected io.jmix.ui.sys.AppCookies cookies

Constructor Detail

LoginScreenSupport

public LoginScreenSupport()

Method Detail

setAuthenticationManager

@Autowired
public void setAuthenticationManager(org.springframework.security.authentication.AuthenticationManager authenticationManager)

setUiProperties

@Autowired
public void setUiProperties(io.jmix.ui.UiProperties uiProperties)

setCoreProperties

@Autowired
public void setCoreProperties(io.jmix.core.CoreProperties coreProperties)

setScreenBuilders

@Autowired
public void setScreenBuilders(io.jmix.ui.ScreenBuilders screenBuilders)

setAccessManager

@Autowired
public void setAccessManager(io.jmix.core.AccessManager accessManager)

setMessages

@Autowired
public void setMessages(io.jmix.core.Messages messages)

setDeviceInfoProvider

@Autowired
public void setDeviceInfoProvider(io.jmix.ui.deviceinfo.DeviceInfoProvider deviceInfoProvider)

setRememberMeServices

@Autowired
public void setRememberMeServices(org.springframework.security.web.authentication.RememberMeServices rememberMeServices)

setAuthenticationStrategy

@Autowired(required=false)
public void setAuthenticationStrategy(org.springframework.security.web.authentication.session.SessionAuthenticationStrategy authenticationStrategy)

setApplicationEventPublisher

@Autowired
public void setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher applicationEventPublisher)

authenticate

public org.springframework.security.core.Authentication authenticate(AuthDetails authDetails,
                                                                     @Nullable
                                                                     io.jmix.ui.screen.FrameOwner frameOwner)
                                                              throws org.springframework.security.core.AuthenticationException

Performs authentication via AuthenticationManager and uses UsernamePasswordAuthenticationToken with credentials from AuthDetails.

If locale is not provided it will use the first locale from CoreProperties.getAvailableLocales() list.

After successful authentication, there will be an attempt to open the main screen using UiProperties.getMainScreenId() from FrameOwner if it is not null.

Parameters:

authDetails - authentication details

frameOwner - invoking screen to open main screen

Returns:

a fully authenticated object including credentials

Throws:

org.springframework.security.core.AuthenticationException - if exception occurs while authentication process

onSuccessfulAuthentication

protected void onSuccessfulAuthentication(org.springframework.security.core.Authentication authentication,
                                          AuthDetails authDetails,
                                          @Nullable
                                          io.jmix.ui.screen.FrameOwner frameOwner)

saveCookies

protected void saveCookies(AuthDetails authDetails)

checkLoginToUi

protected void checkLoginToUi(AuthDetails authDetails,
                              org.springframework.security.core.Authentication authentication)

showMainScreen

protected void showMainScreen(@Nullable
                              io.jmix.ui.screen.FrameOwner frameOwner)

createAuthenticationToken

protected org.springframework.security.core.Authentication createAuthenticationToken(java.lang.String username,
                                                                                     java.lang.String password,
                                                                                     @Nullable
                                                                                     java.util.Locale locale,
                                                                                     @Nullable
                                                                                     java.util.TimeZone timeZone)

getDefaultLocale

protected java.util.Locale getDefaultLocale()

getDeviceTimeZone

@Nullable
protected java.util.TimeZone getDeviceTimeZone()

getCookies

protected io.jmix.ui.sys.AppCookies getCookies()