org.granite.client.tide

Class Context

java.lang.Object

org.granite.client.tide.Context

public class Context
extends java.lang.Object

General Tide context implementation It can either wrap a Spring or CDI container or be used separately Currently only one context can be active at a time A context is created by a context manager

Author:

William DRAI

See Also:

ContextManager

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Context.Properties

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Context()
	Context(ContextManager contextManager, Context parentCtx, java.lang.String contextId) Create a context using the specified manager and context id Should not be used directly

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	allByAnnotatedWith(java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass) Return a map of all component instances annotated with the specified annotation
<T> T[]	allByType(java.lang.Class<T> type) Return an array of all component instances implementing the expected type
<T> T[]	allByType(java.lang.Class<T> type, boolean create) Return an array of all component instances implementing the expected type
java.util.List<java.lang.String>	allNames() Return a list of all component names in this context
<T> T	byName(java.lang.String name) Return a component instance by its name in the container InstanceStore implementations are free to (but don't have to) automatically create a suitable component instance with the expected name when no instance exists
<T> T	byNameNoProxy(java.lang.String name) Return a component instance by its name in the container Does not create a default proxy (ComponentImpl) if no instance exists
<T> T	byType(java.lang.Class<T> type) Return a component instance looked up by its type If more than one instance is found, throws a runtime exception
void	callLater(java.lang.Runnable runnable) Convenience method to defer execution of a method in the main UI thread
void	checkValid() Check that this context is not finished
void	clear() Clear all data and instances in the context
void	defineProperties(Context.Properties properties)
void	destroyInstance(java.lang.Object instance) Destroy an instance when it is removed from the context
java.lang.String	getContextId() Context id
ContextManager	getContextManager() Manager for this context
DataManager	getDataManager() Data manager for this context
EntityManager	getEntityManager() Entity manager for this context
EventBus	getEventBus() Event bus for this context
java.util.Map<java.lang.String,java.lang.Object>	getInitialBeans() Map of beans defined before the initialization of the context so they can be registered in the DI container
Context	getParentContext() Parent context for conversation contexts
java.lang.Object	getPlatformContext() Get platform context
void	initContext(Application application, EventBus eventBus, InstanceStore instanceStore) Initialize the context
void	initInstance(java.lang.Object instance, java.lang.String name) Initialize an instance when it is added to the context
boolean	isContextIdFromServer() Indicate that the context id has been defined by the server Unused for now
boolean	isFinished() Indicate that the context is eligible for destruction
boolean	isGlobal() Is this context the global context ?
void	markAsFinished() Mark this context as eligible for destruction
void	postInit()
void	remove(java.lang.Object instance) Remove the component instance from the context May not work with all containers (Spring and CDI are static and cannot be modified after initialization)
void	remove(java.lang.String name) Remove the component instance having the specified name from the context May not work with all containers (Spring and CDI are static and cannot be modified after initialization)
<T> T	set(java.lang.String name, T instance) Set a component instance as a managed instance with the specified name in the context May not work with all containers (Spring and CDI are static and cannot be modified after initialization)
<T> T	set(T instance) Set a component instance as a managed instance in the context May not work with all containers (Spring and CDI are static and cannot be modified after initialization)
void	setContextId(java.lang.String contextId, boolean fromServer) Update the context id
void	setDataManager(DataManager dataManager) Set the data manager for this context
void	setPlatformContext(java.lang.Object context) Set the internal platform context

Methods inherited from class java.lang.Object

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

Constructor Detail

Context

protected Context()

Context

public Context(ContextManager contextManager,
       Context parentCtx,
       java.lang.String contextId)

Create a context using the specified manager and context id Should not be used directly

Parameters:

contextManager - context manager

parentCtx - parent context for conversation contexts (not supported yet)

contextId - context id

Method Detail

getContextManager

public ContextManager getContextManager()

Manager for this context

Returns:

context manager

setPlatformContext

public void setPlatformContext(java.lang.Object context)

Set the internal platform context

Parameters:

context - internal context

getPlatformContext

public java.lang.Object getPlatformContext()

Get platform context

Returns:

internal context

getEntityManager

public EntityManager getEntityManager()

Entity manager for this context

Returns:

entity manager

setDataManager

public void setDataManager(DataManager dataManager)

Set the data manager for this context

Parameters:

dataManager - data manager

See Also:

DataManager

getDataManager

public DataManager getDataManager()

Data manager for this context

Returns:

data manager

getInitialBeans

public java.util.Map<java.lang.String,java.lang.Object> getInitialBeans()

Map of beans defined before the initialization of the context so they can be registered in the DI container

Returns:

map of initialization beans keyed by name

isGlobal

public boolean isGlobal()

Is this context the global context ?

Returns:

is global context

initContext

public void initContext(Application application,
               EventBus eventBus,
               InstanceStore instanceStore)

Initialize the context

Parameters:

application - application for this context (depends on the target platform/framework)

eventBus - event bus for this context (depends on the framework and/or the DI container)

instanceStore - instance store (depends on the DI container)

getEventBus

public EventBus getEventBus()

Event bus for this context

Returns:

event bus

postInit

public void postInit()

getParentContext

public Context getParentContext()

Parent context for conversation contexts

Returns:

parent context

getContextId

public java.lang.String getContextId()

Context id

Returns:

context id

isContextIdFromServer

public boolean isContextIdFromServer()

Indicate that the context id has been defined by the server Unused for now

Returns:

true if id received from server

isFinished

public boolean isFinished()

Indicate that the context is eligible for destruction

Returns:

true is finished

setContextId

public void setContextId(java.lang.String contextId,
                boolean fromServer)

Update the context id

Parameters:

contextId - context id

fromServer - is this id received from the server ?

byName

public <T> T byName(java.lang.String name)

Return a component instance by its name in the container InstanceStore implementations are free to (but don't have to) automatically create a suitable component instance with the expected name when no instance exists

Type Parameters:

T - component type

Parameters:

name - component name

Returns:

component instance

byNameNoProxy

public <T> T byNameNoProxy(java.lang.String name)

Return a component instance by its name in the container Does not create a default proxy (ComponentImpl) if no instance exists

Type Parameters:

T - component type

Parameters:

name - component name

Returns:

component instance or null if not found

byType

public <T> T byType(java.lang.Class<T> type)

Return a component instance looked up by its type If more than one instance is found, throws a runtime exception

Type Parameters:

T - expected component type

Parameters:

type - expected component type

Returns:

component instance

allByType

public <T> T[] allByType(java.lang.Class<T> type)

Return an array of all component instances implementing the expected type

Type Parameters:

T - expected component type

Parameters:

type - expected component type

Returns:

array of component instances

allByType

public <T> T[] allByType(java.lang.Class<T> type,
                boolean create)

Return an array of all component instances implementing the expected type

Type Parameters:

T - expected component type

Parameters:

type - expected component type

create - if true, should create an instance if none is existing

Returns:

array of component instances or null if no instance found

allByAnnotatedWith

public java.util.Map<java.lang.String,java.lang.Object> allByAnnotatedWith(java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)

Return a map of all component instances annotated with the specified annotation

Parameters:

annotationClass - annotation

Returns:

map of component instances keyed by name

allNames

public java.util.List<java.lang.String> allNames()

Return a list of all component names in this context

Returns:

list of names

set

public <T> T set(java.lang.String name,
        T instance)

Set a component instance as a managed instance with the specified name in the context May not work with all containers (Spring and CDI are static and cannot be modified after initialization)

Type Parameters:

T - component type

Parameters:

name - component name

instance - component instance

Returns:

component instance

set

public <T> T set(T instance)

Set a component instance as a managed instance in the context May not work with all containers (Spring and CDI are static and cannot be modified after initialization)

Type Parameters:

T - component type

Parameters:

instance - component instance

Returns:

component instance

remove

public void remove(java.lang.String name)

Remove the component instance having the specified name from the context May not work with all containers (Spring and CDI are static and cannot be modified after initialization)

Parameters:

name - component name

remove

public void remove(java.lang.Object instance)

Remove the component instance from the context May not work with all containers (Spring and CDI are static and cannot be modified after initialization)

Parameters:

instance - component instance

clear

public void clear()

Clear all data and instances in the context

initInstance

public void initInstance(java.lang.Object instance,
                java.lang.String name)

Initialize an instance when it is added to the context

Parameters:

instance - component instance

name - component name

destroyInstance

public void destroyInstance(java.lang.Object instance)

Destroy an instance when it is removed from the context

Parameters:

instance - component instance

defineProperties

public void defineProperties(Context.Properties properties)

checkValid

public void checkValid()

Check that this context is not finished

Throws:

InvalidContextException - when context finished

callLater

public void callLater(java.lang.Runnable runnable)

Convenience method to defer execution of a method in the main UI thread

Parameters:

runnable - runnable method

markAsFinished

public void markAsFinished()

Mark this context as eligible for destruction