com.sap.engine.interfaces.messaging.api.ack

Interface AckFactory

public interface AckFactory

The AckFactory interface can be used to create the different types of acknowledgement messages, supported by the Messaging System.

Method Summary

Modifier and Type	Method and Description
void	ackNotSupported(String connectionName, MessageKey messageKey, AckType[] acksNotSupported) Used to notify the Messaging System that a received message cannot be acked in one of the following ways because the application doesn't support that feature.
void	applicationAck(String connectionName, MessageKey messageToAck) Used to notify the Messaging System that the message has been processed by it's final recipient.
void	applicationErrorAck(String connectionName, MessageKey messageToAck, Exception error) Used to notify the Messaging System that the message could not be processed by it's final recipient.
void	deliveryAck(String connectionName, MessageKey messageToAck) Used to notify the Messaging System that the message has reached it's final destination.
void	deliveryErrorAck(String connectionName, MessageKey messageToAck, Exception error) Used to notify the Messaging System that the message did not reached it's final destination.

Method Detail

deliveryAck

void deliveryAck(String connectionName,
                 MessageKey messageToAck)
          throws MessagingException

Used to notify the Messaging System that the message has reached it's final destination. If the application acts as a hub and has received an asynchronous notification that the message has been received by the ultimate receiver.

Parameters:

connectionName - the name of the connection, that is to be used for sending the ack message.

messageToAck - the id of the Message in the Mesasging System that has been delivered.

Throws:

MessagingException - if the notification fails.

deliveryErrorAck

void deliveryErrorAck(String connectionName,
                      MessageKey messageToAck,
                      Exception error)
               throws MessagingException

Used to notify the Messaging System that the message did not reached it's final destination. If the application acts as a hub and has received an asynchronous notification that the message could'nt be received by the ultimate receiver.

Parameters:

connectionName - the name of the connection, that is to be used for sending the ack message.

messageToAck - the id of the Message in the Mesasging System that has been delivered.

error - the reason the message could not be delivered.

Throws:

MessagingException - if the notification fails.

applicationAck

void applicationAck(String connectionName,
                    MessageKey messageToAck)
             throws MessagingException

Used to notify the Messaging System that the message has been processed by it's final recipient.

Parameters:

connectionName - the name of the connection, that is to be used for sending the ack message.

messageToAck - messageToAck

Throws:

MessagingException - MessagingException

applicationErrorAck

void applicationErrorAck(String connectionName,
                         MessageKey messageToAck,
                         Exception error)
                  throws MessagingException

Used to notify the Messaging System that the message could not be processed by it's final recipient.

Parameters:

connectionName - the name of the connection, that is to be used for sending the ack message.

messageToAck - messageToAck

error - the reason the application couldn't process the message.

Throws:

MessagingException - MessagingException

ackNotSupported

void ackNotSupported(String connectionName,
                     MessageKey messageKey,
                     AckType[] acksNotSupported)
              throws MessagingException

Used to notify the Messaging System that a received message cannot be acked in one of the following ways because the application doesn't support that feature.

Parameters:

connectionName - the name of the connection, that is to be used for sending the ack message.

messageKey - the key of the message for which the not supported ack should be sent.

acksNotSupported - a list of acks that are not supported by the application.

Throws:

MessagingException - if one of the Strings does not match the above possible values.