01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * published by the Free Software Foundation; either version 2.1 of
10: * the License, or (at your option) any later version.
11: *
12: * This software is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this software; if not, write to the Free
19: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21: */
22: package org.jboss.monitor.services;
23:
24: import javax.management.ObjectName;
25:
26: import org.jboss.system.ServiceMBean;
27:
28: /**
29: * MBean interface for a simple service used to configure the
30: * periodic emition of notifications by a standard JMX Timer.
31: *
32: * @see javax.management.timer.Timer
33: *
34: * @author <a href="mailto:dimitris@jboss.org">Dimitris Andreadis</a>
35: * @version $Revision: 57210 $
36: */
37: public interface TimerServiceMBean extends ServiceMBean {
38: // Attributes ----------------------------------------------------
39:
40: /**
41: * The type of the emitted notifications
42: */
43: void setNotificationType(String type);
44:
45: String getNotificationType();
46:
47: /**
48: * The message carried by the emitted notifications
49: */
50: void setNotificationMessage(String message);
51:
52: String getNotificationMessage();
53:
54: /**
55: * Timer period in milliseconds; accepts suffix modifiers
56: * e.g. "1000", "500msec", "10sec", "5min", "1h"
57: */
58: void setTimerPeriod(String timerPeriod);
59:
60: String getTimerPeriod();
61:
62: /**
63: * Number of occurences
64: */
65: void setRepeatitions(long repeatitions);
66:
67: long getRepeatitions();
68:
69: /**
70: * The execution mode, true==fixed-rate, false==fixed-delay (default)
71: */
72: void setFixedRate(boolean fixedRate);
73:
74: boolean getFixedRate();
75:
76: /**
77: * The utilized TimerMBean
78: */
79: void setTimerMBean(ObjectName timerMBean);
80:
81: ObjectName getTimerMBean();
82:
83: }
|