01: /*
02: * $Id: ServiceServiceMBean.java 11234 2008-03-06 23:44:34Z tcarlson $
03: * --------------------------------------------------------------------------------------
04: * Copyright (c) MuleSource, Inc. All rights reserved. http://www.mulesource.com
05: *
06: * The software in this package is published under the terms of the CPAL v1.0
07: * license, a copy of which has been included with this distribution in the
08: * LICENSE.txt file.
09: */
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: import javax.management.ObjectName;
18:
19: /**
20: * <code>ServiceServiceMBean</code> defines the management interface for a mule
21: * managed service.
22: */
23: public interface ServiceServiceMBean extends Stoppable, Startable,
24: ServiceStatsMBean {
25: /**
26: * The statistics for this service
27: *
28: * @return statistics for this service
29: * @see ServiceStats
30: */
31: ObjectName getStatistics();
32:
33: /**
34: * The name of this service
35: *
36: * @return The name of this service
37: */
38: String getName();
39:
40: /**
41: * The number of queued events for this service
42: *
43: * @return The number of queued events for this service
44: */
45: int getQueueSize();
46:
47: /**
48: * Pauses event processing for theComponent. Unlike stop(), a paused service
49: * will still consume messages from the underlying transport, but those messages
50: * will be queued until the service is resumed. In order to persist these
51: * queued messages you can set the 'recoverableMode' property on the
52: * Muleconfiguration to true. this causes all internal queues to store their
53: * state.
54: *
55: * @throws MuleException if the service failed to pause.
56: * @see org.mule.config.MuleConfiguration
57: */
58: void pause() throws MuleException;
59:
60: /**
61: * Resumes the Service that has been paused. If the service is not paused
62: * nothing is executed.
63: *
64: * @throws MuleException if the service failed to resume
65: */
66: void resume() throws MuleException;
67:
68: boolean isPaused();
69:
70: boolean isStopped();
71:
72: void dispose() throws MuleException;
73:
74: /**
75: * Causes the service to stop without processing its event queue first
76: */
77: void forceStop() throws MuleException;
78:
79: boolean isStopping();
80: }
|