Package com.vaadin.flow.server

Class AbstractSessionLockEvent

java.lang.Object
java.util.EventObject
com.vaadin.flow.server.AbstractSessionLockEvent
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
SessionLockAcquiredEvent, SessionLockEvent, SessionLockReleasedEvent, SessionLockRequestedEvent
public abstract class AbstractSessionLockEvent extends EventObject
Describes which service an event fired through the service event bus around acquisition and release of a Vaadin session lock is about.

The same lock instance protects a session whether it is acquired by the framework while handling a request or via VaadinSession.lock() (for example from UI.access(Command)). The events of a given outermost lock-hold are fired on the same thread, so timing state can be kept in a thread local.

Listeners are added for the concrete event types SessionLockRequestedEvent, SessionLockAcquiredEvent and SessionLockReleasedEvent, since the event bus dispatches events by their exact type.

Since:
25.3
See Also:

  • Constructor Details

    • AbstractSessionLockEvent

      protected AbstractSessionLockEvent(VaadinService service)
      Creates a new event.
      Parameters:
      service - the Vaadin service whose session lock is being acquired or released, not null

  • Method Details

    • getSource

      public VaadinService getSource()
      Gets the Vaadin service from which this event originates.
      Overrides:
      getSource in class EventObject
      Returns:
      the Vaadin service instance

    • getService

      public VaadinService getService()
      Gets the Vaadin service from which this event originates.
      Returns:
      the Vaadin service instance