Package org.dellroad.stuff.vaadin7

Class VaadinApplicationListener<E extends ApplicationEvent>

java.lang.Object

org.dellroad.stuff.vaadin7.VaadinExternalListener<ApplicationEventMulticaster>

org.dellroad.stuff.vaadin7.VaadinApplicationListener<E>

Type Parameters:

E - The type of the event

All Implemented Interfaces:

EventListener, ApplicationListener<E>

public abstract class VaadinApplicationListener<E extends ApplicationEvent>
extends VaadinExternalListener<ApplicationEventMulticaster>
implements ApplicationListener<E>

A Spring ApplicationListener support superclass customized for use by listeners that are part of a Vaadin application when listening to non-Vaadin application event sources.

Listeners that are part of a Vaadin application should use this superclass if they are going to be registered with non-Vaadin event sources. This will ensure that events are delivered in the proper Vaadin application context and memory leaks are avoided when the session closes.

See Also:

VaadinExternalListener, VaadinUtil.invoke(com.vaadin.server.VaadinSession, java.lang.Runnable), VaadinApplicationScope, SpringVaadinSessionListener

Constructor Summary

Constructors

Constructor	Description
VaadinApplicationListener(ApplicationEventMulticaster multicaster)	Convenience constructor.
VaadinApplicationListener(ApplicationEventMulticaster multicaster, VaadinSession session)	Primary constructor.

Method Summary

Modifier and Type	Method	Description
void	onApplicationEvent(E event)
protected abstract void	onApplicationEventInternal(E event)	Handle a listener event.
protected void	register(ApplicationEventMulticaster multicaster)	Register as a listener on the given event source.
protected void	unregister(ApplicationEventMulticaster multicaster)	Register as a listener from the given event source.

Methods inherited from class org.dellroad.stuff.vaadin7.VaadinExternalListener

getEventSource, getSession, handleEvent, isAsynchronous, register, setAsynchronous, unregister

Methods inherited from class java.lang.Object

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

Constructor Detail

VaadinApplicationListener

public VaadinApplicationListener(ApplicationEventMulticaster multicaster)

Convenience constructor. Equivalent to:

VaadinApplicationListener(multicaster, VaadinUtil.getCurrentSession())

Parameters:

multicaster - the application event multicaster on which this listener will register

Throws:

IllegalArgumentException - if multicaster is null

IllegalArgumentException - if there is no VaadinSession associated with the current thread

VaadinApplicationListener

public VaadinApplicationListener(ApplicationEventMulticaster multicaster,
                                 VaadinSession session)

Primary constructor.

Parameters:

multicaster - the application event multicaster on which this listener will register

session - the associated Vaadin application

Throws:

IllegalArgumentException - if either parameter is null

Method Detail

register

protected void register(ApplicationEventMulticaster multicaster)

Description copied from class: VaadinExternalListener

Register as a listener on the given event source.

Subclass must implement this to perform the actual listener registration.

Specified by:

register in class VaadinExternalListener<ApplicationEventMulticaster>

Parameters:

multicaster - event source, never null; will be same as provided to the constructor

unregister

protected void unregister(ApplicationEventMulticaster multicaster)

Description copied from class: VaadinExternalListener

Register as a listener from the given event source.

Subclass must implement this to perform the actual listener registration.

Specified by:

unregister in class VaadinExternalListener<ApplicationEventMulticaster>

Parameters:

multicaster - event source, never null; will be same as provided to the constructor

onApplicationEvent

public final void onApplicationEvent(E event)

Specified by:

onApplicationEvent in interface ApplicationListener<E extends ApplicationEvent>

onApplicationEventInternal

protected abstract void onApplicationEventInternal(E event)

Handle a listener event. When this method is invoked, it will already be within the context of the VaadinSession with which this listener is associated.

Parameters:

event - event to handle

See Also:

VaadinUtil.invoke(com.vaadin.server.VaadinSession, java.lang.Runnable), VaadinUtil.getCurrentSession()