org.nuxeo.ecm.automation

Class OperationContext

java.lang.Object

org.nuxeo.ecm.automation.OperationContext

All Implemented Interfaces:

Map<String,Object>

Direct Known Subclasses:

RestOperationContext, ScriptOperationContext

public class OperationContext
extends Object
implements Map<String,Object>

An operation context. Holds context objects, a context parameters map and a list of operations to run.

Context objects are:

• The Operation Chain Input - optional. It will be used as the input for the first operation in the chain. If input is null then only VOID methods in the first operation will be matched.
• A Core Session - which is optional and should be provided by the caller. (either at creation time as a constructor argument, either using the setCoreSession(CoreSession) method. When running the operation chain in asynchronous mode another session will be created by preserving the current session credentials.

Each entry in the operation list contains the ID of the operation to be run and a map of operation parameters to use when initializing the operation.

The context parameters map can be filled with contextual information by the caller. Each operation will be able to access the contextual data at runtime and to update it if needed.

Author:

Bogdan Stefanescu

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	OperationContext.ChainCallback ChainCallback store all automation traces for execution

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

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected OperationContext.ChainCallback	chainCallback
protected List<CleanupHandler>	cleanupHandlers
protected boolean	commit Whether to save the session at the end of the chain execution.
protected Object	input The execution input that will be updated after an operation run with the operation output
protected LoginStack	loginStack A logins stack manage multiple logins and sessions in a single chain execution
protected Map<String,List<Object>>	stacks Each stack use a key the type of the objects in the stack: document, documents, blob or blobs
protected List<String>	trace A list of trace.
protected Map<String,Object>	vars The context variables map

Constructor Summary

Constructors

Constructor and Description
OperationContext()
OperationContext(CoreSession session)
OperationContext(CoreSession session, Map<String,Object> vars)
OperationContext(OperationContext ctx)

Method Summary

Modifier and Type	Method and Description
void	addChainCallback(OperationCallback chainCallback)
void	addCleanupHandler(CleanupHandler handler)
void	addTrace(String trace) Deprecated.
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
void	dispose()
Set<Map.Entry<String,Object>>	entrySet()
Object	get(Object key)
<T> T	getAdapter(Class<T> type)
OperationCallback	getChainCallback()
CoreSession	getCoreSession()
String	getFormattedTrace() Deprecated.
Object	getInput()
LoginStack	getLoginStack()
Principal	getPrincipal()
OperationContext	getSubContext(Boolean isolate, Object input)
List<String>	getTrace() Deprecated.
Map<String,Object>	getVars()
boolean	isCommit()
boolean	isEmpty()
Set<String>	keySet()
Object	peek(String type)
Object	pop(String type)
Object	pull(String type)
void	push(String type, Object obj)
Object	put(String key, Object value)
void	putAll(Map<? extends String,? extends Object> m)
Object	remove(Object key)
void	removeCleanupHandler(CleanupHandler handler)
void	setCommit(boolean commit)
void	setCoreSession(CoreSession session)
void	setInput(Object input)
void	setRollback() Set the rollback mark on the current tx.
int	size() the map API
Collection<Object>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

vars

protected Map<String,Object> vars

The context variables map

commit

protected boolean commit

Whether to save the session at the end of the chain execution. The default is true.

cleanupHandlers

protected final transient List<CleanupHandler> cleanupHandlers

stacks

protected final transient Map<String,List<Object>> stacks

Each stack use a key the type of the objects in the stack: document, documents, blob or blobs

loginStack

protected transient LoginStack loginStack

A logins stack manage multiple logins and sessions in a single chain execution

input

protected Object input

The execution input that will be updated after an operation run with the operation output

trace

protected List<String> trace

A list of trace. Since 5.7.3 messages is no longer useful for tracing. Use chain call backs to do it.

chainCallback

protected OperationContext.ChainCallback chainCallback

Since:

5.7.3 Collect operation invokes.

Constructor Detail

OperationContext

public OperationContext()

OperationContext

public OperationContext(OperationContext ctx)

OperationContext

public OperationContext(CoreSession session)

OperationContext

public OperationContext(CoreSession session,
                        Map<String,Object> vars)

Method Detail

setCoreSession

public void setCoreSession(CoreSession session)

setCommit

public void setCommit(boolean commit)

isCommit

public boolean isCommit()

getCoreSession

public CoreSession getCoreSession()

getLoginStack

public LoginStack getLoginStack()

getPrincipal

public Principal getPrincipal()

setInput

public void setInput(Object input)

getInput

public Object getInput()

peek

public Object peek(String type)

push

public void push(String type,
                 Object obj)

pop

public Object pop(String type)

pull

public Object pull(String type)

getAdapter

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

addTrace

@Deprecated
public void addTrace(String trace)

Deprecated.

since 5.7.3 #addTrace is no longer useful for tracing. Use chain call backs to do it.

getTrace

@Deprecated
public List<String> getTrace()

Deprecated.

since 5.7.3 #getTrace is no longer useful for tracing. Use chain call backs to do it.

getFormattedTrace

@Deprecated
public String getFormattedTrace()

Deprecated.

since 5.7.3 #getFormattedTrace is no longer useful for tracing. Use chain call backs to do it.

addCleanupHandler

public void addCleanupHandler(CleanupHandler handler)

removeCleanupHandler

public void removeCleanupHandler(CleanupHandler handler)

dispose

public void dispose()
             throws OperationException

Throws:

OperationException

setRollback

public void setRollback()

Set the rollback mark on the current tx. This will cause the transaction to rollback. Also this is setting the session commit flag on false

getVars

public Map<String,Object> getVars()

size

public int size()

the map API

Specified by:

size in interface Map<String,Object>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,Object>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,Object>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,Object>

get

public Object get(Object key)

Specified by:

get in interface Map<String,Object>

put

public Object put(String key,
                  Object value)

Specified by:

put in interface Map<String,Object>

remove

public Object remove(Object key)

Specified by:

remove in interface Map<String,Object>

putAll

public void putAll(Map<? extends String,? extends Object> m)

Specified by:

putAll in interface Map<String,Object>

clear

public void clear()

Specified by:

clear in interface Map<String,Object>

keySet

public Set<String> keySet()

Specified by:

keySet in interface Map<String,Object>

values

public Collection<Object> values()

Specified by:

values in interface Map<String,Object>

entrySet

public Set<Map.Entry<String,Object>> entrySet()

Specified by:

entrySet in interface Map<String,Object>

getChainCallback

public OperationCallback getChainCallback()

Since:

5.7.3

addChainCallback

public void addChainCallback(OperationCallback chainCallback)

Since:

5.7.3

getSubContext

public OperationContext getSubContext(Boolean isolate,
                                      Object input)

Parameters:

isolate - define if keeps context variables for the subcontext

Returns:

a subcontext

Since:

5.7.3