io.axoniq.axonserver.connector.impl

Class ForwardingReplyChannel<T>

java.lang.Object

io.axoniq.axonserver.connector.impl.ForwardingReplyChannel<T>

Type Parameters:

T - the message type forwarded by this ReplyChannel to the given StreamObserver

All Implemented Interfaces:

ReplyChannel<T>

public class ForwardingReplyChannel<T>
extends Object
implements ReplyChannel<T>

A ReplyChannel implementation which forwards send(Object), sendAck() and sendNack(ErrorMessage) operations through to a StreamObserver.

Constructor Summary

Constructors

Constructor and Description
ForwardingReplyChannel(String instructionId, String clientId, io.grpc.stub.StreamObserver<T> stream, Function<InstructionAck,T> ackBuilder, Runnable onComplete) Construct a ForwardingReplyChannel to forward replies to the given stream.

Method Summary

Modifier and Type	Method and Description
void	complete() Marks the inbound instruction as completed.
void	completeWithError(ErrorCategory errorCategory, String message) Marks the inbound instruction as exceptionally completed.
void	completeWithError(ErrorMessage errorMessage) Marks the inbound instruction as exceptionally completed.
void	send(T outboundMessage) Sends the given outboundMessage as a reply to an incoming instruction.
void	sendAck() Sends an receipt acknowledgement if one hasn't been sent yet for this instruction.
void	sendNack(ErrorMessage errorMessage) Sends a negative acknowledgement, indicating that the incoming message could not be handled as expected, using given errorMessage to describe the reason.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.axoniq.axonserver.connector.ReplyChannel

sendLast, sendNack

Constructor Detail

ForwardingReplyChannel

public ForwardingReplyChannel(String instructionId,
                              String clientId,
                              io.grpc.stub.StreamObserver<T> stream,
                              Function<InstructionAck,T> ackBuilder,
                              Runnable onComplete)

Construct a ForwardingReplyChannel to forward replies to the given stream.

Parameters:

instructionId - the instruction identifier used to send ACK or NACK messages. If the given instruction identifier is null or empty, no ACK/NACK will be send

clientId - the client identifier used to define the error location upon a completeWithError(ErrorCategory, String) invocation

stream - the StreamObserver to forward replies of this ReplyChannel on

ackBuilder - the builder function used to construct the InstructionAck message, used for both a sendAck() and ReplyChannel.sendNack()

onComplete - operation to perform when this this ReplyChannel is completed, both successfully and exceptionally

Method Detail

send

public void send(T outboundMessage)

Description copied from interface: ReplyChannel

Sends the given outboundMessage as a reply to an incoming instruction. Where possible, the instruction identifiers should be set on the outbound message.

Specified by:

send in interface ReplyChannel<T>

Parameters:

outboundMessage - the message to send

sendAck

public void sendAck()

Description copied from interface: ReplyChannel

Sends an receipt acknowledgement if one hasn't been sent yet for this instruction. If not explicitly sent, it will be sent once the ReplyChannel.complete() method is invoked.

If the incoming instruction has no instruction ID, this method does nothing.

Specified by:

sendAck in interface ReplyChannel<T>

complete

public void complete()

Description copied from interface: ReplyChannel

Marks the inbound instruction as completed.

Specified by:

complete in interface ReplyChannel<T>

completeWithError

public void completeWithError(ErrorMessage errorMessage)

Description copied from interface: ReplyChannel

Marks the inbound instruction as exceptionally completed. The given errorMessage should provide sufficient information about the error.

Specified by:

completeWithError in interface ReplyChannel<T>

Parameters:

errorMessage - the ErrorMessage describing the error

sendNack

public void sendNack(ErrorMessage errorMessage)

Description copied from interface: ReplyChannel

Sends a negative acknowledgement, indicating that the incoming message could not be handled as expected, using given errorMessage to describe the reason. If not explicitly sent, it will be send once the ReplyChannel.completeWithError(ErrorMessage) or ReplyChannel.completeWithError(ErrorCategory, String) methods are invoked. The given errorMessage should provide sufficient information about the error.

If the incoming instruction has no instruction ID, this method does nothing.

Specified by:

sendNack in interface ReplyChannel<T>

completeWithError

public void completeWithError(ErrorCategory errorCategory,
                              String message)

Description copied from interface: ReplyChannel

Marks the inbound instruction as exceptionally completed. The given errorCategory and message should provide sufficient information about the error.

Specified by:

completeWithError in interface ReplyChannel<T>

Parameters:

errorCategory - the category that best described the error encountered

message - a message providing more details about the Error