org.onosproject.yms.app.ysr

Interface YangSchemaRegistry

All Known Implementing Classes:

DefaultYangSchemaRegistry

public interface YangSchemaRegistry

Abstraction of entity which provides interfaces to YANG schema registry.

Method Summary

Modifier and Type	Method and Description
void	flushYsrData() Clears database for YSR.
Object	getRegisteredApplication(org.onosproject.yangutils.datamodel.YangSchemaNode yangSchemaNode) Returns application's implementation's class object.
Class<?>	getRegisteredClass(org.onosproject.yangutils.datamodel.YangSchemaNode schemaNode) Returns registered service class.
org.onosproject.yangutils.datamodel.YangSchemaNode	getRootYangSchemaNodeForNotification(String eventSubject) Returns YANG schema node of root for notifications.
String	getYangFile(YangModuleIdentifier moduleIdentifier) Protocols like RESTCONF, use the definitions within the YANG modules advertised by the server are used to construct an RPC operation or data resource identifier.
org.onosproject.yangutils.datamodel.YangSchemaNode	getYangSchemaNodeUsingAppName(String appName) Returns YANG schema nodes using application name.
org.onosproject.yangutils.datamodel.YangSchemaNode	getYangSchemaNodeUsingGeneratedRootNodeInterfaceFileName(String rootInterfaceFileName) Returns YANG schema nodes using root interface file name.
org.onosproject.yangutils.datamodel.YangSchemaNode	getYangSchemaNodeUsingGeneratedRootNodeOpPramFileName(String rootOpParamFileName) Returns YANG schema nodes using root op param file name.
org.onosproject.yangutils.datamodel.YangSchemaNode	getYangSchemaNodeUsingSchemaName(String schemaName) Returns YANG schema node using schema name.
void	processModuleLibrary(String serviceName, YangModuleLibrary library) Process module library for a registered service.
void	registerApplication(Object managerObject, Class<?> serviceClass) Registers applications to YMS.
void	unRegisterApplication(Object managerObject, Class<?> serviceClass) Unregisters applications to YMS.
boolean	verifyNotificationObject(Object appObj, Class<?> service) Verifies if the manager object is already registered with notification handler.

Method Detail

registerApplication

void registerApplication(Object managerObject,
                         Class<?> serviceClass)

Registers applications to YMS.

Parameters:

managerObject - application's object

serviceClass - service class which needs to be registered

unRegisterApplication

void unRegisterApplication(Object managerObject,
                           Class<?> serviceClass)

Unregisters applications to YMS.

Parameters:

managerObject - application's object

serviceClass - service class which needs to be unregistered

getRegisteredApplication

Object getRegisteredApplication(org.onosproject.yangutils.datamodel.YangSchemaNode yangSchemaNode)

Returns application's implementation's class object.

Parameters:

yangSchemaNode - application's schema node

Returns:

application's implementation's class object

getYangSchemaNodeUsingSchemaName

org.onosproject.yangutils.datamodel.YangSchemaNode getYangSchemaNodeUsingSchemaName(String schemaName)

Returns YANG schema node using schema name.

Parameters:

schemaName - module name.

Returns:

YANG schema node using schema name

getYangSchemaNodeUsingAppName

org.onosproject.yangutils.datamodel.YangSchemaNode getYangSchemaNodeUsingAppName(String appName)

Returns YANG schema nodes using application name.

Parameters:

appName - application's service name

Returns:

YANG schema nodes using application name

getYangSchemaNodeUsingGeneratedRootNodeInterfaceFileName

org.onosproject.yangutils.datamodel.YangSchemaNode getYangSchemaNodeUsingGeneratedRootNodeInterfaceFileName(String rootInterfaceFileName)

Returns YANG schema nodes using root interface file name.

Parameters:

rootInterfaceFileName - name of generated interface file for root node

Returns:

YANG schema nodes using root interface file name

getYangSchemaNodeUsingGeneratedRootNodeOpPramFileName

org.onosproject.yangutils.datamodel.YangSchemaNode getYangSchemaNodeUsingGeneratedRootNodeOpPramFileName(String rootOpParamFileName)

Returns YANG schema nodes using root op param file name.

Parameters:

rootOpParamFileName - name of generated op param file for root node

Returns:

YANG schema nodes using root op param file name

getRootYangSchemaNodeForNotification

org.onosproject.yangutils.datamodel.YangSchemaNode getRootYangSchemaNodeForNotification(String eventSubject)

Returns YANG schema node of root for notifications.

Parameters:

eventSubject - event subject

Returns:

YANG schema node of root for notifications

getRegisteredClass

Class<?> getRegisteredClass(org.onosproject.yangutils.datamodel.YangSchemaNode schemaNode)

Returns registered service class.

Parameters:

schemaNode - YANG schema node

Returns:

registered service class

verifyNotificationObject

boolean verifyNotificationObject(Object appObj,
                                 Class<?> service)

Verifies if the manager object is already registered with notification handler.

Parameters:

appObj - application object

service - service class

Returns:

true if the manager object is already registered with notification handler

flushYsrData

void flushYsrData()

Clears database for YSR.

getYangFile

String getYangFile(YangModuleIdentifier moduleIdentifier)

Protocols like RESTCONF, use the definitions within the YANG modules advertised by the server are used to construct an RPC operation or data resource identifier.

Schema Resource: The server can optionally support retrieval of the YANG modules it supports.

Parameters:

moduleIdentifier - module's identifier

Returns:

YANG file contents of the requested YANG module.

processModuleLibrary

void processModuleLibrary(String serviceName,
                          YangModuleLibrary library)

Process module library for a registered service.

Parameters:

serviceName - service class name

library - YANG module library