Joram 5.3.1

org.objectweb.joram.client.jms
Interface DestinationMBean

All Known Subinterfaces:
QueueMBean, TopicMBean
All Known Implementing Classes:
ClusterDestination, ClusterQueue, ClusterTopic, DeadMQueue, Destination, Queue, TemporaryQueue, TemporaryTopic, Topic

public interface DestinationMBean


Method Summary
 void addReader(java.lang.String proxyId)
          Administration method setting a given user as a reader on this destination.
 void addWriter(java.lang.String proxyId)
          Administration method setting a given user as a writer on this destination.
 void delete()
          Administration method removing this destination from the platform.
 java.lang.String getAdminName()
           
 java.lang.String getDMQId()
          Monitoring method returning the dead message queue id of this destination, null if not set.
 java.lang.String getName()
           
 java.util.List getReaderList()
          Monitoring method returning the list of all users that have a reading permission on this destination, or an empty list if no specific readers are set.
 java.util.Hashtable getStatistic()
          Deprecated.  
 java.util.Hashtable getStatistics()
          Returns values of all valid JMX attributes about the destination.
 java.util.List getWriterList()
          Monitoring method returning the list of all users that have a writing permission on this destination, or an empty list if no specific writers are set.
 boolean isFreelyReadable()
          Monitoring method returning true if this destination provides free READ access.
 boolean isFreelyWriteable()
          Monitoring method returning true if this destination provides free WRITE access.
 boolean isQueue()
          Returns true if the destination is a queue.
 boolean isTopic()
          Returns true if the destination is a topic.
 void removeReader(java.lang.String proxyId)
          Administration method unsetting a given user as a reader on this destination.
 void removeWriter(java.lang.String proxyId)
          Administration method unsetting a given user as a writer on this destination.
 void setDMQId(java.lang.String dmqId)
          Admininistration method setting or unsetting a dead message queue for this destination.
 void setFreelyReadable(boolean b)
          Administration method (un)setting free reading access to this destination.
 void setFreelyWriteable(boolean b)
          Administration method (un)setting free writing access to this destination.
 

Method Detail

getName

java.lang.String getName()

getAdminName

java.lang.String getAdminName()

isQueue

boolean isQueue()
Returns true if the destination is a queue.


isTopic

boolean isTopic()
Returns true if the destination is a topic.


delete

void delete()
            throws java.net.ConnectException,
                   AdminException,
                   javax.jms.JMSException
Administration method removing this destination from the platform.

Throws:
java.net.ConnectException
AdminException
javax.jms.JMSException

addReader

void addReader(java.lang.String proxyId)
               throws java.net.ConnectException,
                      AdminException
Administration method setting a given user as a reader on this destination.

Parameters:
proxyId - The unique identification of the user's proxy.
Throws:
java.net.ConnectException - If the administration connection is closed or broken.
AdminException - If the request fails.

addWriter

void addWriter(java.lang.String proxyId)
               throws java.net.ConnectException,
                      AdminException
Administration method setting a given user as a writer on this destination.

Parameters:
proxyId - The unique identification of the user's proxy.
Throws:
java.net.ConnectException - If the administration connection is closed or broken.
AdminException - If the request fails.

removeReader

void removeReader(java.lang.String proxyId)
                  throws java.net.ConnectException,
                         AdminException
Administration method unsetting a given user as a reader on this destination.

Parameters:
proxyId - The unique identification of the user's proxy.
Throws:
java.net.ConnectException - If the administration connection is closed or broken.
AdminException - If the request fails.

removeWriter

void removeWriter(java.lang.String proxyId)
                  throws java.net.ConnectException,
                         AdminException
Administration method unsetting a given user as a writer on this destination.

Parameters:
proxyId - The unique identification of the user's proxy.
Throws:
java.net.ConnectException - If the administration connection is closed or broken.
AdminException - If the request fails.

getReaderList

java.util.List getReaderList()
                             throws java.net.ConnectException,
                                    AdminException
Monitoring method returning the list of all users that have a reading permission on this destination, or an empty list if no specific readers are set.

Throws:
java.net.ConnectException
AdminException

getWriterList

java.util.List getWriterList()
                             throws java.net.ConnectException,
                                    AdminException
Monitoring method returning the list of all users that have a writing permission on this destination, or an empty list if no specific writers are set.

Throws:
java.net.ConnectException
AdminException

isFreelyReadable

boolean isFreelyReadable()
                         throws java.net.ConnectException,
                                AdminException
Monitoring method returning true if this destination provides free READ access.

Throws:
java.net.ConnectException
AdminException

isFreelyWriteable

boolean isFreelyWriteable()
                          throws java.net.ConnectException,
                                 AdminException
Monitoring method returning true if this destination provides free WRITE access.

Throws:
java.net.ConnectException
AdminException

setFreelyReadable

void setFreelyReadable(boolean b)
                       throws java.net.ConnectException,
                              AdminException
Administration method (un)setting free reading access to this destination.

Throws:
java.net.ConnectException
AdminException

setFreelyWriteable

void setFreelyWriteable(boolean b)
                        throws java.net.ConnectException,
                               AdminException
Administration method (un)setting free writing access to this destination.

Throws:
java.net.ConnectException
AdminException

getDMQId

java.lang.String getDMQId()
                          throws java.net.ConnectException,
                                 AdminException
Monitoring method returning the dead message queue id of this destination, null if not set.

Throws:
java.net.ConnectException
AdminException

setDMQId

void setDMQId(java.lang.String dmqId)
              throws java.net.ConnectException,
                     AdminException,
                     javax.jms.InvalidDestinationException
Admininistration method setting or unsetting a dead message queue for this destination.

Throws:
java.net.ConnectException
AdminException
javax.jms.InvalidDestinationException

getStatistic

java.util.Hashtable getStatistic()
                                 throws java.net.ConnectException,
                                        AdminException
Deprecated. 

Return a set of statistic values from the destination. Be careful this method is deprecated and should be removed in future version, use getStatistics method in replacement.

Throws:
java.net.ConnectException
AdminException

getStatistics

java.util.Hashtable getStatistics()
                                  throws java.net.ConnectException,
                                         AdminException
Returns values of all valid JMX attributes about the destination.

Returns:
a Hashtable containing the values of all valid JMX attributes about the destination. The keys are the name of corresponding attributes.
Throws:
java.net.ConnectException
AdminException

Joram 5.3.1

Copyright © 2000 - 2009 Scalagent D.T. - All rights reserved