org.springframework.cloud.contract.verifier.messaging

Interface MessageVerifierReceiver<M>

Type Parameters:

M - message type

All Known Subinterfaces:

MessageVerifier<M>

All Known Implementing Classes:

CamelStubMessages, NoOpStubMessages, SpringAmqpStubMessages, SpringIntegrationStubMessages, StreamStubMessages

public interface MessageVerifierReceiver<M>

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

Since:

2.2.0

Author:

Marcin Grzejszczak

Method Summary

Modifier and Type	Method and Description
default M	receive(String destination) Receives the message from the given destination.
default M	receive(String destination, long timeout, TimeUnit timeUnit) Receives the message from the given destination.
M	receive(String destination, long timeout, TimeUnit timeUnit, YamlContract contract) Receives the message from the given destination.
M	receive(String destination, YamlContract contract) Receives the message from the given destination.

Method Detail

receive

default 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

default 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

receive

M receive(String destination,
          long timeout,
          TimeUnit timeUnit,
          @Nullable
          YamlContract contract)

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

contract - contract related to this method

Returns:

received message

receive

M receive(String destination,
          YamlContract contract)

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

Parameters:

destination - destination from which the message will be received

contract - contract related to this method

Returns:

received message