diff options
author | Ashlee Young <ashlee@onosfw.com> | 2015-09-09 22:15:21 -0700 |
---|---|---|
committer | Ashlee Young <ashlee@onosfw.com> | 2015-09-09 22:15:21 -0700 |
commit | 13d05bc8458758ee39cb829098241e89616717ee (patch) | |
tree | 22a4d1ce65f15952f07a3df5af4b462b4697cb3a /framework/src/onos/apps/routing-api/src/main/java/org/onosproject/routing/config/LocalIpPrefixEntry.java | |
parent | 6139282e1e93c2322076de4b91b1c85d0bc4a8b3 (diff) |
ONOS checkin based on commit tag e796610b1f721d02f9b0e213cf6f7790c10ecd60
Change-Id: Ife8810491034fe7becdba75dda20de4267bd15cd
Diffstat (limited to 'framework/src/onos/apps/routing-api/src/main/java/org/onosproject/routing/config/LocalIpPrefixEntry.java')
-rw-r--r-- | framework/src/onos/apps/routing-api/src/main/java/org/onosproject/routing/config/LocalIpPrefixEntry.java | 141 |
1 files changed, 141 insertions, 0 deletions
diff --git a/framework/src/onos/apps/routing-api/src/main/java/org/onosproject/routing/config/LocalIpPrefixEntry.java b/framework/src/onos/apps/routing-api/src/main/java/org/onosproject/routing/config/LocalIpPrefixEntry.java new file mode 100644 index 00000000..d9d1824b --- /dev/null +++ b/framework/src/onos/apps/routing-api/src/main/java/org/onosproject/routing/config/LocalIpPrefixEntry.java @@ -0,0 +1,141 @@ +/* + * Copyright 2015 Open Networking Laboratory + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.onosproject.routing.config; + +import com.fasterxml.jackson.annotation.JsonProperty; +import com.google.common.base.MoreObjects; + +import java.util.Objects; + +import org.onlab.packet.IpAddress; +import org.onlab.packet.IpPrefix; + +/** + * Configuration details for an IP prefix entry. + */ +public class LocalIpPrefixEntry { + private final IpPrefix ipPrefix; + private final IpPrefixType type; + private final IpAddress gatewayIpAddress; + + /** + * Specifies the type of local IP prefix. + */ + public enum IpPrefixType { + /** + * Public IP prefixes should be exchanged by eBGP. + */ + PUBLIC, + /** + * Private IP prefixes should be used only locally and not exchanged + * by eBGP. + */ + PRIVATE, + /** + * For IP prefixes in blacklist. + */ + BLACK_LIST + } + + /** + * Creates a new IP prefix entry. + * + * @param ipPrefix an IP prefix as a String + * @param type an IP prefix type as an IpPrefixType + * @param gatewayIpAddress IP of the gateway + */ + public LocalIpPrefixEntry(@JsonProperty("ipPrefix") String ipPrefix, + @JsonProperty("type") IpPrefixType type, + @JsonProperty("gatewayIp") IpAddress + gatewayIpAddress) { + this.ipPrefix = IpPrefix.valueOf(ipPrefix); + this.type = type; + this.gatewayIpAddress = gatewayIpAddress; + } + + /** + * Gets the IP prefix of the IP prefix entry. + * + * @return the IP prefix + */ + public IpPrefix ipPrefix() { + return ipPrefix; + } + + /** + * Gets the IP prefix type of the IP prefix entry. + * + * @return the IP prefix type + */ + public IpPrefixType ipPrefixType() { + return type; + } + + /** + * Gets the gateway IP address of the IP prefix entry. + * + * @return the gateway IP address + */ + public IpAddress getGatewayIpAddress() { + return gatewayIpAddress; + } + + /** + * Tests whether the IP version of this entry is IPv4. + * + * @return true if the IP version of this entry is IPv4, otherwise false. + */ + public boolean isIp4() { + return ipPrefix.isIp4(); + } + + /** + * Tests whether the IP version of this entry is IPv6. + * + * @return true if the IP version of this entry is IPv6, otherwise false. + */ + public boolean isIp6() { + return ipPrefix.isIp6(); + } + + @Override + public int hashCode() { + return Objects.hash(ipPrefix, type); + } + + @Override + public boolean equals(Object obj) { + if (obj == this) { + return true; + } + + if (!(obj instanceof LocalIpPrefixEntry)) { + return false; + } + + LocalIpPrefixEntry that = (LocalIpPrefixEntry) obj; + return Objects.equals(this.ipPrefix, that.ipPrefix) + && Objects.equals(this.type, that.type); + } + + @Override + public String toString() { + return MoreObjects.toStringHelper(getClass()) + .add("ipPrefix", ipPrefix) + .add("ipPrefixType", type) + .toString(); + } +} |