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

Class BindingToNormalizedNodeCodec

java.lang.Object

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

All Implemented Interfaces:

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

@Beta
public final class BindingToNormalizedNodeCodec
extends Object
implements BindingTreeCodecFactory, BindingNormalizedNodeSerializer, org.opendaylight.yangtools.yang.model.api.SchemaContextListener, AutoCloseable

Codec for serialize/deserialize Binding and DOM data.

Constructor Summary

Constructors

Constructor and Description
BindingToNormalizedNodeCodec(GeneratedClassLoadingStrategy classLoadingStrategy, BindingNormalizedNodeCodecRegistry codecRegistry) Init class without waiting for schema.
BindingToNormalizedNodeCodec(GeneratedClassLoadingStrategy classLoadingStrategy, BindingNormalizedNodeCodecRegistry codecRegistry, boolean waitForSchema) Init class with waiting for schema.

Method Summary

Modifier and Type	Method and Description
void	close()
BindingTreeCodec	create(BindingRuntimeContext context) Creates Binding Codec Tree for specified Binding runtime context.
BindingTreeCodec	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) Prepare deserialize function of Binding identifier to DOM.
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.
com.google.common.collect.ImmutableBiMap<Method,org.opendaylight.yangtools.yang.model.api.OperationDefinition>	getActionMethodToSchema(Class<?> key) Resolve method with definition of specific action as binding object.
org.opendaylight.yangtools.yang.model.api.SchemaPath	getActionPath(Class<? extends Action<?,?,?,?>> type) Get Action schema path.
BindingNormalizedNodeCodecRegistry	getCodecFactory() Get codec factory.
BindingNormalizedNodeCodecRegistry	getCodecRegistry() Get codec registry.
org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>	getDefaultNodeFor(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier parentMapPath) Get default DOM object on path for list.
Set<Class<? extends Notification>>	getNotificationClasses(Set<org.opendaylight.yangtools.yang.model.api.SchemaPath> interested) Get specific notification classes as Binding objects.
org.opendaylight.yangtools.yang.model.api.RpcDefinition	getRpcDefinition(Class<? extends Rpc<?,?>> type)
com.google.common.collect.ImmutableBiMap<Method,org.opendaylight.yangtools.yang.model.api.OperationDefinition>	getRPCMethodToSchema(Class<?> key) Resolve method with definition of specific RPC as binding object.
com.google.common.collect.ImmutableBiMap<Method,org.opendaylight.yangtools.yang.model.api.SchemaPath>	getRPCMethodToSchemaPath(Class<?> key) Deprecated.
org.opendaylight.yangtools.yang.model.api.SchemaPath	getRpcPath(Class<? extends Rpc<?,?>> type) Get RPC schema path.
Map.Entry<InstanceIdentifier<?>,BindingTreeNodeCodec<?>>	getSubtreeCodec(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier domIdentifier) Get subtree codec of DOM identifier.
org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>	instanceIdentifierToNode(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier parentPath) Resolve DOM object on specific DOM identifier.
void	onGlobalContextUpdated(org.opendaylight.yangtools.yang.model.api.SchemaContext arg0)
Optional<Map.Entry<InstanceIdentifier<? extends TreeNode>,TreeNode>>	toBinding(Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,? extends org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>> normalized) DOM to Binding.
Optional<InstanceIdentifier<? extends TreeNode>>	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.
DOMDataTreeIdentifier	toDOMDataTreeIdentifier(DataTreeIdentifier<?> path) Create new DOM data tree identifier from Binding data tree identifier.
Collection<DOMDataTreeIdentifier>	toDOMDataTreeIdentifiers(Collection<DataTreeIdentifier<?>> subtrees) Binding subtree identifiers to DOM subtree identifiers.
<P extends TreeNode> Set<DOMDataTreeIdentifier>	toDOMDataTreeIdentifiers(Set<DataTreeIdentifier<P>> subtrees)
org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier	toNormalized(InstanceIdentifier<? extends TreeNode> binding) Translates supplied Binding Instance Identifier into NormalizedNode instance identifier.
<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.
Map.Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier,org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>	toNormalizedNode(Map.Entry<InstanceIdentifier<? extends TreeNode>,TreeNode> 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	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.
org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier	toYangInstanceIdentifierBlocking(InstanceIdentifier<? extends TreeNode> binding) Translates supplied Binding Instance Identifier into NormalizedNode instance identifier with waiting for schema.
org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier	toYangInstanceIdentifierCached(InstanceIdentifier<?> binding) Get cached DOM identifier of Binding identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

BindingToNormalizedNodeCodec

public BindingToNormalizedNodeCodec(GeneratedClassLoadingStrategy classLoadingStrategy,
                                    BindingNormalizedNodeCodecRegistry codecRegistry)

Init class without waiting for schema.

Parameters:

classLoadingStrategy - - class loader

codecRegistry - - codec registry

BindingToNormalizedNodeCodec

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

Init class with waiting for schema.

Parameters:

classLoadingStrategy - - class loader

codecRegistry - - codec registry

waitForSchema - - boolean of waiting for schema

Method Detail

toYangInstanceIdentifierBlocking

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

Translates supplied Binding Instance Identifier into NormalizedNode instance identifier with waiting for schema.

Parameters:

binding - - Binding Instance Identifier

Returns:

DOM Instance Identifier

toNormalized

public org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier toNormalized(InstanceIdentifier<? extends TreeNode> 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

@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

toYangInstanceIdentifierCached

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

Get cached DOM identifier of Binding identifier.

Parameters:

binding - - binding identifier

Returns:

DOM identifier

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

toNormalizedNode

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

Converts Binding Map.Entry to DOM Map.Entry.

Same as toNormalizedNode(InstanceIdentifier, TreeNode).

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

@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

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

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

toBinding

public Optional<InstanceIdentifier<? extends TreeNode>> 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 Optional<Map.Entry<InstanceIdentifier<? extends TreeNode>,TreeNode>> 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

DOM to Binding.

Parameters:

normalized - - DOM object

Returns:

Binding object

Throws:

org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException - If fail to deserialize

onGlobalContextUpdated

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

Specified by:

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

deserializeFunction

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

Prepare deserialize function of Binding identifier to DOM.

Parameters:

path - - Binding identifier

Returns:

DOM function

getCodecRegistry

public BindingNormalizedNodeCodecRegistry getCodecRegistry()

Get codec registry.

Returns:

codec registry

close

public void close()

Specified by:

close in interface AutoCloseable

getCodecFactory

public BindingNormalizedNodeCodecRegistry getCodecFactory()

Get codec factory.

Returns:

codec factory

getRPCMethodToSchemaPath

@Deprecated
public com.google.common.collect.ImmutableBiMap<Method,org.opendaylight.yangtools.yang.model.api.SchemaPath> getRPCMethodToSchemaPath(Class<?> key)

Deprecated.

Resolve method with path of specific RPC as binding object.

Parameters:

key - - RPC as binding object

Returns:

map of method with path of specific RPC

getActionPath

public org.opendaylight.yangtools.yang.model.api.SchemaPath getActionPath(Class<? extends Action<?,?,?,?>> type)

Get Action schema path.

Parameters:

type - - Action implementation class type

Returns:

schema path of Action

getRpcPath

public org.opendaylight.yangtools.yang.model.api.SchemaPath getRpcPath(Class<? extends Rpc<?,?>> type)

Get RPC schema path.

Parameters:

type - - RPC implementation class type

Returns:

schema path of RPC

getRpcDefinition

public org.opendaylight.yangtools.yang.model.api.RpcDefinition getRpcDefinition(Class<? extends Rpc<?,?>> type)

getRPCMethodToSchema

public com.google.common.collect.ImmutableBiMap<Method,org.opendaylight.yangtools.yang.model.api.OperationDefinition> getRPCMethodToSchema(Class<?> key)

Resolve method with definition of specific RPC as binding object.

Parameters:

key - - RPC as binding object

Returns:

map of method with definition of specific RPC

getActionMethodToSchema

public com.google.common.collect.ImmutableBiMap<Method,org.opendaylight.yangtools.yang.model.api.OperationDefinition> getActionMethodToSchema(Class<?> key)

Resolve method with definition of specific action as binding object.

Parameters:

key - - action as binding object

Returns:

map of method with definition of specific action

create

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

getSubtreeCodec

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

Get subtree codec of DOM identifier.

Parameters:

domIdentifier - - DOM identifier

Returns:

codec for subtree

getNotificationClasses

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

Get specific notification classes as Binding objects.

Parameters:

interested - - set of specific notifications paths

Returns:

notification as Binding objects according to input set of their DOM paths

instanceIdentifierToNode

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

Resolve DOM object on specific DOM identifier.

Parameters:

parentPath - - DOM identifier

Returns:

DOM object

getDefaultNodeFor

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

Get default DOM object on path for list.

Parameters:

parentMapPath - - path

Returns:

specific DOM object

toDOMDataTreeIdentifiers

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

Binding subtree identifiers to DOM subtree identifiers.

Parameters:

subtrees - - binding subtree

Returns:

DOM subtree

toDOMDataTreeIdentifiers

public <P extends TreeNode> Set<DOMDataTreeIdentifier> toDOMDataTreeIdentifiers(Set<DataTreeIdentifier<P>> subtrees)

toDOMDataTreeIdentifier

public DOMDataTreeIdentifier toDOMDataTreeIdentifier(DataTreeIdentifier<?> path)

Create new DOM data tree identifier from Binding data tree identifier.

Parameters:

path - - binding data tree identifier

Returns:

DOM data tree identifier