IHAListener.java

/*
 * Copyright (c) 2013 Big Switch Networks, Inc.
 *
 * Licensed under the Eclipse Public License, Version 1.0 (the
 * "License"); you may not use this file except in compliance with the
 * License. You may obtain a copy of the License at
 *
 *      http://www.eclipse.org/legal/epl-v10.html
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

package org.sdnplatform.core;

import java.util.Map;

import org.sdnplatform.core.IControllerService.Role;


public interface IHAListener {
    /**
     * Gets called when the controller changes role (i.e. Master -> Slave).
     * Note that oldRole CAN be null.
     * @param oldRole The controller's old role
     * @param newRole The controller's new role
     */
    public void roleChanged(Role oldRole, Role newRole);
    
    /**
     * Gets called when the IP addresses of the controller nodes in the 
     * controller cluster change. All parameters map controller ID to
     * the controller's IP.
     *  
     * @param curControllerNodeIPs The current mapping of controller IDs to IP
     * @param addedControllerNodeIPs These IPs were added since the last update
     * @param removedControllerNodeIPs These IPs were removed since the last update
     */
    public void controllerNodeIPsChanged(
    		Map<String, String> curControllerNodeIPs,  
    		Map<String, String> addedControllerNodeIPs,  
    		Map<String, String> removedControllerNodeIPs
    		);
}