org.granite.client.tide.impl

Class SimpleContextManager

java.lang.Object

org.granite.client.tide.impl.SimpleContextManager

All Implemented Interfaces:

ContextManager

Direct Known Subclasses:

AndroidContextManager

public class SimpleContextManager
extends java.lang.Object
implements ContextManager

Author:

William DRAI

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleContextManager.DefaultInstanceStoreFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected Application	application
static java.lang.String	CONTEXT_CREATE
static java.lang.String	CONTEXT_DESTROY
protected EventBus	eventBus

Constructor Summary

Constructors

Constructor and Description
SimpleContextManager()
SimpleContextManager(Application application) Create a simple context manager using the specified application
SimpleContextManager(Application application, EventBus eventBus) Create a simple context manager using the specified application and event bus

Method Summary

Methods

Modifier and Type	Method and Description
void	addToContextsToDestroy(java.lang.String contextId) Add context to the list of contexts to destroy
protected Context	createContext(Context parentCtx, java.lang.String contextId)
void	destroyContext(java.lang.String contextId) Destroy a context
void	destroyContexts() Destroy all contexts
void	destroyFinishedContexts() Destroy finished contexts and reset current pending contexts
java.util.List<Context>	getAllContexts() Get a list of all conversation contexts
Context	getContext() Get the global context
Context	getContext(java.lang.String contextId) Get the context from its id
Context	getContext(java.lang.String contextId, java.lang.String parentContextId, boolean create) Get a context from its id with the specified parent id, and create it if it does not exist
void	initModules(java.lang.Class<?>... moduleClasses) Configure modules for specified class names
void	initModules(java.lang.String... moduleClassNames) Configure modules for specified class names
boolean	isGlobal(Context context) Determine if the specified context is the global one
Context	newContext(java.lang.String contextId, java.lang.String parentContextId) Create a context with the specified id and parent id if it does not exist
void	registerFactory(java.lang.Class<?> type, Factory<?> factory)
void	registerFactory(java.lang.String name, Factory<?> factory)
void	removeFromContextsToDestroy(java.lang.String contextId) Remove context from the list of contexts to destroy
Context	retrieveContext(Context sourceContext, java.lang.String contextId, boolean wasConversationCreated, boolean wasConversationEnded) Get or create the context for the specified context id and server conversation flags
void	scanModules(java.lang.String... packageNames) Scan specific packages and configure found modules
void	setInstanceStoreFactory(InstanceStoreFactory instanceStoreFactory) Set the instance store factory for this context manager
void	updateContextId(java.lang.String previousContextId, Context context) Defines new context for existing id

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT_CREATE

public static final java.lang.String CONTEXT_CREATE

See Also:

Constant Field Values

CONTEXT_DESTROY

public static final java.lang.String CONTEXT_DESTROY

See Also:

Constant Field Values

application

protected final Application application

eventBus

protected final EventBus eventBus

Constructor Detail

SimpleContextManager

public SimpleContextManager()

SimpleContextManager

public SimpleContextManager(Application application)

Create a simple context manager using the specified application

Parameters:

application - application

SimpleContextManager

public SimpleContextManager(Application application,
                    EventBus eventBus)

Create a simple context manager using the specified application and event bus

Parameters:

application - application

eventBus - event bus

Method Detail

setInstanceStoreFactory

public void setInstanceStoreFactory(InstanceStoreFactory instanceStoreFactory)

Set the instance store factory for this context manager

Parameters:

instanceStoreFactory - instance store factory

isGlobal

public boolean isGlobal(Context context)

Determine if the specified context is the global one

Specified by:

isGlobal in interface ContextManager

Parameters:

context -

Returns:

true if global

getContext

public Context getContext()

Description copied from interface: ContextManager

Get the global context

Specified by:

getContext in interface ContextManager

Returns:

global context

getContext

public Context getContext(java.lang.String contextId)

Description copied from interface: ContextManager

Get the context from its id

Specified by:

getContext in interface ContextManager

Parameters:

contextId - context id

Returns:

context

createContext

protected Context createContext(Context parentCtx,
                    java.lang.String contextId)

getContext

public Context getContext(java.lang.String contextId,
                 java.lang.String parentContextId,
                 boolean create)

Description copied from interface: ContextManager

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

Specified by:

getContext in interface ContextManager

Parameters:

contextId - context id

parentContextId - parent context id

create - if true, create a context if not exist

Returns:

the context

newContext

public Context newContext(java.lang.String contextId,
                 java.lang.String parentContextId)

Description copied from interface: ContextManager

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

Specified by:

newContext in interface ContextManager

Parameters:

contextId - context id

parentContextId - parent context id

Returns:

the created context

destroyContext

public void destroyContext(java.lang.String contextId)

Description copied from interface: ContextManager

Destroy a context

Specified by:

destroyContext in interface ContextManager

Parameters:

contextId - context id

getAllContexts

public java.util.List<Context> getAllContexts()

Description copied from interface: ContextManager

Get a list of all conversation contexts

Specified by:

getAllContexts in interface ContextManager

Returns:

list of conversation contexts

destroyContexts

public void destroyContexts()

Description copied from interface: ContextManager

Destroy all contexts

Specified by:

destroyContexts in interface ContextManager

destroyFinishedContexts

public void destroyFinishedContexts()

Description copied from interface: ContextManager

Destroy finished contexts and reset current pending contexts

Specified by:

destroyFinishedContexts in interface ContextManager

removeFromContextsToDestroy

public void removeFromContextsToDestroy(java.lang.String contextId)

Remove context from the list of contexts to destroy

Specified by:

removeFromContextsToDestroy in interface ContextManager

Parameters:

contextId - context id

addToContextsToDestroy

public void addToContextsToDestroy(java.lang.String contextId)

Add context to the list of contexts to destroy

Specified by:

addToContextsToDestroy in interface ContextManager

Parameters:

contextId - context id

retrieveContext

public Context retrieveContext(Context sourceContext,
                      java.lang.String contextId,
                      boolean wasConversationCreated,
                      boolean wasConversationEnded)

Description copied from interface: ContextManager

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

Specified by:

retrieveContext in interface ContextManager

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

public void updateContextId(java.lang.String previousContextId,
                   Context context)

Defines new context for existing id

Specified by:

updateContextId in interface ContextManager

Parameters:

previousContextId - existing id

context - new context

scanModules

public void scanModules(java.lang.String... packageNames)

Scan specific packages and configure found modules

Parameters:

packageNames - module package names

initModules

public void initModules(java.lang.String... moduleClassNames)

Configure modules for specified class names

Parameters:

moduleClassNames - module classes

initModules

public void initModules(java.lang.Class<?>... moduleClasses)

Configure modules for specified class names

Parameters:

moduleClasses - module classes

registerFactory

public void registerFactory(java.lang.String name,
                   Factory<?> factory)

registerFactory

public void registerFactory(java.lang.Class<?> type,
                   Factory<?> factory)