org.springframework.cloud.contract.verifier.messaging

Interface MessageVerifier<M>

Type Parameters:

M - message type

All Known Implementing Classes:

CamelStubMessages, NoOpStubMessages, SpringAmqpStubMessages, SpringIntegrationStubMessages, StreamStubMessages

public interface MessageVerifier<M>

Core interface that allows you to build, send and receive messages. Destination is relevant to the underlying implementation. Might be a channel, queue, topic etc.

Since:

1.0.0

Author:

Marcin Grzejszczak

Method Summary

Modifier and Type	Method and Description
M	receive(String destination) Receives the message from the given destination.
M	receive(String destination, long timeout, TimeUnit timeUnit) Receives the message from the given destination.
void	send(M message, String destination) Sends the message to the given destination.
<T> void	send(T payload, Map<String,Object> headers, String destination) Sends the given payload with headers, to the given destination.

Method Detail

send

void send(M message,
          String destination)

Sends the message to the given destination.

Parameters:

message - to send

destination - destination to which the message will be sent

send

<T> void send(T payload,
              Map<String,Object> headers,
              String destination)

Sends the given payload with headers, to the given destination.

Type Parameters:

T - payload type

Parameters:

payload - payload to send

headers - headers to send

destination - destination to which the message will be sent

receive

M receive(String destination,
          long timeout,
          TimeUnit timeUnit)

Receives the message from the given destination. You can provide the timeout for receiving that message.

Parameters:

destination - destination from which the message will be received

timeout - timeout to wait for the message

timeUnit - param to define the unit of timeout

Returns:

received message

receive

M receive(String destination)

Receives the message from the given destination. A default timeout will be applied.

Parameters:

destination - destination from which the message will be received

Returns:

received message