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.binding.runtime.api.BindingRuntimeContext;
37 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTree;
38 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeNode;
39 import org.opendaylight.mdsal.binding.dom.codec.api.BindingDataObjectCodecTreeNode;
40 import org.opendaylight.mdsal.binding.dom.codec.api.BindingStreamEventWriter;
41 import org.opendaylight.mdsal.binding.dom.codec.impl.NodeCodecContext.CodecContextFactory;
42 import org.opendaylight.mdsal.binding.dom.codec.loader.CodecClassLoader;
43 import org.opendaylight.mdsal.binding.dom.codec.spi.BindingSchemaMapping;
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 BindingRuntimeContext context;
124 private final SchemaRootCodecContext<?> root;
126 BindingCodecContext(final BindingRuntimeContext context) {
127 this.context = requireNonNull(context, "Binding Runtime Context is required.");
128 this.root = SchemaRootCodecContext.create(this);
129 this.identityCodec = new IdentityCodec(context);
130 this.instanceIdentifierCodec = new InstanceIdentifierCodec(this);
134 public BindingRuntimeContext getRuntimeContext() {
139 public CodecClassLoader getLoader() {
143 InstanceIdentifierCodec getInstanceIdentifierCodec() {
144 return instanceIdentifierCodec;
148 public IdentityCodec getIdentityCodec() {
149 return identityCodec;
153 public DataObjectSerializer getEventStreamSerializer(final Class<?> type) {
154 return serializers.getUnchecked(type);
158 public DataObjectStreamer<?> getDataObjectSerializer(final Class<?> type) {
159 return streamers.getUnchecked(type);
163 public DataObjectSerializer getSerializer(final Class<? extends DataObject> type) {
164 return serializers.getUnchecked(type);
167 public Entry<YangInstanceIdentifier, BindingStreamEventWriter> newWriter(final InstanceIdentifier<?> path,
168 final NormalizedNodeStreamWriter domWriter) {
169 final List<YangInstanceIdentifier.PathArgument> yangArgs = new LinkedList<>();
170 final DataContainerCodecContext<?,?> codecContext = getCodecContextNode(path, yangArgs);
171 return new SimpleEntry<>(YangInstanceIdentifier.create(yangArgs), codecContext.createWriter(domWriter));
174 public BindingStreamEventWriter newWriterWithoutIdentifier(final InstanceIdentifier<?> path,
175 final NormalizedNodeStreamWriter domWriter) {
176 return getCodecContextNode(path, null).createWriter(domWriter);
179 BindingStreamEventWriter newRpcWriter(final Class<? extends DataContainer> rpcInputOrOutput,
180 final NormalizedNodeStreamWriter domWriter) {
181 return root.getRpc(rpcInputOrOutput).createWriter(domWriter);
184 BindingStreamEventWriter newNotificationWriter(final Class<? extends Notification> notification,
185 final NormalizedNodeStreamWriter domWriter) {
186 return root.getNotification(notification).createWriter(domWriter);
189 public DataContainerCodecContext<?,?> getCodecContextNode(final InstanceIdentifier<?> binding,
190 final List<YangInstanceIdentifier.PathArgument> builder) {
191 DataContainerCodecContext<?,?> currentNode = root;
192 for (final InstanceIdentifier.PathArgument bindingArg : binding.getPathArguments()) {
193 currentNode = currentNode.bindingPathArgumentChild(bindingArg, builder);
194 checkArgument(currentNode != null, "Supplied Instance Identifier %s is not valid.", binding);
200 * Multi-purpose utility function. Traverse the codec tree, looking for
201 * the appropriate codec for the specified {@link YangInstanceIdentifier}.
202 * As a side-effect, gather all traversed binding {@link InstanceIdentifier.PathArgument}s
203 * into the supplied collection.
205 * @param dom {@link YangInstanceIdentifier} which is to be translated
206 * @param bindingArguments Collection for traversed path arguments
207 * @return Codec for target node, or @null if the node does not have a
208 * binding representation (choice, case, leaf).
211 @Nullable BindingDataObjectCodecTreeNode<?> getCodecContextNode(final @NonNull YangInstanceIdentifier dom,
212 final @Nullable Collection<InstanceIdentifier.PathArgument> bindingArguments) {
213 NodeCodecContext currentNode = root;
214 ListNodeCodecContext<?> currentList = null;
216 for (final YangInstanceIdentifier.PathArgument domArg : dom.getPathArguments()) {
217 checkArgument(currentNode instanceof DataContainerCodecContext,
218 "Unexpected child of non-container node %s", currentNode);
219 final DataContainerCodecContext<?,?> previous = (DataContainerCodecContext<?, ?>) currentNode;
220 final NodeCodecContext nextNode = previous.yangPathArgumentChild(domArg);
223 * List representation in YANG Instance Identifier consists of two
224 * arguments: first is list as a whole, second is list as an item so
225 * if it is /list it means list as whole, if it is /list/list - it
226 * is wildcarded and if it is /list/list[key] it is concrete item,
227 * all this variations are expressed in Binding Aware Instance
228 * Identifier as Item or IdentifiableItem
230 if (currentList != null) {
231 checkArgument(currentList == nextNode,
232 "List should be referenced two times in YANG Instance Identifier %s", dom);
234 // We entered list, so now we have all information to emit
235 // list path using second list argument.
236 if (bindingArguments != null) {
237 bindingArguments.add(currentList.getBindingPathArgument(domArg));
240 currentNode = nextNode;
241 } else if (nextNode instanceof ListNodeCodecContext) {
242 // We enter list, we do not update current Node yet,
243 // since we need to verify
244 currentList = (ListNodeCodecContext<?>) nextNode;
245 } else if (nextNode instanceof ChoiceNodeCodecContext) {
246 // We do not add path argument for choice, since
247 // it is not supported by binding instance identifier.
248 currentNode = nextNode;
249 } else if (nextNode instanceof DataContainerCodecContext) {
250 if (bindingArguments != null) {
251 bindingArguments.add(((DataContainerCodecContext<?, ?>) nextNode).getBindingPathArgument(domArg));
253 currentNode = nextNode;
254 } else if (nextNode instanceof ValueNodeCodecContext) {
255 LOG.debug("Instance identifier referencing a leaf is not representable ({})", dom);
260 // Algorithm ended in list as whole representation
261 // we sill need to emit identifier for list
262 if (currentNode instanceof ChoiceNodeCodecContext) {
263 LOG.debug("Instance identifier targeting a choice is not representable ({})", dom);
266 if (currentNode instanceof CaseNodeCodecContext) {
267 LOG.debug("Instance identifier targeting a case is not representable ({})", dom);
271 if (currentList != null) {
272 if (bindingArguments != null) {
273 bindingArguments.add(currentList.getBindingPathArgument(null));
277 if (currentNode != null) {
278 verify(currentNode instanceof BindingDataObjectCodecTreeNode, "Illegal return node %s for identifier %s",
280 return (BindingDataObjectCodecTreeNode<?>) currentNode;
285 NotificationCodecContext<?> getNotificationContext(final SchemaPath notification) {
286 return root.getNotification(notification);
289 RpcInputCodec<?> getRpcInputCodec(final SchemaPath path) {
290 return root.getRpc(path);
293 ActionCodecContext getActionCodec(final Class<? extends Action<?, ?, ?>> action) {
294 return root.getAction(action);
298 public ImmutableMap<Method, ValueNodeCodecContext> getLeafNodes(final Class<?> parentClass,
299 final DataNodeContainer childSchema) {
300 final Map<String, DataSchemaNode> getterToLeafSchema = new HashMap<>();
301 for (final DataSchemaNode leaf : childSchema.getChildNodes()) {
302 if (leaf instanceof TypedDataSchemaNode || leaf instanceof AnyxmlSchemaNode
303 || leaf instanceof AnydataSchemaNode) {
304 getterToLeafSchema.put(BindingSchemaMapping.getGetterMethodName(leaf), leaf);
307 return getLeafNodesUsingReflection(parentClass, getterToLeafSchema);
310 private ImmutableMap<Method, ValueNodeCodecContext> getLeafNodesUsingReflection(
311 final Class<?> parentClass, final Map<String, DataSchemaNode> getterToLeafSchema) {
312 final Map<Method, ValueNodeCodecContext> leaves = new HashMap<>();
313 for (final Method method : parentClass.getMethods()) {
314 if (method.getParameterCount() == 0) {
315 final DataSchemaNode schema = getterToLeafSchema.get(method.getName());
317 final ValueNodeCodecContext valueNode;
318 if (schema instanceof LeafSchemaNode) {
319 final LeafSchemaNode leafSchema = (LeafSchemaNode) schema;
321 final Class<?> valueType = method.getReturnType();
322 final IllegalArgumentCodec<Object, Object> codec = getCodec(valueType, leafSchema.getType());
323 valueNode = LeafNodeCodecContext.of(leafSchema, codec, method.getName(), valueType,
324 context.getSchemaContext());
325 } else if (schema instanceof LeafListSchemaNode) {
326 final Optional<Type> optType = ClassLoaderUtils.getFirstGenericParameter(
327 method.getGenericReturnType());
328 checkState(optType.isPresent(), "Failed to find return type for %s", method);
330 final Class<?> valueType;
331 final Type genericType = optType.get();
332 if (genericType instanceof Class<?>) {
333 valueType = (Class<?>) genericType;
334 } else if (genericType instanceof ParameterizedType) {
335 valueType = (Class<?>) ((ParameterizedType) genericType).getRawType();
337 throw new IllegalStateException("Unexpected return type " + genericType);
340 final LeafListSchemaNode leafListSchema = (LeafListSchemaNode) schema;
341 final IllegalArgumentCodec<Object, Object> codec = getCodec(valueType, leafListSchema.getType());
342 valueNode = new LeafSetNodeCodecContext(leafListSchema, codec, method.getName());
343 } else if (schema instanceof AnyxmlSchemaNode) {
344 valueNode = new OpaqueNodeCodecContext.Anyxml<>((AnyxmlSchemaNode) schema, method.getName(),
345 opaqueReturnType(method), loader);
346 } else if (schema instanceof AnydataSchemaNode) {
347 valueNode = new OpaqueNodeCodecContext.Anydata<>((AnydataSchemaNode) schema, method.getName(),
348 opaqueReturnType(method), loader);
350 verify(schema == null, "Unhandled schema %s for method %s", schema, method);
351 // We do not have schema for leaf, so we will ignore it (e.g. getClass).
355 leaves.put(method, valueNode);
358 return ImmutableMap.copyOf(leaves);
361 // FIXME: this is probably not right w.r.t. nulls
362 IllegalArgumentCodec<Object, Object> getCodec(final Class<?> valueType, final TypeDefinition<?> instantiatedType) {
363 if (Class.class.equals(valueType)) {
364 @SuppressWarnings({ "unchecked", "rawtypes" })
365 final IllegalArgumentCodec<Object, Object> casted = (IllegalArgumentCodec) identityCodec;
367 } else if (InstanceIdentifier.class.equals(valueType)) {
368 @SuppressWarnings({ "unchecked", "rawtypes" })
369 final IllegalArgumentCodec<Object, Object> casted = (IllegalArgumentCodec) instanceIdentifierCodec;
371 } else if (BindingReflections.isBindingClass(valueType)) {
372 return getCodecForBindingClass(valueType, instantiatedType);
374 return ValueTypeCodec.NOOP_CODEC;
377 @SuppressWarnings("checkstyle:illegalCatch")
378 // FIXME: this is probably not right w.r.t. nulls
379 private IllegalArgumentCodec<Object, Object> getCodecForBindingClass(final Class<?> valueType,
380 final TypeDefinition<?> typeDef) {
381 if (typeDef instanceof IdentityrefTypeDefinition) {
382 return ValueTypeCodec.encapsulatedValueCodecFor(valueType, typeDef, identityCodec);
383 } else if (typeDef instanceof InstanceIdentifierTypeDefinition) {
384 return ValueTypeCodec.encapsulatedValueCodecFor(valueType, typeDef, instanceIdentifierCodec);
385 } else if (typeDef instanceof UnionTypeDefinition) {
386 final Callable<UnionTypeCodec> unionLoader = UnionTypeCodec.loader(valueType, (UnionTypeDefinition) typeDef,
389 return unionLoader.call();
390 } catch (final Exception e) {
391 throw new IllegalStateException("Unable to load codec for " + valueType, e);
393 } else if (typeDef instanceof LeafrefTypeDefinition) {
394 final Entry<GeneratedType, WithStatus> typeWithSchema = context.getTypeWithSchema(valueType);
395 final WithStatus schema = typeWithSchema.getValue();
396 checkState(schema instanceof TypeDefinition);
397 return getCodec(valueType, (TypeDefinition<?>) schema);
399 return ValueTypeCodec.getCodecFor(valueType, typeDef);
403 public IdentifiableItemCodec getPathArgumentCodec(final Class<?> listClz, final ListSchemaNode schema) {
404 final Optional<Class<Identifier<?>>> optIdentifier = ClassLoaderUtils.findFirstGenericArgument(listClz,
406 checkState(optIdentifier.isPresent(), "Failed to find identifier for %s", listClz);
408 final Class<Identifier<?>> identifier = optIdentifier.get();
409 final Map<QName, ValueContext> valueCtx = new HashMap<>();
410 for (final ValueNodeCodecContext leaf : getLeafNodes(identifier, schema).values()) {
411 final QName name = leaf.getDomPathArgument().getNodeType();
412 valueCtx.put(name, new ValueContext(identifier, leaf));
414 return IdentifiableItemCodec.of(schema, identifier, listClz, valueCtx);
417 @SuppressWarnings("unchecked")
419 public <T extends DataObject> BindingDataObjectCodecTreeNode<T> getSubtreeCodec(final InstanceIdentifier<T> path) {
420 // TODO Do we need defensive check here?
421 return (BindingDataObjectCodecTreeNode<T>) getCodecContextNode(path, null);
425 public BindingCodecTreeNode getSubtreeCodec(final YangInstanceIdentifier path) {
426 return getCodecContextNode(path, null);
430 public BindingCodecTreeNode getSubtreeCodec(final Absolute path) {
431 throw new UnsupportedOperationException("Not implemented yet.");
434 @SuppressWarnings("rawtypes")
435 private static Class<? extends OpaqueObject> opaqueReturnType(final Method method) {
436 final Class<?> valueType = method.getReturnType();
437 verify(OpaqueObject.class.isAssignableFrom(valueType), "Illegal value type %s", valueType);
438 return valueType.asSubclass(OpaqueObject.class);