Oracle JDBC API Reference
11g Release 2 ("11.2.0.3.0")

oracle.jdbc.aq
Class AQNotificationEvent

java.lang.Object
  extended by java.util.EventObject
      extended by oracle.jdbc.aq.AQNotificationEvent
All Implemented Interfaces:
java.io.Serializable

public abstract class AQNotificationEvent
extends java.util.EventObject

An AQNotificationEvent will be created whenever a new message is enqueued in a queue for which you have registered your interest (see OracleConnection.registerAQNotification).

The AQNotificationEvent provides information about the new message that has been enqueued.

See Also:
Serialized Form

Nested Class Summary
static class AQNotificationEvent.AdditionalEventType
           
static class AQNotificationEvent.EventType
           
 
Field Summary
static java.lang.String BUILD_DATE
           
static boolean TRACE
           
 
Method Summary
abstract  AQNotificationEvent.AdditionalEventType getAdditionalEventType()
          Retrieve the additional event type.
abstract  java.lang.String getConnectionInformation()
          Retrieves a description of the TCP connection on which the notification was received.
abstract  java.lang.String getConsumerName()
          Retrieves the name of the consumer.
abstract  AQNotificationEvent.EventType getEventType()
          Retrieve the event type.
abstract  byte[] getMessageId()
          Retrieves the ID of the new message.
abstract  AQMessageProperties getMessageProperties()
          Retrieves the properties of the new message.
abstract  byte[] getPayload()
          Retrieves the payload of the new message.
abstract  java.lang.String getQueueName()
          Retrieves the name of the queue.
abstract  java.lang.String getRegistration()
          Retrieves the registration name which is the name that you provided when you registered for AQ notification with the registerAQNotification method.
abstract  java.lang.String toString()
           
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

BUILD_DATE

public static final java.lang.String BUILD_DATE
See Also:
Constant Field Values

TRACE

public static final boolean TRACE
See Also:
Constant Field Values
Method Detail

getMessageProperties

public abstract AQMessageProperties getMessageProperties()
                                                  throws java.sql.SQLException
Retrieves the properties of the new message.

Throws:
java.sql.SQLException

getRegistration

public abstract java.lang.String getRegistration()
                                          throws java.sql.SQLException
Retrieves the registration name which is the name that you provided when you registered for AQ notification with the registerAQNotification method.

In the case of a single consumer queue, the registration name is the name of the queue whereas in the case of a multi-consumer queue, it's the name of the queue plus the name of the consumer ("SCOTT.MY_QUEUE:RECEIVER").

Throws:
java.sql.SQLException

getPayload

public abstract byte[] getPayload()
                           throws java.sql.SQLException
Retrieves the payload of the new message. Note that this feature only works with RAW queues and that it needs to be activated with the OracleConnection.NTF_AQ_PAYLOAD option during registration.

Throws:
java.sql.SQLException

getQueueName

public abstract java.lang.String getQueueName()
                                       throws java.sql.SQLException
Retrieves the name of the queue.

Throws:
java.sql.SQLException

getMessageId

public abstract byte[] getMessageId()
                             throws java.sql.SQLException
Retrieves the ID of the new message.

Throws:
java.sql.SQLException

getConsumerName

public abstract java.lang.String getConsumerName()
                                          throws java.sql.SQLException
Retrieves the name of the consumer. In the case of a multi-consumer queue, this retrieves the name of the consumer upon which you register for AQ notification.

Throws:
java.sql.SQLException

getConnectionInformation

public abstract java.lang.String getConnectionInformation()
Retrieves a description of the TCP connection on which the notification was received.


getEventType

public abstract AQNotificationEvent.EventType getEventType()
Retrieve the event type.


getAdditionalEventType

public abstract AQNotificationEvent.AdditionalEventType getAdditionalEventType()
Retrieve the additional event type.


toString

public abstract java.lang.String toString()
Overrides:
toString in class java.util.EventObject

Oracle JDBC API Reference
11g Release 2 ("11.2.0.3.0")

Copyright © 1998, 2007, Oracle. All rights reserved.