org.opendaylight.mdsal.binding.dom.adapter

Class BindingToNormalizedNodeCodec

java.lang.Object

org.opendaylight.mdsal.binding.dom.adapter.BindingToNormalizedNodeCodec

All Implemented Interfaces:

AutoCloseable, EventListener, BindingCodecTreeFactory, BindingNormalizedNodeSerializer, org.opendaylight.yangtools.yang.model.api.SchemaContextListener

public class BindingToNormalizedNodeCodec
extends Object
implements BindingCodecTreeFactory, BindingNormalizedNodeSerializer, org.opendaylight.yangtools.yang.model.api.SchemaContextListener, AutoCloseable

A combinations of BindingCodecTreeFactory and BindingNormalizedNodeSerializer, with internal caching of instance identifiers.

NOTE: this class is non-final to allow controller adapter migration without duplicated code.

Constructor Summary

Constructors

Constructor and Description
BindingToNormalizedNodeCodec(ClassLoadingStrategy classLoadingStrategy, BindingNormalizedNodeCodecRegistry codecRegistry)
BindingToNormalizedNodeCodec(ClassLoadingStrategy classLoadingStrategy, BindingNormalizedNodeCodecRegistry codecRegistry, boolean waitForSchema)

Method Summary

Modifier and Type	Method and Description
void	close()
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> Function<Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>,Optional<T>>	deserializeFunction(InstanceIdentifier<T> path) Deprecated. Use BindingNormalizedNodeCodecRegistry.deserializeFunction(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T>) instead.
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.
<T extends RpcInput> T	fromNormalizedNodeActionInput(Class<? extends Action<?,?,?>> action, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode input) Translates supplied ContainerNode action input.
<T extends RpcOutput> T	fromNormalizedNodeActionOutput(Class<? extends Action<?,?,?>> action, org.opendaylight.yangtools.yang.data.api.schema.ContainerNode output) Translates supplied ContainerNode action output.
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.
BindingNormalizedNodeCodecRegistry	getCodecFactory()
BindingNormalizedNodeCodecRegistry	getCodecRegistry()
org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>	getDefaultNodeFor(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier parentMapPath) Deprecated. This method is not generally useful, as empty lists do not convey information in YANG (they are equivalent to non-present lists). It also leaks implementation details to a broader scope and should never have been public in the first place.
Set<Class<? extends Notification>>	getNotificationClasses(Set<org.opendaylight.yangtools.yang.model.api.SchemaPath> interested)
protected com.google.common.collect.ImmutableBiMap<Method,org.opendaylight.yangtools.yang.model.api.RpcDefinition>	getRpcMethodToSchema(Class<? extends RpcService> key)
com.google.common.collect.ImmutableBiMap<Method,org.opendaylight.yangtools.yang.model.api.SchemaPath>	getRpcMethodToSchemaPath(Class<? extends RpcService> key)
protected @NonNull Map.Entry<InstanceIdentifier<?>,BindingCodecTreeNode<?>>	getSubtreeCodec(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier domIdentifier)
protected org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>	instanceIdentifierToNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier parentPath)
static BindingToNormalizedNodeCodec	newInstance(ClassLoadingStrategy classLoadingStrategy, DOMSchemaService schemaService)
void	onGlobalContextUpdated(org.opendaylight.yangtools.yang.model.api.SchemaContext context)
Optional<Map.Entry<InstanceIdentifier<? extends DataObject>,DataObject>>	toBinding(@NonNull Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,? extends org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>> normalized)
Optional<InstanceIdentifier<? extends DataObject>>	toBinding(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier normalized) Returns a Binding-Aware instance identifier from normalized instance-identifier if it is possible to create representation.
protected DOMDataTreeIdentifier	toDOMDataTreeIdentifier(DataTreeIdentifier<?> path)
protected Collection<DOMDataTreeIdentifier>	toDOMDataTreeIdentifiers(Collection<DataTreeIdentifier<?>> subtrees)
BindingLazyContainerNode<RpcInput>	toLazyNormalizedNodeActionInput(Class<? extends Action<?,?,?>> action, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier identifier, RpcInput input) Lazily translates supplied Binding action input into NormalizedNode data.
BindingLazyContainerNode<RpcOutput>	toLazyNormalizedNodeActionOutput(Class<? extends Action<?,?,?>> action, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier identifier, RpcOutput output) Lazily translates supplied Binding action output into NormalizedNode data.
org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier	toNormalized(InstanceIdentifier<? extends DataObject> binding) Translates supplied Binding Instance Identifier into NormalizedNode instance identifier.
<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.
Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>	toNormalizedNode(Map.Entry<InstanceIdentifier<? extends DataObject>,DataObject> binding) Converts Binding Map.Entry to DOM Map.Entry.
org.opendaylight.yangtools.yang.data.api.schema.ContainerNode	toNormalizedNodeActionInput(Class<? extends Action<?,?,?>> action, RpcInput input) Translates supplied Binding action input into NormalizedNode data.
org.opendaylight.yangtools.yang.data.api.schema.ContainerNode	toNormalizedNodeActionOutput(Class<? extends Action<?,?,?>> action, RpcOutput output) Translates supplied Binding action output into NormalizedNode data.
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.
protected org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier	toYangInstanceIdentifierBlocking(InstanceIdentifier<? extends DataObject> binding)
protected org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier	toYangInstanceIdentifierCached(InstanceIdentifier<?> binding)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer

toLazyNormalizedNodeActionInput, toLazyNormalizedNodeActionOutput

Constructor Detail

BindingToNormalizedNodeCodec

public BindingToNormalizedNodeCodec(ClassLoadingStrategy classLoadingStrategy,
                                    BindingNormalizedNodeCodecRegistry codecRegistry)

BindingToNormalizedNodeCodec

public BindingToNormalizedNodeCodec(ClassLoadingStrategy classLoadingStrategy,
                                    BindingNormalizedNodeCodecRegistry codecRegistry,
                                    boolean waitForSchema)

Method Detail

newInstance

public static BindingToNormalizedNodeCodec newInstance(ClassLoadingStrategy classLoadingStrategy,
                                                       DOMSchemaService schemaService)

toYangInstanceIdentifierBlocking

protected org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier toYangInstanceIdentifierBlocking(InstanceIdentifier<? extends DataObject> binding)

toNormalized

public final org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier toNormalized(InstanceIdentifier<? extends DataObject> binding)

Translates supplied Binding Instance Identifier into NormalizedNode instance identifier.

Parameters:

binding - Binding Instance Identifier

Returns:

DOM Instance Identifier

Throws:

IllegalArgumentException - If supplied Instance Identifier is not valid.

toYangInstanceIdentifier

public final 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

toYangInstanceIdentifierCached

protected org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier toYangInstanceIdentifierCached(InstanceIdentifier<?> binding)

toNormalizedNode

public final <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

toNormalizedNode

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

Converts Binding Map.Entry to DOM Map.Entry.

Same as toNormalizedNode(InstanceIdentifier, DataObject).

Parameters:

binding - Map Entry with InstanceIdentifier as key and DataObject as value.

Returns:

DOM Map Entry with YangInstanceIdentifier as key and NormalizedNode as value.

fromNormalizedNode

public final 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 final 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 final 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

fromNormalizedNodeActionInput

public <T extends RpcInput> T fromNormalizedNodeActionInput(Class<? extends Action<?,?,?>> action,
                                                            org.opendaylight.yangtools.yang.data.api.schema.ContainerNode input)

Description copied from interface: BindingNormalizedNodeSerializer

Translates supplied ContainerNode action input.

Specified by:

fromNormalizedNodeActionInput in interface BindingNormalizedNodeSerializer

Parameters:

action - Binding action class

input - ContainerNode representing data

Returns:

Binding representation of action input

fromNormalizedNodeActionOutput

public <T extends RpcOutput> T fromNormalizedNodeActionOutput(Class<? extends Action<?,?,?>> action,
                                                              org.opendaylight.yangtools.yang.data.api.schema.ContainerNode output)

Description copied from interface: BindingNormalizedNodeSerializer

Translates supplied ContainerNode action output.

Specified by:

fromNormalizedNodeActionOutput in interface BindingNormalizedNodeSerializer

Parameters:

action - Binding action class

output - ContainerNode representing data

Returns:

Binding representation of action output

fromYangInstanceIdentifier

public final 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.

toNormalizedNodeNotification

public final 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 final 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

toNormalizedNodeActionInput

public org.opendaylight.yangtools.yang.data.api.schema.ContainerNode toNormalizedNodeActionInput(Class<? extends Action<?,?,?>> action,
                                                                                                 RpcInput input)

Description copied from interface: BindingNormalizedNodeSerializer

Translates supplied Binding action input into NormalizedNode data.

Specified by:

toNormalizedNodeActionInput in interface BindingNormalizedNodeSerializer

Parameters:

action - Binding action class

input - Binding action input

Returns:

NormalizedNode representation of action input

toNormalizedNodeActionOutput

public org.opendaylight.yangtools.yang.data.api.schema.ContainerNode toNormalizedNodeActionOutput(Class<? extends Action<?,?,?>> action,
                                                                                                  RpcOutput output)

Description copied from interface: BindingNormalizedNodeSerializer

Translates supplied Binding action output into NormalizedNode data.

Specified by:

toNormalizedNodeActionOutput in interface BindingNormalizedNodeSerializer

output - Binding action output

Returns:

NormalizedNode representation of action output

toLazyNormalizedNodeActionInput

public BindingLazyContainerNode<RpcInput> toLazyNormalizedNodeActionInput(Class<? extends Action<?,?,?>> action,
                                                                          org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier identifier,
                                                                          RpcInput input)

Description copied from interface: BindingNormalizedNodeSerializer

Lazily translates supplied Binding action input into NormalizedNode data.

Specified by:

toLazyNormalizedNodeActionInput in interface BindingNormalizedNodeSerializer

Parameters:

action - Binding action class

input - Binding action input

Returns:

NormalizedNode representation of action input

toLazyNormalizedNodeActionOutput

public BindingLazyContainerNode<RpcOutput> toLazyNormalizedNodeActionOutput(Class<? extends Action<?,?,?>> action,
                                                                            org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier identifier,
                                                                            RpcOutput output)

Description copied from interface: BindingNormalizedNodeSerializer

Lazily translates supplied Binding action output into NormalizedNode data.

Specified by:

toLazyNormalizedNodeActionOutput in interface BindingNormalizedNodeSerializer

Parameters:

action - Binding action class

output - Binding action output

Returns:

NormalizedNode representation of action output

toBinding

public final Optional<InstanceIdentifier<? extends DataObject>> toBinding(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier normalized)
                                                                   throws org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException

Returns a Binding-Aware instance identifier from normalized instance-identifier if it is possible to create representation.

Returns Optional.empty for cases where target is mixin node except augmentation.

Throws:

org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException

toBinding

public final Optional<Map.Entry<InstanceIdentifier<? extends DataObject>,DataObject>> toBinding(@NonNull Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,? extends org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>> normalized)
                                                                                         throws org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException

Throws:

org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException

onGlobalContextUpdated

public void onGlobalContextUpdated(org.opendaylight.yangtools.yang.model.api.SchemaContext context)

Specified by:

onGlobalContextUpdated in interface org.opendaylight.yangtools.yang.model.api.SchemaContextListener

deserializeFunction

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

Deprecated. Use BindingNormalizedNodeCodecRegistry.deserializeFunction(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T>) instead.

Deprecated.

getCodecRegistry

public final BindingNormalizedNodeCodecRegistry getCodecRegistry()

close

public void close()

Specified by:

close in interface AutoCloseable

getCodecFactory

public final BindingNormalizedNodeCodecRegistry getCodecFactory()

getRpcMethodToSchemaPath

public final com.google.common.collect.ImmutableBiMap<Method,org.opendaylight.yangtools.yang.model.api.SchemaPath> getRpcMethodToSchemaPath(Class<? extends RpcService> key)

getRpcMethodToSchema

protected com.google.common.collect.ImmutableBiMap<Method,org.opendaylight.yangtools.yang.model.api.RpcDefinition> getRpcMethodToSchema(Class<? extends RpcService> key)

create

public final 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 final 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.

getSubtreeCodec

protected @NonNull Map.Entry<InstanceIdentifier<?>,BindingCodecTreeNode<?>> getSubtreeCodec(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier domIdentifier)

getNotificationClasses

public final Set<Class<? extends Notification>> getNotificationClasses(Set<org.opendaylight.yangtools.yang.model.api.SchemaPath> interested)

instanceIdentifierToNode

protected org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> instanceIdentifierToNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier parentPath)

getDefaultNodeFor

@Deprecated
public org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> getDefaultNodeFor(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier parentMapPath)

Deprecated. This method is not generally useful, as empty lists do not convey information in YANG (they are equivalent to non-present lists). It also leaks implementation details to a broader scope and should never have been public in the first place.

This method creates an empty list container of a particular type.

toDOMDataTreeIdentifiers

protected Collection<DOMDataTreeIdentifier> toDOMDataTreeIdentifiers(Collection<DataTreeIdentifier<?>> subtrees)

toDOMDataTreeIdentifier

protected DOMDataTreeIdentifier toDOMDataTreeIdentifier(DataTreeIdentifier<?> path)