KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > ubermq > jms > server > admin > PersistentConsumerAdmin


1 package com.ubermq.jms.server.admin;
2
3 import java.rmi.*;
4 import java.util.*;
5
6 /**
7  * The administrative interface for a durable subscription
8  * or queue on the UberMQ server.
9  */

10 public interface PersistentConsumerAdmin extends Remote
11 {
12     /**
13      * Describes the durable subscriber. This should generally
14      * be the human-readable name of the subscriber or queue.<P>
15      *
16      * @return a name describing the connection
17      */

18     public String JavaDoc getName()
19         throws RemoteException;
20
21     /**
22      * Describes the set of topics that the subscriber is
23      * subscribed to.<P>
24      *
25      * @return a topic or queue specifier
26      */

27     public String JavaDoc getSubscription()
28         throws RemoteException;
29
30     /**
31      * Describes the persistent consumer in a human-readable
32      * way. This should contain information about connected
33      * subscribers, or active/inactive status.<p>
34      *
35      * @return an HTML formatted String describing
36      * the consumer's state.
37      */

38     public String JavaDoc getDescription()
39         throws RemoteException;
40
41     /**
42      * Returns true if the subscriber is representing
43      * a queue.<P>
44      */

45     public boolean isQueue()
46         throws RemoteException;
47
48     /**
49      * Indicates whether a consumer is connected to this subscription.<P>
50      *
51      * @return true if at least one consumer is connected to this subscription.
52      */

53     public boolean isActive()
54         throws RemoteException;
55
56     /**
57      * Deletes the subscription from the server. This operation
58      * removes all storage associated with the subscription and any
59      * enqueued messages.
60      *
61      * @throws JMSException if the subscription is being used.
62      */

63     public void close()
64         throws javax.jms.JMSException JavaDoc, RemoteException;
65 }
66
Popular Tags