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

Class BindingNormalizedNodeCodecRegistry

java.lang.Object

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

All Implemented Interfaces:

BindingNormalizedNodeWriterFactory, BindingTreeCodecFactory, BindingNormalizedNodeSerializer, TreeNodeSerializerRegistry

@Beta
public class BindingNormalizedNodeCodecRegistry
extends Object
implements TreeNodeSerializerRegistry, BindingTreeCodecFactory, BindingNormalizedNodeWriterFactory, BindingNormalizedNodeSerializer

Serializing and deserializing Binding and DOM data.

Constructor Summary

Constructors

Constructor and Description
BindingNormalizedNodeCodecRegistry(TreeNodeSerializerGenerator generator) Prepare generator for generating serializers and create loader for serializers.

Method Summary

Modifier and Type	Method and Description
BindingCodecContext	create(BindingRuntimeContext context) Creates Binding Codec Tree for specified Binding runtime context.
BindingCodecContext	create(org.opendaylight.yangtools.yang.model.api.SchemaContext context, Class<?>... bindingClasses) Creates Binding Codec Tree for schema context according to binding classes.
<T extends TreeNode> Function<Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>,Optional<T>>	deserializeFunction(InstanceIdentifier<T> path) Deserialize function based on tree node codec context resolved by binding path.
Map.Entry<InstanceIdentifier<?>,TreeNode>	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.
TreeNode	fromNormalizedNodeOperationData(org.opendaylight.yangtools.yang.model.api.SchemaPath path, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode data) Translates supplied NormalizedNode operation (RPC, Action) 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.
BindingTreeCodec	getCodecContext() Get binding tree codec context.
TreeNodeSerializer	getSerializer(Class<? extends TreeNode> type) Returns implementation of requested serializer.
BindingStreamEventWriter	newNotificationWriter(Class<? extends Notification<?>> notification, org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter) Creates a BindingStreamEventWriter for notification which will translate to NormalizedNode model and invoke proper events on supplied NormalizedNodeStreamWriter.
BindingStreamEventWriter	newOperationWriter(Class<? extends Instantiable<?>> operationInputOrOutput, org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter) Creates a BindingStreamEventWriter for operation 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) Create codec context based on runtime context and notify generator that runtime context has been updated.
<T extends TreeNode> 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	toNormalizedNodeOperationData(TreeNode data) Translates supplied Binding operation (RPC, Action) 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(TreeNodeSerializerGenerator generator)

Prepare generator for generating serializers and create loader for serializers.

Parameters:

generator - - serializer generator

Method Detail

getSerializer

public TreeNodeSerializer getSerializer(Class<? extends TreeNode> type)

Description copied from interface: TreeNodeSerializerRegistry

Returns implementation of requested serializer.

Specified by:

getSerializer in interface TreeNodeSerializerRegistry

Parameters:

type - input binding class

Returns:

returns serializer, based on input binding class

getCodecContext

public BindingTreeCodec getCodecContext()

Get binding tree codec context.

Returns:

codec context

onBindingRuntimeContextUpdated

public void onBindingRuntimeContextUpdated(BindingRuntimeContext context)

Create codec context based on runtime context and notify generator that runtime context has been updated.

Parameters:

context - - runtime context

toYangInstanceIdentifier

@Nullable
public org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier toYangInstanceIdentifier(@Nonnull
                                                                                                          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

@Nullable
public InstanceIdentifier<?> fromYangInstanceIdentifier(@Nonnull
                                                                  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

@Nullable
public <T extends TreeNode> 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

Type Parameters:

T - data type

Parameters:

path - - Binding Instance Identifier pointing to data

data - - representing Data Tree

Returns:

NormalizedNode representation

toNormalizedNodeNotification

@Nonnull
public org.opendaylight.yangtools.yang.data.api.schema.ContainerNode toNormalizedNodeNotification(@Nonnull
                                                                                                           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

toNormalizedNodeOperationData

@Nonnull
public org.opendaylight.yangtools.yang.data.api.schema.ContainerNode toNormalizedNodeOperationData(@Nonnull
                                                                                                            TreeNode data)

Description copied from interface: BindingNormalizedNodeSerializer

Translates supplied Binding operation (RPC, Action) input or output into NormalizedNode data.

Specified by:

toNormalizedNodeOperationData in interface BindingNormalizedNodeSerializer

Parameters:

data - - NormalizedNode representing rpc/action data

Returns:

NormalizedNode representation of operation data

fromNormalizedNode

@Nullable
public Map.Entry<InstanceIdentifier<?>,TreeNode> fromNormalizedNode(@Nonnull
                                                                              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

@Nullable
public Notification fromNormalizedNodeNotification(@Nonnull
                                                             org.opendaylight.yangtools.yang.model.api.SchemaPath path,
                                                             @Nonnull
                                                             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

fromNormalizedNodeOperationData

@Nullable
public TreeNode fromNormalizedNodeOperationData(@Nonnull
                                                          org.opendaylight.yangtools.yang.model.api.SchemaPath path,
                                                          @Nonnull
                                                          org.opendaylight.yangtools.yang.data.api.schema.ContainerNode data)

Description copied from interface: BindingNormalizedNodeSerializer

Translates supplied NormalizedNode operation (RPC, Action) input or output into Binding data.

Specified by:

fromNormalizedNodeOperationData in interface BindingNormalizedNodeSerializer

Parameters:

path - - schema path of operation data, schema path consists of rpc/action QName and input/output QName.

data - - NormalizedNode representing data

Returns:

Binding representation of operation data

newWriterAndIdentifier

@Nonnull
public Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,BindingStreamEventWriter> newWriterAndIdentifier(@Nonnull
                                                                                                                                           InstanceIdentifier<?> path,
                                                                                                                                           @Nonnull
                                                                                                                                           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

@Nonnull
public BindingStreamEventWriter newWriter(@Nonnull
                                                   InstanceIdentifier<?> path,
                                                   @Nonnull
                                                   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 variation 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, operations).

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

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

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

domWriter - - stream writer on which events will be invoked

Returns:

BindingStreamEventWriter which will write to supplied NormalizedNodeStreamWriter

newOperationWriter

@Nonnull
public BindingStreamEventWriter newOperationWriter(@Nonnull
                                                            Class<? extends Instantiable<?>> operationInputOrOutput,
                                                            @Nonnull
                                                            org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter domWriter)

Description copied from interface: BindingNormalizedNodeWriterFactory

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

Specified by:

newOperationWriter in interface BindingNormalizedNodeWriterFactory

Parameters:

operationInputOrOutput - - binding class representing operation (RPC, Action) input or output, for which writer should be instantiated

domWriter - - stream writer on which events will be invoked

Returns:

BindingStreamEventWriter which will write to supplied NormalizedNodeStreamWriter

deserializeFunction

public <T extends TreeNode> Function<Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>,Optional<T>> deserializeFunction(InstanceIdentifier<T> path)

Deserialize function based on tree node codec context resolved by binding path.

Parameters:

path - - binding identifier

Returns:

function deserializer of codec context of binding path

create

public BindingCodecContext create(BindingRuntimeContext context)

Description copied from interface: BindingTreeCodecFactory

Creates Binding Codec Tree for specified Binding runtime context.

Specified by:

create in interface BindingTreeCodecFactory

Parameters:

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

Returns:

Binding Codec Tree for specified Binding runtime context

create

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

Description copied from interface: BindingTreeCodecFactory

Creates Binding Codec Tree for schema context according to binding classes.

Specified by:

create in interface BindingTreeCodecFactory

Parameters:

context - - schema 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