Skip navigation links

Oracle® Streams Advanced Queuing Java API Reference
11g Release 2 (11.2)

E10768-01


oracle.jms
Interface AQjmsQueueReceiver

All Superinterfaces:
MessageConsumer, QueueReceiver
All Known Implementing Classes:
AQjmsConsumer

public interface AQjmsQueueReceiver
extends QueueReceiver

Adds Oracle® Streams Advanced Queuing extensions to javax.jms.QueueReceiver.
Allows use of transformations and AQ navigation modes


Method Summary
 int getNavigationMode()
          get the navigation mode used for receiving messagess
 java.lang.String getTransformation()
          Get the transformation for the QueueReceiver
 void receiveNoData()
          Consume the message without returning it to the user.
 void receiveNoData(long timeout)
          Consume the message without returning it to the user.
 void setNavigationMode(int mode)
          set the navigation mode used for receiving messagess
 void setTransformation(java.lang.String transformation)
          Set transformation for this receiver.

 

Methods inherited from interface javax.jms.QueueReceiver
getQueue

 

Methods inherited from interface javax.jms.MessageConsumer
close, getMessageListener, getMessageSelector, receive, receive, receiveNoWait, setMessageListener

 

Method Detail

getNavigationMode

int getNavigationMode()
                      throws JMSException
get the navigation mode used for receiving messagess
Returns:
the navigation mode. See the Oracle "Streams Advanced Queuing User's Guide and Reference" for the explanation of the navigation mode.
Throws:
JMSException - if there was an error in getting the navigation mode

setNavigationMode

void setNavigationMode(int mode)
                       throws JMSException
set the navigation mode used for receiving messagess
Parameters:
mode - the new value of the navigation mode. See Oracle "Streams Advanced Queuing User's Guide and Reference" for explanation of the navigation mode. the valid values of this parameter are oracle.jms.AQjmsConstants.FIRST_MESSAGE oracle.jms.AQjmsConstants.NEXT_MESSAGE oracle.jms.AQjmsConstants.NEXT_TRANSACTION
Throws:
JMSException - if there was an error in setting the navigation mode

receiveNoData

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. This call will block until a message arrives.
Throws:
JMSException - if the message could not be received due to an error

receiveNoData

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

setTransformation

void setTransformation(java.lang.String transformation)
Set transformation for this receiver. This transformation will be applied before the message is returned to the user.
Parameters:
transformation - transformation name

getTransformation

java.lang.String getTransformation()
Get the transformation for the QueueReceiver

Skip navigation links

Oracle® Streams Advanced Queuing Java API Reference
11g Release 2 (11.2)

E10768-01


Copyright © 2003, 2009, Oracle and/or its affiliates. All rights reserved.