org.dellroad.stuff.vaadin7

Annotation Type VaadinConfigurable

@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Documented
 @Inherited
public @interface VaadinConfigurable

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

Analogous to Spring's @Configurable annotation, but causes beans to be autowired into the Spring application context associated with the current VaadinSession (aka "Vaadin application") by SpringVaadinSessionListener instead of the Spring application context associated with the servlet context.

For an extra safety check, consider setting ifSessionNotLocked() where appropriate.

For the this annotation to function properly, @VaadinConfigurable classes must be woven (either at build time or runtime) using the AspectJ compiler with the VaadinConfigurableAspect aspect (included in the dellroad-stuff JAR file), and the SpringVaadinServlet must be used.

See Also:

org.dellroad.stuff.vaadin7, SpringVaadinServlet, SpringVaadinSessionListener, Example Code on GitHub

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Autowire	autowire Whether and how to automatically autowire dependencies.
boolean	dependencyCheck Whether to enable dependency checking.
ErrorAction	ifSessionNotLocked What to do when we discover that the VaadinSession is not locked when the annotated bean is constructed.
boolean	preConstruction Whether to inject dependencies prior to constructor execution.
String	value Configuration bean definition template name, if any.

Element Detail

value

public abstract String value

Configuration bean definition template name, if any.

Returns:

bean definition template name, or empty string for none

Default:

""

autowire

public abstract Autowire autowire

Whether and how to automatically autowire dependencies.

Returns:

true to autowire

Default:

org.springframework.beans.factory.annotation.Autowire.NO

dependencyCheck

public abstract boolean dependencyCheck

Whether to enable dependency checking.

Returns:

true for dependency checking

Default:

false

preConstruction

public abstract boolean preConstruction

Whether to inject dependencies prior to constructor execution.

Returns:

true for pre-construction dependency injection

Default:

false

ifSessionNotLocked

public abstract ErrorAction ifSessionNotLocked

What to do when we discover that the VaadinSession is not locked when the annotated bean is constructed. For beans that are (or will interact with) Vaadin widgets, containers, etc., this typically indicates a programming error. In such cases, this property configures what to do, if anything.

Returns:

action to take if session is not locked

See Also:

VaadinSession.getLockInstance()

Default:

org.dellroad.stuff.java.ErrorAction.EXCEPTION