org.onosproject.yms.ydt

Interface YdtBuilder

All Superinterfaces:

Ydt

All Known Subinterfaces:

YdtExtendedBuilder

All Known Implementing Classes:

YangRequestWorkBench

public interface YdtBuilder
extends Ydt

Abstraction of an entity which provides interfaces to build and obtain YANG data tree which is data (sub)instance representation, abstract of protocol.

NBI protocols need to translate the protocol operation request, into a protocol independent abstract tree called the YANG data tree (YDT). In order to enable the protocol in building these abstract data tree, YANG management system provides a utility called the YANG data tree builder.

Method Summary

Modifier and Type	Method and Description
void	addChild(String name, String namespace) Adds a last child to YANG data tree; this method is to be used by protocols which are unaware of the nature (single/multiple) of node and also unaware of the operation type at every node (Example: RESTCONF).
void	addChild(String name, String namespace, YdtContextOperationType opType) Adds a last child to YANG data tree; this method is to be used by protocols which are unaware of the nature (single/multiple) of node.
void	addChild(String name, String namespace, YdtType ydtType) Adds a last child to YANG data tree, this method is to be used by protocols which are aware of the nature (single/multiple) of node.
void	addChild(String name, String namespace, YdtType ydtType, YdtContextOperationType opType) Adds a last child to YANG data tree; this method is to be used by protocols which are aware of the nature (single/multiple) of node.
void	addLeaf(String name, String namespace, Set<String> valueSet) Adds a last leaf with list of values to YANG data tree.
void	addLeaf(String name, String namespace, String value) Adds a last leaf with value to YANG data tree.
void	addMultiInstanceChild(String name, String namespace, List<String> valueList, YdtContextOperationType opType) Adds an instance of a child list node, or adds a child leaf list with multiple instance.
YdtContext	getCurNode() Returns the current context information available in YDT node.
Map<String,String>	getRootTagAttributeMap() Returns map of tag attribute list associated with root resource.
void	setDefaultEditOperationType(YdtContextOperationType ydtContextOperationType) Sets default operation type.
void	setRootTagAttributeMap(Map<String,String> attributeTag) Sets root node tag attributes.
void	traverseToParent() Traverses up in YANG data tree to the parent node, it is to be used when protocol is using context type "current" and wanted to traverse up the tree.

Methods inherited from interface org.onosproject.yms.ydt.Ydt

getRootNode, getYmsOperationType

Method Detail

setRootTagAttributeMap

void setRootTagAttributeMap(Map<String,String> attributeTag)

Sets root node tag attributes. This is used by protocol to specify tag attributes associated with root resource.

Parameters:

attributeTag - map of root tags attribute values indexed by root tag name

getRootTagAttributeMap

Map<String,String> getRootTagAttributeMap()

Returns map of tag attribute list associated with root resource.

Returns:

linked hash map of tag name with value

addChild

void addChild(String name,
              String namespace)
       throws IllegalArgumentException

Adds a last child to YANG data tree; this method is to be used by protocols which are unaware of the nature (single/multiple) of node and also unaware of the operation type at every node (Example: RESTCONF).

Add child is used to add module/sub-module nodes also. Request may contain revision number corresponding to Module/sub-module in that case YMS expect revision number to be appended to module/sub-module name in the below mentioned format.

module-or-submodule-name ['@' date-arg] date-arg = 4DIGIT "-" 2DIGIT "-" 2DIGIT Example: testModule@2016-10-27.

If the revision date is not specified YMS first search for registered module/sub-module without revision date, if still can't obtain then uses registered module/sub-module with latest revision date.

Parameters:

name - name of child to be added

namespace - namespace of child to be added, if it's null, parent's namespace will be applied to child

Throws:

IllegalArgumentException - when method has been passed an illegal or inappropriate argument.

addChild

void addChild(String name,
              String namespace,
              YdtType ydtType)
       throws IllegalArgumentException

Adds a last child to YANG data tree, this method is to be used by protocols which are aware of the nature (single/multiple) of node.

Add child is used to add module/sub-module nodes also. Request may contain revision number corresponding to Module/sub-module in that case YMS expect revision number to be appended to module/sub-module name in the below mentioned format.

module-or-submodule-name ['@' date-arg] date-arg = 4DIGIT "-" 2DIGIT "-" 2DIGIT Example: testModule@2016-10-27.

If the revision date is not specified YMS first search for registered module/sub-module without revision date, if still can't obtain then uses registered module/sub-module with latest revision date.

Parameters:

name - name of child to be added

namespace - namespace of child to be added, if it's null, parent's namespace will be applied to child

ydtType - type of YDT node to be added

Throws:

IllegalArgumentException - when method has been passed an illegal or inappropriate argument.

addChild

void addChild(String name,
              String namespace,
              YdtContextOperationType opType)
       throws IllegalArgumentException

Adds a last child to YANG data tree; this method is to be used by protocols which are unaware of the nature (single/multiple) of node. This is an overloaded method with operation type. This method can optionally be used when protocol doesn't want to specify operation type by keeping it null.

Add child is used to add module/sub-module nodes also. Request may contain revision number corresponding to Module/sub-module in that case YMS expect revision number to be appended to module/sub-module name in the below mentioned format.

module-or-submodule-name ['@' date-arg] date-arg = 4DIGIT "-" 2DIGIT "-" 2DIGIT Example: testModule@2016-10-27.

If the revision date is not specified YMS first search for registered module/sub-module without revision date, if still can't obtain then uses registered module/sub-module with latest revision date.

Parameters:

name - name of child to be added

namespace - namespace of child to be added, if it's null, parent's namespace will be applied to child

opType - type of requested operation over a node

Throws:

IllegalArgumentException - when method has been passed an illegal or inappropriate argument.

addChild

void addChild(String name,
              String namespace,
              YdtType ydtType,
              YdtContextOperationType opType)
       throws IllegalArgumentException

Adds a last child to YANG data tree; this method is to be used by protocols which are aware of the nature (single/multiple) of node. This is an overloaded method with operation type. This method can optionally be used when protocol doesn't want to specify operation type by keeping it null.

Add child is used to add module/sub-module nodes also. Request may contain revision number corresponding to Module/sub-module in that case YMS expect revision number to be appended to module/sub-module name in the below mentioned format.

module-or-submodule-name ['@' date-arg] date-arg = 4DIGIT "-" 2DIGIT "-" 2DIGIT Example: testModule@2016-10-27.

If the revision date is not specified YMS first search for registered module/sub-module without revision date, if still can't obtain then uses registered module/sub-module with latest revision date.

Parameters:

name - name of child to be added

namespace - namespace of child to be added, if it's null, parent's namespace will be applied to child

ydtType - type of YDT node to be added

opType - type of requested operation over a node

Throws:

IllegalArgumentException - when method has been passed an illegal or inappropriate argument.

addLeaf

void addLeaf(String name,
             String namespace,
             String value)
      throws IllegalArgumentException

Adds a last leaf with value to YANG data tree. Protocols unaware of nature of leaf (single/multiple) will use it to add both single instance and multi instance node. Protocols aware of nature of node will use it for single instance value node addition. Value of leaf can be null which indicates selection node in get operation.

Parameters:

name - name of child to be added

namespace - namespace of child to be added, if it's null, parent's namespace will be applied to child

value - value of the child

Throws:

IllegalArgumentException - when method has been passed an illegal or inappropriate argument.

addLeaf

void addLeaf(String name,
             String namespace,
             Set<String> valueSet)
      throws IllegalArgumentException

Adds a last leaf with list of values to YANG data tree. This method is used by protocols which knows the nature (single/multiple) of node for multi instance node addition. Value of leaf can be null which indicates selection node in get operation.

Parameters:

name - name of child to be added

namespace - namespace of child to be added, if it's null, parent's namespace will be applied to child

valueSet - list of value of the child

Throws:

IllegalArgumentException - when method has been passed an illegal or inappropriate argument.

addMultiInstanceChild

void addMultiInstanceChild(String name,
                           String namespace,
                           List<String> valueList,
                           YdtContextOperationType opType)
                    throws IllegalArgumentException

Adds an instance of a child list node, or adds a child leaf list with multiple instance. In case the name and namespace identifies the child list node, then the values for all the key leaves must be passed in the same order of schema. Then the effective YANG data tree will be like adding a list node, followed by adding the key leaves as the child to the list node. After this operation, the call to getCurNode will return the list node. In case the name and namespace identifies the child leaf-list, then the values identifies the instance of leaf list. After this operation, the call to getCurNode will return the leaf-list node.

Parameters:

name - name of child to be added

namespace - namespace of child to be added, if it's null, parent's namespace will be applied to child

valueList - values of the keys in URI in the same order as defined in YANG file

opType - type of requested operation over a node

Throws:

IllegalArgumentException - when method has been passed an illegal or inappropriate argument.

traverseToParent

void traverseToParent()
               throws IllegalStateException

Traverses up in YANG data tree to the parent node, it is to be used when protocol is using context type "current" and wanted to traverse up the tree.

Throws:

IllegalStateException - when application is not in an appropriate state for the requested operation.

getCurNode

YdtContext getCurNode()

Returns the current context information available in YDT node.

Returns:

current YDT context

setDefaultEditOperationType

void setDefaultEditOperationType(YdtContextOperationType ydtContextOperationType)

Sets default operation type. This operation type is taken if operation type is not explicitly specified in request. If default operation type is not set, merge will be taken as default operation type.

Parameters:

ydtContextOperationType - default edit operation type