2 * Copyright (c) 2019 PANTHEON.tech s.r.o. 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
8 package org.opendaylight.yangtools.rfc8528.model.api;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.annotations.Beta;
13 import com.google.common.collect.ImmutableMap;
14 import com.google.common.collect.Maps;
16 import java.util.Arrays;
17 import java.util.Optional;
18 import org.eclipse.jdt.annotation.NonNullByDefault;
21 * Constants related to {@code ietf-yang-library.yang}. As schema-mount works in concert with yang-library, we need
22 * these constants to interpret correctly categorize incoming data and present them to schema resolution process.
25 * While RFC7895 and RFC8525 are not strictly required by YANG, RFC7950 contains a weak reference to it when dealing
26 * with capability negotiation on protocol layers. Moreover RFC8528 makes it explicit that an instance of yang-library
27 * is mounted underneath both {@code inline} and {@code shared-schema} types of mount.
30 * While we could mandate use of either RFC7895 or RFC8525 across the board, this is not feasible, as mount points may
31 * be nested and point to external systems -- hence it is completely possible to encounter both old and new information
32 * in a single mount point tree.
36 public final class YangLibraryConstants {
38 * The namespace assigned to {@code ietf-yang-library}. This constant is required for XML-like parsers, using
39 * XML namespaces to reference modules.
41 public static final URI MODULE_NAMESPACE = URI.create("urn:ietf:params:xml:ns:yang:ietf-yang-library");
43 * The module name assigned to {@code ietf-yang-library}. This constant is required for JSON-like parsers, using
44 * module names to reference modules.
46 public static final String MODULE_NAME = "ietf-yang-library";
49 * Top-level containers which hold YANG Library information, ordered by descending preference, with more modern
50 * and/or preferred entries first.
52 public enum ContainerName {
53 // Note: order this enum from most-preferred to least-preferred name
55 * Container in RFC8525 (NMDA) YANG Library.
57 RFC8525("yang-library"),
59 * Container in RFC7895 (pre-NMDA) YANG Library.
61 RFC7895("modules-state");
63 private static final ImmutableMap<String, ContainerName> NAME_TO_ENUM = Maps.uniqueIndex(
64 Arrays.asList(values()), ContainerName::getLocalName);
66 private final String localName;
68 ContainerName(final String localName) {
69 this.localName = requireNonNull(localName);
72 public String getLocalName() {
76 public static Optional<ContainerName> forLocalName(final String localName) {
77 return Optional.ofNullable(NAME_TO_ENUM.get(requireNonNull(localName)));
81 private YangLibraryConstants() {