ExecutionContext (xdi2-messaging 0.7.2 API)

java.lang.Object
- xdi2.messaging.context.ExecutionContext

All Implemented Interfaces:

Serializable
```
public final class ExecutionContext
extends Object
implements Serializable
```
Messaging targets as well as contributors and interceptors can use the ExecutionContext to store and share state. The ExecutionContext is created before a MessageEnvelope is executed, and is deleted when execution of the MessageEnvelope is complete. It contains the current position in the execution process, and attributes associated with various stages.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

ExecutionContext()

Constructors
Constructor and Description
`ExecutionContext()`

Method Summary

Methods
Modifier and Type	Method and Description
`Contributor`	`getCurrentContributor()`
`Interceptor<MessagingTarget>`	`getCurrentInterceptor()`
`Message`	`getCurrentMessage()`
`MessageEnvelope`	`getCurrentMessageEnvelope()`
`List<MessageEnvelope>`	`getCurrentMessageEnvelopes()`
`List<Message>`	`getCurrentMessages()`
`MessagingTarget`	`getCurrentMessagingTarget()`
`List<MessagingTarget>`	`getCurrentMessagingTargets()`
`Operation`	`getCurrentOperation()`
`List<Operation>`	`getCurrentOperations()`
`XDIAddress`	`getCurrentTargetAddress()`
`XDIStatement`	`getCurrentTargetStatement()`
`Xdi2MessagingException`	`getException()`
`Contributor`	`getExceptionContributor()`
`Interceptor<MessagingTarget>`	`getExceptionInterceptor()`
`Message`	`getExceptionMessage()`
`MessageEnvelope`	`getExceptionMessageEnvelope()`
`MessagingTarget`	`getExceptionMessagingTarget()`
`Operation`	`getExceptionOperation()`
`XDIAddress`	`getExceptionTargetAddress()`
`XDIStatement`	`getExceptionTargetStatement()`
`Object`	`getExecutionContextAttribute(String key)`
`Map<String,Object>`	`getExecutionContextAttributes()`
`Object`	`getMessageAttribute(String key)`
`Map<String,Object>`	`getMessageAttributes()`
`Object`	`getMessageEnvelopeAttribute(String key)`
`Map<String,Object>`	`getMessageEnvelopeAttributes()`
`Object`	`getOperationAttribute(String key)`
`Map<String,Object>`	`getOperationAttributes()`
`String`	`getTraceBlock()`
`String`	`getTraceLine()`
`boolean`	`isTopExecutionPosition()`
`void`	`popContributor()`
`void`	`popInterceptor()`
`void`	`popMessage()`
`void`	`popMessageEnvelope()`
`void`	`popMessagingTarget()`
`void`	`popOperation()`
`void`	`popTargetAddress()`
`void`	`popTargetStatement()`
`Xdi2MessagingException`	`processException(Exception ex)`
`void`	`pushContributor(Contributor contributor, String comment)`
`void`	`pushInterceptor(Interceptor<MessagingTarget> interceptor, String comment)`
`void`	`pushMessage(Message message, String comment)`
`void`	`pushMessageEnvelope(MessageEnvelope messageEnvelope, String comment)`
`void`	`pushMessagingTarget(MessagingTarget messagingTarget, String comment)`
`void`	`pushOperation(Operation operation, String comment)`
`void`	`pushTargetAddress(XDIAddress targetAddress, String comment)`
`void`	`pushTargetStatement(XDIStatement targetStatement, String comment)`
`void`	`putExecutionContextAttribute(String key, Object value)`
`void`	`putMessageAttribute(String key, Object value)`
`void`	`putMessageEnvelopeAttribute(String key, Object value)`
`void`	`putOperationAttribute(String key, Object value)`
`void`	`resetExecutionContextAttributes()`
`void`	`resetMessageAttributes()`
`void`	`resetMessageEnvelopeAttributes()`
`void`	`resetOperationAttributes()`
`void`	`setExecutionContextAttributes(Map<String,Object> executionContextAttributes)`
`void`	`setMessageAttributes(Map<String,Object> messageAttributes)`
`void`	`setMessageEnvelopeAttributes(Map<String,Object> messageEnvelopeAttributes)`
`void`	`setOperationAttributes(Map<String,Object> operationAttributes)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ExecutionContext
```
public ExecutionContext()
```

Method Detail

getExecutionContextAttribute

public Object getExecutionContextAttribute(String key)

putExecutionContextAttribute

public void putExecutionContextAttribute(String key,
                                Object value)

getExecutionContextAttributes

public Map<String,Object> getExecutionContextAttributes()

setExecutionContextAttributes

public void setExecutionContextAttributes(Map<String,Object> executionContextAttributes)

resetExecutionContextAttributes

public void resetExecutionContextAttributes()

getMessageEnvelopeAttribute

public Object getMessageEnvelopeAttribute(String key)

putMessageEnvelopeAttribute

public void putMessageEnvelopeAttribute(String key,
                               Object value)

getMessageEnvelopeAttributes

public Map<String,Object> getMessageEnvelopeAttributes()

setMessageEnvelopeAttributes

public void setMessageEnvelopeAttributes(Map<String,Object> messageEnvelopeAttributes)

resetMessageEnvelopeAttributes

public void resetMessageEnvelopeAttributes()

getMessageAttribute

public Object getMessageAttribute(String key)

putMessageAttribute

public void putMessageAttribute(String key,
                       Object value)

getMessageAttributes

public Map<String,Object> getMessageAttributes()

setMessageAttributes

public void setMessageAttributes(Map<String,Object> messageAttributes)

resetMessageAttributes
```
public void resetMessageAttributes()
```

getOperationAttribute

public Object getOperationAttribute(String key)

putOperationAttribute

public void putOperationAttribute(String key,
                         Object value)

getOperationAttributes

public Map<String,Object> getOperationAttributes()

setOperationAttributes

public void setOperationAttributes(Map<String,Object> operationAttributes)

resetOperationAttributes

public void resetOperationAttributes()

getException

public Xdi2MessagingException getException()

processException

public Xdi2MessagingException processException(Exception ex)

pushMessagingTarget

public void pushMessagingTarget(MessagingTarget messagingTarget,
                       String comment)

pushMessageEnvelope

public void pushMessageEnvelope(MessageEnvelope messageEnvelope,
                       String comment)

pushMessage

public void pushMessage(Message message,
               String comment)

pushOperation

public void pushOperation(Operation operation,
                 String comment)

pushTargetAddress

public void pushTargetAddress(XDIAddress targetAddress,
                     String comment)

pushTargetStatement

public void pushTargetStatement(XDIStatement targetStatement,
                       String comment)

pushInterceptor

public void pushInterceptor(Interceptor<MessagingTarget> interceptor,
                   String comment)

pushContributor

public void pushContributor(Contributor contributor,
                   String comment)

popMessagingTarget
```
public void popMessagingTarget()
```

popMessageEnvelope
```
public void popMessageEnvelope()
```

popMessage
```
public void popMessage()
```

popOperation
```
public void popOperation()
```

popTargetAddress
```
public void popTargetAddress()
```

popTargetStatement
```
public void popTargetStatement()
```

popInterceptor
```
public void popInterceptor()
```

popContributor
```
public void popContributor()
```

getCurrentMessagingTarget

public MessagingTarget getCurrentMessagingTarget()

getCurrentMessagingTargets

public List<MessagingTarget> getCurrentMessagingTargets()

getCurrentMessageEnvelope

public MessageEnvelope getCurrentMessageEnvelope()

getCurrentMessageEnvelopes

public List<MessageEnvelope> getCurrentMessageEnvelopes()

getCurrentMessage
```
public Message getCurrentMessage()
```

getCurrentMessages

public List<Message> getCurrentMessages()

getCurrentOperation

public Operation getCurrentOperation()

getCurrentOperations

public List<Operation> getCurrentOperations()

getCurrentTargetAddress

public XDIAddress getCurrentTargetAddress()

getCurrentTargetStatement

public XDIStatement getCurrentTargetStatement()

getCurrentInterceptor

public Interceptor<MessagingTarget> getCurrentInterceptor()

getCurrentContributor

public Contributor getCurrentContributor()

getExceptionMessagingTarget

public MessagingTarget getExceptionMessagingTarget()

getExceptionMessageEnvelope

public MessageEnvelope getExceptionMessageEnvelope()

getExceptionMessage
```
public Message getExceptionMessage()
```

getExceptionOperation

public Operation getExceptionOperation()

getExceptionTargetAddress

public XDIAddress getExceptionTargetAddress()

getExceptionTargetStatement

public XDIStatement getExceptionTargetStatement()

getExceptionInterceptor

public Interceptor<MessagingTarget> getExceptionInterceptor()

getExceptionContributor

public Contributor getExceptionContributor()

isTopExecutionPosition

public boolean isTopExecutionPosition()

getTraceLine
```
public String getTraceLine()
```

getTraceBlock
```
public String getTraceBlock()
```

Class ExecutionContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExecutionContext

Method Detail

getExecutionContextAttribute

putExecutionContextAttribute

getExecutionContextAttributes

setExecutionContextAttributes

resetExecutionContextAttributes

getMessageEnvelopeAttribute

putMessageEnvelopeAttribute

getMessageEnvelopeAttributes

setMessageEnvelopeAttributes

resetMessageEnvelopeAttributes

getMessageAttribute

putMessageAttribute

getMessageAttributes

setMessageAttributes

resetMessageAttributes

getOperationAttribute

putOperationAttribute

getOperationAttributes

setOperationAttributes

resetOperationAttributes

getException

processException

pushMessagingTarget

pushMessageEnvelope

pushMessage

pushOperation

pushTargetAddress

pushTargetStatement

pushInterceptor

pushContributor

popMessagingTarget

popMessageEnvelope

popMessage

popOperation

popTargetAddress

popTargetStatement

popInterceptor

popContributor

getCurrentMessagingTarget

getCurrentMessagingTargets

getCurrentMessageEnvelope

getCurrentMessageEnvelopes

getCurrentMessage

getCurrentMessages

getCurrentOperation

getCurrentOperations

getCurrentTargetAddress

getCurrentTargetStatement

getCurrentInterceptor

getCurrentContributor

getExceptionMessagingTarget

getExceptionMessageEnvelope

getExceptionMessage

getExceptionOperation

getExceptionTargetAddress

getExceptionTargetStatement

getExceptionInterceptor

getExceptionContributor

isTopExecutionPosition

getTraceLine

getTraceBlock