Package de.otto.synapse.endpoint.sender

Class AbstractMessageSenderEndpoint

java.lang.Object

de.otto.synapse.endpoint.AbstractMessageEndpoint

de.otto.synapse.endpoint.sender.AbstractMessageSenderEndpoint

All Implemented Interfaces:

MessageEndpoint, MessageSender, MessageSenderEndpoint

public abstract class AbstractMessageSenderEndpoint
extends AbstractMessageEndpoint
implements MessageSenderEndpoint

Sender-side MessageEndpoint endpoint of a Message Channel with support for message translation. and interception.

See Also:

• EIP: Message Endpoint
• EIP: Message Channel

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BATCH_SENDER_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
AbstractMessageSenderEndpoint(String channelName, MessageInterceptorRegistry interceptorRegistry, MessageTranslator<TextMessage> messageTranslator)	Constructor used to create a new MessageEndpoint.

Method Summary

Modifier and Type	Method	Description
protected abstract CompletableFuture<Void>	doSend(TextMessage message)
protected CompletableFuture<Void>	doSendBatch(Stream<TextMessage> batch)
final EndpointType	getEndpointType()	Returns the type of the MessageEndpoint, either EndpointType.SENDER or EndpointType.RECEIVER.
MessageFormat	getMessageFormat()
final CompletableFuture<Void>	send(Message<?> message)	Sends a Message to the message channel.
final CompletableFuture<Void>	sendBatch(Stream<? extends Message<?>> batch)	Sends a stream of messages to the message channel as one or more batches, if batches are supported by the infrastructure.

Methods inherited from class de.otto.synapse.endpoint.AbstractMessageEndpoint

getChannelName, getInterceptorChain, intercept

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.otto.synapse.endpoint.MessageEndpoint

getChannelName, getInterceptorChain, intercept

Field Details

BATCH_SENDER_TIMEOUT

public static final int BATCH_SENDER_TIMEOUT

See Also:

• Constant Field Values

Constructor Details

AbstractMessageSenderEndpoint

public AbstractMessageSenderEndpoint(@Nonnull
 String channelName,
 @Nonnull
 MessageInterceptorRegistry interceptorRegistry,
 @Nonnull
 MessageTranslator<TextMessage> messageTranslator)

Constructor used to create a new MessageEndpoint.

Parameters:

channelName - the name of the underlying channel / stream / queue / message log.

interceptorRegistry - registry used to determine message interceptors for this endpoint.

messageTranslator - the MessageTranslator used to translate message payloads as expected by the consumers.

Method Details

send

public final CompletableFuture<Void> send(@Nonnull
 Message<?> message)

Sends a Message to the message channel.

Specified by:

send in interface MessageSender

Parameters:

message - the message to send

Returns:

a CompletableFuture that can be used for logging, error handling, waiting for completion, etc.

sendBatch

public final CompletableFuture<Void> sendBatch(@Nonnull
 Stream<? extends Message<?>> batch)

Sends a stream of messages to the message channel as one or more batches, if batches are supported by the infrastructure. If not, the messages are send one by one.

Specified by:

sendBatch in interface MessageSender

Parameters:

batch - a stream of messages that is sent in batched mode, if supported

Returns:

a CompletableFuture that can be used for logging, error handling, waiting for completion, etc.

getEndpointType

@Nonnull
public final EndpointType getEndpointType()

Description copied from interface: MessageEndpoint

Returns the type of the MessageEndpoint, either EndpointType.SENDER or EndpointType.RECEIVER.

Specified by:

getEndpointType in interface MessageEndpoint

Returns:

EndpointType

doSendBatch

protected CompletableFuture<Void> doSendBatch(@Nonnull
 Stream<TextMessage> batch)

doSend

protected abstract CompletableFuture<Void> doSend(@Nonnull
 TextMessage message)

getMessageFormat

public MessageFormat getMessageFormat()