Package com.atlassian.bamboo.chains

Class ExecutionContextImpl

java.lang.Object

com.atlassian.bamboo.chains.ExecutionContext

com.atlassian.bamboo.chains.ExecutionContextImpl

All Implemented Interfaces:

Serializable

@PublicApi
public final class ExecutionContextImpl
extends ExecutionContext
implements Serializable

Stores non-persistant contextual data during the execution of a Chain and its ChainStages Key references are weak. The key and value will be garbage collected if the Key reference is lost. Plugin developers may put their own objects into the ExecutionContextImpl to pass information between ChainExecutionManager plugin points. All values remain on the server and are never sent over the network to the Agent and values are no longer available once the Chain finishes executing To store objects in the ExecutionContextImpl first create a key (We recommend that you declare this as static final in one of your classes): Key<MyPluginState> myKey = Key.create(MyPluginState.class); Using the key we can store a new reference of MyPluginState into the ExecutionContextImpl ExecutionContext context = chainExecution.getExecutionContext(); context.putIfAbsent(myKey, new MyPluginState()); To retrieve your object: MyPluginState state = context.getValue(myKey); See ChainExecution.getExecutionContext() and StageExecution.getExecutionContext()

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ExecutionContextImpl()

Method Summary

Modifier and Type	Method	Description
boolean	containsKey(Key<?> key)
<V> V	getValue(Key<V> key)
<V> V	putIfAbsent(Key<V> key, V value)
boolean	remove(Key<?> key, Object value)
<V> boolean	replace(Key<?> key, V oldValue, V newValue)
Collection<Object>	values()

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutionContextImpl

public ExecutionContextImpl()

Method Detail

getValue

@Nullable
public <V> V getValue(Key<V> key)

Specified by:

getValue in class ExecutionContext

containsKey

public boolean containsKey(Key<?> key)

Specified by:

containsKey in class ExecutionContext

remove

public boolean remove(Key<?> key,
                      Object value)

Specified by:

remove in class ExecutionContext

values

public Collection<Object> values()

Specified by:

values in class ExecutionContext

putIfAbsent

public <V> V putIfAbsent(Key<V> key,
                         V value)

Specified by:

putIfAbsent in class ExecutionContext

replace

public <V> boolean replace(Key<?> key,
                           V oldValue,
                           V newValue)

Specified by:

replace in class ExecutionContext