Promote MessageRegistry to pcep-api
[bgpcep.git] / pcep / base-parser / src / main / java / org / opendaylight / protocol / pcep / parser / object / PCEPSvecObjectParser.java
1 /*
2  * Copyright (c) 2013 Cisco Systems, 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.protocol.pcep.parser.object;
9
10 import static com.google.common.base.Preconditions.checkArgument;
11
12 import com.google.common.collect.ImmutableSet;
13 import io.netty.buffer.ByteBuf;
14 import io.netty.buffer.Unpooled;
15 import java.util.Set;
16 import org.opendaylight.protocol.pcep.PCEPDeserializerException;
17 import org.opendaylight.protocol.pcep.spi.CommonObjectParser;
18 import org.opendaylight.protocol.pcep.spi.ObjectSerializer;
19 import org.opendaylight.protocol.pcep.spi.ObjectUtil;
20 import org.opendaylight.protocol.util.BitArray;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ObjectHeader;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.RequestId;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.svec.object.Svec;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.svec.object.SvecBuilder;
26 import org.opendaylight.yangtools.yang.common.netty.ByteBufUtils;
27
28 /**
29  * Parser for {@link Svec}.
30  */
31 public final class PCEPSvecObjectParser extends CommonObjectParser implements ObjectSerializer {
32     private static final int CLASS = 11;
33     private static final int TYPE = 1;
34
35     /*
36      * field lengths in bytes
37      */
38     private static final int FLAGS_SIZE = 24;
39
40     /*
41      * fields offsets in bytes
42      */
43     private static final int FLAGS_F_OFFSET = 1;
44
45     /*
46      * flags offsets inside flags field in bits
47      */
48     private static final int P_FLAG_OFFSET = 19;
49     private static final int D_FLAG_OFFSET = 20;
50     private static final int S_FLAG_OFFSET = 21;
51     private static final int N_FLAG_OFFSET = 22;
52     private static final int L_FLAG_OFFSET = 23;
53
54     /*
55      * min size in bytes
56      */
57     private static final int MIN_SIZE = FLAGS_SIZE / Byte.SIZE + FLAGS_F_OFFSET;
58
59     public PCEPSvecObjectParser() {
60         super(CLASS, TYPE);
61     }
62
63     @Override
64     public Svec parseObject(final ObjectHeader header, final ByteBuf bytes) throws PCEPDeserializerException {
65         checkArgument(bytes != null && bytes.isReadable(), "Array of bytes is mandatory. Can't be null or empty.");
66         if (bytes.readableBytes() < MIN_SIZE) {
67             throw new PCEPDeserializerException("Wrong length of array of bytes. Passed: "
68                 + bytes.readableBytes() + "; Expected: >=" + MIN_SIZE + ".");
69         }
70         bytes.skipBytes(FLAGS_F_OFFSET);
71         final BitArray flags = BitArray.valueOf(bytes, FLAGS_SIZE);
72         final var builder = ImmutableSet.<RequestId>builder();
73         while (bytes.isReadable()) {
74             builder.add(new RequestId(ByteBufUtils.readUint32(bytes)));
75         }
76         final Set<RequestId> requestIDs = builder.build();
77
78         if (requestIDs.isEmpty()) {
79             throw new PCEPDeserializerException("Empty Svec Object - no request ids.");
80         }
81         return new SvecBuilder()
82                 .setIgnore(header.getIgnore())
83                 .setProcessingRule(header.getProcessingRule())
84                 .setLinkDiverse(flags.get(L_FLAG_OFFSET))
85                 .setNodeDiverse(flags.get(N_FLAG_OFFSET))
86                 .setSrlgDiverse(flags.get(S_FLAG_OFFSET))
87                 .setLinkDirectionDiverse(flags.get(D_FLAG_OFFSET))
88                 .setPartialPathDiverse(flags.get(P_FLAG_OFFSET))
89                 .setRequestsIds(requestIDs)
90                 .build();
91     }
92
93     @Override
94     public void serializeObject(final Object object, final ByteBuf buffer) {
95         checkArgument(object instanceof Svec, "Wrong instance of PCEPObject. Passed %s. Needed SvecObject.",
96             object.getClass());
97         final Svec svecObj = (Svec) object;
98         final Set<RequestId> requestIDs = svecObj.getRequestsIds();
99         checkArgument(!requestIDs.isEmpty(), "Empty Svec Object - no request ids.");
100
101         final ByteBuf body = Unpooled.buffer();
102         body.writeZero(FLAGS_F_OFFSET);
103         final BitArray flags = new BitArray(FLAGS_SIZE);
104         flags.set(L_FLAG_OFFSET, svecObj.getLinkDiverse());
105         flags.set(N_FLAG_OFFSET, svecObj.getNodeDiverse());
106         flags.set(S_FLAG_OFFSET, svecObj.getSrlgDiverse());
107         flags.set(D_FLAG_OFFSET, svecObj.getLinkDirectionDiverse());
108         flags.set(P_FLAG_OFFSET, svecObj.getPartialPathDiverse());
109         flags.toByteBuf(body);
110
111         for (final RequestId requestId : requestIDs) {
112             ByteBufUtils.write(body, requestId.getValue());
113         }
114         ObjectUtil.formatSubobject(TYPE, CLASS, object.getProcessingRule(), object.getIgnore(), body, buffer);
115     }
116 }