Daniel Park | 5df6518 | 2016-01-09 00:12:03 +0900 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Laboratory |
Daniel Park | 5df6518 | 2016-01-09 00:12:03 +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 | */ |
sangho | 0c2a3da | 2016-02-16 13:39:07 +0900 | [diff] [blame] | 16 | package org.onosproject.openstacknetworking; |
Daniel Park | 5df6518 | 2016-01-09 00:12:03 +0900 | [diff] [blame] | 17 | |
| 18 | import org.onlab.packet.Ip4Address; |
sangho | 3623cb6 | 2016-01-15 22:06:38 +0900 | [diff] [blame] | 19 | import org.onlab.packet.MacAddress; |
Daniel Park | 5df6518 | 2016-01-09 00:12:03 +0900 | [diff] [blame] | 20 | import org.onosproject.net.DeviceId; |
sangho | 9008853 | 2016-02-25 18:06:12 +0900 | [diff] [blame] | 21 | |
Daniel Park | 5df6518 | 2016-01-09 00:12:03 +0900 | [diff] [blame] | 22 | import static com.google.common.base.Preconditions.checkNotNull; |
| 23 | |
| 24 | /** |
| 25 | * Contains OpenstackPort Information. |
| 26 | */ |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 27 | // TODO remove this |
Daniel Park | 81a61a1 | 2016-02-26 08:24:44 +0900 | [diff] [blame] | 28 | public final class OpenstackPortInfo { |
Daniel Park | 5df6518 | 2016-01-09 00:12:03 +0900 | [diff] [blame] | 29 | private final Ip4Address hostIp; |
sangho | 3623cb6 | 2016-01-15 22:06:38 +0900 | [diff] [blame] | 30 | private final MacAddress hostMac; |
Daniel Park | 3a06c52 | 2016-01-28 20:51:12 +0900 | [diff] [blame] | 31 | private final DeviceId deviceId; |
Daniel Park | 5df6518 | 2016-01-09 00:12:03 +0900 | [diff] [blame] | 32 | private final long vni; |
Daniel Park | 3a06c52 | 2016-01-28 20:51:12 +0900 | [diff] [blame] | 33 | private final Ip4Address gatewayIP; |
Daniel Park | 81a61a1 | 2016-02-26 08:24:44 +0900 | [diff] [blame] | 34 | private final String networkId; |
Daniel Park | 5df6518 | 2016-01-09 00:12:03 +0900 | [diff] [blame] | 35 | |
sangho | 9008853 | 2016-02-25 18:06:12 +0900 | [diff] [blame] | 36 | /** |
| 37 | * Returns OpenstackPortInfo reference. |
| 38 | * |
| 39 | * @param hostIp host IP address |
| 40 | * @param hostMac host MAC address |
| 41 | * @param deviceId device ID |
| 42 | * @param vni tunnel ID |
| 43 | * @param gatewayIP gateway IP address |
Ray Milkey | 21c3ebe | 2016-03-08 10:49:16 -0800 | [diff] [blame] | 44 | * @param networkId network identifier |
sangho | 9008853 | 2016-02-25 18:06:12 +0900 | [diff] [blame] | 45 | */ |
| 46 | public OpenstackPortInfo(Ip4Address hostIp, MacAddress hostMac, DeviceId deviceId, long vni, |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 47 | Ip4Address gatewayIP, String networkId) { |
Daniel Park | 5df6518 | 2016-01-09 00:12:03 +0900 | [diff] [blame] | 48 | this.hostIp = hostIp; |
sangho | 3623cb6 | 2016-01-15 22:06:38 +0900 | [diff] [blame] | 49 | this.hostMac = hostMac; |
Daniel Park | 5df6518 | 2016-01-09 00:12:03 +0900 | [diff] [blame] | 50 | this.deviceId = deviceId; |
| 51 | this.vni = vni; |
Daniel Park | 3a06c52 | 2016-01-28 20:51:12 +0900 | [diff] [blame] | 52 | this.gatewayIP = gatewayIP; |
Daniel Park | 81a61a1 | 2016-02-26 08:24:44 +0900 | [diff] [blame] | 53 | this.networkId = networkId; |
Daniel Park | 5df6518 | 2016-01-09 00:12:03 +0900 | [diff] [blame] | 54 | } |
| 55 | |
sangho | 9008853 | 2016-02-25 18:06:12 +0900 | [diff] [blame] | 56 | /** |
| 57 | * Returns IP address of the port. |
| 58 | * |
| 59 | * @return IP address |
| 60 | */ |
Daniel Park | 5df6518 | 2016-01-09 00:12:03 +0900 | [diff] [blame] | 61 | public Ip4Address ip() { |
| 62 | return hostIp; |
| 63 | } |
| 64 | |
sangho | 9008853 | 2016-02-25 18:06:12 +0900 | [diff] [blame] | 65 | /** |
| 66 | * Returns MAC address of the port. |
| 67 | * |
| 68 | * @return MAC address |
| 69 | */ |
sangho | 3623cb6 | 2016-01-15 22:06:38 +0900 | [diff] [blame] | 70 | public MacAddress mac() { |
| 71 | return hostMac; |
| 72 | } |
| 73 | |
sangho | 9008853 | 2016-02-25 18:06:12 +0900 | [diff] [blame] | 74 | /** |
| 75 | * Returns device ID. |
| 76 | * |
| 77 | * @return device ID |
| 78 | */ |
Daniel Park | 5df6518 | 2016-01-09 00:12:03 +0900 | [diff] [blame] | 79 | public DeviceId deviceId() { |
| 80 | return deviceId; |
| 81 | } |
| 82 | |
sangho | 9008853 | 2016-02-25 18:06:12 +0900 | [diff] [blame] | 83 | /** |
| 84 | * Returns tunnel ID. |
| 85 | * |
| 86 | * @return tunnel ID |
| 87 | */ |
Daniel Park | 5df6518 | 2016-01-09 00:12:03 +0900 | [diff] [blame] | 88 | public long vni() { |
| 89 | return vni; |
| 90 | } |
| 91 | |
sangho | 9008853 | 2016-02-25 18:06:12 +0900 | [diff] [blame] | 92 | /** |
| 93 | * Returns gateway IP address. |
| 94 | * |
| 95 | * @return gateway IP address |
| 96 | */ |
Daniel Park | 3a06c52 | 2016-01-28 20:51:12 +0900 | [diff] [blame] | 97 | public Ip4Address gatewayIP() { |
| 98 | return gatewayIP; |
| 99 | } |
| 100 | |
sangho | 9008853 | 2016-02-25 18:06:12 +0900 | [diff] [blame] | 101 | /** |
Daniel Park | 81a61a1 | 2016-02-26 08:24:44 +0900 | [diff] [blame] | 102 | * Returns network ID. |
| 103 | * |
| 104 | * @return network ID |
| 105 | */ |
| 106 | public String networkId() { |
| 107 | return networkId; |
| 108 | } |
| 109 | |
| 110 | /** |
sangho | 9008853 | 2016-02-25 18:06:12 +0900 | [diff] [blame] | 111 | * Returns the builder of the OpenstackPortInfo. |
| 112 | * |
| 113 | * @return OpenstackPortInfo builder reference |
| 114 | */ |
Daniel Park | 5df6518 | 2016-01-09 00:12:03 +0900 | [diff] [blame] | 115 | public static OpenstackPortInfo.Builder builder() { |
| 116 | return new Builder(); |
| 117 | } |
| 118 | |
sangho | 9008853 | 2016-02-25 18:06:12 +0900 | [diff] [blame] | 119 | /** |
| 120 | * Represents the OpenstackPortInfo Builder. |
| 121 | * |
| 122 | */ |
Daniel Park | 5df6518 | 2016-01-09 00:12:03 +0900 | [diff] [blame] | 123 | public static final class Builder { |
| 124 | private Ip4Address hostIp; |
sangho | 3623cb6 | 2016-01-15 22:06:38 +0900 | [diff] [blame] | 125 | private MacAddress hostMac; |
Daniel Park | 5df6518 | 2016-01-09 00:12:03 +0900 | [diff] [blame] | 126 | private DeviceId deviceId; |
| 127 | private long vni; |
Daniel Park | 3a06c52 | 2016-01-28 20:51:12 +0900 | [diff] [blame] | 128 | private Ip4Address gatewayIP; |
Daniel Park | 81a61a1 | 2016-02-26 08:24:44 +0900 | [diff] [blame] | 129 | private String networkId; |
Daniel Park | 3a06c52 | 2016-01-28 20:51:12 +0900 | [diff] [blame] | 130 | |
sangho | 9008853 | 2016-02-25 18:06:12 +0900 | [diff] [blame] | 131 | /** |
| 132 | * Sets the IP address of the port. |
| 133 | * |
Daniel Park | 81a61a1 | 2016-02-26 08:24:44 +0900 | [diff] [blame] | 134 | * @param gatewayIP gateway IP |
sangho | 9008853 | 2016-02-25 18:06:12 +0900 | [diff] [blame] | 135 | * @return Builder reference |
| 136 | */ |
Daniel Park | 3a06c52 | 2016-01-28 20:51:12 +0900 | [diff] [blame] | 137 | public Builder setGatewayIP(Ip4Address gatewayIP) { |
| 138 | this.gatewayIP = checkNotNull(gatewayIP, "gatewayIP cannot be null"); |
| 139 | return this; |
| 140 | } |
Daniel Park | 5df6518 | 2016-01-09 00:12:03 +0900 | [diff] [blame] | 141 | |
sangho | 9008853 | 2016-02-25 18:06:12 +0900 | [diff] [blame] | 142 | /** |
Daniel Park | 81a61a1 | 2016-02-26 08:24:44 +0900 | [diff] [blame] | 143 | * Sets the network ID. |
| 144 | * |
| 145 | * @param networkId network id |
| 146 | * @return Builder reference |
| 147 | */ |
| 148 | public Builder setNetworkId(String networkId) { |
| 149 | this.networkId = checkNotNull(networkId, "networkId cannot be null"); |
| 150 | return this; |
| 151 | } |
| 152 | |
| 153 | /** |
sangho | 9008853 | 2016-02-25 18:06:12 +0900 | [diff] [blame] | 154 | * Sets the host IP address of the port. |
| 155 | * |
| 156 | * @param hostIp host IP address |
| 157 | * @return Builder reference |
| 158 | */ |
Daniel Park | 5df6518 | 2016-01-09 00:12:03 +0900 | [diff] [blame] | 159 | public Builder setHostIp(Ip4Address hostIp) { |
| 160 | this.hostIp = checkNotNull(hostIp, "hostIp cannot be null"); |
| 161 | return this; |
| 162 | } |
| 163 | |
sangho | 9008853 | 2016-02-25 18:06:12 +0900 | [diff] [blame] | 164 | /** |
| 165 | * Sets the host MAC address of the port. |
| 166 | * |
| 167 | * @param hostMac host MAC address |
| 168 | * @return Builder reference |
| 169 | */ |
sangho | 3623cb6 | 2016-01-15 22:06:38 +0900 | [diff] [blame] | 170 | public Builder setHostMac(MacAddress hostMac) { |
| 171 | this.hostMac = checkNotNull(hostMac, "hostMac cannot be bull"); |
| 172 | return this; |
| 173 | } |
| 174 | |
sangho | 9008853 | 2016-02-25 18:06:12 +0900 | [diff] [blame] | 175 | /** |
| 176 | * Sets the device ID. |
| 177 | * |
| 178 | * @param deviceId device ID |
| 179 | * @return Builder reference |
| 180 | */ |
Daniel Park | 5df6518 | 2016-01-09 00:12:03 +0900 | [diff] [blame] | 181 | public Builder setDeviceId(DeviceId deviceId) { |
| 182 | this.deviceId = checkNotNull(deviceId, "deviceId cannot be null"); |
| 183 | return this; |
| 184 | } |
| 185 | |
sangho | 9008853 | 2016-02-25 18:06:12 +0900 | [diff] [blame] | 186 | /** |
| 187 | * Sets the tunnel ID. |
| 188 | * |
| 189 | * @param vni tunnel ID |
| 190 | * @return Builder reference |
| 191 | */ |
Jonathan Hart | 51539b8 | 2015-10-29 09:53:04 -0700 | [diff] [blame] | 192 | public Builder setVni(long vni) { |
Daniel Park | 5df6518 | 2016-01-09 00:12:03 +0900 | [diff] [blame] | 193 | this.vni = checkNotNull(vni, "vni cannot be null"); |
| 194 | return this; |
| 195 | } |
sangho | 9008853 | 2016-02-25 18:06:12 +0900 | [diff] [blame] | 196 | |
| 197 | /** |
sangho | 9008853 | 2016-02-25 18:06:12 +0900 | [diff] [blame] | 198 | * Builds the OpenstackPortInfo reference. |
| 199 | * |
| 200 | * @return OpenstackPortInfo reference |
| 201 | */ |
Daniel Park | 5df6518 | 2016-01-09 00:12:03 +0900 | [diff] [blame] | 202 | public OpenstackPortInfo build() { |
Hyunsun Moon | b974fca | 2016-06-30 21:20:39 -0700 | [diff] [blame] | 203 | return new OpenstackPortInfo(hostIp, hostMac, deviceId, vni, gatewayIP, networkId); |
Daniel Park | 5df6518 | 2016-01-09 00:12:03 +0900 | [diff] [blame] | 204 | } |
| 205 | } |
Daniel Park | 5df6518 | 2016-01-09 00:12:03 +0900 | [diff] [blame] | 206 | } |