Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2017-present Open Networking Foundation |
Hyunsun Moon | 44aac66 | 2017-02-18 02:07:01 +0900 | [diff] [blame] | 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 | */ |
| 16 | package org.onosproject.openstacknetworking.api; |
| 17 | |
| 18 | import org.onlab.packet.IpAddress; |
| 19 | import org.onlab.packet.MacAddress; |
| 20 | import org.onosproject.net.DeviceId; |
| 21 | import org.onosproject.net.PortNumber; |
| 22 | |
| 23 | /** |
| 24 | * Representation of virtual instance port. |
| 25 | */ |
| 26 | public interface InstancePort { |
| 27 | |
| 28 | /** |
| 29 | * Returns the OpenStack network ID of the instance port. |
| 30 | * |
| 31 | * @return openstack network id |
| 32 | */ |
| 33 | String networkId(); |
| 34 | |
| 35 | /** |
| 36 | * Returns the OpenStack port ID of a given host. |
| 37 | * |
| 38 | * @return openstack port id |
| 39 | */ |
| 40 | String portId(); |
| 41 | |
| 42 | /** |
| 43 | * Returns the MAC address of the instance port. |
| 44 | * |
| 45 | * @return mac address |
| 46 | */ |
| 47 | MacAddress macAddress(); |
| 48 | |
| 49 | /** |
| 50 | * Returns the IP address of the instance port. |
| 51 | * |
| 52 | * @return ip address |
| 53 | */ |
| 54 | IpAddress ipAddress(); |
| 55 | |
| 56 | /** |
| 57 | * Returns the device ID of the instance port. |
| 58 | * |
| 59 | * @return device id |
| 60 | */ |
| 61 | DeviceId deviceId(); |
| 62 | |
| 63 | /** |
| 64 | * Returns the port number of the instance port. |
| 65 | * |
| 66 | * @return port number |
| 67 | */ |
| 68 | PortNumber portNumber(); |
| 69 | } |