org.wso2.transport.jms.callback

Class JMSCallback

java.lang.Object

org.wso2.transport.jms.callback.JMSCallback

Direct Known Subclasses:

AcknowledgementCallback, TransactedSessionCallback

public abstract class JMSCallback
extends Object

Holds common fields and operations for a JMS callback implementation.

Constructor Summary

Constructors

Constructor and Description
JMSCallback(javax.jms.Session session) Creates a call back initializing the JMS session object and saving caller object to be notified.

Method Summary

Modifier and Type	Method and Description
protected void	commitSession() Commits the JMS session.
void	done(boolean success) Invoke this method to update the status of the message consumption.
abstract int	getAcknowledgementMode() Get acknowledgement mode of this JMSCallback.
boolean	isOperationComplete() States whether acknowledgement process has been completed.
protected boolean	isSuccess() Is this transaction/ack a success.
protected void	recoverSession() Recover the JMS session.
protected void	rollbackSession() Rollbacks the JMS session.
void	waitForProcessing()

Methods inherited from class java.lang.Object

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

Constructor Detail

JMSCallback

public JMSCallback(javax.jms.Session session)

Creates a call back initializing the JMS session object and saving caller object to be notified.

Parameters:

session - JMS Session connected with this callback.

Method Detail

isOperationComplete

public boolean isOperationComplete()

States whether acknowledgement process has been completed. This is used by a caller who is waiting to be notified by the callback.

Returns:

True if acknowledging process is completed.

commitSession

protected void commitSession()
                      throws JMSConnectorException

Commits the JMS session.

Throws:

JMSConnectorException - if the JMS provider fails to commit the transaction.

rollbackSession

protected void rollbackSession()
                        throws JMSConnectorException

Rollbacks the JMS session.

Throws:

JMSConnectorException - if the JMS provider fails to roll back the transaction.

recoverSession

protected void recoverSession()
                       throws JMSConnectorException

Recover the JMS session.

Throws:

JMSConnectorException - if the JMS provider fails to recover the session.

done

public void done(boolean success)

Invoke this method to update the status of the message consumption.

Parameters:

success - status of the message processing.

getAcknowledgementMode

public abstract int getAcknowledgementMode()

Get acknowledgement mode of this JMSCallback.

Returns:

Ack mode.

isSuccess

protected boolean isSuccess()

Is this transaction/ack a success.

Returns:

true if success false otherwise.

waitForProcessing

public void waitForProcessing()
                       throws InterruptedException

Throws:

InterruptedException