gerrit.fd Code Review - hc2vpp.git/blob

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   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
  17 package io.fd.hc2vpp.common.translate.util;
  18
  19 import static com.google.common.base.Preconditions.checkNotNull;
  20
  21 import java.util.Arrays;
  22 import javax.annotation.Nonnull;
  23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone;
  27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone;
  29
  30 /**
  31  * Aggregation trait providing logic for converting address based data
  32  */
  33 public interface AddressTranslator extends Ipv4Translator, Ipv6Translator, MacTranslator {
  34
  35     AddressTranslator INSTANCE = new AddressTranslator() {
  36     };
  37
  38     default byte[] ipAddressToArray(IpAddress address) {
  39         checkNotNull(address, "Cannot resolve null address");
  40
  41         if (isIpv6(address)) {
  42             return ipv6AddressNoZoneToArray(new Ipv6AddressNoZone(address.getIpv6Address()));
  43         } else {
  44             return ipv4AddressNoZoneToArray(new Ipv4AddressNoZone(address.getIpv4Address()));
  45         }
  46     }
  47
  48
  49     /**
  50      * Converts {@link IpAddress} to array representing {@link Ipv4Address} or {@link Ipv6Address}
  51      */
  52     default byte[] ipAddressToArray(boolean isIpv6, @Nonnull IpAddress address) {
  53         checkNotNull(address, "Cannot convert null Address");
  54
  55         if (isIpv6) {
  56             return ipv6AddressNoZoneToArray(new Ipv6AddressNoZone(address.getIpv6Address()));
  57         } else {
  58             return ipv4AddressNoZoneToArray(new Ipv4AddressNoZone(address.getIpv4Address()));
  59         }
  60     }
  61
  62     /**
  63      * Converts array bytes to {@link IpAddress}.
  64      */
  65     @Nonnull
  66     default IpAddress arrayToIpAddress(boolean isIpv6, byte[] ip) {
  67         if (isIpv6) {
  68             return new IpAddress(arrayToIpv6AddressNoZone(ip));
  69         } else {
  70             return new IpAddress(arrayToIpv4AddressNoZone(ip));
  71         }
  72     }
  73
  74     // safest way to compare addresses - prevents returning false while using different types from hierarchy
  75     // Ex. Key for MapResolver contains Ipv4Address as value but we translate addresses from binary data to Ipv4AddressNoZone
  76     default boolean addressesEqual(final IpAddress left, final IpAddress right) {
  77         return Arrays.equals(left.getValue(), right.getValue());
  78     }
  79
  80     /**
  81      * Extract mask length from prefixed address
  82      */
  83     default byte extractPrefix(IpPrefix ipPrefix) {
  84         if (isIpv6(ipPrefix)) {
  85             return extractPrefix(ipPrefix.getIpv6Prefix());
  86         } else {
  87             return extractPrefix(ipPrefix.getIpv4Prefix());
  88         }
  89     }
  90
  91     /**
  92      * Convert address part of prefix to byte array
  93      */
  94     default byte[] ipPrefixToArray(IpPrefix ipPrefix) {
  95         if (isIpv6(ipPrefix)) {
  96             return ipv6AddressPrefixToArray(ipPrefix.getIpv6Prefix());
  97         } else {
  98             return ipv4AddressPrefixToArray(ipPrefix.getIpv4Prefix());
  99         }
 100     }
 101 }