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.mdsal.binding.dom.codec.impl;
10 import com.google.common.base.Optional;
11 import com.google.common.collect.ImmutableCollection;
12 import com.google.common.collect.ImmutableSet;
13 import java.io.IOException;
14 import java.util.List;
15 import javax.annotation.Nonnull;
16 import javax.annotation.Nullable;
17 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeCachingCodec;
18 import org.opendaylight.yangtools.yang.binding.BindingStreamEventWriter;
19 import org.opendaylight.yangtools.yang.binding.DataObject;
20 import org.opendaylight.yangtools.yang.binding.DataObjectSerializer;
21 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
22 import org.opendaylight.yangtools.yang.common.QName;
23 import org.opendaylight.yangtools.yang.common.QNameModule;
24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
25 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
26 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
27 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
28 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
29 import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
31 abstract class DataContainerCodecContext<D extends DataObject, T extends WithStatus> extends NodeCodecContext<D> {
33 private final DataContainerCodecPrototype<T> prototype;
34 private volatile DataObjectSerializer eventStreamSerializer;
36 protected DataContainerCodecContext(final DataContainerCodecPrototype<T> prototype) {
37 this.prototype = prototype;
41 public final T getSchema() {
42 return prototype.getSchema();
46 public final ChildAddressabilitySummary getChildAddressabilitySummary() {
47 return prototype.getChildAddressabilitySummary();
50 protected final QNameModule namespace() {
51 return prototype.getNamespace();
54 protected final CodecContextFactory factory() {
55 return prototype.getFactory();
59 protected YangInstanceIdentifier.PathArgument getDomPathArgument() {
60 return prototype.getYangArg();
64 * Returns nested node context using supplied YANG Instance Identifier.
66 * @param arg Yang Instance Identifier Argument
67 * @return Context of child
68 * @throws IllegalArgumentException If supplied argument does not represent valid child.
71 public abstract NodeCodecContext<?> yangPathArgumentChild(YangInstanceIdentifier.PathArgument arg);
74 * Returns nested node context using supplied Binding Instance Identifier
75 * and adds YANG instance identifiers to supplied list.
77 * @param arg Binding Instance Identifier Argument
78 * @return Context of child or null if supplied {@code arg} does not represent valid child.
79 * @throws IllegalArgumentException If supplied argument does not represent valid child.
83 public DataContainerCodecContext<?,?> bindingPathArgumentChild(final PathArgument arg,
84 final List<YangInstanceIdentifier.PathArgument> builder) {
85 final DataContainerCodecContext<?,?> child = streamChild(arg.getType());
87 if (builder != null) {
88 child.addYangPathArgument(arg,builder);
92 throw new IllegalArgumentException("Supplied argument is not valid child");
96 * Returns deserialized Binding Path Argument from YANG instance identifier.
98 protected PathArgument getBindingPathArgument(final YangInstanceIdentifier.PathArgument domArg) {
102 protected final PathArgument bindingArg() {
103 return prototype.getBindingArg();
106 @SuppressWarnings("unchecked")
108 public final Class<D> getBindingClass() {
109 return Class.class.cast(prototype.getBindingClass());
113 * Returns child context as if it was walked by {@link BindingStreamEventWriter}. This means that to enter case, one
114 * must issue getChild(ChoiceClass).getChild(CaseClass).
116 * @param childClass child class
117 * @return Context of child node or null, if supplied class is not subtree child
118 * @throws IllegalArgumentException If supplied child class is not valid in specified context.
121 public abstract @Nullable <C extends DataObject> DataContainerCodecContext<C, ?> streamChild(Class<C> childClass);
124 * Returns child context as if it was walked by {@link BindingStreamEventWriter}. This means that to enter case, one
125 * must issue getChild(ChoiceClass).getChild(CaseClass).
127 * @param childClass child class
128 * @return Context of child or Optional absent is supplied class is not applicable in context.
131 public abstract <C extends DataObject> Optional<DataContainerCodecContext<C,?>> possibleStreamChild(
132 Class<C> childClass);
135 public String toString() {
136 return getClass().getSimpleName() + " [" + prototype.getBindingClass() + "]";
140 public BindingNormalizedNodeCachingCodec<D> createCachingCodec(
141 final ImmutableCollection<Class<? extends DataObject>> cacheSpecifier) {
142 if (cacheSpecifier.isEmpty()) {
143 return new NonCachingCodec<>(this);
145 return new CachingNormalizedNodeCodec<>(this,ImmutableSet.copyOf(cacheSpecifier));
148 BindingStreamEventWriter createWriter(final NormalizedNodeStreamWriter domWriter) {
149 return BindingToNormalizedStreamWriter.create(this, domWriter);
153 protected final <V> V childNonNull(@Nullable final V nullable, final YangInstanceIdentifier.PathArgument child,
154 final String message, final Object... args) {
155 if (nullable != null) {
158 MissingSchemaException.checkModulePresent(factory().getRuntimeContext().getSchemaContext(), child);
159 throw IncorrectNestingException.create(message, args);
163 protected final <V> V childNonNull(@Nullable final V nullable, final QName child, final String message,
164 final Object... args) {
165 if (nullable != null) {
168 MissingSchemaException.checkModulePresent(factory().getRuntimeContext().getSchemaContext(), child);
169 throw IncorrectNestingException.create(message, args);
173 protected final <V> V childNonNull(@Nullable final V nullable, final Class<?> childClass, final String message,
174 final Object... args) {
175 if (nullable != null) {
178 MissingSchemaForClassException.check(factory().getRuntimeContext(), childClass);
179 MissingClassInLoadingStrategyException.check(factory().getRuntimeContext().getStrategy(), childClass);
180 throw IncorrectNestingException.create(message, args);
183 DataObjectSerializer eventStreamSerializer() {
184 if (eventStreamSerializer == null) {
185 eventStreamSerializer = factory().getEventStreamSerializer(getBindingClass());
187 return eventStreamSerializer;
191 public NormalizedNode<?, ?> serialize(final D data) {
192 final NormalizedNodeResult result = new NormalizedNodeResult();
193 // We create DOM stream writer which produces normalized nodes
194 final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
195 writeAsNormalizedNode(data, domWriter);
196 return result.getResult();
200 public void writeAsNormalizedNode(final D data, final NormalizedNodeStreamWriter writer) {
202 eventStreamSerializer().serialize(data, createWriter(writer));
203 } catch (final IOException e) {
204 throw new IllegalStateException("Failed to serialize Binding DTO",e);