org.dellroad.stuff.vaadin7

Class VaadinApplicationScope

java.lang.Object

org.dellroad.stuff.vaadin7.VaadinApplicationScope

All Implemented Interfaces:

SessionDestroyListener, Serializable, BeanFactoryPostProcessor, Scope

public class VaadinApplicationScope
extends Object
implements Scope, BeanFactoryPostProcessor, SessionDestroyListener

A Spring custom Scope for Vaadin applications.

This scopes beans to the lifetime of the VaadinSession (formerly known as "Vaadin application"). Spring destroy-methods will be invoked when the VaadinSession is closed.

To enable this scope, simply add this bean to your application context as a singleton (it will register itself):

  <!-- Enable the "vaadinApplication" custom scope -->
  <bean class="org.dellroad.stuff.vaadin7.VaadinApplicationScope"/>
 

Then declare scoped beans normally using the scope name "vaadinApplication".

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	SCOPE_NAME The name of this scope (i.e., "vaadinApplication").
static String	VAADIN_SERVICE_SESSION_KEY Key to the current VaadinSession instance.

Constructor Summary

Constructors

Constructor and Description
VaadinApplicationScope()

Method Summary

Modifier and Type	Method and Description
Object	get(String name, ObjectFactory<?> objectFactory)
String	getConversationId()
void	postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)
void	registerDestructionCallback(String name, Runnable callback)
Object	remove(String name)
Object	resolveContextualObject(String key)
void	sessionDestroy(SessionDestroyEvent event)

Methods inherited from class java.lang.Object

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

Field Detail

VAADIN_SERVICE_SESSION_KEY

public static final String VAADIN_SERVICE_SESSION_KEY

Key to the current VaadinSession instance. For use by resolveContextualObject(java.lang.String).

See Also:

Constant Field Values

SCOPE_NAME

public static final String SCOPE_NAME

The name of this scope (i.e., "vaadinApplication").

See Also:

Constant Field Values

Constructor Detail

VaadinApplicationScope

public VaadinApplicationScope()

Method Detail

postProcessBeanFactory

public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory)

Specified by:

postProcessBeanFactory in interface BeanFactoryPostProcessor

sessionDestroy

public void sessionDestroy(SessionDestroyEvent event)

Specified by:

sessionDestroy in interface SessionDestroyListener

get

public Object get(String name,
                  ObjectFactory<?> objectFactory)

Specified by:

get in interface Scope

remove

public Object remove(String name)

Specified by:

remove in interface Scope

registerDestructionCallback

public void registerDestructionCallback(String name,
                                        Runnable callback)

Specified by:

registerDestructionCallback in interface Scope

getConversationId

public String getConversationId()

Specified by:

getConversationId in interface Scope

resolveContextualObject

public Object resolveContextualObject(String key)

Specified by:

resolveContextualObject in interface Scope