org.jboss.weld.context

Class AbstractConversationContext<R,S>

java.lang.Object

org.jboss.weld.context.AbstractContext

org.jboss.weld.context.AbstractManagedContext

org.jboss.weld.context.AbstractBoundContext<R>

org.jboss.weld.context.AbstractConversationContext<R,S>

All Implemented Interfaces:

javax.enterprise.context.spi.AlterableContext, javax.enterprise.context.spi.Context, BoundContext<R>, ConversationContext, ManagedContext

Direct Known Subclasses:

BoundConversationContextImpl, HttpConversationContextImpl

public abstract class AbstractConversationContext<R,S>
extends AbstractBoundContext<R>
implements ConversationContext

The base of the conversation context, which can use a variety of storage forms

Author:

Pete Muir, Jozef Hartinger, George Sapountzis, Marko Luksa

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONVERSATIONS_ATTRIBUTE_NAME
static String	DESTRUCTION_QUEUE_ATTRIBUTE_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractConversationContext(String contextId, org.jboss.weld.bootstrap.api.ServiceRegistry services)

Method Summary

Modifier and Type	Method and Description
void	activate()
void	activate(String cid)
boolean	associate(R request)
protected void	associateRequest(ManagedConversation conversation)
protected void	associateRequestWithNewConversation()
void	conversationPromotedToLongRunning(ConversationImpl conversation)
protected void	copyConversationIdGeneratorAndConversationsToSession()
protected abstract BoundBeanStore	createRequestBeanStore(NamingScheme namingScheme, R request)
protected abstract BoundBeanStore	createSessionBeanStore(NamingScheme namingScheme, S session)
void	deactivate()
boolean	destroy(S session)
protected void	destroyConversation(S session, String id)
boolean	dissociate(R request)
String	generateConversationId()
long	getConcurrentAccessTimeout()
ManagedConversation	getConversation(String id)
protected ConversationIdGenerator	getConversationIdGenerator()
Collection<ManagedConversation>	getConversations()
ManagedConversation	getCurrentConversation()
long	getDefaultTimeout()
protected abstract String	getNamingSchemePrefix()
String	getParameterName()
protected R	getRequest() Get the associated store
protected abstract Object	getRequestAttribute(R request, String name) Retrieve an attribute value from the request
Class<? extends Annotation>	getScope()
protected abstract Object	getSessionAttribute(R request, String name, boolean create) Get an attribute value from the session.
protected abstract Object	getSessionAttributeFromSession(S session, String name) Get an attribute value from the session.
protected abstract Iterator<String>	getSessionAttributeNames(S session)
protected abstract S	getSessionFromRequest(R request, boolean create)
protected void	initialize(String cid)
void	invalidate()
protected boolean	isAssociated() Check if the context is currently associated
protected abstract void	removeRequestAttribute(R request, String name) Remove an attribute from the request.
void	sessionCreated()
void	setConcurrentAccessTimeout(long timeout)
void	setDefaultTimeout(long timeout)
void	setParameterName(String cid)
protected abstract void	setRequestAttribute(R request, String name, Object value) Set an attribute in the request.
protected abstract void	setSessionAttribute(R request, String name, Object value, boolean create) Set an attribute in the session.

Methods inherited from class org.jboss.weld.context.AbstractBoundContext

cleanup, getBeanStore, setBeanStore

Methods inherited from class org.jboss.weld.context.AbstractManagedContext

isActive, isValid, removeState, setActive

Methods inherited from class org.jboss.weld.context.AbstractContext

checkContextInitialized, destroy, destroy, get, get, getContextual, getId, getServiceRegistry

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.enterprise.context.spi.AlterableContext

destroy

Methods inherited from interface javax.enterprise.context.spi.Context

get, get, isActive

Field Detail

CONVERSATIONS_ATTRIBUTE_NAME

public static final String CONVERSATIONS_ATTRIBUTE_NAME

DESTRUCTION_QUEUE_ATTRIBUTE_NAME

public static final String DESTRUCTION_QUEUE_ATTRIBUTE_NAME

Constructor Detail

AbstractConversationContext

public AbstractConversationContext(String contextId,
                                   org.jboss.weld.bootstrap.api.ServiceRegistry services)

Method Detail

getParameterName

public String getParameterName()

Specified by:

getParameterName in interface ConversationContext

setParameterName

public void setParameterName(String cid)

Specified by:

setParameterName in interface ConversationContext

setConcurrentAccessTimeout

public void setConcurrentAccessTimeout(long timeout)

Specified by:

setConcurrentAccessTimeout in interface ConversationContext

getConcurrentAccessTimeout

public long getConcurrentAccessTimeout()

Specified by:

getConcurrentAccessTimeout in interface ConversationContext

setDefaultTimeout

public void setDefaultTimeout(long timeout)

Specified by:

setDefaultTimeout in interface ConversationContext

getDefaultTimeout

public long getDefaultTimeout()

Specified by:

getDefaultTimeout in interface ConversationContext

associate

public boolean associate(R request)

Specified by:

associate in interface BoundContext<R>

dissociate

public boolean dissociate(R request)

Specified by:

dissociate in interface BoundContext<R>

Overrides:

dissociate in class AbstractBoundContext<R>

copyConversationIdGeneratorAndConversationsToSession

protected void copyConversationIdGeneratorAndConversationsToSession()

sessionCreated

public void sessionCreated()

associateRequestWithNewConversation

protected void associateRequestWithNewConversation()

associateRequest

protected void associateRequest(ManagedConversation conversation)

activate

public void activate()

Specified by:

activate in interface ConversationContext

Specified by:

activate in interface ManagedContext

Overrides:

activate in class AbstractBoundContext<R>

activate

public void activate(String cid)

Specified by:

activate in interface ConversationContext

initialize

protected void initialize(String cid)

deactivate

public void deactivate()

Specified by:

deactivate in interface ManagedContext

Overrides:

deactivate in class AbstractBoundContext<R>

conversationPromotedToLongRunning

public void conversationPromotedToLongRunning(ConversationImpl conversation)

invalidate

public void invalidate()

Specified by:

invalidate in interface ConversationContext

Specified by:

invalidate in interface ManagedContext

Overrides:

invalidate in class AbstractManagedContext

destroy

public boolean destroy(S session)

destroyConversation

protected void destroyConversation(S session,
                                   String id)

generateConversationId

public String generateConversationId()

Specified by:

generateConversationId in interface ConversationContext

getConversationIdGenerator

protected ConversationIdGenerator getConversationIdGenerator()

getConversation

public ManagedConversation getConversation(String id)

Specified by:

getConversation in interface ConversationContext

getConversations

public Collection<ManagedConversation> getConversations()

Specified by:

getConversations in interface ConversationContext

getCurrentConversation

public ManagedConversation getCurrentConversation()

Specified by:

getCurrentConversation in interface ConversationContext

getScope

public Class<? extends Annotation> getScope()

Specified by:

getScope in interface javax.enterprise.context.spi.Context

setSessionAttribute

protected abstract void setSessionAttribute(R request,
                                            String name,
                                            Object value,
                                            boolean create)

Set an attribute in the session.

Parameters:

request - the request to set the session attribute in

name - the name of the attribute

value - the value of the attribute

create - if false, the attribute will only be set if the session already exists, otherwise it will always be set

Throws:

IllegalStateException - if create is true, and the session can't be created

getSessionAttribute

protected abstract Object getSessionAttribute(R request,
                                              String name,
                                              boolean create)

Get an attribute value from the session.

Parameters:

request - the request to get the session attribute from

name - the name of the attribute

create - if false, the attribute will only be retrieved if the session already exists, other wise it will always be retrieved

Returns:

attribute

Throws:

IllegalStateException - if create is true, and the session can't be created

getSessionAttributeFromSession

protected abstract Object getSessionAttributeFromSession(S session,
                                                         String name)

Get an attribute value from the session.

Parameters:

session - the session to get the session attribute from

name - the name of the attribute

Returns:

attribute

Throws:

IllegalStateException - if create is true, and the session can't be created

removeRequestAttribute

protected abstract void removeRequestAttribute(R request,
                                               String name)

Remove an attribute from the request.

Parameters:

request - the request to remove the attribute from

name - the name of the attribute

setRequestAttribute

protected abstract void setRequestAttribute(R request,
                                            String name,
                                            Object value)

Set an attribute in the request.

Parameters:

request - the request to set the attribute from

name - the name of the attribute

value - the value of the attribute

getRequestAttribute

protected abstract Object getRequestAttribute(R request,
                                              String name)

Retrieve an attribute value from the request

Parameters:

request - the request to get the attribute from

name - the name of the attribute to get

Returns:

the value of the attribute

createRequestBeanStore

protected abstract BoundBeanStore createRequestBeanStore(NamingScheme namingScheme,
                                                         R request)

createSessionBeanStore

protected abstract BoundBeanStore createSessionBeanStore(NamingScheme namingScheme,
                                                         S session)

getSessionFromRequest

protected abstract S getSessionFromRequest(R request,
                                           boolean create)

getNamingSchemePrefix

protected abstract String getNamingSchemePrefix()

isAssociated

protected boolean isAssociated()

Check if the context is currently associated

Returns:

true if the context is associated

getRequest

protected R getRequest()

Get the associated store

Returns:

the request

getSessionAttributeNames

protected abstract Iterator<String> getSessionAttributeNames(S session)