Versions Compared

Old Version 36

changes.mady.by.user Toine Siebelink

Saved on

compared with

New Version 37

changes.mady.by.user Toine Siebelink

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

DescriptionYangJava Object ViewNotesXML Validation

JSON
Validation

Datatypes and basic constraints

Basic String

leaf response-code {
  type string;
}


YesYes
Mandatory Basic String

leaf response-code {925px
  type string;
    mandatory "true";
}


NoNo
Limited String leaf pnf-name {
  type string {
    length "0..256";
}

Specialized class to hold length limitation

YesYes
typedef (String) with pattern

typedef dotted-quad {
  type string {
pattern
  '(([0-9] ...';
  }
}

leaf address {
   type dotted-quad;
   mandatory "true";
}

Checked by XmlParserYesYes
Limited uint64 leaf cid {325px400
  type uint64 {
     range "0..503";
  }
}


YesYes
boolean with default value

leaf blacklisted {
  type boolean;
  default 1;
}


N/AN/A

Unique

Unique list server {
  key "name";
  unique "ip port";
  leaf name {
    type string;
  }
  leaf ip {
    type dotted-quad;
  }
  leaf port {
    type uint32;
  }}


NoNo

Choice

Choicechoice transfer-method {
  leaf transfer-interval {
    type uint64 { range "15..2880"; }
    units minutes; }
  leaf transfer-on-commit {
  type empty;
  }}


N/AN/A

Must

Must leaf ifType {
type enumeration {
enum ethernet;
enum atm;}}
leaf ifMTU {
type uint32;}
must "ifType != 'ethernet' or "
+ "(ifType = 'ethernet' and ifMTU = 1500)"
{error-message 466px"An ethernet MTU must be 1500";}


NoNo

When

When
leaf a {
    type boolean;
}
leaf b {
    type string;
    when "../a = 'true'";
}


NoNo

Extension

Extension declaration

extension store-state-ext {
argument duration;
description "An extension to enable
 state-storage for any attribute.
Use duration to specify how long: nnn h|d|y";
}


N/A
Extension usage leaf attribute-with-temporal-storage {
  type string;
  cm-notify-api:store-state-ext "3 d";
// store state 3 days
}

extension is stored as 'UnknownNode' and refers back to the extension declarationN/A

Augmentation


 augment "server" {
  when "port = '8787'";
    leaf enable-debug {
      type boolean;
    }
}


N/A

RPC

rpc
rpc nbrlist-change-notification {
  description
    "RAN Neighbor List change notification to configure RuntimeDB";
     input {
       :
    }
    output {
      : 
    }
}


N/A
rpc input
 input {
     leaf fap-service-number-of-entries-changed {
       type uint64;
       description
         "Number of cells for which neighbor list has changed";
     }
     list fap-service {
       key "alias";
       leaf alias {
         type string {
           length "1..64";
         }
       }
       leaf cid {
         type string {
         length "0..52";
         }
       }
       uses x-0005b9-lte-g;
       leaf lte-cell-number-of-entries {
         type uint64;
         description
           "Number of cells in a neighbor list that was changed";
       }
       list lte-ran-neighbor-list-in-use-lte-cell-changed {
         key "plmnid cid";
         uses lte-ran-neighbor-list-in-use-lte-cell-g;
         description
           "Changed/Modified List of cells 
in a neighbor list for this fap service";
     }
   }
}


N/A
rpc output
output {
    uses cm-notification-response;
}


N/A

Data Parsing and validation

XML Parsing

Code Block
languagejava
themeMidnight
titleXML Parsing Example
linenumberstrue
collapsetrue
		SchemaContext schemaContext = ... (see previous snippets)
        final Module module = schemaContext.findModules("ultraconfig-interfaces").iterator().next();
        QName qName = QName.create(module.getQNameModule(),"interfaces");
        final Optional<DataSchemaNode> node = module.findDataChildByName(qName);
        if (node.isPresent()) {
            final InputStream resourceAsStream = ClassLoader.getSystemClassLoader().getResourceAsStream("example2data.xml");
            final XMLStreamReader reader = UntrustedXML.createXMLStreamReader(resourceAsStream);
            final NormalizedNodeResult result = new NormalizedNodeResult();
            final NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
            final XmlParserStream xmlParser = XmlParserStream.create(streamWriter, schemaContext, node.get() );
            xmlParser.parse(reader);
            final NormalizedNode<?, ?> transformedInput = result.getResult();
        }

...

The table in the sections above has  has a column with the XML validation findings.

JSON Parsing

Code Block
languagejava
themeMidnight
titleJSON Parsing Example
linenumberstrue
collapsetrue
		SchemaContext schemaContext = ... (see previous snippets)
        JSONCodecFactory jsonCodecFactory = JSONCodecFactorySupplier.DRAFT_LHOTKA_NETMOD_YANG_JSON_02.getShared(schemaContext);
        final NormalizedNodeResult result = new NormalizedNodeResult();
        final NormalizedNodeStreamWriter streamWriter = ImmutableNormalizedNodeStreamWriter.from(result);
        final JsonParserStream jsonParser = JsonParserStream.create(streamWriter, jsonCodecFactory);
        final InputStream resourceAsStream = ClassLoader.getSystemClassLoader().getResourceAsStream("example2data.json");
        final JsonReader jsonReader = new JsonReader(new InputStreamReader(resourceAsStream));
        jsonParser.parse(jsonReader);
        final NormalizedNode<?, ?> transformedInput = result.getResult();

...

JSON Validation Findings
  • As expected the parsing of string, originating form XML or JSON is done by the same code and the results are identical to those for XML Data Parsing
Conclusions
  1. The YangTools model parser is comprehensive and cover all disposable Yang Language elements we might require
  2. complicated, no clear interface
  3. documentation out of data,