1 /*
2 * JBoss, Home of Professional Open Source.
3 * Copyright 2008, Red Hat Middleware LLC, and individual contributors
4 * as indicated by the @author tags. See the copyright.txt file in the
5 * distribution for a 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;
23
24 /**
25 * MBean interface for the preferred master election policy that allows
26 * preferred master to be changed at runtime.
27 *
28 * @author <a href="mailto:galder.zamarreno@jboss.com">Galder Zamarreno</a>
29 */
30 public interface PreferredMasterElectionPolicyMBean extends HASingletonElectionPolicySimpleMBean
31 {
32 /**
33 * Sets the preferred master node. As long as the preferred master node
34 * presents in the cluster, it will be always selected as master node,
35 * no matter what the election policy is.
36 * @param node String format of ip_address:port_number or
37 * host_name:port_number.
38 */
39 void setPreferredMaster(String node);
40
41 /**
42 * Get the preferred master node.
43 *
44 * @return preferred master node in ip_address:port_number or
45 * host_name:port_number format.
46 */
47 String getPreferredMaster();
48 }