org.jboss.mq.server.jmx
Interface DestinationMBean

All Superinterfaces:

org.jboss.system.Service, org.jboss.system.ServiceMBean

All Known Subinterfaces:

QueueMBean, TopicMBean

All Known Implementing Classes:

DestinationMBeanSupport, Queue, Topic

public interface DestinationMBean
extends org.jboss.system.ServiceMBean

MBean interface for destination managers.

Version:

$Revision: 1.7.4.4 $

Author:

Peter Antman

Field Summary

Fields inherited from interface org.jboss.system.ServiceMBean

CREATE_EVENT, CREATED, DESTROY_EVENT, DESTROYED, FAILED, REGISTERED, START_EVENT, STARTED, STARTING, states, STOP_EVENT, STOPPED, STOPPING, UNREGISTERED

Method Summary

javax.management.ObjectName	getDestinationManager() Get the value of JBossMQService.
javax.management.ObjectName	getExpiryDestination() Returns the expiry destination.
boolean	getInMemory() Retrieve the topic/queue in memory mode
String	getJNDIName() Gets the JNDI name use by this destination.
int	getMaxDepth() Retrieve the maximum depth of the queue or individual subscriptions
MessageCounter[]	getMessageCounter() get message counter of all internal queues
int	getMessageCounterHistoryDayLimit() Gets the destination message counter history day limit
MessageStatistics[]	getMessageStatistics() get message statistics of all internal queues
Class	getReceiversImpl() Returns the implementation class for receivers
int	getRecoveryRetries() Returns the recovery retries
long	getRedeliveryDelay() Returns the message redelivery delay, the delay in milliseconds before a rolled back or recovered message is redelivered
int	getRedeliveryLimit() Returns the message redelivery limit; the number of redelivery attempts before a message is moved to the DLQ.
String	listMessageCounter() List destination message counter
String	listMessageCounterHistory() List destination message counter history
void	removeAllMessages() Get the value of JBossMQService.
void	resetMessageCounter() Reset destination message counter
void	resetMessageCounterHistory() Reset destination message counter history
void	setDestinationManager(javax.management.ObjectName jbossMQService) Set the value of JBossMQService.
void	setExpiryDestination(javax.management.ObjectName destination) Sets the expiry destination.
void	setInMemory(boolean mode) Set the temporary topic/queue in memory mode
void	setJNDIName(String name) Sets the JNDI name for this destination
void	setMaxDepth(int depth) Set the maximum depth of the queue or individual subscriptions
void	setMessageCounterHistoryDayLimit(int days) Sets the destination message counter history day limit <0: unlimited, =0: disabled, > 0 maximum day count
void	setReceiversImpl(Class receivers) Sets the class implementating the receivers
void	setRecoveryRetries(int retries) Sets the class implementating the receivers
void	setRedeliveryDelay(long rDelay) Sets the Message redelivery delay in milliseconds.
void	setRedeliveryLimit(int limit) Sets the redelivery limit.
void	setSecurityConf(Element securityConf) Sets the security xml config
void	setSecurityManager(javax.management.ObjectName securityManager) Set the object name of the security manager.

Methods inherited from interface org.jboss.system.ServiceMBean

getName, getState, getStateString, jbossInternalLifecycle

Methods inherited from interface org.jboss.system.Service

create, destroy, start, stop

Method Detail

removeAllMessages

void removeAllMessages()
                       throws Exception

Get the value of JBossMQService.

Throws:

Exception

getDestinationManager

javax.management.ObjectName getDestinationManager()

Get the value of JBossMQService.

Returns:

value of JBossMQService.

setDestinationManager

void setDestinationManager(javax.management.ObjectName jbossMQService)

Set the value of JBossMQService.

Parameters:

v - Value to assign to JBossMQService.

setJNDIName

void setJNDIName(String name)
                 throws Exception

Sets the JNDI name for this destination

Parameters:

name - Name to bind this topic to in the JNDI tree

Throws:

Exception

getJNDIName

String getJNDIName()

Gets the JNDI name use by this destination.

Returns:

The JNDI name currently in use

setSecurityConf

void setSecurityConf(Element securityConf)
                     throws Exception

Sets the security xml config

Throws:

Exception

setSecurityManager

void setSecurityManager(javax.management.ObjectName securityManager)

Set the object name of the security manager.

getMessageCounter

MessageCounter[] getMessageCounter()

get message counter of all internal queues

getMessageStatistics

MessageStatistics[] getMessageStatistics()
                                         throws Exception

get message statistics of all internal queues

Throws:

Exception

listMessageCounter

String listMessageCounter()

List destination message counter

Returns:

String

resetMessageCounter

void resetMessageCounter()

Reset destination message counter

listMessageCounterHistory

String listMessageCounterHistory()

List destination message counter history

Returns:

String

resetMessageCounterHistory

void resetMessageCounterHistory()

Reset destination message counter history

setMessageCounterHistoryDayLimit

void setMessageCounterHistoryDayLimit(int days)

Sets the destination message counter history day limit <0: unlimited, =0: disabled, > 0 maximum day count

Parameters:

days - maximum day count

getMessageCounterHistoryDayLimit

int getMessageCounterHistoryDayLimit()

Gets the destination message counter history day limit

Returns:

Maximum day count

getMaxDepth

int getMaxDepth()

Retrieve the maximum depth of the queue or individual subscriptions

Returns:

the maximum depth

setMaxDepth

void setMaxDepth(int depth)

Set the maximum depth of the queue or individual subscriptions

Parameters:

depth - the maximum depth, zero means unlimited

getInMemory

boolean getInMemory()

Retrieve the topic/queue in memory mode

Returns:

true for in memory

setInMemory

void setInMemory(boolean mode)

Set the temporary topic/queue in memory mode

getRedeliveryLimit

int getRedeliveryLimit()

Returns the message redelivery limit; the number of redelivery attempts before a message is moved to the DLQ.

setRedeliveryLimit

void setRedeliveryLimit(int limit)

Sets the redelivery limit.

getRedeliveryDelay

long getRedeliveryDelay()

Returns the message redelivery delay, the delay in milliseconds before a rolled back or recovered message is redelivered

setRedeliveryDelay

void setRedeliveryDelay(long rDelay)

Sets the Message redelivery delay in milliseconds.

getReceiversImpl

Class getReceiversImpl()

Returns the implementation class for receivers

setReceiversImpl

void setReceiversImpl(Class receivers)

Sets the class implementating the receivers

getRecoveryRetries

int getRecoveryRetries()

Returns the recovery retries

setRecoveryRetries

void setRecoveryRetries(int retries)

Sets the class implementating the receivers

getExpiryDestination

javax.management.ObjectName getExpiryDestination()

Returns the expiry destination.

setExpiryDestination

void setExpiryDestination(javax.management.ObjectName destination)

Sets the expiry destination.