Package 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
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description voidaddInterceptors(String interceptors)add interceptorsvoidaddReader(String proxyId)Administration method setting a given user as a reader on this destination.voidaddWriter(String proxyId)Administration method setting a given user as a writer on this destination.voiddelete()Administration method removing this destination from the platform.StringgetAdminName()StringgetDMQId()Monitoring method returning the dead message queue id of this destination, null if not set.StringgetInterceptors()StringgetName()ListgetReaderList()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.HashtablegetStatistic()Deprecated.HashtablegetStatistics()Returns values of all valid JMX attributes about the destination.ListgetWriterList()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.booleanisFreelyReadable()Monitoring method returningtrueif this destination provides free READ access.booleanisFreelyWriteable()Monitoring method returningtrueif this destination provides free WRITE access.booleanisQueue()Returnstrueif the destination is a queue.booleanisTopic()Returnstrueif the destination is a topic.voidremoveInterceptors(String interceptors)remove interceptorsvoidremoveReader(String proxyId)Administration method unsetting a given user as a reader on this destination.voidremoveWriter(String proxyId)Administration method unsetting a given user as a writer on this destination.voidsetDMQId(String dmqId)Admininistration method setting or unsetting a dead message queue for this destination.voidsetFreelyReadable(boolean b)Administration method (un)setting free reading access to this destination.voidsetFreelyWriteable(boolean b)Administration method (un)setting free writing access to this destination.
-
-
-
Method Detail
-
getName
String getName()
-
getAdminName
String getAdminName()
-
isQueue
boolean isQueue()
Returnstrueif the destination is a queue.
-
isTopic
boolean isTopic()
Returnstrueif the destination is a topic.
-
delete
void delete() throws ConnectException, AdminException, JMSExceptionAdministration method removing this destination from the platform.
-
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:
ConnectExceptionAdminException
-
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:
ConnectExceptionAdminException
-
isFreelyReadable
boolean isFreelyReadable() throws ConnectException, AdminExceptionMonitoring method returningtrueif this destination provides free READ access.- Throws:
ConnectExceptionAdminException
-
isFreelyWriteable
boolean isFreelyWriteable() throws ConnectException, AdminExceptionMonitoring method returningtrueif this destination provides free WRITE access.- Throws:
ConnectExceptionAdminException
-
setFreelyReadable
void setFreelyReadable(boolean b) throws ConnectException, AdminExceptionAdministration method (un)setting free reading access to this destination.- Throws:
ConnectExceptionAdminException
-
setFreelyWriteable
void setFreelyWriteable(boolean b) throws ConnectException, AdminExceptionAdministration method (un)setting free writing access to this destination.- Throws:
ConnectExceptionAdminException
-
getDMQId
String getDMQId() throws ConnectException, AdminException
Monitoring method returning the dead message queue id of this destination, null if not set.- Throws:
ConnectExceptionAdminException
-
setDMQId
void setDMQId(String dmqId) throws ConnectException, AdminException, InvalidDestinationException
Admininistration method setting or unsetting a dead message queue for this destination.
-
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:
ConnectExceptionAdminException
-
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:
ConnectExceptionAdminException
-
addInterceptors
void addInterceptors(String interceptors) throws ConnectException, AdminException
add interceptors- Parameters:
interceptors- list of string className interceptor (separate with ",")- Throws:
ConnectExceptionAdminException
-
getInterceptors
String getInterceptors() throws ConnectException, AdminException
- Returns:
- list of string className interceptor (separate with ",")
- Throws:
ConnectExceptionAdminException
-
removeInterceptors
void removeInterceptors(String interceptors) throws ConnectException, AdminException
remove interceptors- Parameters:
interceptors- list of string className interceptor (separate with ",")- Throws:
ConnectExceptionAdminException
-
-