org.onosproject.yang.runtime

Interface YangRuntimeService

All Known Implementing Classes:

DefaultYangRuntimeHandler

public interface YangRuntimeService

Service for encoding and decoding between internal and external model representations.

Method Summary

Modifier and Type	Method and Description
CompositeData	decode(CompositeStream external, RuntimeContext context) Decodes the external representation of a configuration model from the specified composite stream into an in-memory representation.
CompositeStream	encode(CompositeData internal, RuntimeContext context) Encodes the internal in-memory representation of a configuration model to an external representation consumable from the resulting input stream.

Method Detail

decode

CompositeData decode(CompositeStream external,
                     RuntimeContext context)

Decodes the external representation of a configuration model from the specified composite stream into an in-memory representation.

Resource identifier stream "URI" will get decoded to resource identifier and resource data stream will get decoded to data node.

Protocols like NETCONF may opt only to have resource data without resource identifier, which implies the data node construction from logical root resource ("/").

Also protocols like NETCONF will have decorations around the input stream which will be reported back to protocol in output. Produced annotations will be in order of pre-order traversal.

Parameters:

external - composite input stream carrying external representation of configuration data

context - additional YANG runtime context information

Returns:

in-memory representation of configuration data with decorated node information

Throws:

YangRuntimeException - when fails to perform decode operation

encode

CompositeStream encode(CompositeData internal,
                       RuntimeContext context)

Encodes the internal in-memory representation of a configuration model to an external representation consumable from the resulting input stream.

Resource identifier in composite data will get encoded to resource identifier stream and data node will be encoded to resource data stream.

Logical root node "/" will be removed during encoding and will not be part of either resource identifier or data node.

Protocols like NETCONF may opt only to have data node with resource identifier as null in order to only get complete output in form of body without URI.

Also protocols like NETCONF would like to provide additional decorations for the node. These decoration should be in pre-order traversal order.

Parameters:

internal - in-memory representation of configuration data

context - additional YANG runtime context information

Returns:

input stream carrying external representation of configuration data

Throws:

YangRuntimeException - when fails to perform encode operation