org.onosproject.yang.runtime.impl

Class DefaultYangRuntimeHandler

java.lang.Object

org.onosproject.yang.runtime.impl.DefaultYangRuntimeHandler

All Implemented Interfaces:

YangRuntimeService

public class DefaultYangRuntimeHandler
extends Object
implements YangRuntimeService

Represents YANG runtime codec service implementation.

Constructor Summary

Constructors

Constructor and Description
DefaultYangRuntimeHandler(YangSerializerRegistry r, org.onosproject.yang.model.SchemaContext c) Creates a new YANG runtime manager.

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultYangRuntimeHandler

public DefaultYangRuntimeHandler(YangSerializerRegistry r,
                                 org.onosproject.yang.model.SchemaContext c)

Creates a new YANG runtime manager.

Parameters:

r - serializer registry

c - root's schema context

Method Detail

decode

public CompositeData decode(CompositeStream external,
                            RuntimeContext c)

Description copied from interface: YangRuntimeService

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.

Specified by:

decode in interface YangRuntimeService

Parameters:

external - composite input stream carrying external representation of configuration data

c - additional YANG runtime context information

Returns:

in-memory representation of configuration data with decorated node information

encode

public CompositeStream encode(CompositeData internal,
                              RuntimeContext c)

Description copied from interface: YangRuntimeService

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.

Specified by:

encode in interface YangRuntimeService

Parameters:

internal - in-memory representation of configuration data

c - additional YANG runtime context information

Returns:

input stream carrying external representation of configuration data