MessageCorrelator (Citrus :: Core :: API 3.4.0 API)

```
public interface MessageCorrelator
```
Message correlator interface for synchronous reply messages. Correlator uses a specific header entry in messages in order to construct a unique message correlation key.

Author:

Christoph Deppisch

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getCorrelationKey(Message request)`	Constructs the correlation key from the message header.
`String`	`getCorrelationKey(String id)`	Get the correlation header name.
`String`	`getCorrelationKeyName(String consumerName)`	Constructs unique correlation key name for given consumer name.

- Method Detail
  - getCorrelationKey
```
String getCorrelationKey(Message request)
```
    Constructs the correlation key from the message header.
    
    Parameters:
    
    request -
    
    Returns:
  - getCorrelationKey
```
String getCorrelationKey(String id)
```
    Get the correlation header name.
    
    Parameters:
    
    id -
    
    Returns:
  - getCorrelationKeyName
```
String getCorrelationKeyName(String consumerName)
```
    Constructs unique correlation key name for given consumer name. Correlation key must be unique across all message consumers running inside a test case. Therefore consumer name is passed as argument and must be part of the constructed correlation key name.
    
    Parameters:
    
    consumerName -
    
    Returns: