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