Package io.jmix.flowui.action.security

Class SubstituteUserAction

java.lang.Object

io.jmix.flowui.kit.action.AbstractAction

io.jmix.flowui.kit.action.BaseAction

io.jmix.flowui.action.security.SubstituteUserAction

All Implemented Interfaces:

ExecutableAction, Action, HasShortcutCombination, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

@ActionType("substituteUser")
public class SubstituteUserAction
extends BaseAction
implements ExecutableAction, org.springframework.context.ApplicationContextAware

Makes UI-specific preparations to user substitution and performs it using UserSubstitutionManager Checks if there are unsaved changes on the current view and shows dialog with options:

1. Discard changes (close current view, cleanups background tasks, then performs substitution and navigates to MainView)
2. Cancel (invokes all cancelActions)

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.context.ApplicationContext	applicationContext
protected List<Consumer<org.springframework.security.core.userdetails.UserDetails>>	cancelHandlers
protected Dialogs	dialogs
static final String	ID
protected String	mainViewId
protected Messages	messages
protected org.springframework.security.core.userdetails.UserDetails	newSubstitutedUser
protected org.springframework.security.core.userdetails.UserDetails	prevSubstitutedUser
protected jakarta.servlet.ServletContext	servletContext
protected UserSubstitutionManager	userSubstitutionManager
protected ViewRegistry	viewRegistry

Fields inherited from class io.jmix.flowui.kit.action.BaseAction

enabledExplicitly, visibleExplicitly

Fields inherited from class io.jmix.flowui.kit.action.AbstractAction

description, enabled, eventBus, icon, id, shortcutCombination, text, variant, visible

Fields inherited from interface io.jmix.flowui.kit.action.Action

PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT_COMBINATION, PROP_TEXT, PROP_VARIANT, PROP_VISIBLE

Constructor Summary

Constructors

Constructor	Description
SubstituteUserAction()
SubstituteUserAction(String id)

Method Summary

Modifier and Type	Method	Description
void	actionPerform(com.vaadin.flow.component.Component component)
protected void	doCancel()
protected void	doSubstituteUser()
void	execute()	Executes the Action
protected Optional<View<?>>	findCurrentOpenedView()
protected String	getMainViewLocation()
protected void	openDiscardCurrentViewDialog(View<?> view)
protected void	prepareViewToClose(View<?> view)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setDialogs(Dialogs dialogs)
void	setMessages(Messages messages)
void	setServletContext(jakarta.servlet.ServletContext servletContext)
void	setUiProperties(UiProperties uiProperties)
void	setUserSubstitutionManager(UserSubstitutionManager userSubstitutionManager)
void	setViewRegistry(ViewRegistry viewRegistry)
SubstituteUserAction	withCancelHandler(Consumer<org.springframework.security.core.userdetails.UserDetails> cancelHandler)
SubstituteUserAction	withUsers(org.springframework.security.core.userdetails.UserDetails prevSubstitutedUser, org.springframework.security.core.userdetails.UserDetails newSubstitutedUser)

Methods inherited from class io.jmix.flowui.kit.action.BaseAction

addActionPerformedListener, isApplicable, refreshState, setEnabled, setEnabledInternal, setVisible, setVisibleInternal, withEnabled, withHandler, withIcon, withIcon, withShortcutCombination, withText, withTitle, withVariant, withVisible

Methods inherited from class io.jmix.flowui.kit.action.AbstractAction

addPropertyChangeListener, firePropertyChange, getDescription, getEventBus, getIcon, getId, getShortcutCombination, getText, getVariant, hasListener, isEnabled, isVisible, setDescription, setIcon, setShortcutCombination, setText, setVariant

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.flowui.kit.action.Action

addPropertyChangeListener, getDescription, getIcon, getId, getText, getVariant, isEnabled, isVisible, refreshState, setDescription, setEnabled, setIcon, setText, setVariant, setVisible

Methods inherited from interface io.jmix.flowui.kit.component.HasShortcutCombination

getShortcutCombination, setShortcutCombination

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

servletContext

protected jakarta.servlet.ServletContext servletContext

userSubstitutionManager

protected UserSubstitutionManager userSubstitutionManager

viewRegistry

protected ViewRegistry viewRegistry

dialogs

protected Dialogs dialogs

messages

protected Messages messages

mainViewId

protected String mainViewId

cancelHandlers

protected List<Consumer<org.springframework.security.core.userdetails.UserDetails>> cancelHandlers

newSubstitutedUser

protected org.springframework.security.core.userdetails.UserDetails newSubstitutedUser

prevSubstitutedUser

protected org.springframework.security.core.userdetails.UserDetails prevSubstitutedUser

Constructor Details

SubstituteUserAction

public SubstituteUserAction()

SubstituteUserAction

public SubstituteUserAction(String id)

Method Details

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

setServletContext

@Autowired
public void setServletContext(jakarta.servlet.ServletContext servletContext)

setUserSubstitutionManager

@Autowired
public void setUserSubstitutionManager(UserSubstitutionManager userSubstitutionManager)

setViewRegistry

@Autowired
public void setViewRegistry(ViewRegistry viewRegistry)

setDialogs

@Autowired
public void setDialogs(Dialogs dialogs)

setMessages

@Autowired
public void setMessages(Messages messages)

setUiProperties

@Autowired
public void setUiProperties(UiProperties uiProperties)

actionPerform

public void actionPerform(com.vaadin.flow.component.Component component)

Specified by:

actionPerform in interface Action

Overrides:

actionPerform in class BaseAction

execute

public void execute()

Description copied from interface: ExecutableAction

Executes the Action

Specified by:

execute in interface ExecutableAction

prepareViewToClose

protected void prepareViewToClose(View<?> view)

openDiscardCurrentViewDialog

protected void openDiscardCurrentViewDialog(View<?> view)

findCurrentOpenedView

protected Optional<View<?>> findCurrentOpenedView()

doSubstituteUser

protected void doSubstituteUser()

doCancel

protected void doCancel()

getMainViewLocation

protected String getMainViewLocation()

withUsers

public SubstituteUserAction withUsers(org.springframework.security.core.userdetails.UserDetails prevSubstitutedUser,
 org.springframework.security.core.userdetails.UserDetails newSubstitutedUser)

withCancelHandler

public SubstituteUserAction withCancelHandler(Consumer<org.springframework.security.core.userdetails.UserDetails> cancelHandler)