Package io.jmix.flowui

Class UiEventPublisher

java.lang.Object

io.jmix.flowui.UiEventPublisher

@Component("flowui_UiEventPublisher")
public class UiEventPublisher
extends Object

Sends application events that should be handled in the components (e.g. views). To enable handling application events in the View, annotate a method with EventListener. For instance:

     @EventListener
     public void customUiEventHandler(CustomUiEvent event) {
         // handle event
     }
 

To correctly update the UI, class that implements AppShellConfigurator should contain the Push annotation. It can be the main Spring Boot application class:

     @Push
     @SpringBootApplication
     public class MyDemoProjectApplication implements AppShellConfigurator {
        // configuration
     }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UiEventPublisher.UiUserEvent	Event that should be processed on UI of specific users (or all users if usernames collection is null)

Field Summary

Fields

Modifier and Type	Field	Description
protected ClusterApplicationEventPublisher	clusterApplicationEventPublisher
protected CurrentAuthentication	currentAuthentication
protected SessionHolder	sessionHolder
protected SystemAuthenticator	systemAuthenticator

Constructor Summary

Constructors

Constructor	Description
UiEventPublisher(SystemAuthenticator systemAuthenticator, ClusterApplicationEventPublisher clusterApplicationEventPublisher, SessionHolder sessionHolder, CurrentAuthentication currentAuthentication)

Method Summary

Modifier and Type	Method	Description
protected void	onSessionAccess(com.vaadin.flow.server.VaadinSession session, org.springframework.context.ApplicationEvent event)
void	onUiUserEvent(UiEventPublisher.UiUserEvent event)
protected void	publish(Collection<com.vaadin.flow.component.UI> uis, org.springframework.context.ApplicationEvent event)
void	publishEvent(org.springframework.context.ApplicationEvent event)	Publishes event for all UIs (tabs and browsers) in the current user session.
void	publishEventForCurrentUI(org.springframework.context.ApplicationEvent event)	Publishes event only for the current UI.
void	publishEventForUsers(org.springframework.context.ApplicationEvent event, Collection<String> usernames)	Publishes the event for all UIs in all sessions of users specified in usernames collection.
protected void	publishEventForUsersInternal(org.springframework.context.ApplicationEvent event, Collection<String> usernames)
protected void	sendEventToUserSessions(org.springframework.context.ApplicationEvent event, Map<String,List<com.vaadin.flow.server.VaadinSession>> userSessions)

Methods inherited from class java.lang.Object

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

Field Details

currentAuthentication

protected CurrentAuthentication currentAuthentication

systemAuthenticator

protected SystemAuthenticator systemAuthenticator

clusterApplicationEventPublisher

protected ClusterApplicationEventPublisher clusterApplicationEventPublisher

sessionHolder

protected SessionHolder sessionHolder

Constructor Details

UiEventPublisher

public UiEventPublisher(SystemAuthenticator systemAuthenticator,
 ClusterApplicationEventPublisher clusterApplicationEventPublisher,
 SessionHolder sessionHolder,
 CurrentAuthentication currentAuthentication)

Method Details

onUiUserEvent

@EventListener
public void onUiUserEvent(UiEventPublisher.UiUserEvent event)

publishEventForUsersInternal

protected void publishEventForUsersInternal(org.springframework.context.ApplicationEvent event,
 @Nullable
 Collection<String> usernames)

sendEventToUserSessions

protected void sendEventToUserSessions(org.springframework.context.ApplicationEvent event,
 Map<String,List<com.vaadin.flow.server.VaadinSession>> userSessions)

onSessionAccess

protected void onSessionAccess(com.vaadin.flow.server.VaadinSession session,
 org.springframework.context.ApplicationEvent event)

publishEventForCurrentUI

public void publishEventForCurrentUI(org.springframework.context.ApplicationEvent event)

Publishes event only for the current UI.

Parameters:

event - application event

publishEvent

public void publishEvent(org.springframework.context.ApplicationEvent event)

Publishes event for all UIs (tabs and browsers) in the current user session.

Parameters:

event - application event

publish

protected void publish(Collection<com.vaadin.flow.component.UI> uis,
 org.springframework.context.ApplicationEvent event)

publishEventForUsers

public void publishEventForUsers(org.springframework.context.ApplicationEvent event,
 @Nullable
 Collection<String> usernames)

Publishes the event for all UIs in all sessions of users specified in usernames collection. If usernames collection is null the event will be published for all users.

Parameters:

event - event to publish

usernames - usernames of target users or null if broadcast to all users is needed