KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > ha > singleton > examples > HASingletonMBeanExampleMBean


1 /*
2   * JBoss, Home of Professional Open Source
3   * Copyright 2005, JBoss Inc., and individual contributors as indicated
4   * by the @authors tag. See the copyright.txt in the distribution for a
5   * full listing of individual contributors.
6   *
7   * This is free software; you can redistribute it and/or modify it
8   * under the terms of the GNU Lesser General Public License as
9   * 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    *
36    * @return true if the node that this MBean is registered with
37    * is the master node for the singleton service
38    *
39    */
40   public boolean isMasterNode();
41   
42   /**
43    *
44    * Invoked when this mbean is elected to run the singleton service,
45    * or in other words when this node is elected for master.
46    *
47    */
48   public void startSingleton();
49   
50   /**
51    *
52    * Invoked when this mbean is elected to no longer run the singleton service,
53    * or in other words when this node is elected for slave.
54    *
55    * @param String gracefulShutdown is an example argument passed on singleton stop
56    *
57    */
58   public void stopSingleton( String JavaDoc gracefulShutdown );
59
60   
61 }
62
Popular Tags