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 static com.google.common.base.Preconditions.checkArgument;
11 import static com.google.common.base.Preconditions.checkState;
12 import static com.google.common.base.Verify.verify;
13 import static java.util.Objects.requireNonNull;
15 import com.google.common.cache.CacheBuilder;
16 import com.google.common.cache.CacheLoader;
17 import com.google.common.cache.LoadingCache;
18 import com.google.common.collect.ImmutableMap;
19 import java.io.IOException;
20 import java.lang.reflect.Field;
21 import java.lang.reflect.Method;
22 import java.lang.reflect.ParameterizedType;
23 import java.lang.reflect.Type;
24 import java.util.AbstractMap.SimpleEntry;
25 import java.util.Collection;
26 import java.util.HashMap;
27 import java.util.LinkedList;
28 import java.util.List;
30 import java.util.Map.Entry;
31 import java.util.Optional;
32 import java.util.concurrent.Callable;
33 import java.util.concurrent.ExecutionException;
34 import org.eclipse.jdt.annotation.NonNull;
35 import org.eclipse.jdt.annotation.Nullable;
36 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTree;
37 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeNode;
38 import org.opendaylight.mdsal.binding.dom.codec.api.BindingDataObjectCodecTreeNode;
39 import org.opendaylight.mdsal.binding.dom.codec.api.BindingStreamEventWriter;
40 import org.opendaylight.mdsal.binding.dom.codec.impl.NodeCodecContext.CodecContextFactory;
41 import org.opendaylight.mdsal.binding.dom.codec.loader.CodecClassLoader;
42 import org.opendaylight.mdsal.binding.dom.codec.util.BindingSchemaMapping;
43 import org.opendaylight.mdsal.binding.generator.util.BindingRuntimeContext;
44 import org.opendaylight.mdsal.binding.model.api.GeneratedType;
45 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
46 import org.opendaylight.yangtools.concepts.Delegator;
47 import org.opendaylight.yangtools.concepts.IllegalArgumentCodec;
48 import org.opendaylight.yangtools.concepts.Immutable;
49 import org.opendaylight.yangtools.util.ClassLoaderUtils;
50 import org.opendaylight.yangtools.yang.binding.Action;
51 import org.opendaylight.yangtools.yang.binding.DataContainer;
52 import org.opendaylight.yangtools.yang.binding.DataObject;
53 import org.opendaylight.yangtools.yang.binding.Identifiable;
54 import org.opendaylight.yangtools.yang.binding.Identifier;
55 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
56 import org.opendaylight.yangtools.yang.binding.Notification;
57 import org.opendaylight.yangtools.yang.binding.OpaqueObject;
58 import org.opendaylight.yangtools.yang.common.QName;
59 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
60 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
61 import org.opendaylight.yangtools.yang.model.api.AnydataSchemaNode;
62 import org.opendaylight.yangtools.yang.model.api.AnyxmlSchemaNode;
63 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
64 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
65 import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
66 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
67 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
68 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
69 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
70 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
71 import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode;
72 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
73 import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
74 import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
75 import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
76 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
77 import org.slf4j.Logger;
78 import org.slf4j.LoggerFactory;
80 final class BindingCodecContext implements CodecContextFactory, BindingCodecTree, DataObjectSerializerRegistry,
82 private final class DataObjectSerializerProxy implements DataObjectSerializer, Delegator<DataObjectStreamer<?>> {
83 private final @NonNull DataObjectStreamer<?> delegate;
85 DataObjectSerializerProxy(final DataObjectStreamer<?> delegate) {
86 this.delegate = requireNonNull(delegate);
90 public DataObjectStreamer<?> getDelegate() {
95 public void serialize(final DataObject obj, final BindingStreamEventWriter stream) throws IOException {
96 delegate.serialize(BindingCodecContext.this, obj, stream);
100 private static final Logger LOG = LoggerFactory.getLogger(BindingCodecContext.class);
102 private final LoadingCache<Class<?>, DataObjectStreamer<?>> streamers = CacheBuilder.newBuilder().build(
103 new CacheLoader<Class<?>, DataObjectStreamer<?>>() {
105 public DataObjectStreamer<?> load(final Class<?> key) throws ReflectiveOperationException {
106 final Class<?> streamer = DataObjectStreamerGenerator.generateStreamer(loader, BindingCodecContext.this,
108 final Field instance = streamer.getDeclaredField(DataObjectStreamerGenerator.INSTANCE_FIELD);
109 return (DataObjectStreamer<?>) instance.get(null);
112 private final LoadingCache<Class<?>, DataObjectSerializer> serializers = CacheBuilder.newBuilder().build(
113 new CacheLoader<Class<?>, DataObjectSerializer>() {
115 public DataObjectSerializer load(final Class<?> key) throws ExecutionException {
116 return new DataObjectSerializerProxy(streamers.get(key));
120 private final @NonNull CodecClassLoader loader = CodecClassLoader.create();
121 private final InstanceIdentifierCodec instanceIdentifierCodec;
122 private final @NonNull IdentityCodec identityCodec;
123 private final BindingNormalizedNodeCodecRegistry registry;
124 private final BindingRuntimeContext context;
125 private final SchemaRootCodecContext<?> root;
127 BindingCodecContext(final BindingRuntimeContext context, final BindingNormalizedNodeCodecRegistry registry) {
128 this.context = requireNonNull(context, "Binding Runtime Context is required.");
129 this.root = SchemaRootCodecContext.create(this);
130 this.identityCodec = new IdentityCodec(context);
131 this.instanceIdentifierCodec = new InstanceIdentifierCodec(this);
132 this.registry = requireNonNull(registry);
136 public BindingRuntimeContext getRuntimeContext() {
141 public CodecClassLoader getLoader() {
145 InstanceIdentifierCodec getInstanceIdentifierCodec() {
146 return instanceIdentifierCodec;
150 public IdentityCodec getIdentityCodec() {
151 return identityCodec;
154 @SuppressWarnings({"rawtypes", "unchecked"})
156 public DataObjectSerializer getEventStreamSerializer(final Class<?> type) {
157 return registry.getSerializer((Class) type);
161 public DataObjectStreamer<?> getDataObjectSerializer(final Class<?> type) {
162 return streamers.getUnchecked(type);
166 public DataObjectSerializer getSerializer(final Class<? extends DataObject> type) {
167 return serializers.getUnchecked(type);
170 public Entry<YangInstanceIdentifier, BindingStreamEventWriter> newWriter(final InstanceIdentifier<?> path,
171 final NormalizedNodeStreamWriter domWriter) {
172 final List<YangInstanceIdentifier.PathArgument> yangArgs = new LinkedList<>();
173 final DataContainerCodecContext<?,?> codecContext = getCodecContextNode(path, yangArgs);
174 return new SimpleEntry<>(YangInstanceIdentifier.create(yangArgs), codecContext.createWriter(domWriter));
177 public BindingStreamEventWriter newWriterWithoutIdentifier(final InstanceIdentifier<?> path,
178 final NormalizedNodeStreamWriter domWriter) {
179 return getCodecContextNode(path, null).createWriter(domWriter);
182 BindingStreamEventWriter newRpcWriter(final Class<? extends DataContainer> rpcInputOrOutput,
183 final NormalizedNodeStreamWriter domWriter) {
184 return root.getRpc(rpcInputOrOutput).createWriter(domWriter);
187 BindingStreamEventWriter newNotificationWriter(final Class<? extends Notification> notification,
188 final NormalizedNodeStreamWriter domWriter) {
189 return root.getNotification(notification).createWriter(domWriter);
192 public DataContainerCodecContext<?,?> getCodecContextNode(final InstanceIdentifier<?> binding,
193 final List<YangInstanceIdentifier.PathArgument> builder) {
194 DataContainerCodecContext<?,?> currentNode = root;
195 for (final InstanceIdentifier.PathArgument bindingArg : binding.getPathArguments()) {
196 currentNode = currentNode.bindingPathArgumentChild(bindingArg, builder);
197 checkArgument(currentNode != null, "Supplied Instance Identifier %s is not valid.", binding);
203 * Multi-purpose utility function. Traverse the codec tree, looking for
204 * the appropriate codec for the specified {@link YangInstanceIdentifier}.
205 * As a side-effect, gather all traversed binding {@link InstanceIdentifier.PathArgument}s
206 * into the supplied collection.
208 * @param dom {@link YangInstanceIdentifier} which is to be translated
209 * @param bindingArguments Collection for traversed path arguments
210 * @return Codec for target node, or @null if the node does not have a
211 * binding representation (choice, case, leaf).
214 @Nullable BindingDataObjectCodecTreeNode<?> getCodecContextNode(final @NonNull YangInstanceIdentifier dom,
215 final @Nullable Collection<InstanceIdentifier.PathArgument> bindingArguments) {
216 NodeCodecContext currentNode = root;
217 ListNodeCodecContext<?> currentList = null;
219 for (final YangInstanceIdentifier.PathArgument domArg : dom.getPathArguments()) {
220 checkArgument(currentNode instanceof DataContainerCodecContext,
221 "Unexpected child of non-container node %s", currentNode);
222 final DataContainerCodecContext<?,?> previous = (DataContainerCodecContext<?, ?>) currentNode;
223 final NodeCodecContext nextNode = previous.yangPathArgumentChild(domArg);
226 * List representation in YANG Instance Identifier consists of two
227 * arguments: first is list as a whole, second is list as an item so
228 * if it is /list it means list as whole, if it is /list/list - it
229 * is wildcarded and if it is /list/list[key] it is concrete item,
230 * all this variations are expressed in Binding Aware Instance
231 * Identifier as Item or IdentifiableItem
233 if (currentList != null) {
234 checkArgument(currentList == nextNode,
235 "List should be referenced two times in YANG Instance Identifier %s", dom);
237 // We entered list, so now we have all information to emit
238 // list path using second list argument.
239 if (bindingArguments != null) {
240 bindingArguments.add(currentList.getBindingPathArgument(domArg));
243 currentNode = nextNode;
244 } else if (nextNode instanceof ListNodeCodecContext) {
245 // We enter list, we do not update current Node yet,
246 // since we need to verify
247 currentList = (ListNodeCodecContext<?>) nextNode;
248 } else if (nextNode instanceof ChoiceNodeCodecContext) {
249 // We do not add path argument for choice, since
250 // it is not supported by binding instance identifier.
251 currentNode = nextNode;
252 } else if (nextNode instanceof DataContainerCodecContext) {
253 if (bindingArguments != null) {
254 bindingArguments.add(((DataContainerCodecContext<?, ?>) nextNode).getBindingPathArgument(domArg));
256 currentNode = nextNode;
257 } else if (nextNode instanceof ValueNodeCodecContext) {
258 LOG.debug("Instance identifier referencing a leaf is not representable ({})", dom);
263 // Algorithm ended in list as whole representation
264 // we sill need to emit identifier for list
265 if (currentNode instanceof ChoiceNodeCodecContext) {
266 LOG.debug("Instance identifier targeting a choice is not representable ({})", dom);
269 if (currentNode instanceof CaseNodeCodecContext) {
270 LOG.debug("Instance identifier targeting a case is not representable ({})", dom);
274 if (currentList != null) {
275 if (bindingArguments != null) {
276 bindingArguments.add(currentList.getBindingPathArgument(null));
280 if (currentNode != null) {
281 verify(currentNode instanceof BindingDataObjectCodecTreeNode, "Illegal return node %s for identifier %s",
283 return (BindingDataObjectCodecTreeNode<?>) currentNode;
288 NotificationCodecContext<?> getNotificationContext(final SchemaPath notification) {
289 return root.getNotification(notification);
292 RpcInputCodec<?> getRpcInputCodec(final SchemaPath path) {
293 return root.getRpc(path);
296 ActionCodecContext getActionCodec(final Class<? extends Action<?, ?, ?>> action) {
297 return root.getAction(action);
301 public ImmutableMap<Method, ValueNodeCodecContext> getLeafNodes(final Class<?> parentClass,
302 final DataNodeContainer childSchema) {
303 final Map<String, DataSchemaNode> getterToLeafSchema = new HashMap<>();
304 for (final DataSchemaNode leaf : childSchema.getChildNodes()) {
305 if (leaf instanceof TypedDataSchemaNode || leaf instanceof AnyxmlSchemaNode
306 || leaf instanceof AnydataSchemaNode) {
307 getterToLeafSchema.put(BindingSchemaMapping.getGetterMethodName(leaf), leaf);
310 return getLeafNodesUsingReflection(parentClass, getterToLeafSchema);
313 private ImmutableMap<Method, ValueNodeCodecContext> getLeafNodesUsingReflection(
314 final Class<?> parentClass, final Map<String, DataSchemaNode> getterToLeafSchema) {
315 final Map<Method, ValueNodeCodecContext> leaves = new HashMap<>();
316 for (final Method method : parentClass.getMethods()) {
317 if (method.getParameterCount() == 0) {
318 final DataSchemaNode schema = getterToLeafSchema.get(method.getName());
320 final ValueNodeCodecContext valueNode;
321 if (schema instanceof LeafSchemaNode) {
322 final LeafSchemaNode leafSchema = (LeafSchemaNode) schema;
324 final Class<?> valueType = method.getReturnType();
325 final IllegalArgumentCodec<Object, Object> codec = getCodec(valueType, leafSchema.getType());
326 valueNode = LeafNodeCodecContext.of(leafSchema, codec, method.getName(), valueType,
327 context.getSchemaContext());
328 } else if (schema instanceof LeafListSchemaNode) {
329 final Optional<Type> optType = ClassLoaderUtils.getFirstGenericParameter(
330 method.getGenericReturnType());
331 checkState(optType.isPresent(), "Failed to find return type for %s", method);
333 final Class<?> valueType;
334 final Type genericType = optType.get();
335 if (genericType instanceof Class<?>) {
336 valueType = (Class<?>) genericType;
337 } else if (genericType instanceof ParameterizedType) {
338 valueType = (Class<?>) ((ParameterizedType) genericType).getRawType();
340 throw new IllegalStateException("Unexpected return type " + genericType);
343 final LeafListSchemaNode leafListSchema = (LeafListSchemaNode) schema;
344 final IllegalArgumentCodec<Object, Object> codec = getCodec(valueType, leafListSchema.getType());
345 valueNode = new LeafSetNodeCodecContext(leafListSchema, codec, method.getName());
346 } else if (schema instanceof AnyxmlSchemaNode) {
347 valueNode = new OpaqueNodeCodecContext.Anyxml<>((AnyxmlSchemaNode) schema, method.getName(),
348 opaqueReturnType(method), loader);
349 } else if (schema instanceof AnydataSchemaNode) {
350 valueNode = new OpaqueNodeCodecContext.Anydata<>((AnydataSchemaNode) schema, method.getName(),
351 opaqueReturnType(method), loader);
353 verify(schema == null, "Unhandled schema %s for method %s", schema, method);
354 // We do not have schema for leaf, so we will ignore it (e.g. getClass).
358 leaves.put(method, valueNode);
361 return ImmutableMap.copyOf(leaves);
364 // FIXME: this is probably not right w.r.t. nulls
365 IllegalArgumentCodec<Object, Object> getCodec(final Class<?> valueType, final TypeDefinition<?> instantiatedType) {
366 if (Class.class.equals(valueType)) {
367 @SuppressWarnings({ "unchecked", "rawtypes" })
368 final IllegalArgumentCodec<Object, Object> casted = (IllegalArgumentCodec) identityCodec;
370 } else if (InstanceIdentifier.class.equals(valueType)) {
371 @SuppressWarnings({ "unchecked", "rawtypes" })
372 final IllegalArgumentCodec<Object, Object> casted = (IllegalArgumentCodec) instanceIdentifierCodec;
374 } else if (BindingReflections.isBindingClass(valueType)) {
375 return getCodecForBindingClass(valueType, instantiatedType);
377 return ValueTypeCodec.NOOP_CODEC;
380 @SuppressWarnings("checkstyle:illegalCatch")
381 // FIXME: this is probably not right w.r.t. nulls
382 private IllegalArgumentCodec<Object, Object> getCodecForBindingClass(final Class<?> valueType,
383 final TypeDefinition<?> typeDef) {
384 if (typeDef instanceof IdentityrefTypeDefinition) {
385 return ValueTypeCodec.encapsulatedValueCodecFor(valueType, typeDef, identityCodec);
386 } else if (typeDef instanceof InstanceIdentifierTypeDefinition) {
387 return ValueTypeCodec.encapsulatedValueCodecFor(valueType, typeDef, instanceIdentifierCodec);
388 } else if (typeDef instanceof UnionTypeDefinition) {
389 final Callable<UnionTypeCodec> unionLoader = UnionTypeCodec.loader(valueType, (UnionTypeDefinition) typeDef,
392 return unionLoader.call();
393 } catch (final Exception e) {
394 throw new IllegalStateException("Unable to load codec for " + valueType, e);
396 } else if (typeDef instanceof LeafrefTypeDefinition) {
397 final Entry<GeneratedType, WithStatus> typeWithSchema = context.getTypeWithSchema(valueType);
398 final WithStatus schema = typeWithSchema.getValue();
399 checkState(schema instanceof TypeDefinition);
400 return getCodec(valueType, (TypeDefinition<?>) schema);
402 return ValueTypeCodec.getCodecFor(valueType, typeDef);
406 public IdentifiableItemCodec getPathArgumentCodec(final Class<?> listClz, final ListSchemaNode schema) {
407 final Optional<Class<Identifier<?>>> optIdentifier = ClassLoaderUtils.findFirstGenericArgument(listClz,
409 checkState(optIdentifier.isPresent(), "Failed to find identifier for %s", listClz);
411 final Class<Identifier<?>> identifier = optIdentifier.get();
412 final Map<QName, ValueContext> valueCtx = new HashMap<>();
413 for (final ValueNodeCodecContext leaf : getLeafNodes(identifier, schema).values()) {
414 final QName name = leaf.getDomPathArgument().getNodeType();
415 valueCtx.put(name, new ValueContext(identifier, leaf));
417 return IdentifiableItemCodec.of(schema, identifier, listClz, valueCtx);
420 @SuppressWarnings("unchecked")
422 public <T extends DataObject> BindingDataObjectCodecTreeNode<T> getSubtreeCodec(final InstanceIdentifier<T> path) {
423 // TODO Do we need defensive check here?
424 return (BindingDataObjectCodecTreeNode<T>) getCodecContextNode(path, null);
428 public BindingCodecTreeNode getSubtreeCodec(final YangInstanceIdentifier path) {
429 return getCodecContextNode(path, null);
433 public BindingCodecTreeNode getSubtreeCodec(final Absolute path) {
434 throw new UnsupportedOperationException("Not implemented yet.");
437 @SuppressWarnings("rawtypes")
438 private static Class<? extends OpaqueObject> opaqueReturnType(final Method method) {
439 final Class<?> valueType = method.getReturnType();
440 verify(OpaqueObject.class.isAssignableFrom(valueType), "Illegal value type %s", valueType);
441 return valueType.asSubclass(OpaqueObject.class);