daniel park | b581710 | 2018-02-15 00:18:51 +0900 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2018-present Open Networking Foundation |
| 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.onlab.packet.VlanId; |
| 21 | |
| 22 | /** |
| 23 | * Representation of external peer router. |
| 24 | */ |
| 25 | public interface ExternalPeerRouter { |
Jian Li | 5e2ad4a | 2018-07-16 13:40:53 +0900 | [diff] [blame] | 26 | |
daniel park | b581710 | 2018-02-15 00:18:51 +0900 | [diff] [blame] | 27 | /** |
Jian Li | 5e2ad4a | 2018-07-16 13:40:53 +0900 | [diff] [blame] | 28 | * Returns external peer router IP address. |
daniel park | b581710 | 2018-02-15 00:18:51 +0900 | [diff] [blame] | 29 | * |
| 30 | * @return ip address. |
| 31 | */ |
Jian Li | 5e2ad4a | 2018-07-16 13:40:53 +0900 | [diff] [blame] | 32 | IpAddress ipAddress(); |
daniel park | b581710 | 2018-02-15 00:18:51 +0900 | [diff] [blame] | 33 | |
| 34 | /** |
Jian Li | 5e2ad4a | 2018-07-16 13:40:53 +0900 | [diff] [blame] | 35 | * Returns external peer router MAC address. |
daniel park | b581710 | 2018-02-15 00:18:51 +0900 | [diff] [blame] | 36 | * |
| 37 | * @return mac address |
| 38 | */ |
Jian Li | 5e2ad4a | 2018-07-16 13:40:53 +0900 | [diff] [blame] | 39 | MacAddress macAddress(); |
daniel park | b581710 | 2018-02-15 00:18:51 +0900 | [diff] [blame] | 40 | |
| 41 | /** |
Jian Li | 5e2ad4a | 2018-07-16 13:40:53 +0900 | [diff] [blame] | 42 | * Returns external peer router VLAN ID. |
daniel park | b581710 | 2018-02-15 00:18:51 +0900 | [diff] [blame] | 43 | * |
| 44 | * @return vlan id |
| 45 | */ |
Jian Li | 5e2ad4a | 2018-07-16 13:40:53 +0900 | [diff] [blame] | 46 | VlanId vlanId(); |
| 47 | |
| 48 | /** |
| 49 | * Builder of new external peer router. |
| 50 | */ |
| 51 | interface Builder { |
| 52 | |
| 53 | /** |
| 54 | * Builds an immutable external peer router instance. |
| 55 | * |
| 56 | * @return external peer router |
| 57 | */ |
| 58 | ExternalPeerRouter build(); |
| 59 | |
| 60 | /** |
| 61 | * Returns router builder with supplied IP address. |
| 62 | * |
| 63 | * @param ipAddress IP address of external peer router |
| 64 | * @return peer router builder |
| 65 | */ |
| 66 | Builder ipAddress(IpAddress ipAddress); |
| 67 | |
| 68 | /** |
| 69 | * Returns router builder with supplied MAC address. |
| 70 | * |
| 71 | * @param macAddress MAC address of external peer router |
| 72 | * @return peer router builder |
| 73 | */ |
| 74 | Builder macAddress(MacAddress macAddress); |
| 75 | |
| 76 | /** |
| 77 | * Returns router builder with supplied VLAN ID. |
| 78 | * |
| 79 | * @param vlanId VLAN ID of external peer router |
| 80 | * @return peer router builder |
| 81 | */ |
| 82 | Builder vlanId(VlanId vlanId); |
| 83 | } |
daniel park | b581710 | 2018-02-15 00:18:51 +0900 | [diff] [blame] | 84 | } |