org.mule.extensions.jms.api.operation

Class JmsAck

java.lang.Object

org.mule.extensions.jms.api.operation.JmsAck

public final class JmsAck
extends Object

Operation that allows the user to perform an ACK over a Message produced by the current JmsSession

Since:

4.0

Constructor Summary

Constructors

Constructor and Description
JmsAck()

Method Summary

Modifier and Type	Method and Description
void	ack(JmsConnection connection, String ackId) Allows the user to perform an ACK when the AckMode.MANUAL mode is elected while consuming the Message.

Methods inherited from class java.lang.Object

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

Constructor Detail

JmsAck

public JmsAck()

Method Detail

ack

public void ack(@Connection
                JmsConnection connection,
                @Summary(value="The AckId of the Message to ACK")
                String ackId)
         throws JmsExtensionException

Allows the user to perform an ACK when the AckMode.MANUAL mode is elected while consuming the Message. As per JMS Spec, performing an ACK over a single Message automatically works as an ACK for all the Messages produced in the same JmsSession.

The ackId must refer to a JmsSession created using the current JmsConnection. If the JmsSession or JmsConnection were closed, the ACK will fail. If the ackId does not belong to a JmsSession created using the current JmsConnection

Parameters:

connection - the JmsConnection that created the JmsSession over which the ACK will be performed

ackId - the JmsSession.getAckId()

Throws:

JmsExtensionException - if the JmsSession or JmsConnection were closed, or if the ID doesn't belong to a session of the current connection