TestContext (citrus-core 2.4 API)

java.lang.Object
- com.consol.citrus.context.TestContext

```
public class TestContext
extends Object
```
Class holding and managing test variables. The test context also provides utility methods for replacing dynamic content(variables and functions) in message payloads and headers.

Author:

Christoph Deppisch

Field Summary

Fields
Modifier and Type Field and Description

protected Map<String,Object> variables
Local variables

Fields
Modifier and Type	Field and Description
`protected Map<String,Object>`	`variables` Local variables

Constructor Summary

Constructors
Constructor and Description

TestContext()
Default constructor

Constructors
Constructor and Description
`TestContext()` Default constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addVariables(Map<String,Object> variablesToSet)` Add several new variables to test context.
`void`	`clear()` Clears variables in this test context.
`org.springframework.context.ApplicationContext`	`getApplicationContext()` Gets the Spring bean application context.
`EndpointFactory`	`getEndpointFactory()` Gets the endpoint factory.
`FunctionRegistry`	`getFunctionRegistry()` Get the current function registry.
`Map<String,Object>`	`getGlobalVariables()` Set global variables.
`MessageConstructionInterceptors`	`getMessageConstructionInterceptors()` Gets the message construction interceptors.
`MessageListeners`	`getMessageListeners()` Gets the message listeners.
`MessageValidatorRegistry`	`getMessageValidatorRegistry()` Get the message validator registry.
`NamespaceContextBuilder`	`getNamespaceContextBuilder()` Gets the namespace context builder.
`TestListeners`	`getTestListeners()` Gets the test listeners.
`ValidationMatcherRegistry`	`getValidationMatcherRegistry()` Get the current validation matcher registry
`String`	`getVariable(String variableExpression)` Gets the value for the given variable expression.
`Object`	`getVariableObject(String variableExpression)` Gets the value for the given variable as object representation.
`Map<String,Object>`	`getVariables()` Getter for test variables in this context.
`CitrusRuntimeException`	`handleError(String testName, String packageName, String message, Exception cause)` Handles error creating a new CitrusRuntimeException and informs test listeners.
`boolean`	`hasVariables()` Checks if variables are present right now.
`void`	`onInboundMessage(Message receivedMessage)` Informs message listeners if present that inbound message was received.
`void`	`onOutboundMessage(Message message)` Informs message listeners if present that new outbound message is about to be sent.
`String`	`replaceDynamicContentInString(String str)` Method replacing variable declarations and place holders as well as function expressions in a string
`String`	`replaceDynamicContentInString(String str, boolean enableQuoting)` Method replacing variable declarations and functions in a string, optionally the variable values get surrounded with single quotes.
`String`	`resolveDynamicValue(String expression)` Checks weather the given expression is a variable or function and resolves the value accordingly
`List<String>`	`resolveDynamicValuesInList(List<String> list)` Replaces variables and functions in a list with respective values and returns the new list representation.
`Map<String,Object>`	`resolveDynamicValuesInMap(Map<String,Object> map)` Replaces variables and functions inside a map with respective values and returns a new map representation.
`void`	`setApplicationContext(org.springframework.context.ApplicationContext applicationContext)` Sets the Spring bean application context.
`void`	`setEndpointFactory(EndpointFactory endpointFactory)` Sets the endpoint factory.
`void`	`setFunctionRegistry(FunctionRegistry functionRegistry)` Set the function registry.
`void`	`setGlobalVariables(GlobalVariables globalVariables)` Get global variables.
`void`	`setMessageConstructionInterceptors(MessageConstructionInterceptors messageConstructionInterceptors)` Sets the messsage construction interceptors.
`void`	`setMessageListeners(MessageListeners messageListeners)` Set the message listeners.
`void`	`setMessageValidatorRegistry(MessageValidatorRegistry messageValidatorRegistry)` Set the message validator registry.
`void`	`setNamespaceContextBuilder(NamespaceContextBuilder namespaceContextBuilder)` Sets the namespace context builder.
`void`	`setTestListeners(TestListeners testListeners)` Set the test listeners.
`void`	`setValidationMatcherRegistry(ValidationMatcherRegistry validationMatcherRegistry)` Set the validation matcher registry
`void`	`setVariable(String variableName, Object value)` Creates a new variable in this test context with the respective value.
`void`	`setVariables(Map<String,Object> variables)` Setter for test variables in this context.

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

- Field Detail
  - variables
```
protected Map<String,Object> variables
```
    Local variables
- Constructor Detail
  - TestContext
```
public TestContext()
```
    Default constructor
- Method Detail
  - getVariable
```
public String getVariable(String variableExpression)
```
    Gets the value for the given variable expression. Expression usually is the simple variable name, with optional expression prefix/suffix. In case variable is not known to the context throw runtime exception.
    
    Parameters:
    
    variableExpression - expression to search for.
    
    Returns:
    
    value of the variable
    
    Throws:
    
    CitrusRuntimeException
  - getVariableObject
```
public Object getVariableObject(String variableExpression)
```
    Gets the value for the given variable as object representation. Use this method if you seek for test objects stored in the context.
    
    Parameters:
    
    variableExpression - expression to search for.
    
    Returns:
    
    value of the variable as object
    
    Throws:
    
    CitrusRuntimeException
  - setVariable
```
public void setVariable(String variableName,
                        Object value)
```
    Creates a new variable in this test context with the respective value. In case variable already exists variable is overwritten.
    
    Parameters:
    
    variableName - the name of the new variable
    
    value - the new variable value
    
    Throws:
    
    CitrusRuntimeException
  - addVariables
```
public void addVariables(Map<String,Object> variablesToSet)
```
    Add several new variables to test context. Existing variables will be overwritten.
    
    Parameters:
    
    variablesToSet - the list of variables to set.
  - resolveDynamicValuesInMap
```
public Map<String,Object> resolveDynamicValuesInMap(Map<String,Object> map)
```
    Replaces variables and functions inside a map with respective values and returns a new map representation.
    
    Parameters:
    
    map - optionally having variable entries.
    
    Returns:
    
    the constructed map without variable entries.
  - resolveDynamicValuesInList
```
public List<String> resolveDynamicValuesInList(List<String> list)
```
    Replaces variables and functions in a list with respective values and returns the new list representation.
    
    Parameters:
    
    list - having optional variable entries.
    
    Returns:
    
    the constructed list without variable entries.
  - clear
```
public void clear()
```
    Clears variables in this test context. Initially adds all global variables.
  - hasVariables
```
public boolean hasVariables()
```
    Checks if variables are present right now.
    
    Returns:
    
    boolean flag to mark existence
  - replaceDynamicContentInString
```
public String replaceDynamicContentInString(String str)
```
    Method replacing variable declarations and place holders as well as function expressions in a string
    
    Parameters:
    
    str - the string to parse.
    
    Returns:
    
    resulting string without any variable place holders.
  - replaceDynamicContentInString
```
public String replaceDynamicContentInString(String str,
                                            boolean enableQuoting)
```
    Method replacing variable declarations and functions in a string, optionally the variable values get surrounded with single quotes.
    
    Parameters:
    
    str - the string to parse for variable place holders.
    
    enableQuoting - flag marking surrounding quotes should be added or not.
    
    Returns:
    
    resulting string without any variable place holders.
  - resolveDynamicValue
```
public String resolveDynamicValue(String expression)
```
    Checks weather the given expression is a variable or function and resolves the value accordingly
    
    Parameters:
    
    expression - the expression to resolve
    
    Returns:
    
    the resolved expression value
  - handleError
```
public CitrusRuntimeException handleError(String testName,
                                          String packageName,
                                          String message,
                                          Exception cause)
```
    Handles error creating a new CitrusRuntimeException and informs test listeners.
    
    Parameters:
    
    testName -
    
    packageName -
    
    message -
    
    cause -
    
    Returns:
  - setVariables
```
public void setVariables(Map<String,Object> variables)
```
    Setter for test variables in this context.
    
    Parameters:
    
    variables -
  - getVariables
```
public Map<String,Object> getVariables()
```
    Getter for test variables in this context.
    
    Returns:
    
    test variables for this test context.
  - setGlobalVariables
```
public void setGlobalVariables(GlobalVariables globalVariables)
```
    Get global variables.
    
    Parameters:
    
    globalVariables -
  - getGlobalVariables
```
public Map<String,Object> getGlobalVariables()
```
    Set global variables.
    
    Returns:
    
    the globalVariables
  - getFunctionRegistry
```
public FunctionRegistry getFunctionRegistry()
```
    Get the current function registry.
    
    Returns:
    
    the functionRegistry
  - setFunctionRegistry
```
public void setFunctionRegistry(FunctionRegistry functionRegistry)
```
    Set the function registry.
    
    Parameters:
    
    functionRegistry - the functionRegistry to set
  - setMessageValidatorRegistry
```
public void setMessageValidatorRegistry(MessageValidatorRegistry messageValidatorRegistry)
```
    Set the message validator registry.
    
    Parameters:
    
    messageValidatorRegistry - the messageValidatorRegistry to set
  - getMessageValidatorRegistry
```
public MessageValidatorRegistry getMessageValidatorRegistry()
```
    Get the message validator registry.
    
    Returns:
    
    the messageValidatorRegistry
  - getValidationMatcherRegistry
```
public ValidationMatcherRegistry getValidationMatcherRegistry()
```
    Get the current validation matcher registry
    
    Returns:
  - setValidationMatcherRegistry
```
public void setValidationMatcherRegistry(ValidationMatcherRegistry validationMatcherRegistry)
```
    Set the validation matcher registry
    
    Parameters:
    
    validationMatcherRegistry -
  - getMessageListeners
```
public MessageListeners getMessageListeners()
```
    Gets the message listeners.
    
    Returns:
  - setMessageListeners
```
public void setMessageListeners(MessageListeners messageListeners)
```
    Set the message listeners.
    
    Parameters:
    
    messageListeners -
  - getTestListeners
```
public TestListeners getTestListeners()
```
    Gets the test listeners.
    
    Returns:
  - setTestListeners
```
public void setTestListeners(TestListeners testListeners)
```
    Set the test listeners.
    
    Parameters:
    
    testListeners -
  - getMessageConstructionInterceptors
```
public MessageConstructionInterceptors getMessageConstructionInterceptors()
```
    Gets the message construction interceptors.
    
    Returns:
  - setMessageConstructionInterceptors
```
public void setMessageConstructionInterceptors(MessageConstructionInterceptors messageConstructionInterceptors)
```
    Sets the messsage construction interceptors.
    
    Parameters:
    
    messageConstructionInterceptors -
  - getEndpointFactory
```
public EndpointFactory getEndpointFactory()
```
    Gets the endpoint factory.
    
    Returns:
  - setEndpointFactory
```
public void setEndpointFactory(EndpointFactory endpointFactory)
```
    Sets the endpoint factory.
    
    Parameters:
    
    endpointFactory -
  - setNamespaceContextBuilder
```
public void setNamespaceContextBuilder(NamespaceContextBuilder namespaceContextBuilder)
```
    Sets the namespace context builder.
    
    Parameters:
    
    namespaceContextBuilder -
  - getNamespaceContextBuilder
```
public NamespaceContextBuilder getNamespaceContextBuilder()
```
    Gets the namespace context builder.
    
    Returns:
  - getApplicationContext
```
public org.springframework.context.ApplicationContext getApplicationContext()
```
    Gets the Spring bean application context.
    
    Returns:
  - setApplicationContext
```
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
```
    Sets the Spring bean application context.
    
    Parameters:
    
    applicationContext -
  - onInboundMessage
```
public void onInboundMessage(Message receivedMessage)
```
    Informs message listeners if present that inbound message was received.
    
    Parameters:
    
    receivedMessage -
  - onOutboundMessage
```
public void onOutboundMessage(Message message)
```
    Informs message listeners if present that new outbound message is about to be sent.
    
    Parameters:
    
    message -

Class TestContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

variables

Constructor Detail

TestContext

Method Detail

getVariable

getVariableObject

setVariable

addVariables

resolveDynamicValuesInMap

resolveDynamicValuesInList

clear

hasVariables

replaceDynamicContentInString

replaceDynamicContentInString

resolveDynamicValue

handleError

setVariables

getVariables

setGlobalVariables

getGlobalVariables

getFunctionRegistry

setFunctionRegistry

setMessageValidatorRegistry

getMessageValidatorRegistry

getValidationMatcherRegistry

setValidationMatcherRegistry

getMessageListeners

setMessageListeners

getTestListeners

setTestListeners

getMessageConstructionInterceptors

setMessageConstructionInterceptors

getEndpointFactory

setEndpointFactory

setNamespaceContextBuilder

getNamespaceContextBuilder

getApplicationContext

setApplicationContext

onInboundMessage

onOutboundMessage