Package io.jmix.securityflowui.access

Class UiViewAccessChecker

java.lang.Object

io.jmix.securityflowui.access.UiViewAccessChecker

All Implemented Interfaces:

com.vaadin.flow.router.BeforeEnterListener, com.vaadin.flow.router.internal.BeforeEnterHandler, Serializable

public class UiViewAccessChecker
extends Object
implements com.vaadin.flow.router.BeforeEnterListener

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	enabled
protected Class<? extends com.vaadin.flow.component.Component>	loginView
protected final UiAccessChecker	uiAccessChecker

Constructor Summary

Constructors

Constructor	Description
UiViewAccessChecker(boolean enabled, UiAccessChecker uiAccessChecker)
UiViewAccessChecker(UiAccessChecker uiAccessChecker)

Method Summary

Modifier and Type	Method	Description
void	beforeEnter(com.vaadin.flow.router.BeforeEnterEvent beforeEnterEvent)
void	enable()	Enables the access checker.
protected boolean	isAnonymousAuthentication()
protected boolean	isHasAccess(Class<?> targetView)
protected boolean	isProductionMode(com.vaadin.flow.router.BeforeEnterEvent beforeEnterEvent)
void	setLoginView(Class<? extends com.vaadin.flow.component.Component> loginView)
protected void	throwIfLoginViewSet()

Methods inherited from class java.lang.Object

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

Field Details

uiAccessChecker

protected final UiAccessChecker uiAccessChecker

enabled

protected boolean enabled

loginView

protected Class<? extends com.vaadin.flow.component.Component> loginView

Constructor Details

UiViewAccessChecker

public UiViewAccessChecker(UiAccessChecker uiAccessChecker)

UiViewAccessChecker

public UiViewAccessChecker(boolean enabled,
 UiAccessChecker uiAccessChecker)

Method Details

enable

public void enable()

Enables the access checker.

This must be called for the access checker to perform any checks. By default, the access checker is disabled.

setLoginView

public void setLoginView(Class<? extends com.vaadin.flow.component.Component> loginView)

throwIfLoginViewSet

protected void throwIfLoginViewSet()

beforeEnter

public void beforeEnter(com.vaadin.flow.router.BeforeEnterEvent beforeEnterEvent)

Specified by:

beforeEnter in interface com.vaadin.flow.router.internal.BeforeEnterHandler

isHasAccess

protected boolean isHasAccess(Class<?> targetView)

isProductionMode

protected boolean isProductionMode(com.vaadin.flow.router.BeforeEnterEvent beforeEnterEvent)

isAnonymousAuthentication

protected boolean isAnonymousAuthentication()