blob: 5f2b5fffa23be5e4dc698628d49f28027e281f2d [file] [log] [blame]
Thomas Vachuska4f1a60c2014-10-28 13:39:07 -07001/*
Ray Milkey34c95902015-04-15 09:47:53 -07002 * Copyright 2014-2015 Open Networking Laboratory
Thomas Vachuska4f1a60c2014-10-28 13:39:07 -07003 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
Brian O'Connorabafb502014-12-02 22:26:20 -080016package org.onosproject.cluster;
tomb41d1ac2014-09-24 01:51:24 -070017
Pavlin Radoslavov444b5192014-10-28 10:45:19 -070018import org.onlab.packet.IpAddress;
tomee49c372014-09-26 15:14:50 -070019
Thomas Vachuskade563cf2015-04-01 00:28:50 -070020import java.util.Set;
21
tomb41d1ac2014-09-24 01:51:24 -070022/**
23 * Service for administering the cluster node membership.
24 */
25public interface ClusterAdminService {
26
27 /**
Thomas Vachuskade563cf2015-04-01 00:28:50 -070028 * Forms cluster configuration based on the specified set of node
29 * information.  This method resets and restarts the controller
30 * instance.
31 *
32 * @param nodes set of nodes that form the cluster
33 * @param ipPrefix IP address prefix, e.g. 10.0.1.*
34 */
35 void formCluster(Set<ControllerNode> nodes, String ipPrefix);
36
37 /**
tomee49c372014-09-26 15:14:50 -070038 * Adds a new controller node to the cluster.
39 *
40 * @param nodeId controller node identifier
41 * @param ip node IP listen address
42 * @param tcpPort tcp listen port
43 * @return newly added node
44 */
Pavlin Radoslavov444b5192014-10-28 10:45:19 -070045 ControllerNode addNode(NodeId nodeId, IpAddress ip, int tcpPort);
tomee49c372014-09-26 15:14:50 -070046
47 /**
tomb41d1ac2014-09-24 01:51:24 -070048 * Removes the specified node from the cluster node list.
49 *
50 * @param nodeId controller node identifier
51 */
52 void removeNode(NodeId nodeId);
53
54}