org.apache.deltaspike.cdise.api

Interface ContextControl

public interface ContextControl

Control native CDI Container Contexts. Just inject this interface and you gain manual access over built-in Contexts. The respective integration code will provide a &064;Dependent scoped instance which itself is stateless. The startContext(Class) and stopContext(Class) only affect the current Thread. When leaving a Thread each started context needs to get stopped as well (best practice is to do that in a finally block. If a container supports controlling the Session Context then each Thread will get a new 'dummy' storage assigned. It is not intended to 'attach' to a real Session but to allow the re-use of existing beans. Many containers make heavy use of ThreadLocals. Thus it might be necessary to call

     contextControl.startContext(ApplicationScoped.class);
 

to 'attach' or 'activate' the ApplicationContext within your current Thread.

Method Summary

Modifier and Type	Method and Description
void	startContext(Class<? extends java.lang.annotation.Annotation> scopeClass) Start the specified scope.
void	startContexts() This will start all container built-in Contexts
void	stopContext(Class<? extends java.lang.annotation.Annotation> scopeClass) Stop the specified scope.
void	stopContexts() Stop all container built-in Contexts and destroy all beans properly

Method Detail

startContexts

void startContexts()

This will start all container built-in Contexts

stopContexts

void stopContexts()

Stop all container built-in Contexts and destroy all beans properly

startContext

void startContext(Class<? extends java.lang.annotation.Annotation> scopeClass)

Start the specified scope. This only works for scopes which are handled by the CDI container itself. Custom scoped of 3rd party Context implementations shall be started directly (they are portable anyway).

Parameters:

scopeClass - e.g. RequestScoped.class

stopContext

void stopContext(Class<? extends java.lang.annotation.Annotation> scopeClass)

Stop the specified scope. This only works for scopes which are handled by the CDI container itself. Custom scoped of 3rd party Context implementations shall be stopped directly (they are portable anyway).

Parameters:

scopeClass - e.g. RequestScoped.class