Sonar: Utility classes shouldn't have public constructor
[lispflowmapping.git] / mappingservice / lisp-proto / src / main / java / org / opendaylight / lispflowmapping / lisp / util / MaskUtil.java
1 /*
2  * Copyright (c) 2014 Contextream, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.lispflowmapping.lisp.util;
9
10 import java.net.Inet4Address;
11 import java.net.Inet6Address;
12 import java.net.InetAddress;
13 import java.net.UnknownHostException;
14 import java.nio.ByteBuffer;
15
16 import org.apache.commons.lang3.exception.ExceptionUtils;
17 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.IpPrefix;
18 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.SimpleAddress;
19 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.Address;
20 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.InstanceId;
21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.Ipv4;
22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.Ipv4Prefix;
23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.Ipv6;
24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.Ipv6Prefix;
25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.SourceDestKey;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid;
27 import org.slf4j.Logger;
28 import org.slf4j.LoggerFactory;
29
30 public final class MaskUtil {
31     private static final Logger LOG = LoggerFactory.getLogger(MaskUtil.class);
32     private static final short IPV4_MAX_MASK = 32;
33     private static final short IPV6_MAX_MASK = 128;
34
35     // Utility class, should not be instantiated
36     private MaskUtil() {
37     }
38
39     public static boolean isMaskable(Address address) {
40         if (address instanceof Ipv4Prefix || address instanceof Ipv6Prefix || address instanceof SourceDestKey) {
41             return true;
42         } else if (address instanceof InstanceId) {
43             return isMaskable(((InstanceId)address).getInstanceId().getAddress());
44         }
45         return false;
46     }
47
48     public static boolean isMaskable(SimpleAddress address) {
49         if (address.getIpPrefix() != null) {
50             return true;
51         }
52         return false;
53     }
54
55     public static Eid normalize(Eid eid, short mask) {
56         Address address = eid.getAddress();
57         try {
58             if (address instanceof Ipv4Prefix) {
59                 String[] v4prefix = String.valueOf(((Ipv4Prefix)address).getIpv4Prefix().getValue()).split("/");
60                 InetAddress normalized = normalizeIP(Inet4Address.getByName(v4prefix[0]), mask);
61                 return LispAddressUtil.asIpv4PrefixEid(eid, (Inet4Address)normalized, mask);
62             } else if (address instanceof Ipv6Prefix) {
63                 String[] v6prefix = String.valueOf(((Ipv6Prefix)address).getIpv6Prefix().getValue()).split("/");
64                 InetAddress normalized = normalizeIP(Inet6Address.getByName(v6prefix[0]), mask);
65                 return LispAddressUtil.asIpv6PrefixEid(eid, (Inet6Address)normalized, mask);
66             } else if (address instanceof InstanceId) {
67                 // TODO - not absolutely necessary, but should be implemented
68                 return eid;
69             }
70         } catch (UnknownHostException e) {
71             LOG.trace("Failed to normalize eid {} with mask {}: {}", eid, mask, ExceptionUtils.getStackTrace(e));
72         }
73         return eid;
74     }
75
76     public static Eid normalize(Eid eid) {
77         Address address = eid.getAddress();
78         try {
79             if (address instanceof Ipv4Prefix) {
80                 String[] v4prefix = String.valueOf(((Ipv4Prefix)address).getIpv4Prefix().getValue()).split("/");
81                 short mask = Short.parseShort(v4prefix[1]);
82                 InetAddress normalized = normalizeIP(Inet4Address.getByName(v4prefix[0]), mask);
83                 return LispAddressUtil.asIpv4PrefixEid(eid, (Inet4Address)normalized, mask);
84             } else if (address instanceof Ipv6Prefix) {
85                 String[] v6prefix = String.valueOf(((Ipv6Prefix)address).getIpv6Prefix().getValue()).split("/");
86                 short mask = Short.parseShort(v6prefix[1]);
87                 InetAddress normalized = normalizeIP(Inet6Address.getByName(v6prefix[0]), mask);
88                 return LispAddressUtil.asIpv6PrefixEid(eid, (Inet6Address)normalized, mask);
89             } else if (address instanceof InstanceId) {
90                 // TODO - not absolutely necessary, but should be implemented
91                 return eid;
92             }
93         } catch (UnknownHostException e) {
94             LOG.trace("Failed to normalize eid {}: {}", eid, ExceptionUtils.getStackTrace(e));
95         }
96         return eid;
97     }
98
99     private static InetAddress normalizeIP(InetAddress address, int mask) throws UnknownHostException {
100         ByteBuffer byteRepresentation = ByteBuffer.wrap(address.getAddress());
101         byte b = (byte) 0xff;
102         for (int i = 0; i < byteRepresentation.array().length; i++) {
103             if (mask >= 8) {
104                 byteRepresentation.put(i, (byte) (b & byteRepresentation.get(i)));
105             } else if (mask > 0) {
106                 byteRepresentation.put(i, (byte) ((byte) (b << (8 - mask)) & byteRepresentation.get(i)));
107             } else {
108                 byteRepresentation.put(i, (byte) (0 & byteRepresentation.get(i)));
109             }
110
111             mask -= 8;
112         }
113         return InetAddress.getByAddress(byteRepresentation.array());
114     }
115
116     public static int getMaxMask(Address address) {
117         if (address instanceof Ipv4 || address instanceof Ipv4Prefix) {
118             return IPV4_MAX_MASK;
119         } else if (address instanceof Ipv6 || address instanceof Ipv6Prefix) {
120             return IPV6_MAX_MASK;
121         } else {
122             return -1;
123         }
124     }
125
126     public static short getMaskForAddress(SimpleAddress address) {
127         if (address.getIpPrefix() == null) {
128             return -1;
129         }
130         return getMaskForIpPrefix(address.getIpPrefix());
131     }
132
133     public static short getMaskForIpPrefix(IpPrefix prefix) {
134         return Short.parseShort(String.valueOf(prefix.getValue()).split("/")[1]);
135     }
136
137     public static String getAddressStringForIpPrefix(IpPrefix prefix) {
138         return String.valueOf(prefix.getValue()).split("/")[0];
139     }
140
141     public static String getAddressStringForIpv4Prefix(Ipv4Prefix prefix) {
142         return String.valueOf(prefix.getIpv4Prefix().getValue()).split("/")[0];
143     }
144
145     public static String getAddressStringForIpv6Prefix(Ipv6Prefix prefix) {
146         return String.valueOf(prefix.getIpv6Prefix().getValue()).split("/")[0];
147     }
148
149     public static short getMaskForAddress(Address address) {
150         if (address instanceof Ipv4) {
151             return IPV4_MAX_MASK;
152         } else if (address instanceof Ipv6) {
153             return IPV6_MAX_MASK;
154         } else if (address instanceof Ipv4Prefix) {
155             String[] prefix = String.valueOf(((Ipv4Prefix)address).getIpv4Prefix().getValue()).split("/");  // TODO use something more efficient
156             return Short.parseShort(prefix[1]);
157         } else if (address instanceof Ipv6Prefix) {
158             String[] prefix = String.valueOf(((Ipv6Prefix)address).getIpv6Prefix().getValue()).split("/");  // TODO use something more efficient
159             return Short.parseShort(prefix[1]);
160         } else if (address instanceof InstanceId) {
161             return getMaskForAddress(((InstanceId)address).getInstanceId().getAddress());
162         }
163         return -1;
164     }
165 }