oracle.jms
Interface AQjmsTopicSubscriber

All Superinterfaces:

MessageConsumer, TopicSubscriber

All Known Implementing Classes:

AQjmsConsumer

public interface AQjmsTopicSubscriber

extends TopicSubscriber

Adds Oracle AQ extensions to javax.jms.TopicSubscriber
Allows use of navigation mode and methods to consume message without returning it to user.

getNavigationMode

public int getNavigationMode()
                      throws JMSException

Get the navigation mode for receiving messages.

Throws:

JMSException - if the navigation mode could not be set

setNavigationMode

public void setNavigationMode(int mode)
                       throws JMSException

set the navigation mode used for receiving messagess

Parameters:

mode - the new value of the navigation mode

Throws:

JMSException - if there was an error in getting the navigation mode

receiveNoData

public void receiveNoData()
                   throws JMSException

Consume the message without returning it to the user. This call will avoid the ovehead of fetching the message from the database and hence can be used as an optimization by jms clients who have already got the message for example using a queue browser.

Throws:

JMSException - if the message could not be received due to an error

receiveNoData

public void receiveNoData(long timeout)
                   throws JMSException

Consume the message without returning it to the user. This call will avoid the ovehead of fetching the message from the database and hence can be used as an optimization by jms clients who have already got the message for example using a queue browser. This call will block until a message arrives or the timeout expires

Parameters:

timeout - the timeout value in milliseconds

Throws:

JMSException - if the message could not be received due to an error

receive

public javax.jms.Message receive(long timeout,
                                 oracle.jms.AQjmsSignature signature)
                          throws JMSException

Receive the next message if available within the specified timeout

Parameters:

timeout - the timeout value (in milliseconds) signature the signature value

Returns:

the next message produced for this message consumer, or null if one is not available.

Throws:

JMSException - if JMS fails to receive the next message due to some error.