org.mule.management.mbeans
Interface ComponentServiceMBean

All Superinterfaces:
Startable, Stoppable
All Known Implementing Classes:
ComponentService

public interface ComponentServiceMBean
extends Stoppable, Startable

ComponentServiceMBean defines the management interface for a mule managed component

Version:
$Revision: 1.2 $
Author:
Ross Mason

Method Summary
 void dispose()
           
 java.lang.String getName()
          The name of this component
 int getQueueSize()
          The number of queued events for this component
 ObjectName getStatistics()
          The statistics for this component
 boolean isPaused()
           
 boolean isStopped()
           
 void pause()
          Pauses event processing for theComponent.
 void resume()
          Resumes the Component that has been paused.
 
Methods inherited from interface org.mule.umo.lifecycle.Stoppable
stop
 
Methods inherited from interface org.mule.umo.lifecycle.Startable
start
 

Method Detail

getStatistics

public ObjectName getStatistics()
The statistics for this component

Returns:
statistics for this component
See Also:
ComponentStats

getName

public java.lang.String getName()
The name of this component

Returns:
The name of this component

getQueueSize

public int getQueueSize()
The number of queued events for this component

Returns:
The number of queued events for this component

pause

public void pause()
           throws UMOException
Pauses event processing for theComponent. Unlike stop(), a paused component will still consume messages from the underlying transport, but those messages will be queued until the component is resumed. In order to persist these queued messages you can set the 'recoverableMode' property on the Muleconfiguration to true. this causes all internal queues to store their state.

Throws:
UMOException - if the component failed to pause.
See Also:
MuleConfiguration

resume

public void resume()
            throws UMOException
Resumes the Component that has been paused. If the component is not paused nothing is executed.

Throws:
UMOException - if the component failed to resume

isPaused

public boolean isPaused()

isStopped

public boolean isStopped()

dispose

public void dispose()
             throws UMOException
Throws:
UMOException


Copyright © 2003-2005 SymphonySoft Limited. All Rights Reserved.