org.onosproject.yms.app.ysr

Class DefaultYangSchemaRegistry

java.lang.Object

org.onosproject.yms.app.ysr.DefaultYangSchemaRegistry

All Implemented Interfaces:

YangSchemaRegistry

public class DefaultYangSchemaRegistry
extends Object
implements YangSchemaRegistry

Representation of default YANG schema registry. Yang schema registry provides interface to an application to register its YANG schema with YMS. It provides YANG schema nodes to YDT, YNB and YSB.

Constructor Summary

Constructors

Constructor and Description
DefaultYangSchemaRegistry() Creates an instance of default YANG schema registry.

Method Summary

Modifier and Type	Method and Description
void	flushYsrData() Clears database for YSR.
Object	getRegisteredApplication(org.onosproject.yangutils.datamodel.YangSchemaNode schemaNode) 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 name) 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 name) Returns YANG schema nodes using root interface file name.
org.onosproject.yangutils.datamodel.YangSchemaNode	getYangSchemaNodeUsingGeneratedRootNodeOpPramFileName(String name) 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 appObject, 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultYangSchemaRegistry

public DefaultYangSchemaRegistry()

Creates an instance of default YANG schema registry.

Method Detail

registerApplication

public void registerApplication(Object appObject,
                                Class<?> serviceClass)

Description copied from interface: YangSchemaRegistry

Registers applications to YMS.

Specified by:

registerApplication in interface YangSchemaRegistry

Parameters:

appObject - application's object

serviceClass - service class which needs to be registered

unRegisterApplication

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

Description copied from interface: YangSchemaRegistry

Unregisters applications to YMS.

Specified by:

unRegisterApplication in interface YangSchemaRegistry

Parameters:

managerObject - application's object

serviceClass - service class which needs to be unregistered

getRegisteredApplication

public Object getRegisteredApplication(org.onosproject.yangutils.datamodel.YangSchemaNode schemaNode)

Description copied from interface: YangSchemaRegistry

Returns application's implementation's class object.

Specified by:

getRegisteredApplication in interface YangSchemaRegistry

Parameters:

schemaNode - application's schema node

Returns:

application's implementation's class object

getYangSchemaNodeUsingSchemaName

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

Description copied from interface: YangSchemaRegistry

Returns YANG schema node using schema name.

Specified by:

getYangSchemaNodeUsingSchemaName in interface YangSchemaRegistry

Parameters:

schemaName - module name.

Returns:

YANG schema node using schema name

getYangSchemaNodeUsingAppName

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

Description copied from interface: YangSchemaRegistry

Returns YANG schema nodes using application name.

Specified by:

getYangSchemaNodeUsingAppName in interface YangSchemaRegistry

Parameters:

appName - application's service name

Returns:

YANG schema nodes using application name

getYangSchemaNodeUsingGeneratedRootNodeInterfaceFileName

public org.onosproject.yangutils.datamodel.YangSchemaNode getYangSchemaNodeUsingGeneratedRootNodeInterfaceFileName(String name)

Description copied from interface: YangSchemaRegistry

Returns YANG schema nodes using root interface file name.

Specified by:

getYangSchemaNodeUsingGeneratedRootNodeInterfaceFileName in interface YangSchemaRegistry

Parameters:

name - name of generated interface file for root node

Returns:

YANG schema nodes using root interface file name

getYangSchemaNodeUsingGeneratedRootNodeOpPramFileName

public org.onosproject.yangutils.datamodel.YangSchemaNode getYangSchemaNodeUsingGeneratedRootNodeOpPramFileName(String name)

Description copied from interface: YangSchemaRegistry

Returns YANG schema nodes using root op param file name.

Specified by:

getYangSchemaNodeUsingGeneratedRootNodeOpPramFileName in interface YangSchemaRegistry

Parameters:

name - name of generated op param file for root node

Returns:

YANG schema nodes using root op param file name

getRootYangSchemaNodeForNotification

public org.onosproject.yangutils.datamodel.YangSchemaNode getRootYangSchemaNodeForNotification(String name)

Description copied from interface: YangSchemaRegistry

Returns YANG schema node of root for notifications.

Specified by:

getRootYangSchemaNodeForNotification in interface YangSchemaRegistry

Parameters:

name - event subject

Returns:

YANG schema node of root for notifications

getRegisteredClass

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

Description copied from interface: YangSchemaRegistry

Returns registered service class.

Specified by:

getRegisteredClass in interface YangSchemaRegistry

Parameters:

schemaNode - YANG schema node

Returns:

registered service class

getYangFile

public String getYangFile(YangModuleIdentifier moduleIdentifier)

Description copied from interface: YangSchemaRegistry

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.

Specified by:

getYangFile in interface YangSchemaRegistry

Parameters:

moduleIdentifier - module's identifier

Returns:

YANG file contents of the requested YANG module.

verifyNotificationObject

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

Description copied from interface: YangSchemaRegistry

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

Specified by:

verifyNotificationObject in interface YangSchemaRegistry

Parameters:

appObj - application object

service - service class

Returns:

true if the manager object is already registered with notification handler

flushYsrData

public void flushYsrData()

Description copied from interface: YangSchemaRegistry

Clears database for YSR.

Specified by:

flushYsrData in interface YangSchemaRegistry

processModuleLibrary

public void processModuleLibrary(String serviceName,
                                 YangModuleLibrary library)

Description copied from interface: YangSchemaRegistry

Process module library for a registered service.

Specified by:

processModuleLibrary in interface YangSchemaRegistry

Parameters:

serviceName - service class name

library - YANG module library