2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.controller.md.sal.binding.impl;
10 import com.google.common.base.Function;
11 import com.google.common.base.Optional;
13 import java.util.Iterator;
14 import java.util.Map.Entry;
16 import javax.annotation.Nonnull;
18 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizationException;
19 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizationOperation;
20 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizer;
21 import org.opendaylight.yangtools.binding.data.codec.impl.BindingNormalizedNodeCodecRegistry;
22 import org.opendaylight.yangtools.sal.binding.generator.impl.GeneratedClassLoadingStrategy;
23 import org.opendaylight.yangtools.sal.binding.generator.util.BindingRuntimeContext;
24 import org.opendaylight.yangtools.yang.binding.DataObject;
25 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
27 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
28 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
29 import org.opendaylight.yangtools.yang.data.impl.codec.BindingIndependentMappingService;
30 import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException;
31 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
32 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
34 public class BindingToNormalizedNodeCodec implements SchemaContextListener,AutoCloseable {
36 private final BindingIndependentMappingService bindingToLegacy;
37 private final BindingNormalizedNodeCodecRegistry codecRegistry;
38 private DataNormalizer legacyToNormalized;
39 private final GeneratedClassLoadingStrategy classLoadingStrategy;
41 public BindingToNormalizedNodeCodec(final GeneratedClassLoadingStrategy classLoadingStrategy, final BindingIndependentMappingService mappingService, final BindingNormalizedNodeCodecRegistry codecRegistry) {
43 this.bindingToLegacy = mappingService;
44 this.classLoadingStrategy = classLoadingStrategy;
45 this.codecRegistry = codecRegistry;
49 public YangInstanceIdentifier toNormalized(final InstanceIdentifier<? extends DataObject> binding) {
50 return codecRegistry.toYangInstanceIdentifier(binding);
53 @SuppressWarnings({ "unchecked", "rawtypes" })
54 public Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalizedNode(
55 final InstanceIdentifier<? extends DataObject> bindingPath, final DataObject bindingObject) {
56 return codecRegistry.toNormalizedNode((InstanceIdentifier) bindingPath, bindingObject);
60 public Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalizedNode(
61 final Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding) {
62 return toNormalizedNode(binding.getKey(),binding.getValue());
67 * Returns a Binding-Aware instance identifier from normalized
68 * instance-identifier if it is possible to create representation.
70 * Returns Optional.absent for cases where target is mixin node except
74 public Optional<InstanceIdentifier<? extends DataObject>> toBinding(final YangInstanceIdentifier normalized)
75 throws DeserializationException {
77 return Optional.<InstanceIdentifier<? extends DataObject>>fromNullable(codecRegistry.fromYangInstanceIdentifier(normalized));
78 } catch (IllegalArgumentException e) {
79 return Optional.absent();
83 public DataNormalizer getDataNormalizer() {
84 return legacyToNormalized;
87 public Optional<Entry<InstanceIdentifier<? extends DataObject>, DataObject>> toBinding(
88 final @Nonnull Entry<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> normalized)
89 throws DeserializationException {
92 * This cast is required, due to generics behaviour in openjdk / oracle javac
94 * InstanceIdentifier has definition InstanceIdentifier<T extends DataObject>,
95 * this means '?' is always <? extends DataObject>. Eclipse compiler
96 * is able to determine this relationship and treats
97 * Entry<InstanceIdentifier<?>,DataObject> and Entry<InstanceIdentifier<? extends DataObject,DataObject>
98 * as assignable. However openjdk / oracle javac treats this two types
99 * as incompatible and issues a compile error.
101 * It is safe to loose generic information and cast it to other generic signature.
104 @SuppressWarnings({ "unchecked", "rawtypes" })
105 final Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding = (Entry) codecRegistry.fromNormalizedNode(normalized.getKey(), normalized.getValue());
106 return Optional.fromNullable(binding);
107 } catch (IllegalArgumentException e) {
108 return Optional.absent();
113 public void onGlobalContextUpdated(final SchemaContext arg0) {
114 legacyToNormalized = new DataNormalizer(arg0);
115 codecRegistry.onBindingRuntimeContextUpdated(BindingRuntimeContext.create(classLoadingStrategy, arg0));
118 public <T extends DataObject> Function<Optional<NormalizedNode<?, ?>>, Optional<T>> deserializeFunction(final InstanceIdentifier<T> path) {
119 return codecRegistry.deserializeFunction(path);
123 * Returns an default object according to YANG schema for supplied path.
125 * @param path DOM Path
126 * @return Node with defaults set on.
128 public NormalizedNode<?, ?> getDefaultNodeFor(final YangInstanceIdentifier path) {
129 Iterator<PathArgument> iterator = path.getPathArguments().iterator();
130 DataNormalizationOperation<?> currentOp = legacyToNormalized.getRootOperation();
131 while (iterator.hasNext()) {
132 PathArgument currentArg = iterator.next();
134 currentOp = currentOp.getChild(currentArg);
135 } catch (DataNormalizationException e) {
136 throw new IllegalArgumentException(String.format("Invalid child encountered in path %s", path), e);
139 return currentOp.createDefault(path.getLastPathArgument());
142 public BindingIndependentMappingService getLegacy() {
143 return bindingToLegacy;
147 public void close() {
148 // NOOP Intentionally