org.onosproject.yms.app.ytb

Interface YangTreeBuilder

All Known Implementing Classes:

DefaultYangTreeBuilder

public interface YangTreeBuilder

Abstraction of an entity which provides interfaces to build YANG data tree from the object received from YNH, YAB or YCH.

Method Summary

Modifier and Type	Method and Description
YdtExtendedBuilder	getYdtBuilderForYo(List<Object> moduleObj, String rootName, String rootNameSpace, YmsOperationType opType, YangSchemaRegistry registry) Returns the YDT builder after building the tree corresponding to the response YANG object received from any of the protocol such as YAB or YCH.
YdtExtendedContext	getYdtForNotification(Object object, String rootName, YangSchemaRegistry registry) Returns the YDT context after building the tree received from the protocol YNH.
YdtExtendedBuilder	getYdtForRpcResponse(Object outputObj, YdtExtendedBuilder reqBuilder) Returns the YDT context after building the RPC response tree.

Method Detail

getYdtBuilderForYo

YdtExtendedBuilder getYdtBuilderForYo(List<Object> moduleObj,
                                      String rootName,
                                      String rootNameSpace,
                                      YmsOperationType opType,
                                      YangSchemaRegistry registry)

Returns the YDT builder after building the tree corresponding to the response YANG object received from any of the protocol such as YAB or YCH.

Parameters:

moduleObj - application module object

rootName - logical root node name

rootNameSpace - logical root node namespace

opType - root node operation type

registry - application schema registry

Returns:

YDT builder from the tree

getYdtForNotification

YdtExtendedContext getYdtForNotification(Object object,
                                         String rootName,
                                         YangSchemaRegistry registry)

Returns the YDT context after building the tree received from the protocol YNH.

Parameters:

object - application notification object

rootName - logical root node name

registry - application schema registry

Returns:

YDT context from the tree

getYdtForRpcResponse

YdtExtendedBuilder getYdtForRpcResponse(Object outputObj,
                                        YdtExtendedBuilder reqBuilder)

Returns the YDT context after building the RPC response tree. The input for building the tree is RPC request builder, RPC output java object. These are received from the YSB protocol.

Parameters:

outputObj - application output object

reqBuilder - RPC request builder from YDT

Returns:

YDT builder where RPC response tree is created