org.adroitlogic.x.base.trp

Class SendNotification

java.lang.Object

org.adroitlogic.x.base.trp.SendNotification

All Implemented Interfaces:

Closeable, AutoCloseable

public class SendNotification
extends Object
implements Closeable

This class implements a notification for the transport senders that are asynchronous and requires a guarantee on the delivery of the messages to the destination

While the transport sender are not expected to instantiate instances of this class the SendCallback.register(XMessageContext, long) method should be used to acquire a notification instance, which should be closed after its use. Also note that for the completion to work properly the SendCallback should be registered with the transport sender such that the sender implementation calls the respective complete method for the notifications to work properly

The usage pattern of this class within a transport sender would be

try (SendNotification sendNotification = sendCallback.register(messageContext)) {
     // ..sending logic
     sendNotification.waitForCompletion();
 }

Or in prior to Java 7

SendNotification sendNotification = sendCallback.register(messageContext);
 try {
     // ..sending logic
     sendNotification.waitForCompletion();
 } finally {
     try { sendNotification.close(); } catch (IOException ignore) {}
 }

Since:

17.01

Author:

Ruwan Linton

Constructor Summary

Constructors

Constructor and Description
SendNotification(SendCallback sendCallback, XMessageContext messageContext, long timeout)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the Send notification and removes the notification from the send callback
(package private) void	complete() Completes the callback.
(package private) void	recordError(Exception e) Notifies and error.
boolean	waitForCompletion() This method waits for the completion notification from the transport sender is reached to the ESB to proceed

Methods inherited from class java.lang.Object

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

Constructor Detail

SendNotification

SendNotification(SendCallback sendCallback,
                 XMessageContext messageContext,
                 long timeout)

Method Detail

waitForCompletion

public boolean waitForCompletion()

This method waits for the completion notification from the transport sender is reached to the ESB to proceed

Returns:

whether the completion was a success or with a failure, if a success this will be true else it is false

recordError

void recordError(Exception e)

Notifies and error. This method is supposed to be only called by the SendCallback hence the access modified being used as package local

Parameters:

e - the exception that needs to be recorded

complete

void complete()

Completes the callback. This method is supposed to be only called by the SendCallback hence the access modified being used as package local

close

public void close()
           throws IOException

Closes the Send notification and removes the notification from the send callback

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - this is inherited from the interface and is never thrown by this method