blob: be114f05cd51c8e8999827ab74c33816bcec1df6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
/*
* Copyright 2014 Open Networking Laboratory
*
* Licensed under the Apache License, Version 2.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.apache.org/licenses/LICENSE-2.0
*
* 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.onosproject.net.host;
import org.onlab.packet.IpAddress;
import org.onlab.packet.MacAddress;
import org.onlab.packet.VlanId;
import org.onosproject.event.ListenerService;
import org.onosproject.net.ConnectPoint;
import org.onosproject.net.DeviceId;
import org.onosproject.net.Host;
import org.onosproject.net.HostId;
import java.util.Set;
/**
* Service for interacting with the inventory of end-station hosts.
*/
public interface HostService
extends ListenerService<HostEvent, HostListener> {
/**
* Returns the number of end-station hosts known to the system.
*
* @return number of end-station hosts
*/
int getHostCount();
/**
* Returns a collection of all end-station hosts.
*
* @return collection of hosts
*/
Iterable<Host> getHosts();
/**
* Returns the host with the specified identifier.
*
* @param hostId host identifier
* @return host or null if one with the given identifier is not known
*/
Host getHost(HostId hostId);
/**
* Returns the set of hosts that belong to the specified VLAN.
*
* @param vlanId vlan identifier
* @return set of hosts in the given vlan id
*/
Set<Host> getHostsByVlan(VlanId vlanId);
/**
* Returns the set of hosts that have the specified MAC address.
*
* @param mac mac address
* @return set of hosts with the given mac
*/
Set<Host> getHostsByMac(MacAddress mac);
/**
* Returns the set of hosts that have the specified IP address.
*
* @param ip ip address
* @return set of hosts with the given IP
*/
Set<Host> getHostsByIp(IpAddress ip);
// TODO: consider adding Host getHostByIp(IpAddress ip, VlanId vlan);
/**
* Returns the set of hosts whose most recent location is the specified
* connection point.
*
* @param connectPoint connection point
* @return set of hosts connected to the connection point
*/
Set<Host> getConnectedHosts(ConnectPoint connectPoint);
/**
* Returns the set of hosts whose most recent location is the specified
* infrastructure device.
*
* @param deviceId device identifier
* @return set of hosts connected to the device
*/
Set<Host> getConnectedHosts(DeviceId deviceId);
/**
* Requests the host service to monitor hosts with the given IP address and
* notify listeners of changes.
*
* @param ip IP address of the host to monitor
*/
void startMonitoringIp(IpAddress ip);
/**
* Stops the host service from monitoring an IP address.
*
* @param ip IP address to stop monitoring
*/
// TODO clients can cancel other client's requests
void stopMonitoringIp(IpAddress ip);
/**
* Requests the host service to resolve the MAC address for the given IP
* address. This will trigger a notification to the host listeners if the MAC
* address is found.
*
* @param ip IP address to find the MAC address for
*/
void requestMac(IpAddress ip);
/**
* Returns the addresses information for all connection points.
*
* @return the set of address bindings for all connection points
* @deprecated in Drake release: use InterfaceService instead
*/
@Deprecated
Set<PortAddresses> getAddressBindings();
/**
* Retrieves the addresses that have been bound to the given connection
* point.
*
* @param connectPoint the connection point to retrieve address bindings for
* @return addresses bound to the port
* @deprecated in Drake release: use InterfaceService instead
*/
@Deprecated
Set<PortAddresses> getAddressBindingsForPort(ConnectPoint connectPoint);
}
|
