View Javadoc

1   /*
2    * $Id: ServiceServiceMBean.java 20297 2010-11-22 18:49:18Z aperepel $
3    * --------------------------------------------------------------------------------------
4    * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
5    *
6    * The software in this package is published under the terms of the CPAL v1.0
7    * license, a copy of which has been included with this distribution in the
8    * LICENSE.txt file.
9    */
10  
11  package org.mule.module.management.mbean;
12  
13  import org.mule.api.MuleException;
14  import org.mule.api.lifecycle.Startable;
15  import org.mule.api.lifecycle.Stoppable;
16  
17  /**
18   * <code>ServiceServiceMBean</code> defines the management interface for a mule
19   * managed service.
20   */
21  public interface ServiceServiceMBean extends Stoppable, Startable, FlowConstructServiceMBean, ServiceStatsMBean
22  {
23      String DEFAULT_JMX_NAME_PREFIX = "type=Service,name=";
24  
25      /**
26       * The number of queued events for this service
27       * 
28       * @return The number of queued events for this service
29       */
30      int getQueueSize();
31  
32          /**
33       * Pauses event processing for theComponent. Unlike stop(), a paused service
34       * will still consume messages from the underlying transport, but those messages
35       * will be queued until the service is resumed. In order to persist these
36       * queued messages you can set the 'recoverableMode' property on the
37       * Muleconfiguration to true. this causes all internal queues to store their
38       * state.
39       *
40       * @throws org.mule.api.MuleException if the service failed to pause.
41       * @see org.mule.api.config.MuleConfiguration
42       */
43      void pause() throws MuleException;
44  
45      /**
46       * Resumes the Service that has been paused. If the service is not paused
47       * nothing is executed.
48       *
49       * @throws MuleException if the service failed to resume
50       */
51      void resume() throws MuleException;
52  
53      boolean isPaused();
54  
55      boolean isStopped();
56  
57      void dispose() throws MuleException;
58  
59      /**
60       * Causes the service to stop without processing its event queue first
61       */
62      void forceStop() throws MuleException;
63  
64      boolean isStopping();
65  
66  }