org.onosproject.yang.runtime

Interface YangModelRegistry

All Known Implementing Classes:

DefaultYangModelRegistry

public interface YangModelRegistry

Registry of YANG models known to YANG runtime.

Method Summary

Modifier and Type	Method and Description
org.onosproject.yang.model.YangModel	getModel(String id) Returns YANG model for given model id.
Set<org.onosproject.yang.model.YangModel>	getModels() Returns collection of all registered models.
org.onosproject.yang.model.YangModule	getModule(org.onosproject.yang.model.YangModuleId id) Returns YANG module for given YANG module id.
void	registerAnydataSchema(org.onosproject.yang.model.ModelObjectId id, org.onosproject.yang.model.ModelObjectId id1) Registers the given generated node referenced by given model object identifier under provided anydata model object identifier.
void	registerModel(ModelRegistrationParam param) Registers a new model.
void	unregisterAnydataSchema(Class id, Class id1) Unregisters the given generated node class under provided anydata class.
void	unregisterModel(ModelRegistrationParam param) Unregisters the specified model.

Method Detail

registerModel

void registerModel(ModelRegistrationParam param)
            throws IllegalArgumentException

Registers a new model.

Parameters:

param - parameters having model to be registered with additional information provided by app

Throws:

IllegalArgumentException - when requested model with provided identifier is already registered or not valid

registerAnydataSchema

void registerAnydataSchema(org.onosproject.yang.model.ModelObjectId id,
                           org.onosproject.yang.model.ModelObjectId id1)
                    throws IllegalArgumentException

Registers the given generated node referenced by given model object identifier under provided anydata model object identifier.

Parameters:

id - identifier to reference anydata container under which application is expecting the data

id1 - identifier to reference the node defined in YANG file which application can send as content or child nodes under anydata

Throws:

IllegalArgumentException - when provided identifier is not not valid

unregisterAnydataSchema

void unregisterAnydataSchema(Class id,
                             Class id1)
                      throws IllegalArgumentException

Unregisters the given generated node class under provided anydata class.

Parameters:

id - identifier to reference anydata container under which application has registered the schema

id1 - identifier to reference the node defined in YANG file which application can send as content or child nodes under anydata

Throws:

IllegalArgumentException - when provided identifier is not not valid

unregisterModel

void unregisterModel(ModelRegistrationParam param)

Unregisters the specified model.

Parameters:

param - parameters having model to be registered with additional information provided by app

getModels

Set<org.onosproject.yang.model.YangModel> getModels()

Returns collection of all registered models.

Returns:

collection of models

getModel

org.onosproject.yang.model.YangModel getModel(String id)

Returns YANG model for given model id.

Parameters:

id - model identifier

Returns:

YANG model

getModule

org.onosproject.yang.model.YangModule getModule(org.onosproject.yang.model.YangModuleId id)

Returns YANG module for given YANG module id.

Parameters:

id - module identifier

Returns:

YANG module