org.perfcake.message.correlator

Class AbstractCorrelator

java.lang.Object

org.perfcake.message.correlator.AbstractCorrelator

All Implemented Interfaces:

Correlator

Direct Known Subclasses:

GenerateHeaderCorrelator, PrefixCorrelator

public abstract class AbstractCorrelator
extends Object
implements Correlator

Default implementation of a correlator that provides an easy way to extend it by providing the minimum functionality that is necessary, which is correlation id extraction from request and response. The response must never be received prior to sending a request. This might look like an obvious statement but there are cases when this optimization can play a role.

Author:

Martin Večeřa

Constructor Summary

Constructors

Constructor and Description
AbstractCorrelator()

Method Summary

Modifier and Type	Method and Description
abstract String	getRequestCorrelationId(Message message, Properties messageAttributes) Extracts the correlation id from the request.
abstract List<String>	getResponseCorrelationIds(Serializable response, io.vertx.core.MultiMap headers) Extracts the correlation ids from the response.
void	registerRequest(SenderTask senderTask, Message message, Properties messageAttributes) Registers a request to be sent.
void	registerResponse(Serializable response, io.vertx.core.MultiMap headers) Extracts the correlation id from the response and calls the corresponding sender task's SenderTask.registerResponse(Serializable) method.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractCorrelator

public AbstractCorrelator()

Method Detail

registerRequest

public void registerRequest(SenderTask senderTask,
                            Message message,
                            Properties messageAttributes)

Description copied from interface: Correlator

Registers a request to be sent.

Specified by:

registerRequest in interface Correlator

Parameters:

senderTask - SenderTask controlling the sending of the message.

message - The message to be sent and from which the correlation id is extracted.

messageAttributes - Message attributes of the message to be sent. Can help with correlation id extraction.

getRequestCorrelationId

public abstract String getRequestCorrelationId(Message message,
                                               Properties messageAttributes)

Extracts the correlation id from the request.

Parameters:

message - The request message.

messageAttributes - The request message attributes.

Returns:

The correlation id corresponding to this request.

registerResponse

public void registerResponse(Serializable response,
                             io.vertx.core.MultiMap headers)

Description copied from interface: Correlator

Extracts the correlation id from the response and calls the corresponding sender task's SenderTask.registerResponse(Serializable) method. Called from a receiver upon receiving a response.

Specified by:

registerResponse in interface Correlator

Parameters:

response - The response received by Receiver.

headers - Headers received with the response. Can be useful for discovering correlation id.

getResponseCorrelationIds

public abstract List<String> getResponseCorrelationIds(Serializable response,
                                                       io.vertx.core.MultiMap headers)

Extracts the correlation ids from the response. It is possible that a single response represents multiple requests.

Parameters:

response - The received response.

headers - Headers received with the response. Can be useful for discovering correlation id.

Returns:

The list of correlation ids corresponding to this response.