org.granite.client.tide

Interface ContextManager

All Known Implementing Classes:

CDIContextManager, SimpleContextManager, SpringContextManager

public interface ContextManager

Main interface for Tide context management The context manager is meant to be a singleton in the application and should be defined as a singleton in a DI container

 ContextManager contextManager = new SimpleContextManager();
 Context context = contextManager.getContext();
 ...
 
 

Author:

William DRAI

Method Summary

Methods

Modifier and Type	Method and Description
void	addToContextsToDestroy(String contextId) Schedule a context for destruction after the next remote call
void	destroyContext(String contextId) Destroy a context
void	destroyContexts() Destroy all contexts
void	destroyFinishedContexts() Destroy finished contexts and reset current pending contexts
List<Context>	getAllContexts() Get a list of all conversation contexts
Context	getContext() Get the global context
Context	getContext(String contextId) Get the context from its id
Context	getContext(String contextId, String parentContextId, boolean create) Get a context from its id with the specified parent id, and create it if it does not exist
Context	newContext(String contextId, String parentContextId) Create a context with the specified id and parent id if it does not exist
void	removeFromContextsToDestroy(String contextId) Deschedule destruction of context
Context	retrieveContext(Context sourceContext, String contextId, boolean wasConversationCreated, boolean wasConversationEnded) Get or create the context for the specified context id and server conversation flags
void	updateContextId(String previousContextId, Context context) Update the context id for an existing context

Method Detail

getContext

Context getContext()

Get the global context

Returns:

global context

getContext

Context getContext(String contextId)

Get the context from its id

Parameters:

contextId - context id

Returns:

context

getContext

Context getContext(String contextId,
                 String parentContextId,
                 boolean create)

Get a context from its id with the specified parent id, and create it if it does not exist

Parameters:

contextId - context id

parentContextId - parent context id

create - if true, create a context if not exist

Returns:

the context

newContext

Context newContext(String contextId,
                 String parentContextId)

Create a context with the specified id and parent id if it does not exist

Parameters:

contextId - context id

parentContextId - parent context id

Returns:

the created context

retrieveContext

Context retrieveContext(Context sourceContext,
                      String contextId,
                      boolean wasConversationCreated,
                      boolean wasConversationEnded)

Get or create the context for the specified context id and server conversation flags

Parameters:

sourceContext - source context

contextId - conversation context id

wasConversationCreated - true if the conversation was just created by the last request on the server

wasConversationEnded - true if the conversation was just ended by the last request on the server

Returns:

the matching context

updateContextId

void updateContextId(String previousContextId,
                   Context context)

Update the context id for an existing context

Parameters:

previousContextId - previous context id

context - context to update

destroyContext

void destroyContext(String contextId)

Destroy a context

Parameters:

contextId - context id

getAllContexts

List<Context> getAllContexts()

Get a list of all conversation contexts

Returns:

list of conversation contexts

destroyContexts

void destroyContexts()

Destroy all contexts

destroyFinishedContexts

void destroyFinishedContexts()

Destroy finished contexts and reset current pending contexts

addToContextsToDestroy

void addToContextsToDestroy(String contextId)

Schedule a context for destruction after the next remote call

Parameters:

contextId - context id

removeFromContextsToDestroy

void removeFromContextsToDestroy(String contextId)

Deschedule destruction of context

Parameters:

contextId - context id