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