DestinationMBean (JORAM :: joram :: jakarta

All Known Subinterfaces:

QueueMBean, TopicMBean

All Known Implementing Classes:

ClusterDestination, ClusterQueue, ClusterTopic, Destination, Queue, TemporaryQueue, TemporaryTopic, Topic
```
public interface DestinationMBean
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addInterceptors(String interceptors)` add interceptors
`void`	`addReader(String proxyId)` Administration method setting a given user as a reader on this destination.
`void`	`addWriter(String proxyId)` Administration method setting a given user as a writer on this destination.
`void`	`delete()` Administration method removing this destination from the platform.
`String`	`getAdminName()`
`String`	`getDMQId()` Monitoring method returning the dead message queue id of this destination, null if not set.
`String`	`getInterceptors()`
`String`	`getName()`
`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.
`Hashtable`	`getStatistic()` Deprecated.
`Hashtable`	`getStatistics()` Returns values of all valid JMX attributes about the destination.
`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`	`removeInterceptors(String interceptors)` remove interceptors
`void`	`removeReader(String proxyId)` Administration method unsetting a given user as a reader on this destination.
`void`	`removeWriter(String proxyId)` Administration method unsetting a given user as a writer on this destination.
`void`	`setDMQId(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
```
String getName()
```
  - getAdminName
```
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 ConnectException,
            AdminException,
            jakarta.jms.JMSException
```
    Administration method removing this destination from the platform.
    
    Throws:
    
    ConnectException
    
    AdminException
    
    jakarta.jms.JMSException
  - addReader
```
void addReader(String proxyId)
        throws 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:
    
    ConnectException - If the administration connection is closed or broken.
    
    AdminException - If the request fails.
  - addWriter
```
void addWriter(String proxyId)
        throws 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:
    
    ConnectException - If the administration connection is closed or broken.
    
    AdminException - If the request fails.
  - removeReader
```
void removeReader(String proxyId)
           throws 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:
    
    ConnectException - If the administration connection is closed or broken.
    
    AdminException - If the request fails.
  - removeWriter
```
void removeWriter(String proxyId)
           throws 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:
    
    ConnectException - If the administration connection is closed or broken.
    
    AdminException - If the request fails.
  - getReaderList
```
List getReaderList()
            throws 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:
    
    ConnectException
    
    AdminException
  - getWriterList
```
List getWriterList()
            throws 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:
    
    ConnectException
    
    AdminException
  - isFreelyReadable
```
boolean isFreelyReadable()
                  throws ConnectException,
                         AdminException
```
    Monitoring method returning true if this destination provides free READ access.
    
    Throws:
    
    ConnectException
    
    AdminException
  - isFreelyWriteable
```
boolean isFreelyWriteable()
                   throws ConnectException,
                          AdminException
```
    Monitoring method returning true if this destination provides free WRITE access.
    
    Throws:
    
    ConnectException
    
    AdminException
  - setFreelyReadable
```
void setFreelyReadable(boolean b)
                throws ConnectException,
                       AdminException
```
    Administration method (un)setting free reading access to this destination.
    
    Throws:
    
    ConnectException
    
    AdminException
  - setFreelyWriteable
```
void setFreelyWriteable(boolean b)
                 throws ConnectException,
                        AdminException
```
    Administration method (un)setting free writing access to this destination.
    
    Throws:
    
    ConnectException
    
    AdminException
  - getDMQId
```
String getDMQId()
         throws ConnectException,
                AdminException
```
    Monitoring method returning the dead message queue id of this destination, null if not set.
    
    Throws:
    
    ConnectException
    
    AdminException
  - setDMQId
```
void setDMQId(String dmqId)
       throws ConnectException,
              AdminException,
              jakarta.jms.InvalidDestinationException
```
    Admininistration method setting or unsetting a dead message queue for this destination.
    
    Throws:
    
    ConnectException
    
    AdminException
    
    jakarta.jms.InvalidDestinationException
  - getStatistic
```
Hashtable getStatistic()
                throws 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:
    
    ConnectException
    
    AdminException
  - getStatistics
```
Hashtable getStatistics()
                 throws 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:
    
    ConnectException
    
    AdminException
  - addInterceptors
```
void addInterceptors(String interceptors)
              throws ConnectException,
                     AdminException
```
    add interceptors
    
    Parameters:
    
    interceptors - list of string className interceptor (separate with ",")
    
    Throws:
    
    ConnectException
    
    AdminException
  - getInterceptors
```
String getInterceptors()
                throws ConnectException,
                       AdminException
```
    Returns:
    
    list of string className interceptor (separate with ",")
    
    Throws:
    
    ConnectException
    
    AdminException
  - removeInterceptors
```
void removeInterceptors(String interceptors)
                 throws ConnectException,
                        AdminException
```
    remove interceptors
    
    Parameters:
    
    interceptors - list of string className interceptor (separate with ",")
    
    Throws:
    
    ConnectException
    
    AdminException

Interface DestinationMBean

Method Summary

Method Detail

getName

getAdminName

isQueue

isTopic

delete

addReader

addWriter

removeReader

removeWriter

getReaderList

getWriterList

isFreelyReadable

isFreelyWriteable

setFreelyReadable

setFreelyWriteable

getDMQId

setDMQId

getStatistic

getStatistics

addInterceptors

getInterceptors

removeInterceptors