Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2014 Open Networking Laboratory |
| 3 | * |
| 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'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.net.host; |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 17 | |
samanwita pal | c40e5ed | 2015-09-24 11:01:51 -0700 | [diff] [blame] | 18 | import org.onlab.packet.IpAddress; |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 19 | import org.onosproject.net.HostId; |
| 20 | import org.onosproject.net.provider.ProviderService; |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 21 | |
| 22 | /** |
| 23 | * Means of conveying host information to the core. |
| 24 | */ |
tom | d735672 | 2014-08-26 01:07:39 -0700 | [diff] [blame] | 25 | public interface HostProviderService extends ProviderService<HostProvider> { |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 26 | |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 27 | /** |
| 28 | * Notifies the core when a host has been detected on a network along with |
Kedar Gupta | 47bd480 | 2015-07-15 09:43:26 -0700 | [diff] [blame] | 29 | * information that identifies the host location. |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 30 | * |
tom | 7869ad9 | 2014-09-09 14:32:08 -0700 | [diff] [blame] | 31 | * @param hostId id of the host that been detected |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 32 | * @param hostDescription description of host and its location |
Sho SHIMIZU | bccb002b | 2015-09-24 15:22:18 -0700 | [diff] [blame] | 33 | * @deprecated in Drake release |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 34 | */ |
Brian O'Connor | f107bd7 | 2015-09-21 15:31:03 -0700 | [diff] [blame] | 35 | @Deprecated |
| 36 | default void hostDetected(HostId hostId, HostDescription hostDescription) { |
| 37 | hostDetected(hostId, hostDescription, false); |
| 38 | } |
| 39 | |
| 40 | /** |
| 41 | * Notifies the core when a host has been detected on a network along with |
| 42 | * information that identifies the host location. |
| 43 | * |
| 44 | * @param hostId id of the host that been detected |
| 45 | * @param hostDescription description of host and its location |
| 46 | * @param replaceIps replace IP set if true, merge IP set otherwise |
| 47 | */ |
| 48 | void hostDetected(HostId hostId, HostDescription hostDescription, boolean replaceIps); |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 49 | |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 50 | /** |
| 51 | * Notifies the core when a host is no longer detected on a network. |
| 52 | * |
tom | 7869ad9 | 2014-09-09 14:32:08 -0700 | [diff] [blame] | 53 | * @param hostId id of the host that vanished |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 54 | */ |
tom | 7869ad9 | 2014-09-09 14:32:08 -0700 | [diff] [blame] | 55 | void hostVanished(HostId hostId); |
tom | e33cc1a | 2014-08-25 21:59:41 -0700 | [diff] [blame] | 56 | |
samanwita pal | c40e5ed | 2015-09-24 11:01:51 -0700 | [diff] [blame] | 57 | /** |
Brian O'Connor | 5251562 | 2015-10-09 17:03:44 -0700 | [diff] [blame] | 58 | * Notifies the core when an IP is no longer associated with a host. |
samanwita pal | c40e5ed | 2015-09-24 11:01:51 -0700 | [diff] [blame] | 59 | * |
Brian O'Connor | 5251562 | 2015-10-09 17:03:44 -0700 | [diff] [blame] | 60 | * @param hostId id of the host |
| 61 | * @param ipAddress ip address of host that vanished |
samanwita pal | c40e5ed | 2015-09-24 11:01:51 -0700 | [diff] [blame] | 62 | */ |
| 63 | void removeIpFromHost(HostId hostId, IpAddress ipAddress); |
| 64 | |
tom | 0eb04ca | 2014-08-25 14:34:51 -0700 | [diff] [blame] | 65 | } |