Package org.dellroad.stuff.vaadin

Vaadin-related classes, especially relating to Spring integration.

See:
Description

Interface Summary

ContextApplication.CloseListener	Implemented by listeners that wish to be notified when a ContextApplication is closed.
VaadinConfigurableObject	Marker interface used by the VaadinConfigurableAspect.

Class Summary

ContextApplication	Application subclass that provides some basic infrastructure for Vaadin applications: Access to the currently running Vaadin application (via a ContextApplication.get()) A way to safely interact with a Vaadin application from a background thread (via ContextApplication.invoke(java.lang.Runnable)) Support for Vaadin application close event notifications Displays any exceptions thrown in an overlay error window A Logger to use
ContextApplication.CloseEvent	Event delivered to listeners when a ContextApplication is closed.
ContextApplicationFactoryBean	Deprecated. Just use a regular bean definition with a factory-method invoking ContextApplication.get
PropertyDef<T>	Defines a Vaadin property, having a name, which is also the property ID, and its type.
SpringContextApplication	Vaadin application implementation that manages an associated Spring WebApplicationContext.
VaadinApplicationListener<E extends ApplicationEvent>	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.
VaadinApplicationScope	A Spring custom Scope for Vaadin applications.

Annotation Types Summary

VaadinConfigurable

Indicates that the class is a candidate for configuration using the VaadinConfigurableAspect aspect.

Package org.dellroad.stuff.vaadin Description

Vaadin-related classes, especially relating to Spring integration.

This package contains classes that add some missing "glue" between Vaadin and Spring. In addition, these classes help address the "scope mismatch" between Vaadin application scope and Spring web application context scope that leads to memory leaks when a Vaadin application closes.

The key features included are:

• Automatic management of per-Vaadin application Spring application contexts, with lifecycle management of Vaadin application beans
• Autowiring of Spring-configured beans (both per-application and global, including the Vaadin application itself) into Vaadin application beans
• An AOP aspect that allows @VaadinConfigurable application beans to be autowired on instantiation using the curent Vaadin application context
• A safe and clearly defined interface for background threads needing to interact with a Vaadin application
• A clearly defined interface for any thread to determine "the currently running Vaadin application"
• A custom Spring scope that truly matches Vaadin application scope
• Support for Vaadin application beans as listeners on non-Vaadin application event multicasters

Key classes include:

• ContextApplication is a Vaadin application sub-class that provides some needed infrastructure, namely:
  • Access to the currently running Vaadin application (via a ContextApplication.get())
  • A way to safely interact with a Vaadin application from a background thread (via ContextApplication.invoke())
  • Support for Vaadin application close event notifications
• SpringContextApplication (a sub-class of ContextApplication) that creates a new Spring application context for each new Vaadin application instance. The parent context is the application context associated with the overall servlet context. This is analogous to what Spring's DispatcherServlet does for each servlet instance. Beans inside this context have a lifecycle which exactly tracks the Vaadin application, eliminating a major source of thread and memory leaks.
• A new AOP aspect that works on @VaadinConfigurable beans, allowing them to be autowired by the SpringContextApplication application context associated with the current Vaadin application instance (note: not just the parent context). Arbitrary beans get autowired into the Vaadin application's context at the time of construction automagically.
• VaadinApplicationScope, which adds a custom Spring scope so you can define application scoped beans with scope="vaadinApplication".
• VaadinApplicationListener, a support superclass for application scoped listeners that register to receive Spring application events multicasted in a (non-application scoped) parent context.

The classes in this package are also available as a Vaadin Add-on and sample code is available on GitHub.

See Also:

Vaadin, Spring Stuff Vaadin Add-on