add documentation to the mapping service TELSDN-568: #close
[lispflowmapping.git] / mappingservice / implementation / src / main / java / org / opendaylight / lispflowmapping / implementation / serializer / address / LispTrafficEngineeringLCAFAddressSerializer.java
1 /*
2  * Copyright (c) 2013 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.implementation.serializer.address;
9
10 import java.nio.ByteBuffer;
11 import java.util.ArrayList;
12 import java.util.List;
13
14 import org.apache.commons.lang3.BooleanUtils;
15 import org.opendaylight.lispflowmapping.implementation.serializer.address.factory.LispAFIAddressSerializerFactory;
16 import org.opendaylight.lispflowmapping.implementation.util.ByteUtil;
17 import org.opendaylight.lispflowmapping.implementation.util.LispAFIConvertor;
18 import org.opendaylight.lispflowmapping.type.AddressFamilyNumberEnum;
19 import org.opendaylight.lispflowmapping.type.LispCanonicalAddressFormatEnum;
20 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.LcafTrafficEngineeringAddress;
21 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.LispAFIAddress;
22 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.lcaftrafficengineeringaddress.Hops;
23 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.lcaftrafficengineeringaddress.HopsBuilder;
24 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.lispaddress.lispaddresscontainer.address.LcafTrafficEngineeringBuilder;
25 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.lispsimpleaddress.PrimitiveAddress;
26 import org.opendaylight.yang.gen.v1.lispflowmapping.rev131031.reencaphop.HopBuilder;
27
28 public class LispTrafficEngineeringLCAFAddressSerializer extends LispLCAFAddressSerializer {
29
30     private static final LispTrafficEngineeringLCAFAddressSerializer INSTANCE = new LispTrafficEngineeringLCAFAddressSerializer();
31
32     // Private constructor prevents instantiation from other classes
33     private LispTrafficEngineeringLCAFAddressSerializer() {
34     }
35
36     public static LispTrafficEngineeringLCAFAddressSerializer getInstance() {
37         return INSTANCE;
38     }
39
40     @Override
41     protected short getLcafLength(LispAFIAddress lispAddress) {
42         short totalSize = 0;
43         if (((LcafTrafficEngineeringAddress) lispAddress).getHops() != null) {
44             for (Hops hop : ((LcafTrafficEngineeringAddress) lispAddress).getHops()) {
45                 totalSize += LispAddressSerializer.getInstance().getAddressSize((LispAFIAddress) hop.getHop().getPrimitiveAddress()) + 2;
46             }
47         }
48         return totalSize;
49     }
50
51     @Override
52     protected void serializeData(ByteBuffer buffer, LispAFIAddress lispAddress) {
53         if (((LcafTrafficEngineeringAddress) lispAddress).getHops() != null) {
54             for (Hops hop : ((LcafTrafficEngineeringAddress) lispAddress).getHops()) {
55                 serializeAFIAddressHeader(buffer, (LispAFIAddress) hop.getHop().getPrimitiveAddress());
56                 buffer.put((byte) 0);
57                 buffer.put((byte) (ByteUtil.boolToBit(BooleanUtils.isTrue(hop.isLookup()), Flags.LOOKUP) | //
58                         ByteUtil.boolToBit(BooleanUtils.isTrue(hop.isRLOCProbe()), Flags.RLOC_PROBE) | //
59                 ByteUtil.boolToBit(BooleanUtils.isTrue(hop.isStrict()), Flags.STRICT)));
60                 LispAddressSerializer serializer = LispAFIAddressSerializerFactory.getSerializer(AddressFamilyNumberEnum
61                         .valueOf(((LispAFIAddress) hop.getHop().getPrimitiveAddress()).getAfi()));
62                 serializer.serializeData(buffer, (LispAFIAddress) hop.getHop().getPrimitiveAddress());
63             }
64         }
65     }
66
67     @Override
68     protected LcafTrafficEngineeringAddress deserializeData(ByteBuffer buffer, byte res2, short length) {
69         List<Hops> hops = new ArrayList<Hops>();
70         while (length > 0) {
71             short afi = buffer.getShort();
72             LispAddressSerializer serializer = LispAFIAddressSerializerFactory.getSerializer(AddressFamilyNumberEnum.valueOf(afi));
73             byte flags = (byte) buffer.getShort();
74             boolean lookup = ByteUtil.extractBit(flags, Flags.LOOKUP);
75             boolean RLOCProbe = ByteUtil.extractBit(flags, Flags.RLOC_PROBE);
76             boolean strict = ByteUtil.extractBit(flags, Flags.STRICT);
77             LispAFIAddress address = serializer.deserializeData(buffer);
78             HopsBuilder builder = new HopsBuilder();
79             builder.setLookup(lookup);
80             builder.setRLOCProbe(RLOCProbe);
81             builder.setStrict(strict);
82             builder.setHop(new HopBuilder().setPrimitiveAddress((PrimitiveAddress) LispAFIConvertor.toPrimitive(address)).build());
83             length -= LispAddressSerializer.getInstance().getAddressSize((LispAFIAddress) builder.getHop().getPrimitiveAddress()) + 2;
84             hops.add(builder.build());
85         }
86         return new LcafTrafficEngineeringBuilder().setAfi(AddressFamilyNumberEnum.LCAF.getIanaCode())
87                 .setLcafType((short) LispCanonicalAddressFormatEnum.TRAFFIC_ENGINEERING.getLispCode()).setHops(hops).build();
88     }
89
90     private interface Flags {
91         int LOOKUP = 0x04;
92         int RLOC_PROBE = 0x02;
93         int STRICT = 0x01;
94     }
95
96 }