org.jboss.mq.server.jmx
Class DestinationMBeanSupport

java.lang.Object
  extended byorg.jboss.mx.util.JBossNotificationBroadcasterSupport (src) 
      extended byorg.jboss.system.ServiceMBeanSupport (src) 
          extended byorg.jboss.mq.server.jmx.DestinationMBeanSupport
All Implemented Interfaces:
DestinationMBean (src) , MBeanRegistration (src) , NotificationBroadcaster (src) , NotificationEmitter (src) , Service (src) , ServiceMBean (src)
Direct Known Subclasses:
Queue (src) , Topic (src)

public abstract class DestinationMBeanSupport
extends ServiceMBeanSupport (src)
implements DestinationMBean (src) , MBeanRegistration (src)

Super class for destination managers.


Field Summary
 
Fields inherited from class org.jboss.system.ServiceMBeanSupport (src)
log, server, SERVICE_CONTROLLER_SIG, serviceName
 
Fields inherited from interface org.jboss.system.ServiceMBean (src)
CREATE_EVENT, CREATED, DESTROY_EVENT, DESTROYED, FAILED, REGISTERED, START_EVENT, STARTED, STARTING, states, STOP_EVENT, STOPPED, STOPPING, UNREGISTERED
 
Constructor Summary
DestinationMBeanSupport()
           
 
Method Summary
 void createService()
          Sub-classes should override this method to provide custum 'create' logic.
 ObjectName (src) getDestinationManager()
          Get the value of JBossMQService.
 boolean getInMemory()
          Retrieve the topic/queue in memory mode
 java.lang.String getJNDIName()
          Gets the JNDI name use by this topic
 int getMaxDepth()
          Retrieve the maximum depth of the queue or individual subscriptions
abstract  MessageCounter (src) [] getMessageCounter()
          Get destination message counter array
 int getMessageCounterHistoryDayLimit()
          Gets the destination message counter history day limit
abstract  MessageStatistics (src) [] getMessageStatistics()
          Get destination stats array
protected  ObjectName (src) getObjectName(MBeanServer (src)  server, ObjectName (src)  name)
          Sub-classes should override this method if they only need to set their object name during MBean pre-registration.
 java.lang.Class getReceiversImpl()
          Get the receivers implemenetation
 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.
protected  org.w3c.dom.Element getSecurityConf()
           
protected  ObjectName (src) getSecurityManager()
           
protected  SpyDestination (src) getSpyDest()
           
 java.lang.String listMessageCounter()
          List destination message counter as HTML table
 java.lang.String listMessageCounterHistory()
          List destination message counter history as HTML table
 void resetMessageCounter()
          Reset destination message counter
 void resetMessageCounterHistory()
          Reset destination message counter history
 void setDestinationManager(ObjectName (src)  jbossMQService)
          Set the value of JBossMQService.
 void setInMemory(boolean mode)
          Set the temporary topic/queue in memory mode
 void setJNDIName(java.lang.String name)
          Sets the JNDI name for this topic
 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(java.lang.Class clazz)
          Set the receivers implementation class
 void setRedeliveryDelay(long rDelay)
          Sets the Message redelivery delay in milliseconds.
 void setRedeliveryLimit(int limit)
          Sets the redelivery limit.
 void setSecurityConf(org.w3c.dom.Element securityConf)
          Sets the security xml config
 void setSecurityManager(ObjectName (src)  securityManager)
          Set the object name of the security manager.
 void startService()
          Sub-classes should override this method to provide custum 'start' logic.
 void stopService()
          Sub-classes should override this method to provide custum 'stop' logic.
 
Methods inherited from class org.jboss.system.ServiceMBeanSupport (src)
create, destroy, destroyService, getLog, getName, getNextNotificationSequenceNumber, getServer, getServiceName, getState, getStateString, jbossInternalCreate, jbossInternalDescription, jbossInternalDestroy, jbossInternalLifecycle, jbossInternalStart, jbossInternalStop, postDeregister, postRegister, preDeregister, preRegister, start, stop
 
Methods inherited from class org.jboss.mx.util.JBossNotificationBroadcasterSupport (src)
addNotificationListener, getNotificationInfo, handleNotification, removeNotificationListener, removeNotificationListener, sendNotification
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.jboss.mq.server.jmx.DestinationMBean (src)
removeAllMessages
 
Methods inherited from interface org.jboss.system.ServiceMBean (src)
getName, getState, getStateString, jbossInternalLifecycle
 
Methods inherited from interface org.jboss.system.Service (src)
create, destroy, start, stop
 
Methods inherited from interface javax.management.MBeanRegistration (src)
postDeregister, postRegister, preDeregister, preRegister
 

Constructor Detail

DestinationMBeanSupport

public DestinationMBeanSupport()
Method Detail

getDestinationManager

public ObjectName (src)  getDestinationManager()
Get the value of JBossMQService.

Specified by:
getDestinationManager in interface DestinationMBean (src)
Returns:
value of JBossMQService.

setDestinationManager

public void setDestinationManager(ObjectName (src)  jbossMQService)
Set the value of JBossMQService.

Specified by:
setDestinationManager in interface DestinationMBean (src)

getSpyDest

protected SpyDestination (src)  getSpyDest()

setSecurityConf

public void setSecurityConf(org.w3c.dom.Element securityConf)
                     throws java.lang.Exception
Description copied from interface: DestinationMBean (src)
Sets the security xml config

Specified by:
setSecurityConf in interface DestinationMBean (src)
Throws:
java.lang.Exception

getSecurityConf

protected org.w3c.dom.Element getSecurityConf()

setSecurityManager

public void setSecurityManager(ObjectName (src)  securityManager)
Description copied from interface: DestinationMBean (src)
Set the object name of the security manager.

Specified by:
setSecurityManager in interface DestinationMBean (src)

getSecurityManager

protected ObjectName (src)  getSecurityManager()

createService

public void createService()
                   throws java.lang.Exception
Description copied from class: ServiceMBeanSupport (src)
Sub-classes should override this method to provide custum 'create' logic.

This method is empty, and is provided for convenience when concrete service classes do not need to perform anything specific for this state change.

Overrides:
createService in class ServiceMBeanSupport (src)
Throws:
java.lang.Exception

startService

public void startService()
                  throws java.lang.Exception
Description copied from class: ServiceMBeanSupport (src)
Sub-classes should override this method to provide custum 'start' logic.

This method is empty, and is provided for convenience when concrete service classes do not need to perform anything specific for this state change.

Overrides:
startService in class ServiceMBeanSupport (src)
Throws:
java.lang.Exception

stopService

public void stopService()
                 throws java.lang.Exception
Description copied from class: ServiceMBeanSupport (src)
Sub-classes should override this method to provide custum 'stop' logic.

This method is empty, and is provided for convenience when concrete service classes do not need to perform anything specific for this state change.

Overrides:
stopService in class ServiceMBeanSupport (src)
Throws:
java.lang.Exception

getObjectName

protected ObjectName (src)  getObjectName(MBeanServer (src)  server,
                                   ObjectName (src)  name)
                            throws MalformedObjectNameException (src) 
Description copied from class: ServiceMBeanSupport (src)
Sub-classes should override this method if they only need to set their object name during MBean pre-registration.

Overrides:
getObjectName in class ServiceMBeanSupport (src)
Throws:
MalformedObjectNameException (src)

setJNDIName

public void setJNDIName(java.lang.String name)
                 throws java.lang.Exception
Sets the JNDI name for this topic

Specified by:
setJNDIName in interface DestinationMBean (src)
Parameters:
name - Name to bind this topic to in the JNDI tree
Throws:
java.lang.Exception

getJNDIName

public java.lang.String getJNDIName()
Gets the JNDI name use by this topic

Specified by:
getJNDIName in interface DestinationMBean (src)
Returns:
The JNDI name currently in use

getMessageCounter

public abstract MessageCounter (src) [] getMessageCounter()
Get destination message counter array

Specified by:
getMessageCounter in interface DestinationMBean (src)
Returns:
MessageCounter[]

getMessageStatistics

public abstract MessageStatistics (src) [] getMessageStatistics()
                                                  throws java.lang.Exception
Get destination stats array

Specified by:
getMessageStatistics in interface DestinationMBean (src)
Returns:
MessageStatistics[]
Throws:
java.lang.Exception - for any error

listMessageCounter

public java.lang.String listMessageCounter()
List destination message counter as HTML table

Specified by:
listMessageCounter in interface DestinationMBean (src)
Returns:
String

resetMessageCounter

public void resetMessageCounter()
Reset destination message counter

Specified by:
resetMessageCounter in interface DestinationMBean (src)

listMessageCounterHistory

public java.lang.String listMessageCounterHistory()
List destination message counter history as HTML table

Specified by:
listMessageCounterHistory in interface DestinationMBean (src)
Returns:
String

resetMessageCounterHistory

public void resetMessageCounterHistory()
Reset destination message counter history

Specified by:
resetMessageCounterHistory in interface DestinationMBean (src)

setMessageCounterHistoryDayLimit

public void setMessageCounterHistoryDayLimit(int days)
Sets the destination message counter history day limit <0: unlimited, =0: disabled, > 0 maximum day count

Specified by:
setMessageCounterHistoryDayLimit in interface DestinationMBean (src)
Parameters:
days - maximum day count

getMessageCounterHistoryDayLimit

public int getMessageCounterHistoryDayLimit()
Gets the destination message counter history day limit

Specified by:
getMessageCounterHistoryDayLimit in interface DestinationMBean (src)
Returns:
Maximum day count

getMaxDepth

public int getMaxDepth()
Description copied from interface: DestinationMBean (src)
Retrieve the maximum depth of the queue or individual subscriptions

Specified by:
getMaxDepth in interface DestinationMBean (src)
Returns:
the maximum depth

setMaxDepth

public void setMaxDepth(int depth)
Description copied from interface: DestinationMBean (src)
Set the maximum depth of the queue or individual subscriptions

Specified by:
setMaxDepth in interface DestinationMBean (src)
Parameters:
depth - the maximum depth, zero means unlimited

getInMemory

public boolean getInMemory()
Description copied from interface: DestinationMBean (src)
Retrieve the topic/queue in memory mode

Specified by:
getInMemory in interface DestinationMBean (src)
Returns:
true for in memory

setInMemory

public void setInMemory(boolean mode)
Description copied from interface: DestinationMBean (src)
Set the temporary topic/queue in memory mode

Specified by:
setInMemory in interface DestinationMBean (src)

getRedeliveryLimit

public int getRedeliveryLimit()
Returns the message redelivery limit; the number of redelivery attempts before a message is moved to the DLQ.

Specified by:
getRedeliveryLimit in interface DestinationMBean (src)

setRedeliveryLimit

public void setRedeliveryLimit(int limit)
Sets the redelivery limit.

Specified by:
setRedeliveryLimit in interface DestinationMBean (src)

getRedeliveryDelay

public long getRedeliveryDelay()
Returns the message redelivery delay, the delay in milliseconds before a rolled back or recovered message is redelivered

Specified by:
getRedeliveryDelay in interface DestinationMBean (src)

setRedeliveryDelay

public void setRedeliveryDelay(long rDelay)
Sets the Message redelivery delay in milliseconds.

Specified by:
setRedeliveryDelay in interface DestinationMBean (src)

getReceiversImpl

public java.lang.Class getReceiversImpl()
Get the receivers implemenetation

Specified by:
getReceiversImpl in interface DestinationMBean (src)
Returns:
the receivers implementation class

setReceiversImpl

public void setReceiversImpl(java.lang.Class clazz)
Set the receivers implementation class

Specified by:
setReceiversImpl in interface DestinationMBean (src)
Parameters:
clazz - the receivers implementation class