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.ha.singleton.examples;
23:
24: /**
25: *
26: * Sample Singleton MBean interface
27: *
28: * @author Ivelin Ivanov <ivelin@apache.org>
29: *
30: */
31: public interface HASingletonMBeanExampleMBean {
32:
33: /**
34: *
35: * @return true if the node that this MBean is registered with
36: * is the master node for the singleton service
37: *
38: */
39: public boolean isMasterNode();
40:
41: /**
42: *
43: * Invoked when this mbean is elected to run the singleton service,
44: * or in other words when this node is elected for master.
45: *
46: */
47: public void startSingleton();
48:
49: /**
50: *
51: * Invoked when this mbean is elected to no longer run the singleton service,
52: * or in other words when this node is elected for slave.
53: *
54: * @param String gracefulShutdown is an example argument passed on singleton stop
55: *
56: */
57: public void stopSingleton(String gracefulShutdown);
58:
59: }
|