Package org.citrusframework.variable.dictionary

Interface DataDictionary<T>

All Superinterfaces:

InitializingPhase, MessageDirectionAware, MessageProcessor, MessageTransformer, Scoped

public interface DataDictionary<T>
extends MessageProcessor, MessageDirectionAware, Scoped, InitializingPhase

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	Description
static enum	DataDictionary.PathMappingStrategy	Possible mapping strategies for identifying matching dictionary items with path comparison.

Nested classes/interfaces inherited from interface org.citrusframework.message.MessageProcessor

MessageProcessor.Builder<T extends MessageProcessor,B extends MessageProcessor.Builder<T,B>>

Field Summary

Fields inherited from interface org.citrusframework.message.MessageProcessor

logger, RESOURCE_PATH, TYPE_RESOLVER

Method Summary

Modifier and Type	Method	Description
String	getName()	Gets the data dictionary name.
DataDictionary.PathMappingStrategy	getPathMappingStrategy()	Gets the path mapping strategy.
<R> R	translate(T key, R value, TestContext context)	Translate value with given path in message content.

Methods inherited from interface org.citrusframework.common.InitializingPhase

initialize

Methods inherited from interface org.citrusframework.message.MessageDirectionAware

getDirection

Methods inherited from interface org.citrusframework.message.MessageProcessor

process, transform

Methods inherited from interface org.citrusframework.Scoped

isGlobalScope

Method Details

translate

<R> R translate(T key,
 R 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.