com.consol.citrus.variable.dictionary

Interface DataDictionary<T>

All Superinterfaces:

MessageConstructionInterceptor

All Known Implementing Classes:

AbstractDataDictionary, AbstractJsonDataDictionary, AbstractXmlDataDictionary, JsonMappingDataDictionary, NodeMappingDataDictionary, XpathMappingDataDictionary

public interface DataDictionary<T>
extends MessageConstructionInterceptor

Data dictionary interface describes a mechanism to modify message content (payload) with global dictionary elements. Dictionary translates element values to those defined in dictionary. Message construction process is aware of dictionaries in Spring application context so user just has to add dictionary implementation to application context. Dictionary takes part in message construction for inbound and outbound messages in Citrus.

Since:

1.4

Author:

Christoph Deppisch

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DataDictionary.PathMappingStrategy Possible mapping strategies for identifying matching dictionary items with path comparison.

Method Summary

Modifier and Type	Method and Description
String	getName() Gets the data dictionary name.
DataDictionary.PathMappingStrategy	getPathMappingStrategy() Gets the path mapping strategy.
boolean	isGlobalScope() Should dictionary be used in global scope.
String	translate(T key, String value, TestContext context) Translate value with given path in message content.

Methods inherited from interface com.consol.citrus.validation.interceptor.MessageConstructionInterceptor

interceptMessageConstruction, supportsMessageType

Method Detail

translate

String translate(T key,
                 String value,
                 TestContext context)

Translate value with given path in message content.

Parameters:

value - current value

key - the key element in message content

context - the current test context

Returns:

getName

String getName()

Gets the data dictionary name.

Returns:

getPathMappingStrategy

DataDictionary.PathMappingStrategy getPathMappingStrategy()

Gets the path mapping strategy.

isGlobalScope

boolean isGlobalScope()

Should dictionary be used in global scope.