Using the yang-parser - An Example

1 How to Include yang-parser in your Project
2 Sample project using “yang-parser 1.0”

How to Include yang-parser in your Project

1. Maven: Include the “oran-public” repository in your settings.xml

Create a profile for the “oran-public” repository

    <profile>
      <id>oran-public</id>
      <repositories>
        <repository>
          <id>oran-public</id>
          <name>oran-public</name>
          <url>https://nexus.o-ran-sc.org/content/repositories/public/</url>
          <releases>
            <enabled>true</enabled>
          </releases>
          <snapshots>
            <enabled>false</enabled>
          </snapshots>
        </repository>
      </repositories>
      <pluginRepositories>
        <pluginRepository>
          <id>oran-public</id>
          <name>oran-public</name>
          <url>https://nexus.o-ran-sc.org/content/repositories/public/</url>
          <releases>
            <enabled>true</enabled>
          </releases>
          <snapshots>
            <enabled>false</enabled>
          </snapshots>
        </pluginRepository>
      </pluginRepositories>
    </profile>

Then, include the profile under activeProfiles. The complete settings.xml file should resemble the one below, which is based on this file.

<?xml version="1.0" encoding="UTF-8"?>
<!--
   Copyright (c) 2016-2018 Huawei Technologies Co., Ltd. and others.  All rights reserved.
   Modifications Copyright (c) 2020 AT&T Technologies.  All rights reserved.

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
-->
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">

  <profiles>
    <profile>
      <id>onap-settings</id>
      <properties>
        <onap.nexus.url>https://nexus.onap.org</onap.nexus.url>
        <onap.nexus.rawrepo.baseurl.upload>https://nexus.onap.org/content/sites/raw</onap.nexus.rawrepo.baseurl.upload>
        <onap.nexus.rawrepo.baseurl.download>https://nexus.onap.org/service/local/repositories/raw/content</onap.nexus.rawrepo.baseurl.download>
        <onap.nexus.rawrepo.serverid>ecomp-raw</onap.nexus.rawrepo.serverid>

        <!-- properties for Nexus Docker registry -->
        <onap.nexus.dockerregistry.daily>nexus3.onap.org:10003</onap.nexus.dockerregistry.daily>
        <onap.nexus.dockerregistry.release>nexus3.onap.org:10002</onap.nexus.dockerregistry.release>
        <docker.pull.registry>nexus3.onap.org:10001</docker.pull.registry>
        <docker.push.registry>nexus3.onap.org:10003</docker.push.registry>
      </properties>
    </profile>
    <profile>
      <id>onap-snapshots</id>
      <repositories>
        <repository>
          <id>onap-snapshots</id>
          <name>onap-snapshots</name>
          <url>https://nexus.onap.org/content/repositories/snapshots/</url>
          <releases>
            <enabled>false</enabled>
          </releases>
          <snapshots>
            <enabled>true</enabled>
          </snapshots>
        </repository>
      </repositories>
      <pluginRepositories>
        <pluginRepository>
          <id>onap-snapshots</id>
          <name>onap-snapshots</name>
          <url>https://nexus.onap.org/content/repositories/snapshots/</url>
          <releases>
            <enabled>false</enabled>
          </releases>
          <snapshots>
            <enabled>true</enabled>
          </snapshots>
        </pluginRepository>
      </pluginRepositories>
    </profile>
    <profile>
      <id>onap-releases</id>
      <repositories>
        <repository>
          <id>onap-releases</id>
          <name>onap-releases</name>
          <url>https://nexus.onap.org/content/repositories/releases/</url>
          <releases>
            <enabled>true</enabled>
          </releases>
          <snapshots>
            <enabled>false</enabled>
          </snapshots>
        </repository>
      </repositories>
      <pluginRepositories>
        <pluginRepository>
          <id>onap-releases</id>
          <name>onap-releases</name>
          <url>https://nexus.onap.org/content/repositories/releases/</url>
          <releases>
            <enabled>true</enabled>
          </releases>
          <snapshots>
            <enabled>false</enabled>
          </snapshots>
        </pluginRepository>
      </pluginRepositories>
    </profile>
    <profile>
      <id>onap-public</id>
      <repositories>
        <repository>
          <id>central</id>
          <url>https://repo1.maven.org/maven2/</url>
        </repository>
        <repository>
          <id>onap-public</id>
          <name>onap-public</name>
          <url>https://nexus.onap.org/content/repositories/public/</url>
          <releases>
            <enabled>true</enabled>
          </releases>
          <snapshots>
            <enabled>false</enabled>
          </snapshots>
        </repository>
      </repositories>
      <pluginRepositories>
        <pluginRepository>
          <id>central</id>
          <url>https://repo1.maven.org/maven2/</url>
        </pluginRepository>
        <pluginRepository>
          <id>onap-public</id>
          <name>onap-public</name>
          <url>https://nexus.onap.org/content/repositories/public/</url>
          <releases>
            <enabled>true</enabled>
          </releases>
          <snapshots>
            <enabled>false</enabled>
          </snapshots>
        </pluginRepository>
      </pluginRepositories>
    </profile>
    <profile>
      <id>oran-public</id>
      <repositories>
        <repository>
          <id>oran-public</id>
          <name>oran-public</name>
          <url>https://nexus.o-ran-sc.org/content/repositories/public/</url>
          <releases>
            <enabled>true</enabled>
          </releases>
          <snapshots>
            <enabled>false</enabled>
          </snapshots>
        </repository>
      </repositories>
      <pluginRepositories>
        <pluginRepository>
          <id>oran-public</id>
          <name>oran-public</name>
          <url>https://nexus.o-ran-sc.org/content/repositories/public/</url>
          <releases>
            <enabled>true</enabled>
          </releases>
          <snapshots>
            <enabled>false</enabled>
          </snapshots>
        </pluginRepository>
      </pluginRepositories>
    </profile>
    <profile>
      <!-- Configure this profile if you have a local nexus cache -->
      <id>local-public</id>
      <repositories>
        <repository>
          <id>local-public</id>
          <name>local-public</name>
          <url>http://nexus-proxy:8081/nexus/content/repositories/public/</url>
          <releases>
            <enabled>true</enabled>
          </releases>
          <snapshots>
            <enabled>false</enabled>
          </snapshots>
        </repository>
      </repositories>
      <pluginRepositories>
        <pluginRepository>
          <id>local-public</id>
          <name>local-public</name>
          <url>http://nexus-proxy:8081/nexus/content/repositories/public/</url>
          <releases>
            <enabled>true</enabled>
          </releases>
          <snapshots>
            <enabled>false</enabled>
          </snapshots>
        </pluginRepository>
      </pluginRepositories>
    </profile>
  </profiles>

  <activeProfiles>
    <activeProfile>onap-settings</activeProfile>
    <activeProfile>onap-snapshots</activeProfile>
    <activeProfile>onap-releases</activeProfile>
    <activeProfile>onap-public</activeProfile>
    <activeProfile>oran-public</activeProfile>
    <!-- <activeProfile>local-public</activeProfile> -->
  </activeProfiles>

</settings>

Finally add as a dependency in the pom.xml

<dependency>
    <groupId>org.oran.smo.yangtools.parser</groupId>
    <artifactId>yang-parser-jar</artifactId>
    <version>1.1.0</version>
</dependency>

2. Install the JAR into the Local Repository

Download the yang-parser-jar from https://nexus.o-ran-sc.org/#view-repositoriesthen install in the local repository

Then add as a dependency

3. Add local dependencies directly (deprecated but still working)

Download the yang-parser-jar from https://nexus.o-ran-sc.org/#view-repositories then add as a local dependency

Sample project using “yang-parser 1.0”

This small sample project should provide enough information to help you start using yang-parser in your project.

SMO