Team
Name | Organization | |
---|---|---|
Adarsh M | Huawei Technologies | adarsh.m@huawei.com |
Bharat Saraswal | Huawei Technologies | bharat.saraswal@huawei.com |
Gaurav Agrawal | Huawei Technologies | gaurav.agrawal@huawei.com |
Janani B | Huawei Technologies | janani.b@huawei.com |
Sathish Kumar M | Huawei Technologies | sathishkumar.m@huawei.com |
Suchitra H N | Huawei Technologies | suchitra.hn@huawei.com |
Vidyashree Rama | Huawei Technologies | vidyashree.rama@huawei.com |
Vinod Kumar S | Huawei Technologies | vinods.kumar@huawei.com |
Shankara | Huawei Technologies | |
Mahesh Poojary S | Huawei Technologies | |
Rama Subba Reddy S | Huawei Technologies |
Requirements for Hummingbird Release
Requested By | Requirements | Suggested Priority (high - Middle -Low) | Current Status |
---|---|---|---|
Thomas Vachuska | Thanks for the demo of the YANG utilities at today’s TST meeting. While a lot of good work was done in the last release, I was a little bit surprised that the codec functionality was pushed off to the next release - and that NB-related concerns superseded SB-related ones. In my view, this is the basic value of using the YANG models - as it provides the ability to consume/produce XML payloads that are complaint with the model in a structured manner via Java API. We have a set of use-cases for this to control/configure devices via NETCONF. Presently we have to accomplish this using hand-crafted XML and we were hoping to use the YANG tools-generated codecs for this. Consequently the SB use of YANG is of much more importance to us than the NB use of YANG - at least for the near-term. In the Hummingbird release we need to be able to use the YANG tools generated artifacts together with our existing NETCONF sub-controller to produce driver implementations for several packet and optical devices. For this reason, I would like to request that this work be prioritized over anything else with respect to other YANG-related work. In order for that to happen, I think a number of other important questions will have to be answered and accounted for in the overall design of the YANG utilities:
| High | reviewing |
Ali Al-Shabibi | JSON or JSON-Schema Intermediary Representation. It would be nice if we could go from YANG to JSON or JSON-Schema because from this IR format we can easily go to XML or JSON or some other format that another protocol may want to use. As you probably know, Netconf is only one of the southbound to deliver payloads other ones such as gRPC or REST can be used. | medium | |
Marc De Leenheer | Support for OpenROADM YANG models. The specification contains two parts, a service-level model (NB) and a device-level model (SB). The first phase has already started, we want to integrate the device model into ONOS by early Q3 2016. In Q4 we will do the service level models. This is high priority work in collaboration with AT&T. | high | |
Aihua Guo | In order to support the use of standard IETF YANG models as an NBI for hierarchical SDN control, it is expected that the following YANG data constructs be supported in the H releases: augment (partially supported in G release), identity, feature/if-feature, when, must, leafref, path, require-instance. These data constructs are defined by YANG 1.1, and most of the IETF YANG models contain those constructs written in YANG 1.1. | high |
Overview
YANG is a data modeling language used to model configuration & state data. Modeling languages such as SMI (SNMP), UML, XML Schema, and others already existed. However, none of these languages were specifically targeted to the needs of configuration management. They lacked critical capabilities like being easily read and understood by human implementers, and fell short in providing mechanisms to validate models of configuration data for semantics and syntax.
YANG Utils are the basic building block to achieve the final goal of abstracting the language based Syntax/Semantics processing by APPs.
The YANG modeled interfaces need to be implemented by corresponding application component. There are 2 parts in implementing the interface:
- syntax/semantics processing of the request/response being exchanged.
- business logic to compute the request.
We intend to abstract the applications from syntactic processing of information encoding with external world.We intend to provide a framework in which the applications only need to implement the business logic and seamlessly support any interface language like REST, NETCONF etc.
Steps to use YANG utils
Step1 : Create a test app and add YANG utils maven plugin to pom file’s build section
<build> <plugins> <plugin> <groupId>org.onosproject</groupId> <artifactId>yangutils-maven-plugin</artifactId> <version>1.0.0-SNAPSHOT</version> <executions> <execution> <configuration> </configuration> <goals> <goal>yang2java</goal> </goals> </execution> </executions> </plugin> </plugins> </build>
Step 2 : Add dependency to pom file’s dependency section
<dependencies> <dependency> <groupId>org.onosproject</groupId> <artifactId>yangutils-datamodel</artifactId> <version>1.7.0-SNAPSHOT</version> </dependency> <dependency> <groupId>org.onosproject</groupId> <artifactId>yangutils-javamodel</artifactId> <version>1.7.0-SNAPSHOT</version> </dependency> <dependency> <groupId>org.onosproject</groupId> <artifactId>onos-api</artifactId> </dependency> <dependency> <groupId>org.apache.felix</groupId> <artifactId>org.apache.felix.scr.annotations</artifactId> </dependency> </dependencies>
Step 3 : Plugin configuration supported in YANG utils
Create a folder structure as “src/main/yang” in the test app folder and place your YANG files in it. In case user want to give desired path for source YANG files and generated java files, the following configuration can be appended to the above pom.xml file.
<configuration> <yangFilesDir>DesiredYangFilesPath</yangFilesDir> <genFilesDir>DesiredGeneratedJavaFilesPath</genFilesDir> </configuration>
Plugin provides user to give configuration if he wants to generate manager/service classes or not. for this if he do not wants to generate service and manager classes he can set flag to "sbi" , and plugin will not generate manager/service classes.
<configuration> <generateJavaFileForsbi>sbi</generateJavaFileForsbi> </configuration>
Step 4 : Execution of application
Build using mvn clean install/ mvn install. Generated java code will be placed in default directory or in desired destination folder configured by user.
Note:
- If user does not provide any configurations for code generation , code will be generated in "target/generated-sources" folder. This folder conatains majorly,
i) Service interface
ii) Module interface and its param class
iii) Attribute interfaces of module and its default implementation class- If a yang file contains only typedef/grouping nodes, there will not be any generation of manager class.
Code generated is as per ONOS coding guidelines.
YANG utils constructs support/plan
YANG Construct | Supported/Planned version |
---|---|
anyxml | Not planned |
argument | Hummingbird |
augment | Goldeneye |
base | Hummingbird |
belongs-to | Goldeneye |
bit | Hummingbird |
case | Goldeneye |
choice | Goldeneye |
config | Falcon |
contact | Goldeneye Enhancement in Hummingbird |
container | Falcon |
default | Goldeneye Enhancement in Humminbird |
description | Goldeneye Enhancement in Hummingbird |
deviate | Not planned |
deviation | Not planned |
enum | Goldeneye |
error-app-tag | Hummingbird |
error-message | Hummingbird |
extension | Hummingbird |
feature | Hummingbird |
fraction-digits | Hummingbird |
grouping | Goldeneye |
identity | Hummingbird |
if-feature | Hummingbird |
import | Goldeneye Enhancement in Hummingbird |
include | Goldeneye Enhancement in Hummingbird |
input | Goldeneye |
key | Goldeneye |
leaf | Falcon |
leaf-list | Falcon |
length | Goldeneye |
list | Falcon |
mandatory | Falcon |
max-elements | Goldeneye |
min-elements | Goldeneye |
module | Falcon |
must | Hummingbird |
namespace | Goldeneye |
notification | Goldeneye |
ordered-by | Not planned |
organization | Goldeneye Enhancement in Hummingbird |
output | Goldeneye |
path | Hummingbird |
pattern | Goldeneye |
position | Goldeneye |
prefix | Goldeneye |
presence | Goldeneye |
range | Goldeneye |
reference | Goldeneye Enhancement in Hummingbird |
refine | Not planned |
require-instance | Hummingbird |
revision | Goldeneye Enhancement in Hummingbird |
revision-date | Goldeneye |
rpc | Goldeneye |
status | Goldeneye Enhancement in Hummingbird |
submodule | Goldeneye |
type | Goldeneye |
typedef | Goldeneye |
unique | Not Planned |
units | Goldeneye |
uses | Goldeneye Enhancement in Hummingbird |
value | Goldeneye |
when | Hummingbird |
yang-version | Goldeneye |
yin-element | Not Planned |
Built-in YANG data types support/plan
Binary | Goldeneye Enhancement in Hummingbird |
Bits | Goldeneye Enhancement in Hummingbird |
boolean | Goldeneye |
decimal64 | Goldeneye Enhancement in Hummingbird |
empty | Goldeneye |
enumeration | Goldeneye |
identityref | Hummingbird |
instance-identifier | Hummingbird |
int8 | Goldeneye |
int16 | Goldeneye |
int32 | Goldeneye |
int64 | Goldeneye |
leafref | Hummingbird |
string | Falcon |
uint8 | Goldeneye |
uint16 | Goldeneye |
uint32 | Goldeneye |
uint64 | Goldeneye |
union | Goldeneye |
Generated JAVA Details
Common behavior
Identifier
The identifier name of YANG constructs are taken, and are used in java by converting it to lower camel case. Identifier names are allowed to have three special characters such as “-”, ”_”, “.”. Whereas, in java, we cannot use these special characters. These characters will be removed during conversion. Conversion takes place by following the below rules of lower camel case.
The first letter of the identifier will be a small letter. If the three special characters occur alone or in group, they will be removed and the consecutive letter will be capitalized.
name-conversion will be mapped as nameConversion
yang-._constuct-generation will be mapped as yangConstuctGeneration
When identifier name has a special character followed by a number, the following letter from the digits will be capitalized.
yang_123construct will be mapped to yang123Construct
In java file, class name or attribute name cannot have java keyword or start with digits. During the conversion into java, we add prefix to the identifier “yangAutoPrefix”, by default.
_123date will be mapped to yangAutoPrefix123Date
const will be mapped to yangAutoPrefixConst
As per camelcase conversion rules, no two consecutive letters will have capitalization and the last letter will also not be capitalized.
- ca-l.e_nder will be mapped to caLeNder
- tric-._k will be mapped to trick
If users input has capital case, the following will be the conversion methods.
TESTNAME will be mapped to testname
TEST-NAME will be mapped to testName
TestName will be mapped to testName
TEST3NAME will be mapped to test3Name
When the identifier has to be used as java class name, after the above conversion, the first letter will be capitalized and if consecutive capital letters are present, it will be corrected and assigned as java class name.
Namespace
The namespace is a mandatory statement in the module. We define namespace for URL/URI and for folder structure of generated java code. Here in ONOS YANG plugin, namespace forms a folder structure which in turn will be the package name in java.
The package will have “org.onosproject.yang.gen.v1.” by default in it. The namespace will be added to the above and the folder structure will also be formed respectively. This becomes the parent package. The conversion from YANG namespace to the java package will take place as below.
The complete namespace will be changed to lowercase letters. When special characters or a group of special characters are found, it replaces those characters by dot.
"http://acme.example.com/system" will be mapped as org.onosproject.yang.gen.v1.http.acme.example.com.system.rev20160427
In java the package cannot have folder name which begins with digits or java keyword. Incase if found in YANG file these will be converted by adding prefix “yangautoprefix”.
http://acme.123example.com/try" will be mapped as org.onosproject.yang.gen.v1.http.acme.yangautoprefix123example.com.yangautoprefixtry.rev20160427
- At the end of the package the revision in module will be added by the string rev<yyyymmdd>.If the revision does not exist in the YANG file current date will be appended to the package.
When a node appears, with child node in it, a new package will be generated under the parent package, for that node. The new package is, parent package appended with the node name. The class for that node will be placed under this newly created package.
Example
File : acme-system.yang module acme-system { namespace "http://acme.example.com/system"; prefix "acme"; organization "ACME Inc."; contact "joe@acme.example.com"; description "The module for entities implementing the ACME system."; revision 2007-06-09 { description "Initial revision."; } container system { container login { leaf message { type string; description "Message given at start of login session"; } } } . . . }
File : System.java package org.onosproject.yang.gen.v1.http.acme.example.com.system.rev20070609.acmesystem; . . . public interface System { . . . } File : Login.java package org.onosproject.yang.gen.v1.http.acme.example.com.system.rev20070609.acmesystem.system; . . . public interface Login { . . . }
Javadocs
Currently Java doc will be generated as per ONOS javadoc guidelines.
Here in wiki for the given examples for each YANG construct we have removed generated javadocs for documentation purpose. Code will contain all the default javadoc which we are providing in golden-eye release. Javadocs support will be enhanced in hummingbird release.
YANG statements
Module
Overview
The primary unit of YANG is module. The module statement groups all the statements that belong to module together. The module statement argument is name of the module followed by sub-statements.
JAVA mapping
Module statement is mapped to
- Service interface
It includes:
a) java methods corresponding to the YANG RPC (Refer RPC section for more details)
b) If module contains notification, generated service interface will extend listener service (refer notification for more details) - Manager class
It includes:
a ) Activate/Deactivate methods
b) If module contains child data nodes, getters and setters for those nodes will be generated for app developers to implement.
c)If module contains notification, generated manager class will extend ListenerRegistry(refer notification for more details) .
The manager class implements the service interface. The name of service interface and manager class is <module_name>Service.java and <module_name>Manager.java.
Example
File : network.yang module network { yang-version 1; namespace "urn:TBD:params:xml:ns:yang:nodes"; prefix nd; organization "TBD"; contact "WILL-BE-DEFINED-LATER"; description "This module defines a common base model for a collection of nodes in a network. Node definitions s are further used in network topologies and inventories."; revision 2014-03-09 { description "Initial revision."; reference "draft-clemm-i2rs-yang-network-topo-04"; } list networklist { key "network-id"; leaf network-id { type string; } leaf server-provided { type boolean; config false; } } …. }
File : NetworkService.java package org.onosproject.yang.gen.v1.urn.tbd.params.xml.ns.yang.nodes.rev20140309; public interface NetworkService { Network getNetwork(); void setNetwork(Network network); } File : NetworkManager.java package org.onosproject.yang.gen.v1.urn.tbd.params.xml.ns.yang.nodes.rev20140309; import org.apache.felix.scr.annotations.Activate; import org.apache.felix.scr.annotations.Component; import org.apache.felix.scr.annotations.Deactivate; import org.apache.felix.scr.annotations.Service; import org.slf4j.Logger; import static org.slf4j.LoggerFactory.getLogger; @Component(immediate = true) @Service public class NetworkManager implements NetworkService { private final Logger log = getLogger(getClass()); @Activate public void activate() { //TODO: YANG utils generated code log.info("Started"); } @Deactivate public void deactivate() { //TODO: YANG utils generated code log.info("Stopped"); } @Override public Network getNetwork() { //TODO: YANG utils generated code return null; } @Override public void setNetwork(Network network) { //TODO: YANG utils generated code } } File : Network.java package org.onosproject.yang.gen.v1.urn.tbd.params.xml.ns.yang.nodes.rev20140309; import java.util.List; import org.onosproject.yang.gen.v1.urn.tbd.params.xml.ns.yang.nodes.rev20140309.network.Networklist; public interface Network { List<Networklist> networklist(); interface NetworkBuilder { List<Networklist> networklist(); NetworkBuilder networklist(List<Networklist> networklist); Network build(); } } File:DefaultNetwork.java package org.onosproject.yang.gen.v1.urn.tbd.params.xml.ns.yang.nodes.rev20140309; import com.google.common.base.MoreObjects; import java.util.List; import java.util.Objects; import org.onosproject.yang.gen.v1.urn.tbd.params.xml.ns.yang.nodes.rev20140309.network.Networklist; public class DefaultNetwork implements Network { protected List<Networklist> networklist; @Override public List<Networklist> networklist() { return networklist; } @Override public int hashCode() { return Objects.hash(networklist); } @Override public boolean equals(Object obj) { if (this == obj) { return true; } if (obj instanceof DefaultNetwork) { DefaultNetwork other = (DefaultNetwork) obj; return Objects.equals(networklist, other.networklist); } return false; } @Override public String toString() { return MoreObjects.toStringHelper(getClass()) .add("networklist", networklist) .toString(); } public DefaultNetwork(NetworkBuilder builderObject) { this.networklist = builderObject.networklist(); } public class NetworkBuilder implements Network.NetworkBuilder { protected List<Networklist> networklist; @Override public List<Networklist> networklist() { return networklist; } @Override public NetworkBuilder networklist(List<Networklist> networklist) { this.networklist = networklist; return this; } @Override public Network build() { return new DefaultNetwork(this); } public NetworkBuilder() { } } }
File : network.yang with an augment node. module network { yang-version 1; namespace "urn:TBD:params:xml:ns:yang:nodes"; prefix nd; organization "TBD"; contact "WILL-BE-DEFINED-LATER"; description "This module defines a common base model for a collection of nodes in a network. Node definitions s are further used in network topologies and inventories."; revision 2014-03-09 { description "Initial revision."; reference "draft-clemm-i2rs-yang-network-topo-04"; } list networklist { key "network-id"; leaf network-id { type string; } leaf server-provided { type boolean; config false; } } augment /networklist { leaf network-ip { type int32; } } .... }
File : NetworkService.java package org.onosproject.yang.gen.v1.urn.tbd.params.xml.ns.yang.nodes.rev20140309; public interface NetworkService { Network getNetwork(); void setNetwork(Network network); Network getAugmentedNetworkNetworklist(); void setAugmentedNetworkNetworklist(Network augmentedNetworkNetworklist); } File : NetworkManager.java package org.onosproject.yang.gen.v1.urn.tbd.params.xml.ns.yang.nodes.rev20140309; import org.apache.felix.scr.annotations.Activate; import org.apache.felix.scr.annotations.Component; import org.apache.felix.scr.annotations.Deactivate; import org.apache.felix.scr.annotations.Service; import org.slf4j.Logger; import static org.slf4j.LoggerFactory.getLogger; @Component(immediate = true) @Service public class NetworkManager implements NetworkService { private final Logger log = getLogger(getClass()); @Activate public void activate() { //TODO: YANG utils generated code log.info("Started"); } @Deactivate public void deactivate() { //TODO: YANG utils generated code log.info("Stopped"); } @Override public Network getNetwork() { //TODO: YANG utils generated code return null; } @Override public void setNetwork(Network network) { //TODO: YANG utils generated code } @Override public Network getAugmentedNetworkNetworklist() { //TODO: YANG utils generated code return null; } @Override public void setAugmentedNetworkNetworklist(Network augmentedNetworkNetworklist) { //TODO: YANG utils generated code } } File : Network.java package org.onosproject.yang.gen.v1.urn.tbd.params.xml.ns.yang.nodes.rev20140309; import java.util.List; import org.onosproject.yang.gen.v1.urn.tbd.params.xml.ns.yang.nodes.rev20140309.network.Networklist; public interface Network { List<Networklist> networklist(); interface NetworkBuilder { List<Networklist> networklist(); NetworkBuilder networklist(List<Networklist> networklist); Network build(); } } File:DefaultNetwork.java package org.onosproject.yang.gen.v1.urn.tbd.params.xml.ns.yang.nodes.rev20140309; import com.google.common.base.MoreObjects; import java.util.List; import java.util.Objects; import org.onosproject.yang.gen.v1.urn.tbd.params.xml.ns.yang.nodes.rev20140309.network.Networklist; public class DefaultNetwork implements Network { protected List<Networklist> networklist; @Override public List<Networklist> networklist() { return networklist; } @Override public int hashCode() { return Objects.hash(networklist); } @Override public boolean equals(Object obj) { if (this == obj) { return true; } if (obj instanceof DefaultNetwork) { DefaultNetwork other = (DefaultNetwork) obj; return Objects.equals(networklist, other.networklist); } return false; } @Override public String toString() { return MoreObjects.toStringHelper(getClass()) .add("networklist", networklist) .toString(); } public DefaultNetwork(NetworkBuilder builderObject) { this.networklist = builderObject.networklist(); } public class NetworkBuilder implements Network.NetworkBuilder { protected List<Networklist> networklist; @Override public List<Networklist> networklist() { return networklist; } @Override public NetworkBuilder networklist(List<Networklist> networklist) { this.networklist = networklist; return this; } @Override public Network build() { return new DefaultNetwork(this); } public NetworkBuilder() { } } }
Sub Module
Overview
The “submodule” groups all the statements that belongs to the submodule together. The "submodule" statement's argument is the name of the submodule, followed by a block of sub statements.
JAVA mapping
Submodule mapping to java is same as module and files with be generated in module’s namespace.
Example
File : acme-system.yang module acme-system { namespace "http://yang-central.org/ns/example/acme"; prefix acme; include "acme-types"; container access { leaf id { type uint32; } } } File : acme-types.yang submodule acme-types { yang-version 1; belongs-to "acme-system" { prefix "acme"; } container access { leaf access-timeout { type uint32; } leaf retries { type uint8; } } }
File : AcmeSystemManager.java package org.onosproject.yang.gen.v1.http.yang.central.org.ns.example.acme.rev20160720; import org.apache.felix.scr.annotations.Activate; import org.apache.felix.scr.annotations.Component; import org.apache.felix.scr.annotations.Deactivate; import org.apache.felix.scr.annotations.Service; import org.slf4j.Logger; import static org.slf4j.LoggerFactory.getLogger; @Component(immediate = true) @Service public class AcmeSystemManager implements AcmeSystemService { private final Logger log = getLogger(getClass()); @Activate public void activate() { //TODO: YANG utils generated code log.info("Started"); } @Deactivate public void deactivate() { //TODO: YANG utils generated code log.info("Stopped"); } @Override public AcmeSystem getAcmeSystem() { //TODO: YANG utils generated code return null; } @Override public void setAcmeSystem(AcmeSystem acmeSystem) { //TODO: YANG utils generated code } } File : AcmeSystemService.java package org.onosproject.yang.gen.v1.http.yang.central.org.ns.example.acme.rev20160720; public interface AcmeSystemService { AcmeSystem getAcmeSystem(); void setAcmeSystem(AcmeSystem acmeSystem); } File : AcmeTypesManager.java package org.onosproject.yang.gen.v1.http.yang.central.org.ns.example.acme.rev20160720; import org.apache.felix.scr.annotations.Activate; import org.apache.felix.scr.annotations.Component; import org.apache.felix.scr.annotations.Deactivate; import org.apache.felix.scr.annotations.Service; import org.slf4j.Logger; import static org.slf4j.LoggerFactory.getLogger; @Component(immediate = true) @Service public class AcmeTypesManager implements AcmeTypesService { private final Logger log = getLogger(getClass()); @Activate public void activate() { //TODO: YANG utils generated code log.info("Started"); } @Deactivate public void deactivate() { //TODO: YANG utils generated code log.info("Stopped"); } @Override public AcmeTypes getAcmeTypes() { //TODO: YANG utils generated code return null; } @Override public void setAcmeTypes(AcmeTypes acmeTypes) { //TODO: YANG utils generated code } } File : AcmeTypesService.java package org.onosproject.yang.gen.v1.http.yang.central.org.ns.example.acme.rev20160720; public interface AcmeTypesService { AcmeTypes getAcmeTypes(); void setAcmeTypes(AcmeTypes acmeTypes); }
Prefix
Overview
Prefix is used to define prefix associated with module. It is used as a hint to other module developers when they import our module.
JAVA mapping
There is no java mapping for prefix statement.
Example
module dhcp { namespace "http://yang-central.org/ns/example/dhcp"; prefix dhcp; import ietf-yang-types { prefix yang; } import ietf-inet-types { prefix inet; } }
Note the prefixes above. In order to refer to the yang-module from now on, we use the prefix, e.g. the statement:
type yang:date-and-time;
refers to the date-and-time type defined in the yang-types module.
We use the prefix defined in the module itself, e.g. in the yang-types module, the prefix is defined as yang. You can use which prefix you want in your import, as long as it is unique within the module, but by using the prefix from the module, your module will be easier to read for others.
Import
Overview
A module can import definitions from other module or submodule by using import statement. It takes an argument, the name of the module or submodule followed by sub statements prefix and revision statement. Multiple import statements may be specified to import from different modules. Prefix statement inside import is mandatory and its scope is within the imported module or sub-module.
JAVA mapping
When imported YANG file is used in any of the nodes in current YANG file, then Java code will genereted for imported YANG file. If it is imported YANG file is not used in any of the node in current YANG file then Java code for imported file will not be genereted.
Example
File : flow-classifier.yang module flow-classifier { yang-version 1; namespace "sfc.flowclassifier"; prefix "flow-classifier"; import "ietf-yang-types" { prefix "yang"; } organization "ON-LAB"; description "This submodule defines for flow classifier."; revision "2016-05-24" { description "Initial revision."; } leaf id { type yang:uuid; } } File : ietf-yang-types.yang module ietf-yang-types { namespace "urn:ietf:params:xml:ns:yang:ietf-yang-types"; prefix "yang"; organization "IETF NETMOD (NETCONF Data Modeling Language) Working Group"; contact "WG Web: <http://tools.ietf.org/wg/netmod/> WG List: <mailto:netmod@ietf.org> WG Chair: David Kessens <mailto:david.kessens@nsn.com> WG Chair: Juergen Schoenwaelder <mailto:j.schoenwaelder@jacobs-university.de> Editor: Juergen Schoenwaelder <mailto:j.schoenwaelder@jacobs-university.de>"; description "This module contains a collection of generally useful derived YANG data types. Copyright (c) 2013 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info). This version of this YANG module is part of RFC 6991; see the RFC itself for full legal notices."; revision 2013-07-15 { description "This revision adds the following new data types: - yang-identifier - hex-string - uuid - dotted-quad"; reference "RFC 6991: Common YANG Data Types"; } revision 2010-09-24 { description "Initial revision."; reference "RFC 6021: Common YANG Data Types"; } typedef uuid { type string { pattern '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-' + '[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'; } description "A Universally Unique IDentifier in the string representation defined in RFC 4122. The canonical representation uses lowercase characters. The following is an example of a UUID in string representation: f81d4fae-7dec-11d0-a765-00a0c91e6bf6 "; reference "RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace"; } }
File : FlowClassifierManager.java there will be no manager file generation because flowclassifier yang only contains one leaf. File : FlowClassifierService package org.onosproject.yang.gen.v1.sfc.flowclassifier.rev20160524; public interface FlowClassifierService { FlowClassifier getFlowClassifier(); void setFlowClassifier(FlowClassifier flowClassifier); } File : IetfYangTypesManager.java there will be no manager file generation because yang files contains only typedef. File : IetfYangTypesService.java package org.onosproject.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev20130715; public interface IetfYangTypesService { IetfYangTypes getIetfYangTypes(); void setIetfYangTypes(IetfYangTypes ietfYangTypes); } File : Uuid.java package org.onosproject.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev20100924.ietfyangtypes; import java.util.Objects; import com.google.common.base.MoreObjects; public final class Uuid { private String string; private Uuid() { } public Uuid(String value) { this.string = value; } public static Uuid of(String value) { return new Uuid(value); } public String string() { return string; } @Override public int hashCode() { return Objects.hash(string); } @Override public boolean equals(Object obj) { if (this == obj) { return true; } if (obj instanceof Uuid) { Uuid other = (Uuid) obj; return Objects.equals(string, other.string); } return false; } @Override public String toString() { return MoreObjects.toStringHelper(getClass()) .add("string", string) .toString(); } public static Uuid fromString(String valInString) { try { String tmpVal = (valInString); return of(tmpVal); } catch (Exception e) { } return null; } }
Include
Overview
A module uses a include statement to include sub-module that belongs to module. The argument is the name of sub-module. Modules are only allowed to include sub-module that belongs to module, as defined by belongs-to statement. When a module includes a submodule, it incorporates the contents of the submodule into the node hierarchy of the module.
JAVA mapping
There is no java mapping for include statement.
Example
Please refer submodule example
Organization
Overview
The "organization" statement defines the party responsible for this module. The argument is a string that is used to specify a textual description of the organization(s) under whose auspices this module was developed.
JAVA mapping
Organization will be used as javadoc in generated java code in Hummingbird release version. Currently it is not used in generated java code.
Example
Please refer module example section
Contact
Overview
The "contact" statement provides contact information for the module. The argument is a string that is used to specify contact information for the person or persons to whom technical queries concerning this module should be sent, such as their name, postal address, telephone number, and electronic mail address.
JAVA mapping
Contact information will be used as javadoc in generated java code in Hummingbird release version. Currently it is not used in generated java code.
Example
Please refer module example section
Belongs to
Overview
The "belongs-to" statement specifies the module to which the submodule belongs. The argument is an identifier that is the name of the module. A submodule must only be included by the module to which it belongs, or by another submodule that belongs to that module.
JAVA mapping
No java mapping for belongs to statement in generated code.
Example
Please refer submodule example section.
Leaf
Overview
A leaf is an atomic element in YANG. It has value, but does not have child. It is used for defining the scalar variable of a built-in type or a derived type.
Java mapping
In java leaf is converted to define variable with its respective java built-in type or derived type.
Example
File : acme-system.yang module acme-system { namespace "http://acme.example.com/system"; prefix "acme"; organization "ACME Inc."; contact "joe@acme.example.com"; description "The module for entities implementing the ACME system."; revision 2007-06-09 { description "Initial revision."; } container system { leaf host-name { type string; description "Hostname for this system"; } } . . . }
File: System.java public interface System { String hostName(); interface SystemBuilder { String hostName(); SystemBuilder hostName(String hostName); System build(); } } File : DefaultSystem.java package org.onosproject.yang.gen.v1.http.acme.example.com.system.rev20070609.acmesystem; import com.google.common.base.MoreObjects; import java.util.HashMap; import java.util.Map; import java.util.Objects; import org.onosproject.yangutils.datamodel.YangAugmentedInfo; public class DefaultSystem implements System { private Map<Class<?>, YangAugmentedInfo> yangAugmentedInfoMap = new HashMap<>(); protected String hostName; @Override public String hostName() { return hostName; } . . . }
Leaf-list
Overview
A leaf-list is also used for defining scalar variable, like leaf, but in an array of a particular type. The type of the variable can be either built-in type or a derived type.
Java mapping
In java leaf-list is stored in List, with respect to, java built-in type or derived type.
Example
File : acme-system.yang module acme-system { namespace "http://acme.example.com/system"; prefix "acme"; organization "ACME Inc."; contact "joe@acme.example.com"; description "The module for entities implementing the ACME system."; revision 2007-06-09 { description "Initial revision."; } container system { leaf-list domain-search { type string; description "List of domain names to search"; } } . . . }
File : System.java public interface System { String hostName(); interface SystemBuilder { String hostName(); SystemBuilder hostName(String hostName); System build(); } } File : DefaultSystem.java public class DefaultSystem implements System { private Map<Class<?>, YangAugmentedInfo> yangAugmentedInfoMap = new HashMap<>(); protected String hostName; @Override public String hostName() { return hostName; } . . . }
Container
Overview
Container is a holder that can hold many nodes within it. It is used for logically grouping certain set of nodes.
Java mapping
In java, container acts as a class which can hold information contained within. A class of the container is formed only when container has nodes in it. In addition to that, container's parent holder will have container class’s information.
Container statement is mapped to java as
- Interface File
It includes:
a) Getters for the attributes.
b) Builder interface which contains getters/setters and build method. - Builder Class File
It includes:
a) Builder class which is the implementation of builder interface defined in interface file.
b) Impl class which is the implementation of interface file.
c) hashCode(), equals(), toString() methods overridden in it. - OpParam class File:
it inlcudes:
a) Operation types for restconf/netconf operations.
b) setter method for leaf and leaf list if present.
c) isFilterContentMatch() method for matching the contents if they are set in object or not.
d) setter and getter for bitset values of present leaves/leaf-lists.
Example
File : acme-system.yang module acme-system { namespace "http://acme.example.com/system"; prefix "acme"; organization "ACME Inc."; contact "joe@acme.example.com"; description "The module for entities implementing the ACME system."; revision 2007-06-09 { description "Initial revision."; } container system { container login { leaf message { type string; description "Message given at start of login session"; } } } . . . }
File : System.java package org.onosproject.yang.gen.v1.http.acme.example.com.system.rev20070609.acmesystem; import org.onosproject.yang.gen.v1.http.acme.example.com.system.rev20070609.acmesystem.system.Login; public interface System { Login login(); interface SystemBuilder { Login login(); SystemBuilder login(Login login); System build(); } } File : DefaultSystem.java package org.onosproject.yang.gen.v1.http.acme.example.com.system.rev20070609.acmesystem; import com.google.common.base.MoreObjects; import java.util.HashMap; import java.util.Map; import java.util.Objects; import org.onosproject.yang.gen.v1.http.acme.example.com.system.rev20070609.acmesystem.system.Login; import org.onosproject.yangutils.datamodel.YangAugmentedInfo; public class DefaultSystem implements System { private Map<Class<?>, YangAugmentedInfo> yangAugmentedInfoMap = new HashMap<>(); protected Login login; @Override public Login login() { return login; } @Override public int hashCode() { return Objects.hash(login); } @Override public boolean equals(Object obj) { if (this == obj) { return true; } if (obj instanceof DefaultSystem) { DefaultSystem other = (DefaultSystem) obj; return Objects.equals(login, other.login); } return false; } @Override public String toString() { return MoreObjects.toStringHelper(getClass()) .add("login", login) .toString(); } public DefaultSystem(SystemBuilder builderObject) { this.login = builderObject.login(); } public void addAugmentedInfo(YangAugmentedInfo value, Class classObject) { yangAugmentedInfoMap.put(classObject, value); } public YangAugmentedInfo getAugmentedInfo(Class classObject) { return yangAugmentedInfoMap.get(classObject); } public Map<Class<?>, YangAugmentedInfo> getYangAugmentedInfoMap() { return yangAugmentedInfoMap; } public class SystemBuilder implements System.SystemBuilder { protected Login login; @Override public Login login() { return login; } @Override public SystemBuilder login(Login login) { this.login = login; return this; } @Override public System build() { return new DefaultSystem(this); } public SystemBuilder() { } } } File: SystemOpParam.java package org.onosproject.yang.gen.v1.http.acme.example.com.system.rev20070609.acmesystem; import org.onosproject.yang.gen.v1.http.acme.example.com.system.rev20070609.acmesystem.system.Login; import org.onosproject.yangutils.datamodel.YangAugmentedInfo; import org.onosproject.yangutils.datamodel.YangAugmentedOpParamInfo; import java.util.BitSet; public class SystemOpParam extends DefaultSystem { public static enum OperationType { MERGE, REPLACE, CREATE, DELETE, REMOVE } private OperationType opParamType; public OperationType getOpertionType() { return opParamType; } public boolean isFilterContentMatch(Object obj) { DefaultSystem appInstance = (DefaultSystem)obj; for (YangAugmentedInfo yangAugmentedInfo : this.getYangAugmentedInfoMap().values()) { if (!(yangAugmentedInfo instanceof YangAugmentedOpParamInfo)) { throw new IllegalArgumentException("provided augmented info is invalid for content match."); } YangAugmentedInfo yangAugmentedOpParamInfo = appInstance .getAugmentedInfo(((YangAugmentedOpParamInfo) yangAugmentedInfo).getBaseClass()); if(!((YangAugmentedOpParamInfo) yangAugmentedInfo).isFilterContentMatch(yangAugmentedOpParamInfo)) { return false; } } return true; } public SystemOpParam(SystemOpParamBuilder builderObject) { super(builderObject); } public class SystemOpParamBuilder extends DefaultSystem.SystemBuilder { private OperationType opParamType; public OperationType getOpertionType() { return opParamType; } public void setOpertionType(OperationType operationType) { this.opParamType = operationType; } } }
List
Overview
List is also like container that can hold many nodes by logically grouping. The only difference is, list can have multiple instances whereas container has only one instance.
Java mapping
In java, list acts as a class which can hold information contained within. A class of the list is formed only when list has nodes in it. In addition to that, list's parent holder will have list information by creating the list information in java List so that many instances of the class can be stored in it.
The list statement mapping in java is as same as container for the generation of java (refer container to know what files are generated).
In the below example the list holder is also a list with the same name. In such cases the complete path is defined for attribute in parent, in order to make sure that they are not referring to themselves. This case is same for any class generating YANG constructs.
Example
File : acme-system.yang module acme-system { namespace "http://acme.example.com/system"; prefix "acme"; organization "ACME Inc."; contact "joe@acme.example.com"; description "The module for entities implementing the ACME system."; revision 2007-06-09 { description "Initial revision."; } list login { key "name"; list login { key "name"; leaf name { type string; } leaf full-name { type string; } leaf class { type string; } } leaf name { type string; } } . . . }
File : Login.java package org.onosproject.yang.gen.v1.http.acme.example.com.system.rev20070609.acmesystem; import java.util.List; public interface Login { String name(); List<org.onosproject.yang.gen.v1.http.acme.example.com.system.rev20070609.acmesystem.login.Login> login(); interface LoginBuilder { String name(); List<org.onosproject.yang.gen.v1.http.acme.example.com.system.rev20070609.acmesystem.login.Login> login(); LoginBuilder name(String name); LoginBuilder login(List<org.onosproject.yang.gen.v1.http.acme.example.com.system.rev20070609.acmesystem .login .Login> login); Login build(); } } File : DefaultLogin.java package org.onosproject.yang.gen.v1.http.acme.example.com.system.rev20070609.acmesystem; import com.google.common.base.MoreObjects; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Objects; import org.onosproject.yangutils.datamodel.YangAugmentedInfo; public class DefaultLogin implements Login { private Map<Class<?>, YangAugmentedInfo> yangAugmentedInfoMap = new HashMap<>(); protected String name; protected List<org.onosproject.yang.gen.v1.http.acme.example.com.system.rev20070609.acmesystem.login.Login> login; @Override public String name() { return name; } @Override public List<org.onosproject.yang.gen.v1.http.acme.example.com.system.rev20070609.acmesystem.login.Login> login() { return login; } @Override public int hashCode() { return Objects.hash(name, login); } @Override public boolean equals(Object obj) { if (this == obj) { return true; } if (obj instanceof DefaultLogin) { DefaultLogin other = (DefaultLogin) obj; return Objects.equals(name, other.name) && Objects.equals(login, other.login); } return false; } @Override public String toString() { return MoreObjects.toStringHelper(getClass()) .add("name", name) .add("login", login) .toString(); } public DefaultLogin(LoginBuilder builderObject) { this.name = builderObject.name(); this.login = builderObject.login(); } public void addAugmentedInfo(YangAugmentedInfo value, Class classObject) { yangAugmentedInfoMap.put(classObject, value); } public YangAugmentedInfo getAugmentedInfo(Class classObject) { return yangAugmentedInfoMap.get(classObject); } public Map<Class<?>, YangAugmentedInfo> getYangAugmentedInfoMap() { return yangAugmentedInfoMap; } public class LoginBuilder implements Login.LoginBuilder { protected String name; protected List<org.onosproject.yang.gen.v1.http.acme.example.com.system.rev20070609.acmesystem.login .Login> login; @Override public String name() { return name; } @Override public List<org.onosproject.yang.gen.v1.http.acme.example.com.system.rev20070609.acmesystem.login .Login> login() { return login; } @Override public LoginBuilder name(String name) { this.name = name; return this; } @Override public LoginBuilder login(List<org.onosproject.yang.gen.v1.http.acme.example.com.system.rev20070609 .acmesystem .login.Login> login) { this.login = login; return this; } @Override public Login build() { return new DefaultLogin(this); } public LoginBuilder() { } } } File:LoginOpParam.java package org.onosproject.yang.gen.v1.http.acme.example.com.system.rev20070609.acmesystem; import java.util.List; import org.onosproject.yangutils.datamodel.YangAugmentedInfo; import org.onosproject.yangutils.datamodel.YangAugmentedOpParamInfo; import java.util.BitSet; public class LoginOpParam extends DefaultLogin { public static enum OperationType { MERGE, REPLACE, CREATE, DELETE, REMOVE } private OperationType opParamType; private BitSet filterLeafFlags = new BitSet(); private BitSet selectLeafFlags = new BitSet(); public BitSet getFilterLeafFlags() { return filterLeafFlags; } public BitSet getSelectLeafFlags() { return selectLeafFlags; } public OperationType getOpertionType() { return opParamType; } public boolean isFilterContentMatch(Object obj) { DefaultLogin appInstance = (DefaultLogin)obj; for (YangAugmentedInfo yangAugmentedInfo : this.getYangAugmentedInfoMap().values()) { if (!(yangAugmentedInfo instanceof YangAugmentedOpParamInfo)) { throw new IllegalArgumentException("provided augmented info is invalid for content match."); } YangAugmentedInfo yangAugmentedOpParamInfo = appInstance .getAugmentedInfo(((YangAugmentedOpParamInfo) yangAugmentedInfo).getBaseClass()); if(!((YangAugmentedOpParamInfo) yangAugmentedInfo).isFilterContentMatch(yangAugmentedOpParamInfo)) { return false; } } if (getFilterLeafFlags().get(1)) { if (appInstance.name() == null || !(name().equals(appInstance.name()))) { return false; } } return true; } public LoginOpParam(LoginOpParamBuilder builderObject) { super(builderObject); filterLeafFlags = builderObject.getFilterLeafFlags(); } public class LoginOpParamBuilder extends DefaultLogin.LoginBuilder { private OperationType opParamType; private BitSet filterLeafFlags = new BitSet(); private BitSet selectLeafFlags = new BitSet(); @Override public LoginBuilder name(String recvname) { name = recvname; getFilterLeafFlags().set(1); return this; } public BitSet getFilterLeafFlags() { return filterLeafFlags; } public BitSet getSelectLeafFlags() { return selectLeafFlags; } public OperationType getOpertionType() { return opParamType; } public void setOpertionType(OperationType operationType) { this.opParamType = operationType; } } }
Grouping and uses
Overview
Grouping the nodes together, for reusing them at many places, can be done in YANG. Grouping the nodes is done by grouping statement and using those grouped nodes at different places is done by uses statement.
Java mapping
During YANG to java conversion, the contents of grouping is copied wherever uses statement is used and code will be generated for nodes inside grouping wherever it is used.
Example
module Test { namespace "http://test.example.com/"; prefix "test"; organization "ACME Inc."; grouping endpoint { leaf address { type int32; } leaf port { type int8; } } container connection { container source { uses endpoint; } container destination { uses endpoint; } } . . . }
File : Connection.java package org.onosproject.yang.gen.v1.http.test.example.com.rev20160718.test; import org.onosproject.yang.gen.v1.http.test.example.com.rev20160718.test.connection.Source; public interface Connection { Source source(); interface ConnectionBuilder { Source source(); ConnectionBuilder source(Source source); Connection build(); } } File : Source.java package org.onosproject.yang.gen.v1.http.test.example.com.rev20160718.test.connection; public interface Source { int address(); byte port(); interface SourceBuilder { int address(); byte port(); SourceBuilder address(int address); SourceBuilder port(byte port); Source build(); } }
Choice and case
Overview
The choice statement defines a set of alternatives, only one of which may exist at any one time. The argument is an identifier, followed by a block of sub-statements that holds detailed choice information.
A choice consists of a number of branches, defined with the “case” substatement. Each branch contains a number of child nodes. The nodes from at most one of the choice's branches exist at the same time.
The case statement is used to define branches of the choice. It takes identifier as an argument, followed by a block of sub-statements that holds detailed case information.
JAVA mapping
Choice is mapped to interface(marker interface).
Case statement are mapped to the JAVA interfaces
It includes
Interface file which extends choice marker interface
Builder class which implements the builder interface and impl class which implements the interface
- Impl class includes overridden methods, hashcode, equals, toString methods.
- OpParam class File:
it inlcudes:
a) Operation types for restconf/netconf operations.
b) setter method for leaf and leaf list if present.
c) isFilterContentMatch() method for matching the contents if they are set in object or not.
d) setter and getter for bitset values of present leaves/leaf-lists.
Example
File : link.yang module link { yang-version 1; namespace http://huawei.com; prefix Ant; container link { choice interfaceType { case ethernerType { leaf ethernet { type string; } } case p2pType { leaf p2p { type string; } } } } }
File : InterfaceType.java package org.onosproject.yang.gen.v1.http.huawei.com.rev20160721.link.link; public interface InterfaceType { } File : EthernerType.java package org.onosproject.yang.gen.v1.http.huawei.com.rev20160721.link.link.interfacetype; import org.onosproject.yang.gen.v1.http.huawei.com.rev20160721.link.link.InterfaceType; public interface EthernerType extends InterfaceType { String ethernet(); interface EthernerTypeBuilder { String ethernet(); EthernerTypeBuilder ethernet(String ethernet); EthernerType build(); } } File : DefaultEthernerType.java package org.onosproject.yang.gen.v1.http.huawei.com.rev20160721.link.link.interfacetype; import com.google.common.base.MoreObjects; import java.util.HashMap; import java.util.Map; import java.util.Objects; import org.onosproject.yangutils.datamodel.YangAugmentedInfo; public class DefaultEthernerType implements EthernerType { private Map<Class<?>, YangAugmentedInfo> yangAugmentedInfoMap = new HashMap<>(); protected String ethernet; @Override public String ethernet() { return ethernet; } @Override public int hashCode() { return Objects.hash(ethernet); } @Override public boolean equals(Object obj) { if (this == obj) { return true; } if (obj instanceof DefaultEthernerType) { DefaultEthernerType other = (DefaultEthernerType) obj; return Objects.equals(ethernet, other.ethernet); } return false; } @Override public String toString() { return MoreObjects.toStringHelper(getClass()) .add("ethernet", ethernet) .toString(); } public DefaultEthernerType(EthernerTypeBuilder builderObject) { this.ethernet = builderObject.ethernet(); } public void addAugmentedInfo(YangAugmentedInfo value, Class classObject) { yangAugmentedInfoMap.put(classObject, value); } public YangAugmentedInfo getAugmentedInfo(Class classObject) { return yangAugmentedInfoMap.get(classObject); } public Map<Class<?>, YangAugmentedInfo> getYangAugmentedInfoMap() { return yangAugmentedInfoMap; } public class EthernerTypeBuilder implements EthernerType.EthernerTypeBuilder { protected String ethernet; @Override public String ethernet() { return ethernet; } @Override public EthernerTypeBuilder ethernet(String ethernet) { this.ethernet = ethernet; return this; } @Override public EthernerType build() { return new DefaultEthernerType(this); } public EthernerTypeBuilder() { } } } File:EthernerTypeOpParam.java package org.onosproject.yang.gen.v1.http.huawei.com.rev20160721.link.link.interfacetype; import org.onosproject.yangutils.datamodel.YangAugmentedInfo; import org.onosproject.yangutils.datamodel.YangAugmentedOpParamInfo; import java.util.BitSet; public class EthernerTypeOpParam extends DefaultEthernerType { public static enum OperationType { MERGE, REPLACE, CREATE, DELETE, REMOVE } private OperationType opParamType; private BitSet filterLeafFlags = new BitSet(); private BitSet selectLeafFlags = new BitSet(); public BitSet getFilterLeafFlags() { return filterLeafFlags; } public BitSet getSelectLeafFlags() { return selectLeafFlags; } public OperationType getOpertionType() { return opParamType; } public boolean isFilterContentMatch(Object obj) { DefaultEthernerType appInstance = (DefaultEthernerType)obj; for (YangAugmentedInfo yangAugmentedInfo : this.getYangAugmentedInfoMap().values()) { if (!(yangAugmentedInfo instanceof YangAugmentedOpParamInfo)) { throw new IllegalArgumentException("provided augmented info is invalid for content match."); } YangAugmentedInfo yangAugmentedOpParamInfo = appInstance .getAugmentedInfo(((YangAugmentedOpParamInfo) yangAugmentedInfo).getBaseClass()); if(!((YangAugmentedOpParamInfo) yangAugmentedInfo).isFilterContentMatch(yangAugmentedOpParamInfo)) { return false; } } if (getFilterLeafFlags().get(1)) { if (appInstance.ethernet() == null || !(ethernet().equals(appInstance.ethernet()))) { return false; } } return true; } public EthernerTypeOpParam(EthernerTypeOpParamBuilder builderObject) { super(builderObject); filterLeafFlags = builderObject.getFilterLeafFlags(); } public class EthernerTypeOpParamBuilder extends DefaultEthernerType.EthernerTypeBuilder { private OperationType opParamType; private BitSet filterLeafFlags = new BitSet(); private BitSet selectLeafFlags = new BitSet(); @Override public EthernerTypeBuilder ethernet(String recvethernet) { ethernet = recvethernet; getFilterLeafFlags().set(1); return this; } public BitSet getFilterLeafFlags() { return filterLeafFlags; } public BitSet getSelectLeafFlags() { return selectLeafFlags; } public OperationType getOpertionType() { return opParamType; } public void setOpertionType(OperationType operationType) { this.opParamType = operationType; } } }
RPC
Overview
RPCs are modeled with RPC statement. The input statement is used to define input parameters to the RPC and output statement is used to define output parameters to the RPC.
JAVA mapping
Rpc statement is mapped to a method in module manager class and service interface.
The generated method will depends on the sub statements input and output. Input and Output will have there own java classes and RPC method will contain Output class's object as return type and Input class's object will be input for the method. If no output node is present , return type will be "void". Same way if no input is present , there will be no input parameter for the method.
Example
File: sfc.yang module Sfc { yang-version 1; namespace http://huawei.com; prefix Ant; rpc SFP { input { leaf port { type string; } } output { leaf path { type string; } } } }
File : SfcService.java package org.onosproject.yang.gen.v1.http.huawei.com.rev20160721; import org.onosproject.yang.gen.v1.http.huawei.com.rev20160721.sfc.sfp.SfpInput; import org.onosproject.yang.gen.v1.http.huawei.com.rev20160721.sfc.sfp.SfpOutput; public interface SfcService { Sfc getSfc(); void setSfc(Sfc sfc); SfpOutput sfp(SfpInput inputVar); } File : SfcManager.java package org.onosproject.yang.gen.v1.http.huawei.com.rev20160721; import org.apache.felix.scr.annotations.Activate; import org.apache.felix.scr.annotations.Component; import org.apache.felix.scr.annotations.Deactivate; import org.apache.felix.scr.annotations.Service; import org.onosproject.yang.gen.v1.http.huawei.com.rev20160721.sfc.sfp.SfpInput; import org.onosproject.yang.gen.v1.http.huawei.com.rev20160721.sfc.sfp.SfpOutput; import org.slf4j.Logger; import static org.slf4j.LoggerFactory.getLogger; @Component(immediate = true) @Service public class SfcManager implements SfcService { private final Logger log = getLogger(getClass()); @Activate public void activate() { //TODO: YANG utils generated code log.info("Started"); } @Deactivate public void deactivate() { //TODO: YANG utils generated code log.info("Stopped"); } @Override public Sfc getSfc() { //TODO: YANG utils generated code return null; } @Override public void setSfc(Sfc sfc) { //TODO: YANG utils generated code } @Override public SfpOutput sfp(SfpInput inputVar) { //TODO: YANG utils generated code return null; } } File : SfpInput.java package org.onosproject.yang.gen.v1.http.huawei.com.rev20160721.sfc.sfp; public interface SfpInput { String port(); interface SfpInputBuilder { String port(); SfpInputBuilder port(String port); SfpInput build(); } } File : DefaultSfpInput.java package org.onosproject.yang.gen.v1.http.huawei.com.rev20160721.sfc.sfp; import com.google.common.base.MoreObjects; import java.util.HashMap; import java.util.Map; import java.util.Objects; import org.onosproject.yangutils.datamodel.YangAugmentedInfo; public class DefaultSfpInput implements SfpInput { private Map<Class<?>, YangAugmentedInfo> yangAugmentedInfoMap = new HashMap<>(); protected String port; @Override public String port() { return port; } @Override public int hashCode() { return Objects.hash(port); } @Override public boolean equals(Object obj) { if (this == obj) { return true; } if (obj instanceof DefaultSfpInput) { DefaultSfpInput other = (DefaultSfpInput) obj; return Objects.equals(port, other.port); } return false; } @Override public String toString() { return MoreObjects.toStringHelper(getClass()) .add("port", port) .toString(); } public DefaultSfpInput(SfpInputBuilder builderObject) { this.port = builderObject.port(); } public void addAugmentedInfo(YangAugmentedInfo value, Class classObject) { yangAugmentedInfoMap.put(classObject, value); } public YangAugmentedInfo getAugmentedInfo(Class classObject) { return yangAugmentedInfoMap.get(classObject); } public Map<Class<?>, YangAugmentedInfo> getYangAugmentedInfoMap() { return yangAugmentedInfoMap; } public class SfpInputBuilder implements SfpInput.SfpInputBuilder { protected String port; @Override public String port() { return port; } @Override public SfpInputBuilder port(String port) { this.port = port; return this; } @Override public SfpInput build() { return new DefaultSfpInput(this); } public SfpInputBuilder() { } } } File: SfpInputOpParam.java package org.onosproject.yang.gen.v1.http.huawei.com.rev20160721.sfc.sfp; import org.onosproject.yangutils.datamodel.YangAugmentedInfo; import org.onosproject.yangutils.datamodel.YangAugmentedOpParamInfo; import java.util.BitSet; public class SfpInputOpParam extends DefaultSfpInput { public static enum OperationType { MERGE, REPLACE, CREATE, DELETE, REMOVE } private OperationType opParamType; private BitSet filterLeafFlags = new BitSet(); private BitSet selectLeafFlags = new BitSet(); public BitSet getFilterLeafFlags() { return filterLeafFlags; } public BitSet getSelectLeafFlags() { return selectLeafFlags; } public OperationType getOpertionType() { return opParamType; } public boolean isFilterContentMatch(Object obj) { DefaultSfpInput appInstance = (DefaultSfpInput)obj; for (YangAugmentedInfo yangAugmentedInfo : this.getYangAugmentedInfoMap().values()) { if (!(yangAugmentedInfo instanceof YangAugmentedOpParamInfo)) { throw new IllegalArgumentException("provided augmented info is invalid for content match."); } YangAugmentedInfo yangAugmentedOpParamInfo = appInstance .getAugmentedInfo(((YangAugmentedOpParamInfo) yangAugmentedInfo).getBaseClass()); if(!((YangAugmentedOpParamInfo) yangAugmentedInfo).isFilterContentMatch(yangAugmentedOpParamInfo)) { return false; } } if (getFilterLeafFlags().get(1)) { if (appInstance.port() == null || !(port().equals(appInstance.port()))) { return false; } } return true; } public SfpInputOpParam(SfpInputOpParamBuilder builderObject) { super(builderObject); filterLeafFlags = builderObject.getFilterLeafFlags(); } public class SfpInputOpParamBuilder extends DefaultSfpInput.SfpInputBuilder { private OperationType opParamType; private BitSet filterLeafFlags = new BitSet(); private BitSet selectLeafFlags = new BitSet(); @Override public SfpInputBuilder port(String recvport) { port = recvport; getFilterLeafFlags().set(1); return this; } public BitSet getFilterLeafFlags() { return filterLeafFlags; } public BitSet getSelectLeafFlags() { return selectLeafFlags; } public OperationType getOpertionType() { return opParamType; } public void setOpertionType(OperationType operationType) { this.opParamType = operationType; } } } File : Sfpoutput.java package org.onosproject.yang.gen.v1.http.huawei.com.rev20160721.sfc.sfp; public interface SfpOutput { String path(); interface SfpOutputBuilder { String path(); SfpOutputBuilder path(String path); SfpOutput build(); } } File : DefaultSfpOutput.java package org.onosproject.yang.gen.v1.http.huawei.com.rev20160721.sfc.sfp; import com.google.common.base.MoreObjects; import java.util.HashMap; import java.util.Map; import java.util.Objects; import org.onosproject.yangutils.datamodel.YangAugmentedInfo; public class DefaultSfpOutput implements SfpOutput { private Map<Class<?>, YangAugmentedInfo> yangAugmentedInfoMap = new HashMap<>(); protected String path; @Override public String path() { return path; } @Override public int hashCode() { return Objects.hash(path); } @Override public boolean equals(Object obj) { if (this == obj) { return true; } if (obj instanceof DefaultSfpOutput) { DefaultSfpOutput other = (DefaultSfpOutput) obj; return Objects.equals(path, other.path); } return false; } @Override public String toString() { return MoreObjects.toStringHelper(getClass()) .add("path", path) .toString(); } public DefaultSfpOutput(SfpOutputBuilder builderObject) { this.path = builderObject.path(); } public void addAugmentedInfo(YangAugmentedInfo value, Class classObject) { yangAugmentedInfoMap.put(classObject, value); } public YangAugmentedInfo getAugmentedInfo(Class classObject) { return yangAugmentedInfoMap.get(classObject); } public Map<Class<?>, YangAugmentedInfo> getYangAugmentedInfoMap() { return yangAugmentedInfoMap; } public class SfpOutputBuilder implements SfpOutput.SfpOutputBuilder { protected String path; @Override public String path() { return path; } @Override public SfpOutputBuilder path(String path) { this.path = path; return this; } @Override public SfpOutput build() { return new DefaultSfpOutput(this); } public SfpOutputBuilder() { } } } File: SfpOutputOpParam.java package org.onosproject.yang.gen.v1.http.huawei.com.rev20160721.sfc.sfp; import org.onosproject.yangutils.datamodel.YangAugmentedInfo; import org.onosproject.yangutils.datamodel.YangAugmentedOpParamInfo; import java.util.BitSet; public class SfpOutputOpParam extends DefaultSfpOutput { public static enum OperationType { MERGE, REPLACE, CREATE, DELETE, REMOVE } private OperationType opParamType; private BitSet filterLeafFlags = new BitSet(); private BitSet selectLeafFlags = new BitSet(); public BitSet getFilterLeafFlags() { return filterLeafFlags; } public BitSet getSelectLeafFlags() { return selectLeafFlags; } public OperationType getOpertionType() { return opParamType; } public boolean isFilterContentMatch(Object obj) { DefaultSfpOutput appInstance = (DefaultSfpOutput)obj; for (YangAugmentedInfo yangAugmentedInfo : this.getYangAugmentedInfoMap().values()) { if (!(yangAugmentedInfo instanceof YangAugmentedOpParamInfo)) { throw new IllegalArgumentException("provided augmented info is invalid for content match."); } YangAugmentedInfo yangAugmentedOpParamInfo = appInstance .getAugmentedInfo(((YangAugmentedOpParamInfo) yangAugmentedInfo).getBaseClass()); if(!((YangAugmentedOpParamInfo) yangAugmentedInfo).isFilterContentMatch(yangAugmentedOpParamInfo)) { return false; } } if (getFilterLeafFlags().get(1)) { if (appInstance.path() == null || !(path().equals(appInstance.path()))) { return false; } } return true; } public SfpOutputOpParam(SfpOutputOpParamBuilder builderObject) { super(builderObject); filterLeafFlags = builderObject.getFilterLeafFlags(); } public class SfpOutputOpParamBuilder extends DefaultSfpOutput.SfpOutputBuilder { private OperationType opParamType; private BitSet filterLeafFlags = new BitSet(); private BitSet selectLeafFlags = new BitSet(); @Override public SfpOutputBuilder path(String recvpath) { path = recvpath; getFilterLeafFlags().set(1); return this; } public BitSet getFilterLeafFlags() { return filterLeafFlags; } public BitSet getSelectLeafFlags() { return selectLeafFlags; } public OperationType getOpertionType() { return opParamType; } public void setOpertionType(OperationType operationType) { this.opParamType = operationType; } } }
Notification
Overview
The "notification" statement is used to define a notification. It takes one argument, which is an identifier, followed by a block of substatements that holds detailed notification information.
JAVA mapping
Notification is mapped to events and event listeners in ONOS. Events are used by Managers to notify its listeners about changes in the network, and by Stores to notify their peers of events in a distributed setting. An Event is comprised of a event type and a subject built of model objects.
When notification statement is present in YANG, an event class , event subject class, event listener interface and notification interface and builder will be generated.
When multiple notifications are present event class include the an enum with types of events for all notification like DEVICE_ADDED, DEVICE_REMOVED and it extends AbstractEvent with event type and event subject class. It is used to notify EventListeners about the event.
Event Subject class will have all the objects of events for multiple notifications and getters and setters for the events.
Event Listener is interface which extends EventListener.
Manager Extends ListenerRegistry with event and eventListener.
Example
File : ospf.yang module ospf { namespace "http://example.com/ospf"; prefix "ospf"; notification test { leaf event-class { type string; } leaf severity { type string; } } }
File : OspfManager.java package org.onosproject.yang.gen.v1.http.example.com.ospf.rev20160721; import org.apache.felix.scr.annotations.Activate; import org.apache.felix.scr.annotations.Component; import org.apache.felix.scr.annotations.Deactivate; import org.apache.felix.scr.annotations.Service; import org.onosproject.event.ListenerRegistry; import org.onosproject.yang.gen.v1.http.example.com.ospf.rev20160721.ospf.OspfEvent; import org.onosproject.yang.gen.v1.http.example.com.ospf.rev20160721.ospf.OspfEventListener; import org.slf4j.Logger; import static org.slf4j.LoggerFactory.getLogger; @Component(immediate = true) @Service public class OspfManager extends ListenerRegistry<OspfEvent, OspfEventListener> implements OspfService { private final Logger log = getLogger(getClass()); @Activate public void activate() { //TODO: YANG utils generated code log.info("Started"); } @Deactivate public void deactivate() { //TODO: YANG utils generated code log.info("Stopped"); } @Override public Ospf getOspf() { //TODO: YANG utils generated code return null; } @Override public void setOspf(Ospf ospf) { //TODO: YANG utils generated code } } File : OspfService.java package org.onosproject.yang.gen.v1.http.example.com.ospf.rev20160721; import org.onosproject.event.ListenerService; import org.onosproject.yang.gen.v1.http.example.com.ospf.rev20160721.ospf.OspfEvent; import org.onosproject.yang.gen.v1.http.example.com.ospf.rev20160721.ospf.OspfEventListener; public interface OspfService extends ListenerService<OspfEvent, OspfEventListener> { Ospf getOspf(); void setOspf(Ospf ospf); } File : OspfEvent.java package org.onosproject.yang.gen.v1.http.example.com.ospf.rev20160527.ospf; import org.onosproject.event.AbstractEvent; public class OspfEvent extends AbstractEvent<OspfEvent.Type, OspfEventSubject> { public enum Type { TEST } public OspfEvent(Type type, OspfEventSubject subject) { super(type, subject); } public OspfEvent(Type type, OspfEventSubject subject, long time) { super(type, subject, time); } } File : OspfEventSubject.java package org.onosproject.yang.gen.v1.http.example.com.ospf.rev20160519.ospf; public class OspfEventSubject { private Test test; public Test test() { return test; } public void test(Test test) { this.test = test; } } File : OspfEventListener.java package org.onosproject.yang.gen.v1.http.example.com.ospf.rev20160519.ospf; import org.onosproject.event.EventListener; public interface OspfEventListener extends EventListener<OspfEvent> { } File : Test.java package org.onosproject.yang.gen.v1.http.example.com.ospf.rev20160721.ospf; public interface Test { String eventClass(); String severity(); interface TestBuilder { String eventClass(); String severity(); TestBuilder eventClass(String eventClass); TestBuilder severity(String severity); Test build(); } } File : DefaultTest.java package org.onosproject.yang.gen.v1.http.example.com.ospf.rev20160721.ospf; import com.google.common.base.MoreObjects; import java.util.HashMap; import java.util.Map; import java.util.Objects; import org.onosproject.yangutils.datamodel.YangAugmentedInfo; public class DefaultTest implements Test { private Map<Class<?>, YangAugmentedInfo> yangAugmentedInfoMap = new HashMap<>(); protected String eventClass; protected String severity; @Override public String eventClass() { return eventClass; } @Override public String severity() { return severity; } @Override public int hashCode() { return Objects.hash(eventClass, severity); } @Override public boolean equals(Object obj) { if (this == obj) { return true; } if (obj instanceof DefaultTest) { DefaultTest other = (DefaultTest) obj; return Objects.equals(eventClass, other.eventClass) && Objects.equals(severity, other.severity); } return false; } @Override public String toString() { return MoreObjects.toStringHelper(getClass()) .add("eventClass", eventClass) .add("severity", severity) .toString(); } public DefaultTest(TestBuilder builderObject) { this.eventClass = builderObject.eventClass(); this.severity = builderObject.severity(); } public void addAugmentedInfo(YangAugmentedInfo value, Class classObject) { yangAugmentedInfoMap.put(classObject, value); } public YangAugmentedInfo getAugmentedInfo(Class classObject) { return yangAugmentedInfoMap.get(classObject); } public Map<Class<?>, YangAugmentedInfo> getYangAugmentedInfoMap() { return yangAugmentedInfoMap; } public class TestBuilder implements Test.TestBuilder { protected String eventClass; protected String severity; @Override public String eventClass() { return eventClass; } @Override public String severity() { return severity; } @Override public TestBuilder eventClass(String eventClass) { this.eventClass = eventClass; return this; } @Override public TestBuilder severity(String severity) { this.severity = severity; return this; } @Override public Test build() { return new DefaultTest(this); } public TestBuilder() { } } } File:TestOpParam.java package org.onosproject.yang.gen.v1.http.example.com.ospf.rev20160721.ospf; import org.onosproject.yangutils.datamodel.YangAugmentedInfo; import org.onosproject.yangutils.datamodel.YangAugmentedOpParamInfo; import java.util.BitSet; public class TestOpParam extends DefaultTest { public static enum OperationType { MERGE, REPLACE, CREATE, DELETE, REMOVE } private OperationType opParamType; private BitSet filterLeafFlags = new BitSet(); private BitSet selectLeafFlags = new BitSet(); public BitSet getFilterLeafFlags() { return filterLeafFlags; } public BitSet getSelectLeafFlags() { return selectLeafFlags; } public OperationType getOpertionType() { return opParamType; } public boolean isFilterContentMatch(Object obj) { DefaultTest appInstance = (DefaultTest)obj; for (YangAugmentedInfo yangAugmentedInfo : this.getYangAugmentedInfoMap().values()) { if (!(yangAugmentedInfo instanceof YangAugmentedOpParamInfo)) { throw new IllegalArgumentException("provided augmented info is invalid for content match."); } YangAugmentedInfo yangAugmentedOpParamInfo = appInstance .getAugmentedInfo(((YangAugmentedOpParamInfo) yangAugmentedInfo).getBaseClass()); if(!((YangAugmentedOpParamInfo) yangAugmentedInfo).isFilterContentMatch(yangAugmentedOpParamInfo)) { return false; } } if (getFilterLeafFlags().get(1)) { if (appInstance.eventClass() == null || !(eventClass().equals(appInstance.eventClass()))) { return false; } } if (getFilterLeafFlags().get(2)) { if (appInstance.severity() == null || !(severity().equals(appInstance.severity()))) { return false; } } return true; } public TestOpParam(TestOpParamBuilder builderObject) { super(builderObject); filterLeafFlags = builderObject.getFilterLeafFlags(); } public class TestOpParamBuilder extends DefaultTest.TestBuilder { private OperationType opParamType; private BitSet filterLeafFlags = new BitSet(); private BitSet selectLeafFlags = new BitSet(); @Override public TestBuilder eventClass(String recveventClass) { eventClass = recveventClass; getFilterLeafFlags().set(1); return this; } @Override public TestBuilder severity(String recvseverity) { severity = recvseverity; getFilterLeafFlags().set(2); return this; } public BitSet getFilterLeafFlags() { return filterLeafFlags; } public BitSet getSelectLeafFlags() { return selectLeafFlags; } public OperationType getOpertionType() { return opParamType; } public void setOpertionType(OperationType operationType) { this.opParamType = operationType; } } }
Augment
Overview
Augment means “make (something) greater by adding to it; increase.” in YANG augment adds some information in target node. Here in YANG, container, list, choice, case, input, output, or notification node can come as a target node.
As the child node of augment node only "container", "leaf", "list", "leaf-list", "uses", and "choice" can come. If augment comes under a module or submodule.
If a target node is a choice node the "case" statement, or a case shorthand statement can be come as a child node of augment node.
If a target node is from some other YANG file than a mandatory node which is is one of:
A leaf, choice, or anyxml node with a "mandatory" statement with the value "true".
A list or leaf-list node with a "min-elements" statement with a value greater than zero.
A container node without a "presence" statement, which has at least one mandatory node as a child.
should not come as a child node of augment node.
A augment node can't add the same augmented info to an augmented node multiple times.
Java mapping
For a given augment node in the YANG file one interface file and one builder class file will be generated. Generated files will be having attributes, getters and setters for augment node's child nodes and leaf or leaf-list.
For augment we have given one interface named as "YangAugmentedInfo” as part of YANG utils plugin.
File generated for augment node will be implementing AugmentedInfo class.
Node in data model tree which can be augmented as per the YANG rules for them we have given 3 methods , which are :
public void addAugmentedInfo(YangAugmentedInfo value, Class classObject) { yangAugmentedInfoMap.put(classObject, value); } public YangAugmentedInfo getAugmentedInfo(Class classObject) { return yangAugmentedInfoMap.get(classObject); } public Map<Class<?>, YangAugmentedInfo> getYangAugmentedInfoMap() { return yangAugmentedInfoMap; }
these methods will be providing augmentation functionalities for augmentable nodes. These class will be storing augmentedInfo , which is nothing but a augment node which are augmenting this node. Also we have provides one code snippet in OpParam file which checks if augmented info is set or not in IsFilterMatchMethod().
OpParam file will extend "YangAugmentedOpParamInfo" interface provides by YangUtils.
Example
File : Test.yang module Test { yang-version 1; namespace "http://huawei.com"; prefix Ant; description "Interval before a route is declared invalid"; container interface { leaf ifType { type string; } } augment "/interface" { leaf ds0ChannelNumber { type int16; } } }
File: TestService.java package org.onosproject.yang.gen.v1.http.huawei.com.rev20160721; public interface TestService { Test getTest(); void setTest(Test test); Test getAugmentedTestYangAutoPrefixInterface(); void setAugmentedTestYangAutoPrefixInterface(Test augmentedTestYangAutoPrefixInterface); } File: TestManager.java package org.onosproject.yang.gen.v1.http.huawei.com.rev20160721; import org.apache.felix.scr.annotations.Activate; import org.apache.felix.scr.annotations.Component; import org.apache.felix.scr.annotations.Deactivate; import org.apache.felix.scr.annotations.Service; import org.slf4j.Logger; import static org.slf4j.LoggerFactory.getLogger; @Component(immediate = true) @Service public class TestManager implements TestService { private final Logger log = getLogger(getClass()); @Activate public void activate() { //TODO: YANG utils generated code log.info("Started"); } @Deactivate public void deactivate() { //TODO: YANG utils generated code log.info("Stopped"); } @Override public Test getTest() { //TODO: YANG utils generated code return null; } @Override public void setTest(Test test) { //TODO: YANG utils generated code } @Override public Test getAugmentedTestYangAutoPrefixInterface() { //TODO: YANG utils generated code return null; } @Override public void setAugmentedTestYangAutoPrefixInterface(Test augmentedTestYangAutoPrefixInterface) { //TODO: YANG utils generated code } } File : AugmentedYangAutoPrefixInterface.java package org.onosproject.yang.gen.v1.http.huawei.com.rev20160721.test; import org.onosproject.yangutils.datamodel.YangAugmentedInfo; public interface AugmentedYangAutoPrefixInterface extends YangAugmentedInfo { short ds0ChannelNumber(); interface AugmentedYangAutoPrefixInterfaceBuilder { short ds0ChannelNumber(); AugmentedYangAutoPrefixInterfaceBuilder ds0ChannelNumber(short ds0ChannelNumber); AugmentedYangAutoPrefixInterface build(); } } File : DefaultAugmentedYangAutoPrefixInterface.java package org.onosproject.yang.gen.v1.http.huawei.com.rev20160721.test; import com.google.common.base.MoreObjects; import java.util.Objects; public class DefaultAugmentedYangAutoPrefixInterface implements AugmentedYangAutoPrefixInterface { protected short ds0ChannelNumber; @Override public short ds0ChannelNumber() { return ds0ChannelNumber; } @Override public int hashCode() { return Objects.hash(ds0ChannelNumber); } @Override public boolean equals(Object obj) { if (this == obj) { return true; } if (obj instanceof DefaultAugmentedYangAutoPrefixInterface) { DefaultAugmentedYangAutoPrefixInterface other = (DefaultAugmentedYangAutoPrefixInterface) obj; return Objects.equals(ds0ChannelNumber, other.ds0ChannelNumber); } return false; } @Override public String toString() { return MoreObjects.toStringHelper(getClass()) .add("ds0ChannelNumber", ds0ChannelNumber) .toString(); } public DefaultAugmentedYangAutoPrefixInterface(AugmentedYangAutoPrefixInterfaceBuilder builderObject) { this.ds0ChannelNumber = builderObject.ds0ChannelNumber(); } public class AugmentedYangAutoPrefixInterfaceBuilder implements AugmentedYangAutoPrefixInterface .AugmentedYangAutoPrefixInterfaceBuilder { protected short ds0ChannelNumber; @Override public short ds0ChannelNumber() { return ds0ChannelNumber; } @Override public AugmentedYangAutoPrefixInterfaceBuilder ds0ChannelNumber(short ds0ChannelNumber) { this.ds0ChannelNumber = ds0ChannelNumber; return this; } @Override public AugmentedYangAutoPrefixInterface build() { return new DefaultAugmentedYangAutoPrefixInterface(this); } public AugmentedYangAutoPrefixInterfaceBuilder() { } } } File:AugmentedYangAutoPrefixInterfaceOpParam.java package org.onosproject.yang.gen.v1.http.huawei.com.rev20160721.test; import java.util.BitSet; import org.onosproject.yangutils.datamodel.YangAugmentedOpParamInfo; public class AugmentedYangAutoPrefixInterfaceOpParam extends DefaultAugmentedYangAutoPrefixInterface implements YangAugmentedOpParamInfo { public static enum OperationType { MERGE, REPLACE, CREATE, DELETE, REMOVE } private OperationType opParamType; private BitSet filterLeafFlags = new BitSet(); private BitSet selectLeafFlags = new BitSet(); public BitSet getFilterLeafFlags() { return filterLeafFlags; } public BitSet getSelectLeafFlags() { return selectLeafFlags; } public OperationType getOpertionType() { return opParamType; } public boolean isFilterContentMatch(Object obj) { DefaultAugmentedYangAutoPrefixInterface appInstance = (DefaultAugmentedYangAutoPrefixInterface)obj; if (getFilterLeafFlags().get(1)) { if (appInstance.ds0ChannelNumber() != ds0ChannelNumber()) { return false; } } return true; } public AugmentedYangAutoPrefixInterfaceOpParam(AugmentedYangAutoPrefixInterfaceOpParamBuilder builderObject) { super(builderObject); filterLeafFlags = builderObject.getFilterLeafFlags(); } @Override public Class<?> getBaseClass() { return DefaultAugmentedYangAutoPrefixInterface.class; } public class AugmentedYangAutoPrefixInterfaceOpParamBuilder extends DefaultAugmentedYangAutoPrefixInterface .AugmentedYangAutoPrefixInterfaceBuilder { private OperationType opParamType; private BitSet filterLeafFlags = new BitSet(); private BitSet selectLeafFlags = new BitSet(); @Override public AugmentedYangAutoPrefixInterfaceBuilder ds0ChannelNumber(short recvds0ChannelNumber) { ds0ChannelNumber = recvds0ChannelNumber; getFilterLeafFlags().set(1); return this; } public BitSet getFilterLeafFlags() { return filterLeafFlags; } public BitSet getSelectLeafFlags() { return selectLeafFlags; } public OperationType getOpertionType() { return opParamType; } public void setOpertionType(OperationType operationType) { this.opParamType = operationType; } } }
Type
Overview
The "type" statement takes as an argument a string that is the name of a YANG built-in type or a derived type, followed by an optional block of sub statements that are used to put further restrictions on the type.
Java mapping
YANG | Description | JAVA |
---|---|---|
binary | Any binary data | To be implemented |
bits | A set of bits or flags | To be implemented |
boolean | "True" or "false" | boolean |
decimal64 | 64-bit signed decimal number | To be implemented |
empty | A leaf that does not have any value | boolean |
enumeration | Enumerated strings | Enum class will be generated |
identityref | A reference to an abstract identity | To be implemented |
instance-identifier | References a data tree node | String |
int8 | 8-bit signed integer | byte |
int16 | 16-bit signed integer | short |
int32 | 32-bit signed integer | int |
int64 | 64-bit signed integer | long |
leafref | A reference to a leaf instance | The type of referenced leaf/leaf-list will be used |
string | Human-readable string | String |
uint8 | 8-bit unsigned integer | short |
uint16 | 16-bit unsigned integer | int |
uint32 | 32-bit unsigned integer | long |
uint64 | 64-bit unsigned integer | BigInteger |
union | Choice of member types | Union class will be generated |
Example
leaf one { type string; } leaf two { type int32; } leaf-list three { type boolean; } leaf-list four { type int16; }
private String one; private int two; private List<Boolean> three; private List<Short> four;
Typedef
Overview
Typedef is user defined type for his implementation. It has the base type which is must for typedef. To give more information about the typedef there should be sub statements to describe it. Unit statement is optional for typedef which give info about the unit of the type. Default is like a value which will be assigned to the typedef if no value is given.default value should follow all restriction defined for the base-type.
Java mapping
For a given typedef node one class file will be generated which will have an attribute with the base type of typedef. There will be a constructor and a getter method, of method and implementation of hashcode, equals and toString methods.
Example
File : test.yang module test { yang-version 1; namespace "http://huawei.com"; prefix "test"; typedef percent { type uint8; description "Percentage"; } leaf completed { type percent; } }
File : Percent.java package org.onosproject.yang.gen.v1.http.huawei.com.rev20160526.test; import java.util.Objects; import com.google.common.base.MoreObjects; public final class Percent { private short uint8; private Percent() { } public Percent(short value) { this.uint8 = value; } public static Percent of(short value) { return new Percent(value); } public short uint8() { return uint8; } @Override public int hashCode() { return Objects.hash(uint8); } @Override public boolean equals(Object obj) { if (this == obj) { return true; } if (obj instanceof Percent) { Percent other = (Percent) obj; return Objects.equals(uint8, other.uint8); } return false; } @Override public String toString() { return MoreObjects.toStringHelper(getClass()) .add("uint8", uint8) .toString(); } public static Percent fromString(String valInString) { try { short tmpVal = Short.parseShort(valInString); return of(tmpVal); } catch (Exception e) { } return null; } }
Enumeration
Overview
Enum statement only can come when a leaf is of type enumeration. Each enum has one string then should be unique . The string must not be empty string and must not have white spaces. Enum can have sub statements, value statement will give the info about its value. If the enum statement in enumeration has no value statement then its value is considered as zero and subsequently incremented by one for next values.
Java mapping
For a given enumeration node one enum file will be generated which will have all the enum as its attributes. There will be a constructor and a getter method for the values.
Example
File: test.yang module Test { yang-version 1; namespace "http://huawei.com"; prefix Ant; description "Interval before a route is declared invalid"; leaf packetType { type enumeration { enum "unbounded"; enum ZERO; enum two; enum four; } } }
File : PacketTypeEnum.java package org.onosproject.yang.gen.v1.http.huawei.com.rev20160526.test; public enum PacketTypeEnum { UNBOUNDED(0), ZERO(1), TWO(2), FOUR(3); private int packetTypeEnum; PacketTypeEnum(int value) { packetTypeEnum = value; } public static PacketTypeEnum of(int value) { switch (value) { case 0: return PacketTypeEnum.UNBOUNDED; case 1: return PacketTypeEnum.ZERO; case 2: return PacketTypeEnum.TWO; case 3: return PacketTypeEnum.FOUR; default : return null; } } public int packetTypeEnum() { return packetTypeEnum; } public static PacketTypeEnum fromString(String valInString) { try { int tmpVal = Integer.parseInt(valInString); return of(tmpVal); } catch (Exception e) { } return null; } }
Union
Overview
Union is a built in type which represents its member types. Union can have multiple member types. To use union there must be a type statement. Except empty and leafref all types can come under union.
When a value comes for union , which can match to multiple member types of union, then in that case to whichever type value matches from the member types defined in union value, will be taken from union as the values type.
Java mapping
For a given union node one class file will be generated which will have all the an attribute with the type union is having. There will be a constructor , getter method, of method, fromString, HashCode, equals and ToString methods for the values.
Example
File : test.yang module test { yang-version 1; namespace "http://huawei.com"; prefix "test"; typedef ip-address { type union { type int32; type uint32; } } }
File : IpAddressUnion.java package org.onosproject.yang.gen.v1.http.huawei.com.rev20160526.test.ipaddress; import java.util.Objects; import com.google.common.base.MoreObjects; public final class IpAddressUnion { private int int32; private long uint32; private IpAddressUnion() { } public IpAddressUnion(int value) { this.int32 = value; } public IpAddressUnion(long value) { this.uint32 = value; } public static IpAddressUnion of(int value) { return new IpAddressUnion(value); } public static IpAddressUnion of(long value) { return new IpAddressUnion(value); } public int int32() { return int32; } public long uint32() { return uint32; } @Override public int hashCode() { return Objects.hash(int32, uint32); } @Override public boolean equals(Object obj) { if (this == obj) { return true; } if (obj instanceof IpAddressUnion) { IpAddressUnion other = (IpAddressUnion) obj; return Objects.equals(int32, other.int32) && Objects.equals(uint32, other.uint32); } return false; } @Override public String toString() { return MoreObjects.toStringHelper(getClass()) .omitNullValues() .add("int32", int32) .add("uint32", uint32) .toString(); } public static IpAddressUnion fromString(String valInString) { try { int tmpVal = Integer.parseInt(valInString); return of(tmpVal); } catch (Exception e) { } try { long tmpVal = Long.parseLong(valInString); return of(tmpVal); } catch (Exception e) { } return null; } }
When there are two types with same java mapping. for resolving this conflict we will be checking the range of the value and then we will assign it to the right attribute. Order will be taken care of while code generation and conflict range validation . for example : if union have type int32 followed by uint16, then range validation will be done on basis of int32 , in other case range will be validated on basis of uint16.
File : test.yang module test { yang-version 1; namespace "http://huawei.com"; prefix "test"; typedef ip-address { type union { type int32; type uint16; type int64; type uint32; type string; } } }
File : IpAddressUnion.java package org.onosproject.yang.gen.v1.http.huawei.com.rev20160721.test.ipaddress; import com.google.common.base.MoreObjects; import java.math.BigInteger; import java.util.Objects; public final class IpAddressUnion { private static final int INT32_MIN_RANGE = -2147483648; private static final int INT32_MAX_RANGE = 2147483647; private static final BigInteger INT64_MIN_RANGE = new BigInteger("-9223372036854775808"); private static final BigInteger INT64_MAX_RANGE = new BigInteger("9223372036854775807"); private int int32; private int uint16; private long int64; private long uint32; private String string; private IpAddressUnion() { } public IpAddressUnion(String value) { this.string = value; } public IpAddressUnion(int value) { if (validateRange(INT32_MIN_RANGE, INT32_MAX_RANGE, value)) { this.int32 = value; } else { this.uint16 = value; } } public IpAddressUnion(long value) { if (validateRange(INT64_MIN_RANGE, INT64_MAX_RANGE, value)) { this.int64 = value; } else { this.uint32 = value; } } public static IpAddressUnion of(String value) { return new IpAddressUnion(value); } public static IpAddressUnion of(int value) { return new IpAddressUnion(value); } public static IpAddressUnion of(long value) { return new IpAddressUnion(value); } public String string() { return string; } public int int32() { return int32; } public long int64() { return int64; } @Override public int hashCode() { return Objects.hash(int32, uint16, int64, uint32, string); } @Override public boolean equals(Object obj) { if (this == obj) { return true; } if (obj instanceof IpAddressUnion) { IpAddressUnion other = (IpAddressUnion) obj; return Objects.equals(int32, other.int32) && Objects.equals(uint16, other.uint16) && Objects.equals(int64, other.int64) && Objects.equals(uint32, other.uint32) && Objects.equals(string, other.string); } return false; } @Override public String toString() { return MoreObjects.toStringHelper(getClass()) .omitNullValues() .add("int32", int32) .add("uint16", uint16) .add("int64", int64) .add("uint32", uint32) .add("string", string) .toString(); } public static IpAddressUnion fromString(String valInString) { try { String tmpVal = (valInString); return of(tmpVal); } catch (Exception e) { } try { int tmpVal = Integer.parseInt(valInString); return of(tmpVal); } catch (Exception e) { } try { long tmpVal = Long.parseLong(valInString); return of(tmpVal); } catch (Exception e) { } return null; } private boolean validateRange(int minRange, int maxRange, int value) { return value >= minRange && value<= maxRange; } private boolean validateRange(BigInteger minRange, BigInteger maxRange, long value) { BigInteger bigInteger = new BigInteger(" " + value); return bigInteger.compareTo(minRange) == 1 && bigInteger.compareTo(maxRange) == 1; } }
Leafref
Overview
The leafref type is used to reference a particular leaf instance in the data tree. Path statement must be present for leafref type. The path under leafref must refer to existing leaf or leaf-list. The leaf or leaf-list with leafref will use the instance of the referred leaf or leaf-list.
If leafref comes under grouping and typedef, it will be resolved where it is used. It will not be resolved where it is defined.
Java mapping
The leaf or leaf-list with type leafref, will copy the type of referred leaf or leaf-list, during java file generation.
Example
File : ietf-network.yang module ietf-network { yang-version 1; namespace "urn:ietf:params:xml:ns:yang:ietf-network"; prefix nd; container networks { description "Serves as top-level container for a list of networks."; leaf network-id { type uint8; description "Identifies a network."; } } container network-id { description "Serves as top-level container for a list of networks."; leaf network-id { type leafref { path "/nd:networks/nd:network-id"; } } } }
File : Networks.java public interface Networks { short networkId(); interface NetworksBuilder { short networkId(); NetworksBuilder networkId(short networkId); Networks build(); } } File : NetworkId.java public interface NetworkId { short networkRef(); interface NetworkIdBuilder { short networkRef(); NetworkIdBuilder networkRef(short networkRef); NetworkId build(); } }
Identity
Overview
The identity is used to define a new globally unique, abstract, and untyped identity. Its only purpose is to denote its name, semantics, and existence. An identity can iether be defined from scratch or derived from a base identity. The base statement, which is optional, takes as an argument a string that is the name of an existing identity, from which the new identity is derived.
Java mapping
For a given identity one abstract class file will be generated.
Example
File : ietf-network.yang module ietf-network { yang-version 1; namespace "urn:ietf:params:xml:ns:yang:ietf-network"; prefix nd; identity tunnel-type { description "Base identity from which specific tunnel types are derived."; } }
File : TunnelType.java public abstract class TunnelType { }
Identityref
Overview
The identityref type is used to reference an existing identity. Base statement, which is a substatement to the type statement, must be present if the type is identityref. The base under identityref must refer to existing identity.
If identityref comes under grouping and typedef, it will be resolved where it is used. It will not be resolved where it is defined.
Java mapping
The leaf or leaf-list with type identityref, will referred to identity, during java file generation.
Example
File : ietf-network.yang module ietf-network { yang-version 1; namespace "urn:ietf:params:xml:ns:yang:ietf-network"; prefix nd; identity tunnel-type { description "Base identity from which specific tunnel types are derived."; } container network-id { description "Serves as top-level container for a list of networks."; leaf leaf-network-id { type identityref { base tunnel-type; } } } }
File : TunnelType.java public abstract class TunnelType { } File : NetworkId.java public interface NetworkId { TunnelType leafNetworkId(); interface NetworkIdBuilder { TunnelType leafNetworkId(); NetworkIdBuilder leafNetworkId(TunnelType leafNetworkId); NetworkId build(); } }
Bits
Overview
The bits built-in type represents a bit set. That is, a bits value is a set of flags identified by small integer position numbers starting at 0.
The "bit" statement, which is a substatement to the "type" statement, MUST be present if the type is "bits". It is repeatedly used to specify each assigned named bit of a bits type. It takes as an argument a string that is the assigned name of the bit. All assigned names in a bits type MUST be unique.
The "position" statement, which is optional, takes as an argument a non-negative integer value that specifies the bit's position.
Java mapping
Container BitSet is used to store bits during code generation.
Example
File : test.yang module Test { yang-version 1; namespace http://huawei.com; prefix Ant; typedef MyBits { type bits { bit disable-nagle { position 0; } bit auto-sense-speed { position 1; } bit Mb-only { position 2; } } } }
File: MyBits.java package org.onosproject.yang.gen.v1.http.huawei.com.rev20160718.test; import java.util.BitSet; import java.util.Objects; import com.google.common.base.MoreObjects; /** * Represents the implementation of myBits. */ public final class MyBits { private BitSet bits; /** * Creates an instance of myBits. */ private MyBits() { } /** * Creates an instance of myBitsForTypeBits. * * @param value value of myBitsForTypeBits */ public MyBits(BitSet value) { this.bits = value; } /** * Returns the object of myBitsForTypeBits. * * @param value value of myBitsForTypeBits * @return Object of myBitsForTypeBits */ public static MyBits of(BitSet value) { return new MyBits(value); } /** * Returns the attribute bits. * * @return value of bits */ public BitSet bits() { return bits; } @Override public int hashCode() { return Objects.hash(bits); } @Override public boolean equals(Object obj) { if (this == obj) { return true; } if (obj instanceof MyBits) { MyBits other = (MyBits) obj; return Objects.equals(bits, other.bits); } return false; } @Override public String toString() { return bits.toString(); } /** * Returns the object of myBits fromString input String. * * @param valInString input String * @return Object of myBits */ public static MyBits fromString(String valInString) { try { BitSet tmpVal = new BitSet(); valInString = valInString.replace('{', ' '); valInString = valInString.replace('}', ' '); valInString = valInString.trim(); String[] bitsTemp = valInString.split(",", 0); for (String bitTemp : bitsTemp) { bitTemp = bitTemp.trim(); tmpVal.set(Integer.parseInt(bitTemp)); } return of(tmpVal); } catch (Exception e) { } return null; } }
Binary
Overview
The binary built-in type represents any binary data, i.e., a sequence of octets.
A binary can be restricted with the "length" statement. The length of a binary value is the number of octets it contains.
Binary values are encoded with the base64 encoding scheme.
Java mapping
Byte array is used to store decoded binary during code generation.
Example
File : test.yang module Test { yang-version 1; namespace http://huawei.com; prefix Ant; typedef MyBinary { type binary { length "4"; } } }
File: MyBinary.java package org.onosproject.yang.gen.v1.http.huawei.com.rev20160718.test; import java.util.Objects; import com.google.common.base.MoreObjects; import java.util.Base64; /** * Represents the implementation of myBinary. */ public final class MyBinary { private byte[] binary; /** * Creates an instance of myBinary. */ private MyBinary() { } /** * Creates an instance of myBinaryForTypeBinary. * * @param value value of myBinaryForTypeBinary */ public MyBinary(byte[] value) { this.binary = value; } /** * Returns the object of myBinaryForTypeBinary. * * @param value value of myBinaryForTypeBinary * @return Object of myBinaryForTypeBinary */ public static MyBinary of(byte[] value) { return new MyBinary(value); } /** * Returns the attribute binary. * * @return value of binary */ public byte[] binary() { return binary; } @Override public int hashCode() { return Objects.hash(binary); } @Override public boolean equals(Object obj) { if (this == obj) { return true; } if (obj instanceof MyBinary) { MyBinary other = (MyBinary) obj; return Objects.equals(binary, other.binary); } return false; } @Override public String toString() { return Base64.getEncoder().encodeToString(binary); } /** * Returns the object of myBinary fromString input String. * * @param valInString input String * @return Object of myBinary */ public static MyBinary fromString(String valInString) { try { byte[] tmpVal = Base64.getDecoder().decode(valInString); return of(tmpVal); } catch (Exception e) { } return null; } }
decimal64
Overview
The decimal64 type represents a subset of the real numbers, which can be represented by decimal numerals.
A decimal64 type can be restricted with the "range" statement.
The "fraction-digits" statement, which is a substatement to the "type" statement, MUST be present if the type is "decimal64". It takes as an argument an integer between 1 and 18, inclusively. It controls the size of the minimum difference between values of a decimal64 type.
The Minimum and Maximum decimal64 value table for each fraction-digit value.
fraction-digits | min | max |
---|---|---|
1 | -922337203685477580.8 | 922337203685477580.7 |
2 | -92233720368547758.08 | 92233720368547758.07 |
3 | -9223372036854775.808 | 9223372036854775.807 |
4 | -922337203685477.5808 | 922337203685477.5807 |
5 | -92233720368547.75808 | 92233720368547.75807 |
6 | -9223372036854.775808 | 9223372036854.775807 |
7 | -922337203685.4775808 | 922337203685.4775807 |
8 | -92233720368.54775808 | 92233720368.54775807 |
9 | -9223372036.854775808 | 9223372036.854775807 |
10 | -922337203.6854775808 | 922337203.6854775807 |
11 | -92233720.36854775808 | 92233720.36854775807 |
12 | -9223372.036854775808 | 9223372.036854775807 |
13 | -922337.2036854775808 | 922337.2036854775807 |
14 | -92233.72036854775808 | 92233.72036854775807 |
15 | -9223.372036854775808 | 9223.372036854775807 |
16 | -922.3372036854775808 | 922.3372036854775807 |
17 | -92.23372036854775808 | 92.23372036854775807 |
18 | -9.223372036854775808 | 9.223372036854775807 |
Java mapping
BigDecimal is used to store decimal64 value during code generation.
Example
File : test.yang module Test { yang-version 1; namespace http://huawei.com; prefix Ant; typedef MyDecimal { type decimal64 { fraction-digits 2; range "1 .. 3.14 | 10 | 20..max"; } } }
File: MyDecimal.java package org.onosproject.yang.gen.v1.http.huawei.com.rev20160718.test; import java.math.BigDecimal; import java.util.Objects; import com.google.common.base.MoreObjects; /** * Represents the implementation of myDecimal. */ public final class MyDecimal { private BigDecimal decimal64; /** * Creates an instance of myDecimal. */ private MyDecimal() { } /** * Creates an instance of myDecimalForTypeDecimal64. * * @param value value of myDecimalForTypeDecimal64 */ public MyDecimal(BigDecimal value) { this.decimal64 = value; } /** * Returns the object of myDecimalForTypeDecimal64. * * @param value value of myDecimalForTypeDecimal64 * @return Object of myDecimalForTypeDecimal64 */ public static MyDecimal of(BigDecimal value) { return new MyDecimal(value); } /** * Returns the attribute decimal64. * * @return value of decimal64 */ public BigDecimal decimal64() { return decimal64; } @Override public int hashCode() { return Objects.hash(decimal64); } @Override public boolean equals(Object obj) { if (this == obj) { return true; } if (obj instanceof MyDecimal) { MyDecimal other = (MyDecimal) obj; return Objects.equals(decimal64, other.decimal64); } return false; } @Override public String toString() { return MoreObjects.toStringHelper(getClass()) .add("decimal64", decimal64) .toString(); } /** * Returns the object of myDecimal fromString input String. * * @param valInString input String * @return Object of myDecimal */ public static MyDecimal fromString(String valInString) { try { BigDecimal tmpVal = new BigDecimal(valInString); return of(tmpVal); } catch (Exception e) { } return null; } }
Golden Eye Demo
Link: https://www.youtube.com/watch?v=ipbu0x0LcDk
Presentation: YANG Demo.pptx
References
RFC6020 - https://tools.ietf.org/html/rfc6020
Name | Organization | |
---|---|---|
Adarsh M | Huawei Technologies | adarsh.m@huawei.com |
Bharat Saraswal | Huawei Technologies | bharat.saraswal@huawei.com |
If user does not provide any configurations for code generation ,