com.axelor.rpc

Class Context

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

com.axelor.rpc.Context

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

public class Context
extends HashMap<String,Object>

The Context class represents an ActionRequest context.

The request context is mapped to an instance of the bean class on which the action is being performed. The instance can be accessed via asType(Class) method.
Example (Java):

 Context context = request.getContext();
 SaleOrderLine soLine = context.asType(SaleOrderLine.class);
 SaleOrder so = context.getParentContext().asType(SaleOrder.class);
 

Example (Groovy):

 def context = request.context
 def soLine = context as SaleOrderLine
 def so = context.parentContext as SaleOrder
 

The bean instanced returned from the context is a detached object (possibly a cglib proxy) and should not be used with JPA/Hibernate session. It's only for convenience to get the context values using the bean methods.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
<T> T	asType(Class<T> type)
boolean	containsKey(Object key)
static Context	create(Map<String,Object> data, Class<?> beanClass)
Object	get(Object key)
Class<?>	getContextClass()
Context	getParentContext()
void	update(Map<String,Object> values) Update the context object with the given values. Use this method instead of HashMap.putAll(Map) to propagate the values to the underlying context object.
void	update(String key, Object value) Update the context with the specified key and value. Use this method instead of HashMap.put(K, V) to propagate the value to the underlying context object.

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsValue, entrySet, forEach, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Method Detail

create

public static Context create(Map<String,Object> data,
                             Class<?> beanClass)

asType

public <T> T asType(Class<T> type)

getContextClass

public Class<?> getContextClass()

getParentContext

public Context getParentContext()

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,Object>

Overrides:

containsKey in class HashMap<String,Object>

get

public Object get(Object key)

Specified by:

get in interface Map<String,Object>

Overrides:

get in class HashMap<String,Object>

update

public void update(String key,
                   Object value)

Update the context with the specified key and value.
Use this method instead of HashMap.put(K, V) to propagate the value to the underlying context object.

Parameters:

key - key with with the context should be updated

value - value to be associated to the given key

update

public void update(Map<String,Object> values)

Update the context object with the given values.
Use this method instead of HashMap.putAll(Map) to propagate the values to the underlying context object.

Parameters:

values - mappings to be updated