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 final class BindingToNormalizedNodeCodec
extends Object
implements BindingCodecTreeFactory, BindingNormalizedNodeSerializer, org.opendaylight.yangtools.yang.model.api.SchemaContextListener, AutoCloseable

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> 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.
BindingNormalizedNodeCodecRegistry	getCodecFactory()
BindingNormalizedNodeCodecRegistry	getCodecRegistry()
org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>	getDefaultNodeFor(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier parentMapPath)
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 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)
void	onGlobalContextUpdated(org.opendaylight.yangtools.yang.model.api.SchemaContext context)
com.google.common.base.Optional<Map.Entry<InstanceIdentifier<? extends DataObject>,DataObject>>	toBinding(Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,? extends org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>> normalized)
com.google.common.base.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)
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	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

BindingToNormalizedNodeCodec

public BindingToNormalizedNodeCodec(ClassLoadingStrategy classLoadingStrategy,
                                    BindingNormalizedNodeCodecRegistry codecRegistry)

BindingToNormalizedNodeCodec

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

Method Detail

toNormalized

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

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

toNormalizedNode

public 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 Map.Entry<InstanceIdentifier<?>,DataObject> 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

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

fromNormalizedNodeRpcData

public DataObject fromNormalizedNodeRpcData(@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 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

fromYangInstanceIdentifier

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.

toNormalizedNodeNotification

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

toNormalizedNodeRpcData

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

toBinding

public com.google.common.base.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.absent for cases where target is mixin node except augmentation.

Throws:

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

toBinding

public com.google.common.base.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

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)

getCodecRegistry

public BindingNormalizedNodeCodecRegistry getCodecRegistry()

close

public void close()

Specified by:

close in interface AutoCloseable

getCodecFactory

public BindingNormalizedNodeCodecRegistry getCodecFactory()

getRpcMethodToSchemaPath

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

getSubtreeCodec

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

getNotificationClasses

public 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

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

toDOMDataTreeIdentifiers

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

toDOMDataTreeIdentifier

protected DOMDataTreeIdentifier toDOMDataTreeIdentifier(DataTreeIdentifier<?> path)