org.onosproject.yms.app.ydt

Class YangRequestWorkBench

java.lang.Object

org.onosproject.yms.app.ydt.YangRequestWorkBench

All Implemented Interfaces:

YdtExtendedBuilder, Ydt, YdtBuilder

public class YangRequestWorkBench
extends Object
implements YdtExtendedBuilder

Represents YANG request work bench which contains all parameters for request handling and methods to build and obtain YANG data tree which is data (sub)instance representation, abstract of protocol.

Constructor Summary

Constructors

Constructor and Description
YangRequestWorkBench(String name, String namespace, YmsOperationType opType, YangSchemaRegistry reg, boolean isValidate) Creates an instance of YANG request work bench which is use to initialize logical rootNode and and schema registry.

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.
YdtExtendedContext	addChild(YdtContextOperationType opType, org.onosproject.yangutils.datamodel.YangSchemaNode schemaNode) Adds a last child to YANG data tree; this method is to be used by YANG object builder.
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.
YdtExtendedContext	addLeaf(String value, org.onosproject.yangutils.datamodel.YangSchemaNode schemaNode) Adds a last leaf to YANG data tree; this method is to be used by YANG object builder.
YdtExtendedContext	addLeafList(Set<String> valueSet, org.onosproject.yangutils.datamodel.YangSchemaNode schemaNode) Adds a last leaf list to YANG data tree; this method is to be used by YANG object builder.
void	addMultiInstanceChild(String name, String namespace, List<String> keysValueList, YdtContextOperationType opType) Adds an instance of a child list node, or adds a child leaf list with multiple instance.
YdtAppContext	getAppRootNode() Returns the ydt app context tree logical root node.
Set<String>	getAugGenMethodSet() Returns the method name's set for an augmented target node in an application tree.
YdtExtendedContext	getCurNode() Returns the current context information available in YDT node.
YdtExtendedContext	getRootNode() Returns the root context information available in YDT node.
Map<String,String>	getRootTagAttributeMap() Returns map of tag attribute list associated with root resource.
YangSchemaRegistry	getYangSchemaRegistry() Returns the YANG schema registry of Ydt.
YmsOperationType	getYmsOperationType() Returns YANG management system operation type.
void	setAugGenMethodSet(Set<String> augGenMethodSet) Sets the method name's set for an augmented target node in an application tree.
void	setDefaultEditOperationType(YdtContextOperationType opType) 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.
void	traverseToParentWithoutValidation() Traverses up in YANG data tree to the parent node, it is to be used when protocol is using extended context type and wanted to traverse up the tree without doing any validation.

Methods inherited from class java.lang.Object

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

Constructor Detail

YangRequestWorkBench

public YangRequestWorkBench(String name,
                            String namespace,
                            YmsOperationType opType,
                            YangSchemaRegistry reg,
                            boolean isValidate)

Creates an instance of YANG request work bench which is use to initialize logical rootNode and and schema registry.

Parameters:

name - name of logical container of a protocol which is a holder of the complete tree

namespace - namespace of logical container

opType - type of operation done by using YANG interface

reg - Yang schema registry

isValidate - Flag to identify data validation need to be done by YDT or not

Method Detail

getYangSchemaRegistry

public YangSchemaRegistry getYangSchemaRegistry()

Returns the YANG schema registry of Ydt. This method will be used by ytb.

Returns:

YANG schema registry

getAppRootNode

public YdtAppContext getAppRootNode()

Returns the ydt app context tree logical root node. This method will be used by yab and ytb.

Returns:

YdtAppContext app tree logical root node

setRootTagAttributeMap

public void setRootTagAttributeMap(Map<String,String> attributeTag)

Description copied from interface: YdtBuilder

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

Specified by:

setRootTagAttributeMap in interface YdtBuilder

Parameters:

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

getRootTagAttributeMap

public Map<String,String> getRootTagAttributeMap()

Description copied from interface: YdtBuilder

Returns map of tag attribute list associated with root resource.

Specified by:

getRootTagAttributeMap in interface YdtBuilder

Returns:

linked hash map of tag name with value

addChild

public void addChild(String name,
                     String namespace)
              throws IllegalArgumentException

Description copied from interface: YdtBuilder

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.

Specified by:

addChild in interface YdtBuilder

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

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

Description copied from interface: YdtBuilder

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.

Specified by:

addChild in interface YdtBuilder

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

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

Description copied from interface: YdtBuilder

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.

Specified by:

addChild in interface YdtBuilder

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

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

Description copied from interface: YdtBuilder

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.

Specified by:

addChild in interface YdtBuilder

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

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

Description copied from interface: YdtBuilder

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.

Specified by:

addLeaf in interface YdtBuilder

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

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

Description copied from interface: YdtBuilder

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.

Specified by:

addLeaf in interface YdtBuilder

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.

traverseToParent

public void traverseToParent()
                      throws IllegalStateException

Description copied from interface: YdtBuilder

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.

Specified by:

traverseToParent in interface YdtBuilder

Throws:

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

getCurNode

public YdtExtendedContext getCurNode()

Description copied from interface: YdtBuilder

Returns the current context information available in YDT node.

Specified by:

getCurNode in interface YdtExtendedBuilder

Specified by:

getCurNode in interface YdtBuilder

Returns:

current YDT context

setDefaultEditOperationType

public void setDefaultEditOperationType(YdtContextOperationType opType)

Description copied from interface: YdtBuilder

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.

Specified by:

setDefaultEditOperationType in interface YdtBuilder

Parameters:

opType - default edit operation type

getRootNode

public YdtExtendedContext getRootNode()

Description copied from interface: Ydt

Returns the root context information available in YDT node. This root node is a logical container of a protocol which holds the complete data tree. After building YANG data tree, root node can be obtained from this.

Specified by:

getRootNode in interface YdtExtendedBuilder

Specified by:

getRootNode in interface Ydt

Returns:

root YDT context which is logical container of a protocol which is holder of the complete tree

getYmsOperationType

public YmsOperationType getYmsOperationType()

Description copied from interface: Ydt

Returns YANG management system operation type. It represents type of root level operation for the request. This is used by protocols to specify the root level operation associated with the request.

Specified by:

getYmsOperationType in interface Ydt

Returns:

YANG management system operation type

addMultiInstanceChild

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

Description copied from interface: YdtBuilder

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.

Specified by:

addMultiInstanceChild in interface YdtBuilder

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

keysValueList - 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.

addChild

public YdtExtendedContext addChild(YdtContextOperationType opType,
                                   org.onosproject.yangutils.datamodel.YangSchemaNode schemaNode)

Description copied from interface: YdtExtendedBuilder

Adds a last child to YANG data tree; this method is to be used by YANG object builder.

Specified by:

addChild in interface YdtExtendedBuilder

Parameters:

opType - type of requested operation over a node

schemaNode - schema node from YANG metadata

Returns:

YDT context

addLeafList

public YdtExtendedContext addLeafList(Set<String> valueSet,
                                      org.onosproject.yangutils.datamodel.YangSchemaNode schemaNode)

Description copied from interface: YdtExtendedBuilder

Adds a last leaf list to YANG data tree; this method is to be used by YANG object builder.

Specified by:

addLeafList in interface YdtExtendedBuilder

Parameters:

valueSet - list of value of the child

schemaNode - schema node from YANG metadata

Returns:

YDT context

addLeaf

public YdtExtendedContext addLeaf(String value,
                                  org.onosproject.yangutils.datamodel.YangSchemaNode schemaNode)

Description copied from interface: YdtExtendedBuilder

Adds a last leaf to YANG data tree; this method is to be used by YANG object builder.

Specified by:

addLeaf in interface YdtExtendedBuilder

Parameters:

value - value of the child

schemaNode - schema node from YANG metadata

Returns:

YDT context

traverseToParentWithoutValidation

public void traverseToParentWithoutValidation()
                                       throws IllegalStateException

Description copied from interface: YdtExtendedBuilder

Traverses up in YANG data tree to the parent node, it is to be used when protocol is using extended context type and wanted to traverse up the tree without doing any validation.

Specified by:

traverseToParentWithoutValidation in interface YdtExtendedBuilder

Throws:

IllegalStateException - when user request for traverse to logical root node parent

getAugGenMethodSet

public Set<String> getAugGenMethodSet()

Returns the method name's set for an augmented target node in an application tree.

Returns:

augGenMethodSet set of method name's

setAugGenMethodSet

public void setAugGenMethodSet(Set<String> augGenMethodSet)

Sets the method name's set for an augmented target node in an application tree.

Parameters:

augGenMethodSet - set of method name's