org.opendaylight.mdsal.binding.dom.codec.impl

Class BindingNormalizedNodeCodecRegistry

java.lang.Object

org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry

All Implemented Interfaces:

BindingCodecTreeFactory, BindingNormalizedNodeSerializer, BindingNormalizedNodeWriterFactory, DataObjectSerializerRegistry

public class BindingNormalizedNodeCodecRegistry
extends Object
implements DataObjectSerializerRegistry, BindingCodecTreeFactory, BindingNormalizedNodeWriterFactory, BindingNormalizedNodeSerializer

Constructor Summary

Constructors

Constructor and Description
BindingNormalizedNodeCodecRegistry(DataObjectSerializerGenerator generator)

Method Summary

Modifier and Type	Method and Description
BindingCodecTree	create(BindingRuntimeContext context) Creates Binding Codec Tree for specified Binding runtime context.
BindingCodecTree	create(org.opendaylight.yangtools.yang.model.api.SchemaContext context, Class<?>... bindingClasses) Creates Binding Codec Tree for specified Binding runtime context.
<T extends DataObject> com.google.common.base.Function<com.google.common.base.Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>,com.google.common.base.Optional<T>>	deserializeFunction(InstanceIdentifier<T> path)
Map.Entry<InstanceIdentifier<?>,DataObject>	fromNormalizedNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> data) Translates supplied YANG Instance Identifier and NormalizedNode into Binding data.
Notification	fromNormalizedNodeNotification(org.opendaylight.yangtools.yang.model.api.SchemaPath path, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode data) Translates supplied NormalizedNode Notification into Binding data.
DataObject	fromNormalizedNodeRpcData(org.opendaylight.yangtools.yang.model.api.SchemaPath path, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode data) Translates supplied NormalizedNode RPC input or output into Binding data.
InstanceIdentifier<?>	fromYangInstanceIdentifier(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier dom) Translates supplied YANG Instance Identifier into Binding instance identifier.
BindingCodecTree	getCodecContext()
DataObjectSerializer	getSerializer(Class<? extends DataObject> type)
BindingStreamEventWriter	newNotificationWriter(Class<? extends Notification> notification, org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter streamWriter) Creates a BindingStreamEventWriter for notification which will translate to NormalizedNode model and invoke proper events on supplied NormalizedNodeStreamWriter.
BindingStreamEventWriter	newRpcWriter(Class<? extends DataContainer> rpcInputOrOutput, org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter streamWriter) Creates a BindingStreamEventWriter for RPC data which will translate to NormalizedNode model and invoke proper events on supplied NormalizedNodeStreamWriter.
BindingStreamEventWriter	newWriter(InstanceIdentifier<?> path, org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter) Creates a BindingStreamEventWriter for data tree path which will translate to NormalizedNode model and invoke proper events on supplied NormalizedNodeStreamWriter.
Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,BindingStreamEventWriter>	newWriterAndIdentifier(InstanceIdentifier<?> path, org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter) Creates a BindingStreamEventWriter for data tree path which will translate to NormalizedNode model and invoke proper events on supplied NormalizedNodeStreamWriter.
void	onBindingRuntimeContextUpdated(BindingRuntimeContext context)
<T extends DataObject> Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>	toNormalizedNode(InstanceIdentifier<T> path, T data) Translates supplied Binding Instance Identifier and data into NormalizedNode representation.
org.opendaylight.yangtools.yang.data.api.schema.ContainerNode	toNormalizedNodeNotification(Notification data) Translates supplied Binding Notification or output into NormalizedNode notification.
org.opendaylight.yangtools.yang.data.api.schema.ContainerNode	toNormalizedNodeRpcData(DataContainer data) Translates supplied Binding RPC input or output into NormalizedNode data.
org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier	toYangInstanceIdentifier(InstanceIdentifier<?> binding) Translates supplied Binding Instance Identifier into NormalizedNode instance identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

BindingNormalizedNodeCodecRegistry

public BindingNormalizedNodeCodecRegistry(DataObjectSerializerGenerator generator)

Method Detail

getSerializer

public DataObjectSerializer getSerializer(Class<? extends DataObject> type)

Specified by:

getSerializer in interface DataObjectSerializerRegistry

getCodecContext

public BindingCodecTree getCodecContext()

onBindingRuntimeContextUpdated

public void onBindingRuntimeContextUpdated(BindingRuntimeContext context)

toYangInstanceIdentifier

public org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier toYangInstanceIdentifier(InstanceIdentifier<?> binding)

Description copied from interface: BindingNormalizedNodeSerializer

Translates supplied Binding Instance Identifier into NormalizedNode instance identifier.

Specified by:

toYangInstanceIdentifier in interface BindingNormalizedNodeSerializer

Parameters:

binding - Binding Instance Identifier

Returns:

DOM Instance Identifier

fromYangInstanceIdentifier

public InstanceIdentifier<?> fromYangInstanceIdentifier(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier dom)

Description copied from interface: BindingNormalizedNodeSerializer

Translates supplied YANG Instance Identifier into Binding instance identifier.

Specified by:

fromYangInstanceIdentifier in interface BindingNormalizedNodeSerializer

Parameters:

dom - YANG Instance Identifier

Returns:

Binding Instance Identifier, or null if the instance identifier is not representable.

toNormalizedNode

public <T extends DataObject> Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>> toNormalizedNode(InstanceIdentifier<T> path,
                                                                                                                                                                                              T data)

Description copied from interface: BindingNormalizedNodeSerializer

Translates supplied Binding Instance Identifier and data into NormalizedNode representation.

Specified by:

toNormalizedNode in interface BindingNormalizedNodeSerializer

Parameters:

path - Binding Instance Identifier pointing to data

data - Data object representing data

Returns:

NormalizedNode representation

toNormalizedNodeNotification

public org.opendaylight.yangtools.yang.data.api.schema.ContainerNode toNormalizedNodeNotification(Notification data)

Description copied from interface: BindingNormalizedNodeSerializer

Translates supplied Binding Notification or output into NormalizedNode notification.

Specified by:

toNormalizedNodeNotification in interface BindingNormalizedNodeSerializer

Parameters:

data - NormalizedNode representing notification data

Returns:

NormalizedNode representation of notification

toNormalizedNodeRpcData

public org.opendaylight.yangtools.yang.data.api.schema.ContainerNode toNormalizedNodeRpcData(DataContainer data)

Description copied from interface: BindingNormalizedNodeSerializer

Translates supplied Binding RPC input or output into NormalizedNode data.

Specified by:

toNormalizedNodeRpcData in interface BindingNormalizedNodeSerializer

Parameters:

data - NormalizedNode representing rpc data

Returns:

NormalizedNode representation of rpc data

fromNormalizedNode

public Map.Entry<InstanceIdentifier<?>,DataObject> fromNormalizedNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path,
                                                                      org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> data)

Description copied from interface: BindingNormalizedNodeSerializer

Translates supplied YANG Instance Identifier and NormalizedNode into Binding data.

Specified by:

fromNormalizedNode in interface BindingNormalizedNodeSerializer

Parameters:

path - Binding Instance Identifier

data - NormalizedNode representing data

Returns:

DOM Instance Identifier

fromNormalizedNodeNotification

public Notification fromNormalizedNodeNotification(org.opendaylight.yangtools.yang.model.api.SchemaPath path,
                                                   org.opendaylight.yangtools.yang.data.api.schema.ContainerNode data)

Description copied from interface: BindingNormalizedNodeSerializer

Translates supplied NormalizedNode Notification into Binding data.

Specified by:

fromNormalizedNodeNotification in interface BindingNormalizedNodeSerializer

Parameters:

path - Schema Path of Notification, schema path is absolute, and consists of Notification QName.

data - NormalizedNode representing data

Returns:

Binding representation of Notification

fromNormalizedNodeRpcData

public DataObject fromNormalizedNodeRpcData(org.opendaylight.yangtools.yang.model.api.SchemaPath path,
                                            org.opendaylight.yangtools.yang.data.api.schema.ContainerNode data)

Description copied from interface: BindingNormalizedNodeSerializer

Translates supplied NormalizedNode RPC input or output into Binding data.

Specified by:

fromNormalizedNodeRpcData in interface BindingNormalizedNodeSerializer

Parameters:

path - Schema path of RPC data, Schema path consists of rpc QName and input / output QName.

data - NormalizedNode representing data

Returns:

Binding representation of RPC data

newWriterAndIdentifier

public Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,BindingStreamEventWriter> newWriterAndIdentifier(InstanceIdentifier<?> path,
                                                                                                                                  org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter)

Description copied from interface: BindingNormalizedNodeWriterFactory

Creates a BindingStreamEventWriter for data tree path which will translate to NormalizedNode model and invoke proper events on supplied NormalizedNodeStreamWriter.

Also provides translation of supplied Instance Identifier to YangInstanceIdentifier so client code, does not need to translate that separately.

If YangInstanceIdentifier is not needed, please use BindingNormalizedNodeWriterFactory.newWriter(InstanceIdentifier, NormalizedNodeStreamWriter) method to conserve resources.

Specified by:

newWriterAndIdentifier in interface BindingNormalizedNodeWriterFactory

Parameters:

path - Binding Path in conceptual data tree, for which writer should be instantiated

domWriter - Stream writer on which events will be invoked.

Returns:

Instance Identifier and BindingStreamEventWriter which will write to supplied NormalizedNodeStreamWriter.

newWriter

public BindingStreamEventWriter newWriter(InstanceIdentifier<?> path,
                                          org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter)

Description copied from interface: BindingNormalizedNodeWriterFactory

Creates a BindingStreamEventWriter for data tree path which will translate to NormalizedNode model and invoke proper events on supplied NormalizedNodeStreamWriter.

This variant does not provide YANG instance identifier and is useful for use-cases, where InstanceIdentifier translation is done in other way, or YANG instance identifier is unnecessary (e.g. notifications, RPCs).

Specified by:

newWriter in interface BindingNormalizedNodeWriterFactory

Parameters:

path - Binding Path in conceptual data tree, for which writer should be instantiated

domWriter - Stream writer on which events will be invoked.

Returns:

BindingStreamEventWriter which will write to supplied NormalizedNodeStreamWriter.

newNotificationWriter

public BindingStreamEventWriter newNotificationWriter(Class<? extends Notification> notification,
                                                      org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter streamWriter)

Description copied from interface: BindingNormalizedNodeWriterFactory

Creates a BindingStreamEventWriter for notification which will translate to NormalizedNode model and invoke proper events on supplied NormalizedNodeStreamWriter.

Specified by:

newNotificationWriter in interface BindingNormalizedNodeWriterFactory

Parameters:

notification - Binding class representing notification, for which writer should be instantiated

streamWriter - Stream writer on which events will be invoked.

Returns:

BindingStreamEventWriter which will write to supplied NormalizedNodeStreamWriter.

newRpcWriter

public BindingStreamEventWriter newRpcWriter(Class<? extends DataContainer> rpcInputOrOutput,
                                             org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter streamWriter)

Description copied from interface: BindingNormalizedNodeWriterFactory

Creates a BindingStreamEventWriter for RPC data which will translate to NormalizedNode model and invoke proper events on supplied NormalizedNodeStreamWriter.

Specified by:

newRpcWriter in interface BindingNormalizedNodeWriterFactory

Parameters:

rpcInputOrOutput - Binding class representing RPC input or output, for which writer should be instantiated

streamWriter - Stream writer on which events will be invoked.

Returns:

BindingStreamEventWriter which will write to supplied NormalizedNodeStreamWriter.

deserializeFunction

public <T extends DataObject> com.google.common.base.Function<com.google.common.base.Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>,com.google.common.base.Optional<T>> deserializeFunction(InstanceIdentifier<T> path)

create

public BindingCodecTree create(BindingRuntimeContext context)

Description copied from interface: BindingCodecTreeFactory

Creates Binding Codec Tree for specified Binding runtime context.

Specified by:

create in interface BindingCodecTreeFactory

Parameters:

context - Binding Runtime Context for which Binding codecs should be instantiated.

Returns:

Binding Codec Tree for specified Binding runtime context.

create

public BindingCodecTree create(org.opendaylight.yangtools.yang.model.api.SchemaContext context,
                               Class<?>... bindingClasses)

Description copied from interface: BindingCodecTreeFactory

Creates Binding Codec Tree for specified Binding runtime context.

Specified by:

create in interface BindingCodecTreeFactory

Parameters:

context - Binding Runtime Context for which Binding codecs should be instantiated.

bindingClasses - Binding Runtime Context will be constructed using bindings which contains specified classes, in order to support deserialization in multi-classloader environment.

Returns:

Binding Codec Tree for specified Binding runtime context.