org.adroitlogic.x.base.trp

Class SendCallback<T>

java.lang.Object

org.adroitlogic.x.base.trp.SendCallback<T>

Type Parameters:

T - the identifier type which is used as the key for the notification instances representing the message stored in notification map in the form of SendNotification

public abstract class SendCallback<T>
extends Object

This class is used to get the delivery confirmation, provided that the transport supports it. The computeKey(XMessageContext) method should be implemented to provide the key that represents the message.

Since:

17.01

Author:

Ruwan Linton

Field Summary

Fields

Modifier and Type	Field and Description
Map<T,SendNotification>	notificationMap The notification map which holds the SendNotifications over the key computed using computeKey(XMessageContext) using the message properties

Constructor Summary

Constructors

Constructor and Description
SendCallback()

Method Summary

Modifier and Type	Method and Description
void	close() This method makes sure that no messages/resources is leaking while stopping the SendCallback by checking the notificationMap for any stale messages/notifications.
protected void	complete(T identifier) This is expected to be called by all concrete implementations of SendCallback to make sure the callback completes successfully.
protected abstract T	computeKey(XMessageContext message) This abstract method should be implemented by all concrete implementations such that it provides the same key that is passed in for the complete(Object) and notifyError(Object, Exception) methods using the properties of the message
protected void	notifyError(T identifier, Exception e) This method is expected to be called by concrete implementations of the SendCallback to mark a message as an error or a send failure.
SendNotification	register(XMessageContext messageContext, long timeout) Registers the given message for send completion.
(package private) SendNotification	unregister(XMessageContext message) This method is supposed to be only used by the SendNotification.close() method and hence package local access modifier is used for this method.

Methods inherited from class java.lang.Object

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

Field Detail

notificationMap

public Map<T,SendNotification> notificationMap

The notification map which holds the SendNotifications over the key computed using computeKey(XMessageContext) using the message properties

Constructor Detail

SendCallback

public SendCallback()

Method Detail

register

public SendNotification register(XMessageContext messageContext,
                                 long timeout)

Registers the given message for send completion. Any SendNotification instance acquired by calling this method should be closed within a finally block or use try declared resources to make sure there is no message leak, as follows

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

Or in prior to Java 7

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

Parameters:

messageContext - the messageContext to be registered

timeout - the timeout of the SendNotification for waiting after calling SendNotification.waitForCompletion()

Returns:

the SendNotification created for this message on which the caller can wait for completion

complete

protected void complete(T identifier)

This is expected to be called by all concrete implementations of SendCallback to make sure the callback completes successfully. It is expected that it will use the same key that is used by the computeKey(XMessageContext)

Parameters:

identifier - the identifier of the message/notification that is waiting for completion

notifyError

protected void notifyError(T identifier,
                           Exception e)

This method is expected to be called by concrete implementations of the SendCallback to mark a message as an error or a send failure.

Parameters:

identifier - the identifier of the message/notification that is waiting for completion

e - the exception that is causing the send failure

unregister

SendNotification unregister(XMessageContext message)

This method is supposed to be only used by the SendNotification.close() method and hence package local access modifier is used for this method. It unregister the registered message from the SendCallback

Parameters:

message - the message to be unregistered

Returns:

the unregistered SendNotification if there was a one registered for this message or null otherwise

computeKey

protected abstract T computeKey(XMessageContext message)

This abstract method should be implemented by all concrete implementations such that it provides the same key that is passed in for the complete(Object) and notifyError(Object, Exception) methods using the properties of the message

Parameters:

message - the message to be used for computing the key for the SendNotification

Returns:

the computed key

close

public void close()

This method makes sure that no messages/resources is leaking while stopping the SendCallback by checking the notificationMap for any stale messages/notifications. This should usually be called within the stop method of transport sender.

See Also:

TransportSender.stop()