org.apache.deltaspike.core.impl.scope.window

Class WindowBeanHolder

java.lang.Object

org.apache.deltaspike.core.impl.scope.window.WindowBeanHolder

All Implemented Interfaces:

Serializable

@SessionScoped
public class WindowBeanHolder
extends Object
implements Serializable

This holder will store the window Ids and it's beans for the current HTTP Session. We use standard SessionScoped bean to not need to treat async-supported and similar headache.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WindowBeanHolder()

Method Summary

Methods

Modifier and Type	Method and Description
void	destroyBeans() This method properly destroys all current @WindowScoped beans of the active session and also prepares the storage for new beans.
Map<String,org.apache.deltaspike.core.util.context.ContextualStorage>	forceNewStorage() This method will replace the storageMap and with a new empty one.
org.apache.deltaspike.core.util.context.ContextualStorage	getContextualStorage(javax.enterprise.inject.spi.BeanManager beanManager, String windowId) This method will return the ContextualStorage or create a new one if no one is yet assigned to the current windowId.
Map<String,org.apache.deltaspike.core.util.context.ContextualStorage>	getStorageMap()

Methods inherited from class java.lang.Object

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

Constructor Detail

WindowBeanHolder

public WindowBeanHolder()

Method Detail

getContextualStorage

public org.apache.deltaspike.core.util.context.ContextualStorage getContextualStorage(javax.enterprise.inject.spi.BeanManager beanManager,
                                                                             String windowId)

This method will return the ContextualStorage or create a new one if no one is yet assigned to the current windowId.

Parameters:

beanManager - we need the CDI BeanManager for serialisation.

windowId - the windowId for the current browser tab or window.

getStorageMap

public Map<String,org.apache.deltaspike.core.util.context.ContextualStorage> getStorageMap()

forceNewStorage

public Map<String,org.apache.deltaspike.core.util.context.ContextualStorage> forceNewStorage()

This method will replace the storageMap and with a new empty one. This method can be used to properly destroy the WindowBeanHolder beans without having to sync heavily. Any Contextual.destroy(Object, javax.enterprise.context.spi.CreationalContext) should be performed on the returned old storage map.

Returns:

the old storageMap.

destroyBeans

@PreDestroy
public void destroyBeans()

This method properly destroys all current @WindowScoped beans of the active session and also prepares the storage for new beans. It will automatically get called when the session context closes but can also get invoked manually, e.g. if a user likes to get rid of all it's @WindowScoped beans.