Package org.dellroad.stuff.vaadin7

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-Vaadin application and "servlet global") into Vaadin beans
• An AOP aspect that allows @VaadinConfigurable application beans to be autowired on instantiation using the curent Vaadin application's Spring application context
• A safe and clearly defined interface for background threads needing to interact with a Vaadin application
• A custom Spring scope that matches Vaadin application scope
• Support for Vaadin application beans as listeners on non-Vaadin application event sources

Key classes include:

• SpringVaadinServlet associates a Spring application context with each "Vaadin application" instance (i.e., each VaadinSession) using the SpringVaadinSessionListener class (which does the bulk of the work). The parent context is the application context associated with the overall servlet context already set up by Spring. 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.
• An AOP aspect that works on @VaadinConfigurable beans, allowing them to be autowired by the Spring application context associated with the current Vaadin application instance by SpringVaadinServlet (note: not just the parent context). Arbitrary beans get autowired into the Vaadin application's context at the time of construction.
• VaadinApplicationScope, which adds a custom Spring scope so you can define application scoped beans in XML with scope="vaadinApplication" (for example, in the parent context).
• VaadinExternalListener, a support superclass for listeners scoped to a Vaadin application that avoids memory leaks when listening to more widely scoped event sources. In particular, the subclass VaadinApplicationListener supports listeners for Spring application events multicasted in a (non-Vaadin application scoped) parent context.
• The VaadinApplication class can serve as an application-wide singleton for a Vaadin application just like the Vaadin 6.x class of the same name used to do.
• VaadinUtil provides some utility and convenience methods.

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

See Also:

SpringVaadinServlet, VaadinConfigurable, SpringVaadinSessionListener, VaadinApplicationScope, VaadinExternalListener, VaadinApplicationListener, Vaadin, Spring Stuff Vaadin Add-on

Interface Summary

Interface	Description
BackedItem<T>	Extension of the Item interface for implementations that are backed by an underlying Java object.
BackedProperty<T,V>	Extension of the Property interface for implementations that are backed by an underlying Java object.
Connectable	Generic interface supporting connection and disconnection.
PropertyExtractor<T>	Classes that can extract Property values from Java objects.
QueryList<T>	Cacheable list of Java objects backing an AbstractQueryContainer.
SortingPropertyExtractor<T>	PropertyExtractor that also sorts properties, given two instances of the target Java type.
VaadinConfigurableObject	Marker interface used by the VaadinConfigurableAspect.

Class Summary

Class	Description
AbstractQueryContainer<T>	Support superclass for read-only Container implementations where each Item in the container is backed by a Java object, and the Java objects are generated via a query that returns a QueryList containing only some portion of the total list of backing objects at any one time.
AbstractSimpleContainer<I,T>	Support superclass for simple read-only, in-memory Container implementations where each Item in the container is backed by a Java object.
AbstractUnsizedContainer<T>	A specialization of AbstractQueryContainer that doesn't require up-front knowledge of the underlying data's size.
AlwaysInvalidQueryList<T>	A QueryList that always throws InvalidQueryListException.
BlobField	A Vaadin Field for editing Propertys with byte[] array values (i.e., "blobs").
ConvertedProperty<P,M>	Applies a Converter to a Property of one type (the "model" type) to produce a Property of another type (the "presentation" type).
EnumComboBox	ComboBox that chooses an Enum value.
EnumContainer<T extends Enum<T>>	Container backed by the instances of an Enum type.
FieldBuilder	Automatically builds and binds fields for a Java bean annotated with FieldBuilder annotations.
FieldBuilder.AnnotationApplier<A extends Annotation,F extends AbstractField<?>>	Class that knows how to apply annotation properties to a corresponding field.
FieldLayout<T>	A HorizontalLayout that also exposes an internally wrapped Field.
PropertyDef<T>	Defines a Vaadin property, having a name, which is also the property ID, and its type.
ProvidesPropertyScanner<T>	Scans a Java class hierarchy for @ProvidesProperty and @ProvidesPropertySort annotated getter methods and creates a corresponding set of PropertyDef property definitions and a SortingPropertyExtractor that will extract the properties from instances of the given class and sort them accordingly.
ReadOnlyProperty<V>	Support superclass for Propertys with read-only values.
SelfKeyedContainer<T>	A SimpleKeyedContainer where the item IDs are the underlying container objects themselves.
SimpleContainer<T>	An AbstractSimpleContainer with Integer item IDs.
SimpleItem<T>	Simple read-only Item implementation backed by a Java object.
SimpleKeyedContainer<I,T>	An AbstractSimpleContainer where the item IDs are generated from the items themselves by the subclass-provided method SimpleKeyedContainer.getKeyFor(T).
SimpleProperty<T,V>	Simple read-only Property implementation backed by a Java object.
SimpleQueryList<T>	Simple QueryList implementation using a normal List.
SpringVaadinServlet	A VaadinServlet that associates and manages a Spring ConfigurableWebApplicationContext with each VaadinSession (aka, "Vaadin application" in the old terminology).
SpringVaadinSessionListener	Manages an associated Spring WebApplicationContext with each VaadinSession (aka, "Vaadin application").
StringValuePropertyDef	A PropertyDef representing the String value of an object using Object#toString().
VaadinApplication	A globally accessible "Vaadin application" singleton.
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.
VaadinDelayedAction	DelayedAction for actions that are associated with a Vaadin appliction.
VaadinExternalListener<S>	Support superclass customized for use by listeners that are part of a Vaadin application when listening to non-Vaadin ("external") event sources.
VaadinSessionContainer<T extends VaadinSessionInfo>	Container containing active VaadinSessions.
VaadinSessionInfo	Represents one VaadinSession in a VaadinSessionContainer.
VaadinUtil	Miscellaneous utility methods.
WindowQueryList<T>	QueryList implementation that only actually holds a portion, or "window" of a larger list.
WritableResource	Support superclass for StreamResource implementations that can be more easily implemented by writing to an OutputStream than providing an InputStream.

Exception Summary

Exception	Description
InvalidQueryListException	Exception thrown by QueryList.get(long) when the list has become invalid.

Annotation Types Summary

Annotation Type	Description
FieldBuilder.AbstractField	Specifies how a Java property should be edited in Vaadin using an AbstractField.
FieldBuilder.AbstractSelect	Specifies how a Java property should be edited in Vaadin using an AbstractSelect.
FieldBuilder.AbstractTextField	Specifies how a Java property should be edited in Vaadin using a AbstractTextField.
FieldBuilder.CheckBox	Specifies how a Java property should be edited in Vaadin using an CheckBox.
FieldBuilder.ComboBox	Specifies how a Java property should be edited in Vaadin using an ComboBox.
FieldBuilder.DateField	Specifies how a Java property should be edited in Vaadin using an DateField.
FieldBuilder.EnumComboBox	Specifies how a Java property should be edited in Vaadin using an EnumComboBox.
FieldBuilder.ListSelect	Specifies how a Java property should be edited in Vaadin using an ListSelect.
FieldBuilder.PasswordField	Specifies how a Java property should be edited in Vaadin using a PasswordField.
FieldBuilder.ProvidesField	Specifies that the annotated method will return an AbstractField suitable for editing the specified property.
FieldBuilder.TextArea	Specifies how a Java property should be edited in Vaadin using a TextArea.
FieldBuilder.TextField	Specifies how a Java property should be edited in Vaadin using a TextField.
ProvidesProperty	Declares that a Java method provides a read-only Vaadin Property value in a Java class whose instances back the items in a Container.
ProvidesPropertySort	Declares that a Java method provides either a Comparable value or a Comparator that should be used to determine property sort ordering in a Java class whose instances back the items in a Container.
VaadinConfigurable	Indicates that the class is a candidate for configuration using the VaadinConfigurableAspect aspect.