org.dellroad.stuff.vaadin7.VaadinConfigurable Maven / Gradle / Ivy
Show all versions of dellroad-stuff-vaadin7 Show documentation
/*
* Copyright (C) 2022 Archie L. Cobbs. All rights reserved.
*/
package org.dellroad.stuff.vaadin7;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.dellroad.stuff.java.ErrorAction;
import org.springframework.beans.factory.annotation.Autowire;
/**
* Indicates that the class is a candidate for configuration using the {@code VaadinConfigurableAspect} aspect.
*
*
* Analogous to Spring's {@link org.springframework.beans.factory.annotation.Configurable @Configurable} annotation,
* but causes beans to be autowired into the Spring application context associated with the current
* {@link com.vaadin.server.VaadinSession} (aka "Vaadin application") by {@link SpringVaadinSessionListener} instead of
* the Spring application context associated with the servlet context.
*
*
* For an extra safety check, consider setting {@link org.dellroad.stuff.vaadin7.VaadinConfigurable#ifSessionNotLocked}
* where appropriate.
*
*
* For the this annotation to function properly, {@link VaadinConfigurable @VaadinConfigurable} classes must be woven
* (either at build time or runtime) using the
* AspectJ compiler with the
* {@code VaadinConfigurableAspect} aspect (included in the dellroad-stuff JAR file), and the
* {@link SpringVaadinServlet} must be used.
*
* @see org.dellroad.stuff.vaadin7
* @see SpringVaadinServlet
* @see SpringVaadinSessionListener
* @see Example Code on GitHub
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Inherited
public @interface VaadinConfigurable {
/**
* Configuration bean definition template name, if any.
*
* @return bean definition template name, or empty string for none
*/
String value() default "";
/**
* Whether and how to automatically autowire dependencies.
*
* @return true to autowire
*/
Autowire autowire() default Autowire.NO;
/**
* Whether to enable dependency checking.
*
* @return true for dependency checking
*/
boolean dependencyCheck() default false;
/**
* Whether to inject dependencies prior to constructor execution.
*
* @return true for pre-construction dependency injection
*/
boolean preConstruction() default false;
/**
* What to do when we discover that the {@link com.vaadin.server.VaadinSession} is not
* {@linkplain com.vaadin.server.VaadinSession#getLockInstance 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.
*
* @return action to take if session is not locked
* @see com.vaadin.server.VaadinSession#getLockInstance
*/
ErrorAction ifSessionNotLocked() default ErrorAction.EXCEPTION;
}