blob: 90e39c69d92425c61fb7690e22745cf760e5cdf6 [file] [log] [blame]
Thomas Vachuska4f1a60c2014-10-28 13:39:07 -07001/*
Brian O'Connora09fe5b2017-08-03 21:12:30 -07002 * Copyright 2014-present Open Networking Foundation
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.net.host;
tom0eb04ca2014-08-25 14:34:51 -070017
Charles Chanff79dd92018-06-01 16:33:48 -070018import org.apache.commons.lang3.NotImplementedException;
samanwita palc40e5ed2015-09-24 11:01:51 -070019import org.onlab.packet.IpAddress;
Brian O'Connorabafb502014-12-02 22:26:20 -080020import org.onosproject.net.HostId;
Charles Chan888e20a2017-05-01 15:44:23 -070021import org.onosproject.net.HostLocation;
Brian O'Connorabafb502014-12-02 22:26:20 -080022import org.onosproject.net.provider.ProviderService;
tom0eb04ca2014-08-25 14:34:51 -070023
24/**
25 * Means of conveying host information to the core.
26 */
tomd7356722014-08-26 01:07:39 -070027public interface HostProviderService extends ProviderService<HostProvider> {
tom0eb04ca2014-08-25 14:34:51 -070028
tome33cc1a2014-08-25 21:59:41 -070029 /**
30 * Notifies the core when a host has been detected on a network along with
Kedar Gupta47bd4802015-07-15 09:43:26 -070031 * information that identifies the host location.
tome33cc1a2014-08-25 21:59:41 -070032 *
tom7869ad92014-09-09 14:32:08 -070033 * @param hostId id of the host that been detected
tome33cc1a2014-08-25 21:59:41 -070034 * @param hostDescription description of host and its location
Brian O'Connorf107bd72015-09-21 15:31:03 -070035 * @param replaceIps replace IP set if true, merge IP set otherwise
36 */
37 void hostDetected(HostId hostId, HostDescription hostDescription, boolean replaceIps);
tom0eb04ca2014-08-25 14:34:51 -070038
tome33cc1a2014-08-25 21:59:41 -070039 /**
40 * Notifies the core when a host is no longer detected on a network.
41 *
tom7869ad92014-09-09 14:32:08 -070042 * @param hostId id of the host that vanished
tome33cc1a2014-08-25 21:59:41 -070043 */
tom7869ad92014-09-09 14:32:08 -070044 void hostVanished(HostId hostId);
tome33cc1a2014-08-25 21:59:41 -070045
samanwita palc40e5ed2015-09-24 11:01:51 -070046 /**
Brian O'Connor52515622015-10-09 17:03:44 -070047 * Notifies the core when an IP is no longer associated with a host.
samanwita palc40e5ed2015-09-24 11:01:51 -070048 *
Brian O'Connor52515622015-10-09 17:03:44 -070049 * @param hostId id of the host
50 * @param ipAddress ip address of host that vanished
samanwita palc40e5ed2015-09-24 11:01:51 -070051 */
52 void removeIpFromHost(HostId hostId, IpAddress ipAddress);
53
Charles Chan888e20a2017-05-01 15:44:23 -070054 /**
Charles Chanff79dd92018-06-01 16:33:48 -070055 * Notifies the core when a location is associated with a host.
56 *
57 * @param hostId id of the host
58 * @param location location of host that gets discovered
59 */
60 default void addLocationToHost(HostId hostId, HostLocation location) {
61 throw new NotImplementedException("addLocationToHost is not implemented");
62 }
63
64 /**
Charles Chan888e20a2017-05-01 15:44:23 -070065 * Notifies the core when a location is no longer associated with a host.
66 *
67 * @param hostId id of the host
68 * @param location location of host that vanished
69 */
70 void removeLocationFromHost(HostId hostId, HostLocation location);
tom0eb04ca2014-08-25 14:34:51 -070071}