org.onosproject.yms.app.ych.defaultcodecs.xml

Class DefaultXmlCodec

java.lang.Object

org.onosproject.yms.app.ych.defaultcodecs.xml.DefaultXmlCodec

All Implemented Interfaces:

YangDataTreeCodec

public class DefaultXmlCodec
extends Object
implements YangDataTreeCodec

Represents an implementation of YCH data tree codec interface.

Constructor Summary

Constructors

Constructor and Description
DefaultXmlCodec() Creates a new YANG xml codec.

Method Summary

Modifier and Type	Method and Description
YdtBuilder	decodeCompositeProtocolDataToYdt(YangCompositeEncoding protoData, Object schemaReg, YmsOperationType opType) When YMS decode composite protocol operation request it uses the registered decode method to translate the protocol data into a abstract YANG data tree.
YdtBuilder	decodeProtocolDataToYdt(String protoData, Object schemaReg, YmsOperationType opType) When YMS decode simple protocol operation request it uses the registered decode method to translate the protocol data into a abstract YANG data tree.
YangCompositeEncoding	encodeYdtToCompositeProtocolFormat(YdtBuilder ydtBuilder) When the YMS need to encode composite protocol operation request, it will translate the YANG objects into an abstract YANG data tree and invoke this registered encode method.
String	encodeYdtToProtocolFormat(YdtBuilder ydtBuilder) When the YMS need to encode simple protocol operation request, it will translate the YANG objects into an abstract YANG data tree and invoke this registered encode method.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultXmlCodec

public DefaultXmlCodec()

Creates a new YANG xml codec.

Method Detail

encodeYdtToProtocolFormat

public String encodeYdtToProtocolFormat(YdtBuilder ydtBuilder)

Description copied from interface: YangDataTreeCodec

When the YMS need to encode simple protocol operation request, it will translate the YANG objects into an abstract YANG data tree and invoke this registered encode method. Protocol CODEC implementation needs to ensure the overridden method can handle any specific extension or representation of protocol data. The operation type will be set in YANG data tree builder.

Specified by:

encodeYdtToProtocolFormat in interface YangDataTreeCodec

Parameters:

ydtBuilder - Abstract YANG data tree contains the operation request

Returns:

protocol specific string representation.

encodeYdtToCompositeProtocolFormat

public YangCompositeEncoding encodeYdtToCompositeProtocolFormat(YdtBuilder ydtBuilder)

Description copied from interface: YangDataTreeCodec

When the YMS need to encode composite protocol operation request, it will translate the YANG objects into an abstract YANG data tree and invoke this registered encode method. Protocol CODEC implementation needs to ensure the overridden method can handle any specific extension or representation of protocol data.

The Initial chain of node in the YDT will have the operation type set to NONE to specify it is a resource identifier. The Resource information is maintained as a subtree to the resource identifier node.

Specified by:

encodeYdtToCompositeProtocolFormat in interface YangDataTreeCodec

Parameters:

ydtBuilder - Abstract YANG data tree contains the operation request

Returns:

composite response containing the requested operation information

decodeCompositeProtocolDataToYdt

public YdtBuilder decodeCompositeProtocolDataToYdt(YangCompositeEncoding protoData,
                                                   Object schemaReg,
                                                   YmsOperationType opType)

Description copied from interface: YangDataTreeCodec

When YMS decode composite protocol operation request it uses the registered decode method to translate the protocol data into a abstract YANG data tree. Then translate the abstract YANG data tree into the YANG modeled Java objects.

The CODEC implementation are unaware of the schema against which they are performing the codec operation, so YMS will send the schema registry on which the YANG data tree needs to operate, so the code implementation needs to pass this schema registry to the get a YDT builder.

Specified by:

decodeCompositeProtocolDataToYdt in interface YangDataTreeCodec

Parameters:

protoData - composite input string containing the protocol data which needs to be decoded

schemaReg - Schema registry based on which the YANG data tree will be built

opType - protocol operation being performed

Returns:

decoded operation request in YANG data tree

decodeProtocolDataToYdt

public YdtBuilder decodeProtocolDataToYdt(String protoData,
                                          Object schemaReg,
                                          YmsOperationType opType)

Description copied from interface: YangDataTreeCodec

When YMS decode simple protocol operation request it uses the registered decode method to translate the protocol data into a abstract YANG data tree. Then translate the abstract YANG data tree into the YANG modeled Java objects.

The CODEC implementation are unaware of the schema against which they are performing the codec operation, so YMS will send the schema registry on which the YANG data tree needs to operate, so the code implementation needs to pass this schema registry to the get a YDT builder.

Specified by:

decodeProtocolDataToYdt in interface YangDataTreeCodec

Parameters:

protoData - input string containing the simple protocol data which needs to be decoded

schemaReg - Schema registry based on which the YANG data tree will be built

opType - protocol operation being performed

Returns:

decoded operation request in YANG data tree