Thomas Vachuska | 781d18b | 2014-10-27 10:31:25 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Licensed to the Apache Software Foundation (ASF) under one |
| 3 | * or more contributor license agreements. See the NOTICE file |
| 4 | * distributed with this work for additional information |
| 5 | * regarding copyright ownership. The ASF licenses this file |
| 6 | * to you under the Apache License, Version 2.0 (the |
| 7 | * "License"); you may not use this file except in compliance |
| 8 | * with the License. You may obtain a copy of the License at |
| 9 | * |
| 10 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | * |
| 12 | * Unless required by applicable law or agreed to in writing, |
| 13 | * software distributed under the License is distributed on an |
| 14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 15 | * KIND, either express or implied. See the License for the |
| 16 | * specific language governing permissions and limitations |
| 17 | * under the License. |
| 18 | */ |
Jonathan Hart | dc711bd | 2014-10-15 11:24:23 -0700 | [diff] [blame] | 19 | package org.onlab.onos.sdnip; |
| 20 | |
| 21 | import java.util.Set; |
| 22 | |
| 23 | import org.onlab.onos.net.ConnectPoint; |
| 24 | import org.onlab.onos.sdnip.config.Interface; |
| 25 | import org.onlab.packet.IpAddress; |
| 26 | |
| 27 | /** |
| 28 | * Provides information about the interfaces in the network. |
| 29 | */ |
| 30 | public interface InterfaceService { |
| 31 | /** |
| 32 | * Retrieves the entire set of interfaces in the network. |
| 33 | * |
| 34 | * @return the set of interfaces |
| 35 | */ |
| 36 | Set<Interface> getInterfaces(); |
| 37 | |
| 38 | /** |
| 39 | * Retrieves the interface associated with the given connect point. |
| 40 | * |
| 41 | * @param connectPoint the connect point to retrieve interface information |
| 42 | * for |
| 43 | * @return the interface |
| 44 | */ |
| 45 | Interface getInterface(ConnectPoint connectPoint); |
| 46 | |
| 47 | /** |
| 48 | * Retrieves the interface that matches the given IP address. Matching |
| 49 | * means that the IP address is in one of the interface's assigned subnets. |
| 50 | * |
| 51 | * @param ipAddress IP address to match |
| 52 | * @return the matching interface |
| 53 | */ |
| 54 | Interface getMatchingInterface(IpAddress ipAddress); |
| 55 | } |