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;
12 import java.util.AbstractMap.SimpleEntry;
13 import java.util.Iterator;
14 import java.util.Map.Entry;
15 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizationException;
16 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizationOperation;
17 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizer;
18 import org.opendaylight.yangtools.binding.data.codec.impl.BindingNormalizedNodeCodecRegistry;
19 import org.opendaylight.yangtools.sal.binding.generator.impl.GeneratedClassLoadingStrategy;
20 import org.opendaylight.yangtools.sal.binding.generator.util.BindingRuntimeContext;
21 import org.opendaylight.yangtools.yang.binding.DataObject;
22 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
24 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
25 import org.opendaylight.yangtools.yang.data.impl.codec.BindingIndependentMappingService;
26 import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException;
27 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
28 import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
29 import org.slf4j.Logger;
30 import org.slf4j.LoggerFactory;
32 public class BindingToNormalizedNodeCodec implements SchemaContextListener,AutoCloseable {
34 private static final Logger LOG = LoggerFactory.getLogger(BindingToNormalizedNodeCodec.class);
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 org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier toNormalized(
50 final InstanceIdentifier<? extends DataObject> binding) {
51 return codecRegistry.toYangInstanceIdentifier(binding);
54 @SuppressWarnings({ "unchecked", "rawtypes" })
55 public Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalizedNode(
56 final InstanceIdentifier<? extends DataObject> bindingPath, final DataObject bindingObject) {
57 return codecRegistry.toNormalizedNode((InstanceIdentifier) bindingPath, bindingObject);
61 public Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalizedNode(
62 final Entry<org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends DataObject>, DataObject> binding) {
63 return toNormalizedNode(binding.getKey(),binding.getValue());
68 * Returns a Binding-Aware instance identifier from normalized
69 * instance-identifier if it is possible to create representation.
71 * Returns Optional.absent for cases where target is mixin node except
75 public Optional<InstanceIdentifier<? extends DataObject>> toBinding(
76 final org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier normalized)
77 throws DeserializationException {
79 return Optional.<InstanceIdentifier<? extends DataObject>>of(codecRegistry.fromYangInstanceIdentifier(normalized));
80 } catch (IllegalArgumentException e) {
81 return Optional.absent();
86 private static final Entry<org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends DataObject>, DataObject> toBindingEntry(
87 final org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends DataObject> key,
88 final DataObject value) {
89 return new SimpleEntry<org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends DataObject>, DataObject>(
93 public DataNormalizer getDataNormalizer() {
94 return legacyToNormalized;
97 @SuppressWarnings("unchecked")
98 public Optional<Entry<org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends DataObject>, DataObject>> toBinding(
99 final Entry<org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> normalized)
100 throws DeserializationException {
102 @SuppressWarnings("rawtypes")
103 Entry binding = codecRegistry.fromNormalizedNode(normalized.getKey(), normalized.getValue());
104 return Optional.<Entry<org.opendaylight.yangtools.yang.binding.InstanceIdentifier<? extends DataObject>, DataObject>>fromNullable(binding);
105 } catch (IllegalArgumentException e) {
106 return Optional.absent();
111 public void onGlobalContextUpdated(final SchemaContext arg0) {
112 legacyToNormalized = new DataNormalizer(arg0);
113 codecRegistry.onBindingRuntimeContextUpdated(BindingRuntimeContext.create(classLoadingStrategy, arg0));
116 public <T extends DataObject> Function<Optional<NormalizedNode<?, ?>>, Optional<T>> deserializeFunction(final InstanceIdentifier<T> path) {
117 return codecRegistry.deserializeFunction(path);
121 * Returns an default object according to YANG schema for supplied path.
123 * @param path DOM Path
124 * @return Node with defaults set on.
126 public NormalizedNode<?, ?> getDefaultNodeFor(final org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path) {
127 Iterator<PathArgument> iterator = path.getPathArguments().iterator();
128 DataNormalizationOperation<?> currentOp = legacyToNormalized.getRootOperation();
129 while (iterator.hasNext()) {
130 PathArgument currentArg = iterator.next();
132 currentOp = currentOp.getChild(currentArg);
133 } catch (DataNormalizationException e) {
134 throw new IllegalArgumentException(String.format("Invalid child encountered in path %s", path), e);
137 return currentOp.createDefault(path.getLastPathArgument());
140 public BindingIndependentMappingService getLegacy() {
141 return bindingToLegacy;
145 public void close() throws Exception {
146 // NOOP Intentionally