AbstractConversationContext (Weld OSGi Bundle 1.1.34.Final API)

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:

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, George Sapountzis

Field Summary

Fields
Modifier and Type Field and Description

static String CONVERSATIONS_ATTRIBUTE_NAME

Fields
Modifier and Type	Field and Description
`static String`	`CONVERSATIONS_ATTRIBUTE_NAME`

Constructor Summary

Constructors
Constructor and Description

AbstractConversationContext()

Constructors
Constructor and Description
`AbstractConversationContext()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`activate()` Activate the Context.
`void`	`activate(String cid)` Activate the conversation context, using the id provided to attempt to restore a long-running conversation
`boolean`	`associate(R request)` Associate the context with the storage (for this thread).
`protected void`	`associateRequest()`
`protected void`	`associateRequest(String cid)`
`protected abstract BoundBeanStore`	`createRequestBeanStore(NamingScheme namingScheme, R request)`
`protected abstract BoundBeanStore`	`createSessionBeanStore(NamingScheme namingScheme, S session)`
`void`	`deactivate()` Deactivate the Context, destroying any instances if the context is invalid.
`boolean`	`destroy(S session)`
`protected void`	`destroyConversation(S session, String id)`
`boolean`	`dissociate(R request)` Dissociate the context from the storage (for this thread).
`String`	`generateConversationId()` Generate a new, unique, conversation id
`long`	`getConcurrentAccessTimeout()` Get the current concurrent access timeout
`ManagedConversation`	`getConversation(String id)` Get the conversation with the given id.
`Collection<ManagedConversation>`	`getConversations()` Get conversations currently known to the context.
`ManagedConversation`	`getCurrentConversation()` Get a handle the current conversation (transient or otherwise).
`long`	`getDefaultTimeout()` Get the default inactivity timeout.
`String`	`getParameterName()` Get the name of the parameter used to propagate the conversation id
`protected abstract Object`	`getRequestAttribute(R request, String name)` Retrieve an attribute value from the request
`Class<? extends Annotation>`	`getScope()` Get the scope type of the context object.
`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 S`	`getSessionFromRequest(R request, boolean create)`
`void`	`invalidate()` Mark the context as due for destruction when deactivate is called.
`protected abstract void`	`removeRequestAttribute(R request, String name)` Remove an attribute from the request.
`void`	`setConcurrentAccessTimeout(long timeout)` Set the concurrent access timeout
`void`	`setDefaultTimeout(long timeout)` Set the default inactivity timeout.
`void`	`setParameterName(String cid)` Set the name of the parameter used to propagate the conversation id
`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, setActive

Methods inherited from class org.jboss.weld.context.AbstractContext
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.Context
get, get, isActive

- Field Detail
  - CONVERSATIONS_ATTRIBUTE_NAME
```
public static final String CONVERSATIONS_ATTRIBUTE_NAME
```
- Constructor Detail
  - AbstractConversationContext
```
public AbstractConversationContext()
```
- Method Detail
  - getParameterName
```
public String getParameterName()
```
    Description copied from interface: ConversationContext
    
    Get the name of the parameter used to propagate the conversation id
    
    Specified by:
    
    getParameterName in interface ConversationContext
    
    Returns:
    
    the name of the conversation id parameter
  - setParameterName
```
public void setParameterName(String cid)
```
    Description copied from interface: ConversationContext
    
    Set the name of the parameter used to propagate the conversation id
    
    Specified by:
    
    setParameterName in interface ConversationContext
    
    Parameters:
    
    cid - the name of the conversation id parameter
  - setConcurrentAccessTimeout
```
public void setConcurrentAccessTimeout(long timeout)
```
    Description copied from interface: ConversationContext
    
    Set the concurrent access timeout
    
    Specified by:
    
    setConcurrentAccessTimeout in interface ConversationContext
    
    Parameters:
    
    timeout - the timeout (in ms) for the concurrent access lock
  - getConcurrentAccessTimeout
```
public long getConcurrentAccessTimeout()
```
    Description copied from interface: ConversationContext
    
    Get the current concurrent access timeout
    
    Specified by:
    
    getConcurrentAccessTimeout in interface ConversationContext
    
    Returns:
    
    the timeout (in ms) for the concurrent access lock
  - setDefaultTimeout
```
public void setDefaultTimeout(long timeout)
```
    Description copied from interface: ConversationContext
    
    Set the default inactivity timeout. This may be overridden on a per conversation basis using Conversation.setTimeout(long)
    
    Specified by:
    
    setDefaultTimeout in interface ConversationContext
    
    Parameters:
    
    timeout - the default inactivity timeout (in ms)
  - getDefaultTimeout
```
public long getDefaultTimeout()
```
    Description copied from interface: ConversationContext
    
    Get the default inactivity timeout. This may have been overridden on a per conversation basis.
    
    Specified by:
    
    getDefaultTimeout in interface ConversationContext
    
    Returns:
    
    the default inactivity timeout (in ms)
  - associate
```
public boolean associate(R request)
```
    Description copied from interface: BoundContext
    
    Associate the context with the storage (for this thread). Once BoundContext.associate(Object) has been called, further calls to BoundContext.associate(Object) will be ignored, until the context has been subsequently BoundContext.dissociate(Object) from the storage.
    
    Specified by:
    
    associate in interface BoundContext<R>
    
    Parameters:
    
    request - the external storage
    
    Returns:
    
    true if the storage was attached, otherwise false
  - dissociate
```
public boolean dissociate(R request)
```
    Description copied from interface: BoundContext
    
    Dissociate the context from the storage (for this thread). The context will only dissociate from the same storage it associated with.
    
    Specified by:
    
    dissociate in interface BoundContext<R>
    
    Overrides:
    
    dissociate in class AbstractBoundContext<R>
    
    Parameters:
    
    request - the external storage
    
    Returns:
    
    true if the storage was dissociated
  - activate
```
public void activate()
```
    Description copied from interface: ManagedContext
    
    Activate the Context.
    
    Specified by:
    
    activate in interface ConversationContext
    
    Specified by:
    
    activate in interface ManagedContext
    
    Overrides:
    
    activate in class AbstractBoundContext<R>
  - associateRequest
```
protected void associateRequest()
```
  - associateRequest
```
protected void associateRequest(String cid)
```
  - activate
```
public void activate(String cid)
```
    Description copied from interface: ConversationContext
    
    Activate the conversation context, using the id provided to attempt to restore a long-running conversation
    
    Specified by:
    
    activate in interface ConversationContext
    
    Parameters:
    
    cid - if the cid is null, a transient conversation will be created, otherwise the conversation will be restored
  - deactivate
```
public void deactivate()
```
    Description copied from interface: ManagedContext
    
    Deactivate the Context, destroying any instances if the context is invalid.
    
    Specified by:
    
    deactivate in interface ManagedContext
    
    Overrides:
    
    deactivate in class AbstractBoundContext<R>
  - invalidate
```
public void invalidate()
```
    Description copied from interface: ManagedContext
    
    Mark the context as due for destruction when deactivate is called.
    
    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()
```
    Description copied from interface: ConversationContext
    
    Generate a new, unique, conversation id
    
    Specified by:
    
    generateConversationId in interface ConversationContext
    
    Returns:
    
    a new, unique conversation id
  - getConversation
```
public ManagedConversation getConversation(String id)
```
    Description copied from interface: ConversationContext
    
    Get the conversation with the given id.
    
    Specified by:
    
    getConversation in interface ConversationContext
    
    Parameters:
    
    id - the id of the conversation to get
    
    Returns:
    
    the conversation, or null if no conversation is known
  - getConversations
```
public Collection<ManagedConversation> getConversations()
```
    Description copied from interface: ConversationContext
    
    Get conversations currently known to the context. This will include any non transient conversations, as well as any conversations which were previously long running and have been made transient during this request.
    
    Specified by:
    
    getConversations in interface ConversationContext
    
    Returns:
    
    a collection containing the conversations
  - getCurrentConversation
```
public ManagedConversation getCurrentConversation()
```
    Description copied from interface: ConversationContext
    
    Get a handle the current conversation (transient or otherwise).
    
    Specified by:
    
    getCurrentConversation in interface ConversationContext
    
    Returns:
    
    the current conversation
  - getScope
```
public Class<? extends Annotation> getScope()
```
    Description copied from interface: Context
    
    Get the scope type of the context object.
    
    Specified by:
    
    getScope in interface Context
    
    Returns:
    
    the scope
  - 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, other wise 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)
```

Class AbstractConversationContext<R,S>

Field Summary

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

Field Detail

CONVERSATIONS_ATTRIBUTE_NAME

Constructor Detail

AbstractConversationContext

Method Detail

getParameterName

setParameterName

setConcurrentAccessTimeout

getConcurrentAccessTimeout

setDefaultTimeout

getDefaultTimeout

associate

dissociate

activate

associateRequest

associateRequest

activate

deactivate

invalidate

destroy

destroyConversation

generateConversationId

getConversation

getConversations

getCurrentConversation

getScope

setSessionAttribute

getSessionAttribute

getSessionAttributeFromSession

removeRequestAttribute

setRequestAttribute

getRequestAttribute

createRequestBeanStore

createSessionBeanStore

getSessionFromRequest