yang/openconfig-model-api/src/main/java/org/opendaylight/yangtools/openconfig/model/api/OpenConfigConstants.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies, s.r.o. 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.yangtools.openconfig.model.api;
   9
  10 import com.google.common.collect.ImmutableList;
  11 import java.net.URI;
  12 import java.util.Collection;
  13 import org.opendaylight.yangtools.yang.common.QNameModule;
  14 import org.opendaylight.yangtools.yang.common.Revision;
  15 import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
  16 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  17
  18 /**
  19  * Constants associated with OpenDaylight extension in yang-ext.yang.
  20  *
  21  * @author Robert Varga
  22  */
  23 public final class OpenConfigConstants {
  24     private static final String MODULE_NAME = "yang-ext";
  25     private static final URI MODULE_NAMESPACE = URI.create("http://openconfig.net/yang/openconfig-ext");
  26
  27     // Initial revision, defining semantic-version
  28     private static final Revision SEMVER_REVISION = Revision.of("2015-10-09");
  29
  30     // Revised extension, adds openconfig-encrypted-value
  31     private static final Revision ENCRYPTED_VALUE_REVISION = Revision.of("2017-01-29");
  32
  33     // Revised extension, renames openconfig-encrypted-value to openconfig-hashed-value
  34     private static final Revision HASHED_VALUE_REVISION = Revision.of("2017-04-11");
  35
  36     /**
  37      * Runtime identity of initial model.
  38      */
  39     public static final QNameModule SEMVER_MODULE = QNameModule.create(MODULE_NAMESPACE, SEMVER_REVISION).intern();
  40
  41     /**
  42      * Runtime identity of model which exposed encrypted-value.
  43      */
  44     public static final QNameModule ENCRYPTED_VALUE_MODULE = QNameModule.create(MODULE_NAMESPACE,
  45         ENCRYPTED_VALUE_REVISION).intern();
  46
  47     /**
  48      * Runtime identity of model which exposed encrypted-value.
  49      */
  50     public static final QNameModule HASHED_VALUE_MODULE = QNameModule.create(MODULE_NAMESPACE, HASHED_VALUE_REVISION)
  51             .intern();
  52
  53     /**
  54      * Original model source name.
  55      */
  56     public static final SourceIdentifier SEMVER_SOURCE = RevisionSourceIdentifier.create(MODULE_NAME,
  57         SEMVER_REVISION);
  58
  59     /**
  60      * Original model source name.
  61      */
  62     public static final SourceIdentifier ENCRYPTED_VALUE_SOURCE = RevisionSourceIdentifier.create(MODULE_NAME,
  63         ENCRYPTED_VALUE_REVISION);
  64
  65     /**
  66      * Original model source name.
  67      */
  68     public static final SourceIdentifier HASHED_VALUE_SOURCE = RevisionSourceIdentifier.create(MODULE_NAME,
  69         HASHED_VALUE_REVISION);
  70
  71     /**
  72      * Normative prefix to use when importing {@link #SEMVER_SOURCE} and later.
  73      */
  74     public static final String MODULE_PREFIX = "oc-ext";
  75
  76     private OpenConfigConstants() {
  77         throw new UnsupportedOperationException();
  78     }
  79
  80     /**
  81      * Return identifiers of all sources known to define the metadata extension.
  82      *
  83      * @return Collection of identifiers.
  84      */
  85     public static Collection<SourceIdentifier> knownModelSources() {
  86         return ImmutableList.of(HASHED_VALUE_SOURCE, ENCRYPTED_VALUE_SOURCE, SEMVER_SOURCE);
  87     }
  88 }