samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Laboratory |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [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.dhcp; |
| 17 | |
| 18 | import com.google.common.base.MoreObjects; |
| 19 | import org.onlab.packet.Ip4Address; |
| 20 | |
| 21 | import java.util.Date; |
| 22 | |
| 23 | import static com.google.common.base.Preconditions.checkNotNull; |
| 24 | |
| 25 | /** |
| 26 | * Stores the MAC ID to IP Address mapping details. |
| 27 | */ |
Thomas Vachuska | a1da42e | 2015-09-09 00:45:22 -0700 | [diff] [blame] | 28 | public final class IpAssignment { |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 29 | |
Hyunsun Moon | 04b1fe9 | 2016-05-18 21:28:06 -0700 | [diff] [blame] | 30 | // TODO make some dhcp options optional |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 31 | private final Ip4Address ipAddress; |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 32 | private final Date timestamp; |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 33 | private final long leasePeriod; |
daniel | cd9deed | 2015-10-30 17:16:16 +0900 | [diff] [blame] | 34 | private final Ip4Address subnetMask; |
Hyunsun Moon | 04b1fe9 | 2016-05-18 21:28:06 -0700 | [diff] [blame] | 35 | private final Ip4Address broadcast; |
daniel | cd9deed | 2015-10-30 17:16:16 +0900 | [diff] [blame] | 36 | private final Ip4Address dhcpServer; |
daniel | cd9deed | 2015-10-30 17:16:16 +0900 | [diff] [blame] | 37 | private final Ip4Address routerAddress; |
daniel | cd9deed | 2015-10-30 17:16:16 +0900 | [diff] [blame] | 38 | private final Ip4Address domainServer; |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 39 | private final AssignmentStatus assignmentStatus; |
| 40 | |
| 41 | public enum AssignmentStatus { |
| 42 | /** |
| 43 | * IP has been requested by a host, but not assigned to it yet. |
| 44 | */ |
| 45 | Option_Requested, |
| 46 | |
| 47 | /** |
Hyunsun Moon | 04b1fe9 | 2016-05-18 21:28:06 -0700 | [diff] [blame] | 48 | * Static IP Assignment with unregistered IP range. |
| 49 | * This assignment can only be added or removed by set or remove static mapping. |
daniel | cd9deed | 2015-10-30 17:16:16 +0900 | [diff] [blame] | 50 | */ |
Hyunsun Moon | 04b1fe9 | 2016-05-18 21:28:06 -0700 | [diff] [blame] | 51 | // TODO allow multiple IP ranges and remove this option |
daniel | 877bb2f | 2015-11-12 21:33:05 +0900 | [diff] [blame] | 52 | Option_RangeNotEnforced, |
daniel | cd9deed | 2015-10-30 17:16:16 +0900 | [diff] [blame] | 53 | /** |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 54 | * IP has been assigned to a host. |
| 55 | */ |
| 56 | Option_Assigned, |
| 57 | |
| 58 | /** |
| 59 | * IP mapping is no longer active. |
| 60 | */ |
Sho SHIMIZU | 9f614a4 | 2015-09-11 15:32:46 -0700 | [diff] [blame] | 61 | Option_Expired |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 62 | } |
| 63 | |
| 64 | /** |
| 65 | * Constructor for IPAssignment, where the ipAddress, the lease period, the timestamp |
| 66 | * and assignment status is supplied. |
| 67 | * |
Hyunsun Moon | 04b1fe9 | 2016-05-18 21:28:06 -0700 | [diff] [blame] | 68 | * @param ipAddress ip address to assign |
| 69 | * @param leasePeriod lease period |
| 70 | * @param timestamp time stamp of the assignment |
| 71 | * @param assignmentStatus statue of the assignment |
| 72 | * @param subnetMask subnet mask of assigned ip range |
| 73 | * @param broadcast broadcast address |
| 74 | * @param dhcpServer dhcp server address |
| 75 | * @param routerAddress router address |
| 76 | * @param domainServer domain server address |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 77 | */ |
Thomas Vachuska | a1da42e | 2015-09-09 00:45:22 -0700 | [diff] [blame] | 78 | private IpAssignment(Ip4Address ipAddress, |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 79 | long leasePeriod, |
| 80 | Date timestamp, |
Hyunsun Moon | 04b1fe9 | 2016-05-18 21:28:06 -0700 | [diff] [blame] | 81 | AssignmentStatus assignmentStatus, |
| 82 | Ip4Address subnetMask, |
| 83 | Ip4Address broadcast, |
| 84 | Ip4Address dhcpServer, |
| 85 | Ip4Address routerAddress, |
| 86 | Ip4Address domainServer) { |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 87 | this.ipAddress = ipAddress; |
| 88 | this.leasePeriod = leasePeriod; |
| 89 | this.timestamp = timestamp; |
| 90 | this.assignmentStatus = assignmentStatus; |
daniel | cd9deed | 2015-10-30 17:16:16 +0900 | [diff] [blame] | 91 | this.subnetMask = subnetMask; |
Hyunsun Moon | 04b1fe9 | 2016-05-18 21:28:06 -0700 | [diff] [blame] | 92 | this.broadcast = broadcast; |
daniel | cd9deed | 2015-10-30 17:16:16 +0900 | [diff] [blame] | 93 | this.dhcpServer = dhcpServer; |
| 94 | this.routerAddress = routerAddress; |
| 95 | this.domainServer = domainServer; |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 96 | } |
| 97 | |
| 98 | /** |
| 99 | * Returns the IP Address of the IP assignment. |
| 100 | * |
| 101 | * @return the IP address |
| 102 | */ |
| 103 | public Ip4Address ipAddress() { |
| 104 | return this.ipAddress; |
| 105 | } |
| 106 | |
| 107 | /** |
| 108 | * Returns the timestamp of the IP assignment. |
| 109 | * |
| 110 | * @return the timestamp |
| 111 | */ |
| 112 | public Date timestamp() { |
| 113 | return this.timestamp; |
| 114 | } |
| 115 | |
| 116 | /** |
| 117 | * Returns the assignment status of the IP assignment. |
| 118 | * |
| 119 | * @return the assignment status |
| 120 | */ |
| 121 | public AssignmentStatus assignmentStatus() { |
| 122 | return this.assignmentStatus; |
| 123 | } |
| 124 | |
| 125 | /** |
| 126 | * Returns the lease period of the IP assignment. |
| 127 | * |
samanwita pal | 2a31340 | 2015-09-14 16:03:22 -0700 | [diff] [blame] | 128 | * @return the lease period in seconds |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 129 | */ |
| 130 | public int leasePeriod() { |
samanwita pal | 2a31340 | 2015-09-14 16:03:22 -0700 | [diff] [blame] | 131 | return (int) this.leasePeriod; |
| 132 | } |
| 133 | |
| 134 | /** |
| 135 | * Returns the lease period of the IP assignment. |
| 136 | * |
| 137 | * @return the lease period in milliseconds |
| 138 | */ |
| 139 | public int leasePeriodMs() { |
| 140 | return (int) this.leasePeriod * 1000; |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 141 | } |
| 142 | |
Hyunsun Moon | 04b1fe9 | 2016-05-18 21:28:06 -0700 | [diff] [blame] | 143 | /** |
| 144 | * Returns subnet mask of the IP assignment. |
| 145 | * |
| 146 | * @return subnet mask |
| 147 | */ |
daniel | cd9deed | 2015-10-30 17:16:16 +0900 | [diff] [blame] | 148 | public Ip4Address subnetMask() { |
| 149 | return subnetMask; |
| 150 | } |
| 151 | |
Hyunsun Moon | 04b1fe9 | 2016-05-18 21:28:06 -0700 | [diff] [blame] | 152 | /** |
| 153 | * Returns broadcast address of the IP assignment. |
| 154 | * |
| 155 | * @return broadcast address |
| 156 | */ |
| 157 | public Ip4Address broadcast() { |
| 158 | return broadcast; |
| 159 | } |
| 160 | |
| 161 | /** |
| 162 | * Returns dhcp server of the IP assignment. |
| 163 | * |
| 164 | * @return dhcp server ip address |
| 165 | */ |
daniel | cd9deed | 2015-10-30 17:16:16 +0900 | [diff] [blame] | 166 | public Ip4Address dhcpServer() { |
| 167 | return dhcpServer; |
| 168 | } |
| 169 | |
Hyunsun Moon | 04b1fe9 | 2016-05-18 21:28:06 -0700 | [diff] [blame] | 170 | /** |
| 171 | * Returns router address of the IP assignment. |
| 172 | * |
| 173 | * @return router ip address |
| 174 | */ |
daniel | cd9deed | 2015-10-30 17:16:16 +0900 | [diff] [blame] | 175 | public Ip4Address routerAddress() { |
| 176 | return routerAddress; |
| 177 | } |
| 178 | |
Hyunsun Moon | 04b1fe9 | 2016-05-18 21:28:06 -0700 | [diff] [blame] | 179 | /** |
| 180 | * Returns domain server address. |
| 181 | * |
| 182 | * @return domain server ip address |
| 183 | */ |
daniel | cd9deed | 2015-10-30 17:16:16 +0900 | [diff] [blame] | 184 | public Ip4Address domainServer() { |
| 185 | return domainServer; |
| 186 | } |
| 187 | |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 188 | @Override |
| 189 | public String toString() { |
| 190 | return MoreObjects.toStringHelper(getClass()) |
| 191 | .add("ip", ipAddress) |
| 192 | .add("timestamp", timestamp) |
| 193 | .add("lease", leasePeriod) |
| 194 | .add("assignmentStatus", assignmentStatus) |
daniel | cd9deed | 2015-10-30 17:16:16 +0900 | [diff] [blame] | 195 | .add("subnetMask", subnetMask) |
Hyunsun Moon | 04b1fe9 | 2016-05-18 21:28:06 -0700 | [diff] [blame] | 196 | .add("broadcast", broadcast) |
daniel | cd9deed | 2015-10-30 17:16:16 +0900 | [diff] [blame] | 197 | .add("dhcpServer", dhcpServer) |
| 198 | .add("routerAddress", routerAddress) |
| 199 | .add("domainServer", domainServer) |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 200 | .toString(); |
| 201 | } |
| 202 | |
| 203 | /** |
| 204 | * Creates and returns a new builder instance. |
| 205 | * |
| 206 | * @return new builder |
| 207 | */ |
| 208 | public static Builder builder() { |
| 209 | return new Builder(); |
| 210 | } |
| 211 | |
| 212 | /** |
| 213 | * Creates and returns a new builder instance that clones an existing IPAssignment. |
| 214 | * |
Ray Milkey | 9b36d81 | 2015-09-09 15:24:54 -0700 | [diff] [blame] | 215 | * @param assignment ip address assignment |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 216 | * @return new builder |
| 217 | */ |
Thomas Vachuska | a1da42e | 2015-09-09 00:45:22 -0700 | [diff] [blame] | 218 | public static Builder builder(IpAssignment assignment) { |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 219 | return new Builder(assignment); |
| 220 | } |
| 221 | |
| 222 | /** |
| 223 | * IPAssignment Builder. |
| 224 | */ |
| 225 | public static final class Builder { |
| 226 | |
| 227 | private Ip4Address ipAddress; |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 228 | private Date timeStamp; |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 229 | private long leasePeriod; |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 230 | private AssignmentStatus assignmentStatus; |
daniel | cd9deed | 2015-10-30 17:16:16 +0900 | [diff] [blame] | 231 | private Ip4Address subnetMask; |
Hyunsun Moon | 04b1fe9 | 2016-05-18 21:28:06 -0700 | [diff] [blame] | 232 | private Ip4Address broadcast; |
daniel | cd9deed | 2015-10-30 17:16:16 +0900 | [diff] [blame] | 233 | private Ip4Address dhcpServer; |
Hyunsun Moon | 04b1fe9 | 2016-05-18 21:28:06 -0700 | [diff] [blame] | 234 | private Ip4Address routerAddress; |
daniel | cd9deed | 2015-10-30 17:16:16 +0900 | [diff] [blame] | 235 | private Ip4Address domainServer; |
| 236 | |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 237 | private Builder() { |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 238 | } |
| 239 | |
Thomas Vachuska | a1da42e | 2015-09-09 00:45:22 -0700 | [diff] [blame] | 240 | private Builder(IpAssignment ipAssignment) { |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 241 | ipAddress = ipAssignment.ipAddress(); |
| 242 | timeStamp = ipAssignment.timestamp(); |
samanwita pal | 2a31340 | 2015-09-14 16:03:22 -0700 | [diff] [blame] | 243 | leasePeriod = ipAssignment.leasePeriod(); |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 244 | assignmentStatus = ipAssignment.assignmentStatus(); |
Hyunsun Moon | 04b1fe9 | 2016-05-18 21:28:06 -0700 | [diff] [blame] | 245 | subnetMask = ipAssignment.subnetMask(); |
| 246 | broadcast = ipAssignment.broadcast(); |
| 247 | dhcpServer = ipAssignment.dhcpServer(); |
| 248 | routerAddress = ipAssignment.routerAddress(); |
| 249 | domainServer = ipAssignment.domainServer(); |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 250 | } |
| 251 | |
Thomas Vachuska | a1da42e | 2015-09-09 00:45:22 -0700 | [diff] [blame] | 252 | public IpAssignment build() { |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 253 | validateInputs(); |
Hyunsun Moon | 04b1fe9 | 2016-05-18 21:28:06 -0700 | [diff] [blame] | 254 | return new IpAssignment(ipAddress, |
| 255 | leasePeriod, |
| 256 | timeStamp, |
| 257 | assignmentStatus, |
| 258 | subnetMask, |
| 259 | broadcast, |
| 260 | dhcpServer, |
| 261 | routerAddress, |
| 262 | domainServer); |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 263 | } |
| 264 | |
| 265 | public Builder ipAddress(Ip4Address addr) { |
| 266 | ipAddress = addr; |
| 267 | return this; |
| 268 | } |
| 269 | |
| 270 | public Builder timestamp(Date timestamp) { |
| 271 | timeStamp = timestamp; |
| 272 | return this; |
| 273 | } |
| 274 | |
| 275 | public Builder leasePeriod(int leasePeriodinSeconds) { |
samanwita pal | 2a31340 | 2015-09-14 16:03:22 -0700 | [diff] [blame] | 276 | leasePeriod = leasePeriodinSeconds; |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 277 | return this; |
| 278 | } |
| 279 | |
| 280 | public Builder assignmentStatus(AssignmentStatus status) { |
| 281 | assignmentStatus = status; |
| 282 | return this; |
| 283 | } |
| 284 | |
daniel | cd9deed | 2015-10-30 17:16:16 +0900 | [diff] [blame] | 285 | public Builder subnetMask(Ip4Address subnetMask) { |
| 286 | this.subnetMask = subnetMask; |
| 287 | return this; |
| 288 | } |
| 289 | |
Hyunsun Moon | 04b1fe9 | 2016-05-18 21:28:06 -0700 | [diff] [blame] | 290 | public Builder broadcast(Ip4Address broadcast) { |
| 291 | this.broadcast = broadcast; |
| 292 | return this; |
| 293 | } |
| 294 | |
daniel | cd9deed | 2015-10-30 17:16:16 +0900 | [diff] [blame] | 295 | public Builder dhcpServer(Ip4Address dhcpServer) { |
| 296 | this.dhcpServer = dhcpServer; |
| 297 | return this; |
| 298 | } |
| 299 | |
| 300 | public Builder domainServer(Ip4Address domainServer) { |
| 301 | this.domainServer = domainServer; |
| 302 | return this; |
| 303 | } |
| 304 | |
| 305 | public Builder routerAddress(Ip4Address routerAddress) { |
| 306 | this.routerAddress = routerAddress; |
| 307 | return this; |
| 308 | } |
| 309 | |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 310 | private void validateInputs() { |
| 311 | checkNotNull(ipAddress, "IP Address must be specified"); |
| 312 | checkNotNull(assignmentStatus, "Assignment Status must be specified"); |
| 313 | checkNotNull(leasePeriod, "Lease Period must be specified"); |
| 314 | checkNotNull(timeStamp, "Timestamp must be specified"); |
| 315 | |
| 316 | switch (assignmentStatus) { |
| 317 | case Option_Requested: |
daniel | 877bb2f | 2015-11-12 21:33:05 +0900 | [diff] [blame] | 318 | case Option_RangeNotEnforced: |
samanwita pal | f28207b | 2015-09-04 10:41:56 -0700 | [diff] [blame] | 319 | case Option_Assigned: |
| 320 | case Option_Expired: |
| 321 | break; |
| 322 | default: |
| 323 | throw new IllegalStateException("Unknown assignment status"); |
| 324 | } |
| 325 | } |
| 326 | } |
| 327 | } |