2 * Copyright (c) 2016 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.protocol.bgp.parser.spi;
11 import com.google.common.base.Preconditions;
12 import com.google.common.collect.ImmutableMap;
13 import io.netty.buffer.ByteBuf;
14 import java.util.Optional;
15 import org.opendaylight.protocol.util.ByteBufWriteUtil;
16 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev180329.PathId;
17 import org.opendaylight.yangtools.yang.common.QName;
18 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
19 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
20 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
21 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
22 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
23 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
24 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodes;
26 public final class PathIdUtil {
27 public static final long NON_PATH_ID_VALUE = 0;
28 public static final PathId NON_PATH_ID = new PathId(NON_PATH_ID_VALUE);
30 private PathIdUtil() {
31 throw new UnsupportedOperationException();
35 * Writes path-id value into the buffer when
36 * the path-id is not null or does not equal to zero.
38 * @param pathId The NLRI Path Identifier.
39 * @param buffer The ByteBuf where path-id value can be written.
41 public static void writePathId(final PathId pathId, final ByteBuf buffer) {
42 if (pathId != null && pathId.getValue() != 0) {
43 ByteBufWriteUtil.writeUnsignedInt(pathId.getValue(), buffer);
48 * Reads Path Identifier (4 bytes) from buffer.
50 * @param buffer Input buffer.
51 * @return Decoded PathId.
53 public static PathId readPathId(final ByteBuf buffer) {
54 Preconditions.checkArgument(buffer != null && buffer.isReadable(ByteBufWriteUtil.INT_BYTES_LENGTH));
55 return new PathId(buffer.readUnsignedInt());
59 * Extract PathId from route change received.
61 * @param data Data containing the path Id
62 * @param pathNii Path Id NodeIdentifier specific per each Rib support
63 * @return The path identifier from data change
65 public static Long extractPathId(final NormalizedNode<?, ?> data, final NodeIdentifier pathNii) {
66 return (Long) NormalizedNodes.findNode(data, pathNii).map(NormalizedNode::getValue).orElse(null);
69 public static NodeIdentifierWithPredicates createNodeIdentifierWithPredicates(final QName routeQname,
70 final QName pathidQname, final Object pathId,
71 final QName routeKeyQname, final Object keyObject) {
72 return NodeIdentifierWithPredicates.of(routeQname,
73 ImmutableMap.of(pathidQname, pathId, routeKeyQname, keyObject));
79 * @param routesCont route container
80 * @param pathIdNii path Id node Identifier
81 * @return PathId or null in case is not the container
83 public static PathId buildPathId(final DataContainerNode<? extends PathArgument> routesCont,
84 final NodeIdentifier pathIdNii) {
85 final Long pathIdVal = PathIdUtil.extractPathId(routesCont, pathIdNii);
86 return pathIdVal == null ? null : new PathId(pathIdVal);
90 * Build Route Key for supporting mp.
91 * Key is composed by 2 elements (route-key + path Id).
93 * @param routeQname route Qname
94 * @param routeKeyQname route key Qname
95 * @param pathIdQname path Id Qname
96 * @param routeKeyValue route key value
97 * @param maybePathIdLeaf path id container, it might me supported or not, in that case default 0 value will
100 * @return Route Key Nid
102 public static NodeIdentifierWithPredicates createNidKey(final QName routeQname, final QName routeKeyQname,
103 final QName pathIdQname, final Object routeKeyValue,
104 final Optional<DataContainerChild<? extends PathArgument, ?>> maybePathIdLeaf) {
105 // FIXME: a cache here would mean we instantiate the same identifier for each route making comparison quicker.
106 final Object pathId = maybePathIdLeaf.isPresent() ? maybePathIdLeaf.get().getValue() : NON_PATH_ID_VALUE;
107 return createNodeIdentifierWithPredicates(routeQname, pathIdQname, pathId, routeKeyQname, routeKeyValue);