Removing a Subscriber

Figure 9-22 Use Case Diagram: Remove a Subscriber

Text description of the illustration adq09qad26.gif

To refer to the table of all basic operations having to do with the Administrative Interface see: "Use Case Model: Administrative Interface -- Basic Operations"

Purpose

Remove a default subscriber from a queue.

Usage Notes

This operation takes effect immediately and the containing transaction is committed. All references to the subscriber in existing messages are removed as part of the operation.

When a queue, queue table, or subscriber is created, modified, or dropped, and if GLOBAL_TOPIC_ENABLED = TRUE, a corresponding LDAP entry is also created.

Syntax

See Chapter 3, "AQ Programmatic Environments" for a list of available functions in each programmatic environment. Use the following syntax references for each programmatic environment:

• PL/SQL (DBMS_AQADM Package): Oracle9i Supplied PL/SQL Packages and Types Reference DBMS_AQADM, REMOVE_SUBSCRIBER procedure

• Visual Basic (OO4O): There is no applicable syntax reference for this use case

• Java (JDBC): Oracle9i Supplied Java Packages Reference oracle.AQ) removeSubscriber

Examples

See Chapter 3, "AQ Programmatic Environments" for a list of available functions in each programmatic environment. Examples are provided in the following programmatic environments.

Examples in the following programmatic environments are provided:

• PL/SQL (DBMS_AQADM): Removing Subscriber

• VB (OO4O): Example not provided.

• Java (JDBC): Removing a Subscriber

PL/SQL (DBMS_AQADM): Removing Subscriber

DECLARE
   subscriber       sys.aq$_agent;
BEGIN
   subscriber := sys.aq$_agent('subscriber1','aq2.msg_queue2', NULL);
   DBMS_AQADM.REMOVE_SUBSCRIBER(
      queue_name => 'aq.multi_queue',
      subscriber => subscriber);
END;

Java (JDBC): Removing a Subscriber

/* Remove a subscriber */
public static void example(AQSession aq_sess) throws AQException
{
     AQQueue         queue;
     AQAgent         agent1;        
     AQAgent         agent2;        

     /* Get the queue object */
     queue = aq_sess.getQueue("AQ", "multi_queue");

     /* add a subscriber */
     agent1 = new AQAgent("subscriber1", "aq2.msg_queue2@london");

     queue.removeSubscriber(agent1);
}