diff options
Diffstat (limited to 'framework/src/onos/core/api/src/main/java/org/onosproject/net/host/HostStore.java')
| -rw-r--r-- | framework/src/onos/core/api/src/main/java/org/onosproject/net/host/HostStore.java | 167 |
1 files changed, 167 insertions, 0 deletions
diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/net/host/HostStore.java b/framework/src/onos/core/api/src/main/java/org/onosproject/net/host/HostStore.java new file mode 100644 index 00000000..ca11a942 --- /dev/null +++ b/framework/src/onos/core/api/src/main/java/org/onosproject/net/host/HostStore.java @@ -0,0 +1,167 @@ +/* + * 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.net.ConnectPoint; +import org.onosproject.net.DeviceId; +import org.onosproject.net.Host; +import org.onosproject.net.HostId; +import org.onosproject.net.provider.ProviderId; +import org.onosproject.store.Store; + +import java.util.Set; + +/** + * Manages inventory of end-station hosts; not intended for direct use. + */ +public interface HostStore extends Store<HostEvent, HostStoreDelegate> { + + /** + * Creates a new host or updates the existing one based on the specified + * description. + * + * @param providerId provider identification + * @param hostId host identification + * @param hostDescription host description data + * @return appropriate event or null if no change resulted + */ + HostEvent createOrUpdateHost(ProviderId providerId, HostId hostId, + HostDescription hostDescription); + + // FIXME: API to remove only IpAddress is missing + /** + * Removes the specified host from the inventory. + * + * @param hostId host identification + * @return remove event or null if host was not found + */ + HostEvent removeHost(HostId hostId); + + /** + * Returns the number of hosts in the store. + * + * @return host count + */ + int getHostCount(); + + /** + * Returns a collection of all hosts in the store. + * + * @return iterable collection of all hosts + */ + Iterable<Host> getHosts(); + + /** + * Returns the host with the specified identifer. + * + * @param hostId host identification + * @return host or null if not found + */ + Host getHost(HostId hostId); + + /** + * Returns the set of all hosts within the specified VLAN. + * + * @param vlanId vlan id + * @return set of hosts in the vlan + */ + Set<Host> getHosts(VlanId vlanId); + + /** + * Returns the set of hosts with the specified MAC address. + * + * @param mac mac address + * @return set of hosts with the given mac + */ + Set<Host> getHosts(MacAddress mac); + + /** + * Returns the set of hosts with the specified IP address. + * + * @param ip ip address + * @return set of hosts with the given IP + */ + Set<Host> getHosts(IpAddress ip); + + /** + * Returns the set of hosts whose location falls on the given connection point. + * + * @param connectPoint connection point + * @return set of hosts + */ + Set<Host> getConnectedHosts(ConnectPoint connectPoint); + + /** + * Returns the set of hosts whose location falls on the given device. + * + * @param deviceId infrastructure device identifier + * @return set of hosts + */ + Set<Host> getConnectedHosts(DeviceId deviceId); + + /** + * Updates the address information for a given port. The given address + * information is added to any previously held information for the port. + * + * @param addresses the port and address information + * @deprecated in Drake release: address info now stored in InterfaceService + */ + @Deprecated + void updateAddressBindings(PortAddresses addresses); + + /** + * Removes the given addresses from the set of address information held for + * a port. + * + * @param addresses the port and address information + * @deprecated in Drake release: address info now stored in InterfaceService + */ + @Deprecated + void removeAddressBindings(PortAddresses addresses); + + /** + * Removes any previously stored address information for a given connection + * point. + * + * @param connectPoint the connection point + * @deprecated in Drake release: address info now stored in InterfaceService + */ + @Deprecated + void clearAddressBindings(ConnectPoint connectPoint); + + /** + * Returns the address bindings stored for all connection points. + * + * @return the set of address bindings + * @deprecated in Drake release: address info now stored in InterfaceService + */ + @Deprecated + Set<PortAddresses> getAddressBindings(); + + /** + * Returns the address bindings for a particular connection point. + * + * @param connectPoint the connection point to return address information + * for + * @return address information for the connection point + * @deprecated in Drake release: address info now stored in InterfaceService + */ + @Deprecated + Set<PortAddresses> getAddressBindingsForPort(ConnectPoint connectPoint); +} |