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.base.Preconditions;
12 import com.google.common.base.Throwables;
13 import com.google.common.cache.CacheBuilder;
14 import com.google.common.cache.CacheLoader;
15 import com.google.common.cache.LoadingCache;
16 import com.google.common.util.concurrent.UncheckedExecutionException;
17 import org.opendaylight.yangtools.yang.binding.BindingMapping;
18 import org.opendaylight.yangtools.yang.binding.DataContainer;
19 import org.opendaylight.yangtools.yang.binding.DataObject;
20 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
21 import org.opendaylight.yangtools.yang.binding.Notification;
22 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
23 import org.opendaylight.yangtools.yang.common.QName;
24 import org.opendaylight.yangtools.yang.common.QNameModule;
25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
27 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
28 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
29 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
30 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
31 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
32 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
33 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
34 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
35 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
36 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
37 import org.opendaylight.yangtools.yang.model.api.meta.StatementSource;
38 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
39 import org.opendaylight.yangtools.yang.model.util.SchemaNodeUtils;
41 final class SchemaRootCodecContext<D extends DataObject> extends DataContainerCodecContext<D,SchemaContext> {
43 private final LoadingCache<Class<?>, DataContainerCodecContext<?,?>> childrenByClass = CacheBuilder.newBuilder()
44 .build(new CacheLoader<Class<?>, DataContainerCodecContext<?,?>>() {
46 public DataContainerCodecContext<?,?> load(final Class<?> key) {
47 return createDataTreeChildContext(key);
51 private final LoadingCache<Class<?>, ContainerNodeCodecContext<?>> rpcDataByClass = CacheBuilder.newBuilder().build(
52 new CacheLoader<Class<?>, ContainerNodeCodecContext<?>>() {
54 public ContainerNodeCodecContext<?> load(final Class<?> key) {
55 return createRpcDataContext(key);
59 private final LoadingCache<Class<?>, NotificationCodecContext<?>> notificationsByClass = CacheBuilder.newBuilder()
60 .build(new CacheLoader<Class<?>, NotificationCodecContext<?>>() {
62 public NotificationCodecContext<?> load(final Class<?> key) {
63 return createNotificationDataContext(key);
67 private final LoadingCache<QName, DataContainerCodecContext<?,?>> childrenByQName = CacheBuilder.newBuilder().build(
68 new CacheLoader<QName, DataContainerCodecContext<?,?>>() {
69 @SuppressWarnings("unchecked")
71 public DataContainerCodecContext<?,?> load(final QName qname) {
72 final DataSchemaNode childSchema = getSchema().getDataChildByName(qname);
73 childNonNull(childSchema, qname,"Argument %s is not valid child of %s", qname,getSchema());
74 if (childSchema instanceof DataNodeContainer || childSchema instanceof ChoiceSchemaNode) {
75 @SuppressWarnings("rawtypes")
76 final Class childCls = factory().getRuntimeContext().getClassForSchema(childSchema);
77 return streamChild(childCls);
80 throw new UnsupportedOperationException("Unsupported child type " + childSchema.getClass());
84 private final LoadingCache<SchemaPath, RpcInputCodec<?>> rpcDataByPath = CacheBuilder.newBuilder().build(
85 new CacheLoader<SchemaPath, RpcInputCodec<?>>() {
86 @SuppressWarnings({ "rawtypes", "unchecked" })
88 public RpcInputCodec load(final SchemaPath key) {
89 final ContainerSchemaNode schema = SchemaContextUtil.getRpcDataSchema(getSchema(), key);
90 if (schema instanceof EffectiveStatement
91 && ((EffectiveStatement) schema).getDeclared().getStatementSource()
92 != StatementSource.DECLARATION) {
93 // This is an implicitly-defined input or output statement. We do not have a corresponding
94 // data representation, so we hard-wire it to null.
95 return UnmappedRpcInputCodec.getInstance();
98 final Class cls = factory().getRuntimeContext().getClassForSchema(schema);
103 private final LoadingCache<SchemaPath, NotificationCodecContext<?>> notificationsByPath = CacheBuilder.newBuilder()
104 .build(new CacheLoader<SchemaPath, NotificationCodecContext<?>>() {
106 @SuppressWarnings({ "rawtypes", "unchecked" })
108 public NotificationCodecContext load(final SchemaPath key) throws Exception {
109 final NotificationDefinition schema = SchemaContextUtil.getNotificationSchema(getSchema(), key);
110 final Class clz = factory().getRuntimeContext().getClassForSchema(schema);
111 return getNotification(clz);
115 private SchemaRootCodecContext(final DataContainerCodecPrototype<SchemaContext> dataPrototype) {
116 super(dataPrototype);
120 * Creates RootNode from supplied CodecContextFactory.
123 * CodecContextFactory
124 * @return A new root node
126 static SchemaRootCodecContext<?> create(final CodecContextFactory factory) {
127 final DataContainerCodecPrototype<SchemaContext> prototype = DataContainerCodecPrototype.rootPrototype(factory);
128 return new SchemaRootCodecContext<>(prototype);
132 @SuppressWarnings("unchecked")
134 public <C extends DataObject> DataContainerCodecContext<C, ?> streamChild(final Class<C> childClass) {
135 /* FIXME: This is still not solved for RPCs
136 * TODO: Probably performance wise RPC, Data and Notification loading cache
137 * should be merge for performance resons. Needs microbenchmark to
138 * determine which is faster (keeping them separate or in same cache).
140 if (Notification.class.isAssignableFrom(childClass)) {
141 return (DataContainerCodecContext<C, ?>) getNotification((Class<? extends Notification>)childClass);
143 return (DataContainerCodecContext<C, ?>) getOrRethrow(childrenByClass,childClass);
147 public <C extends DataObject> Optional<DataContainerCodecContext<C, ?>> possibleStreamChild(
148 final Class<C> childClass) {
149 throw new UnsupportedOperationException("Not supported");
153 public DataContainerCodecContext<?,?> yangPathArgumentChild(final PathArgument arg) {
154 return getOrRethrow(childrenByQName, arg.getNodeType());
158 public D deserialize(final NormalizedNode<?, ?> normalizedNode) {
159 throw new UnsupportedOperationException("Could not create Binding data representation for root");
162 NotificationCodecContext<?> getNotification(final Class<? extends Notification> notification) {
163 return getOrRethrow(notificationsByClass, notification);
166 NotificationCodecContext<?> getNotification(final SchemaPath notification) {
167 return getOrRethrow(notificationsByPath, notification);
170 ContainerNodeCodecContext<?> getRpc(final Class<? extends DataContainer> rpcInputOrOutput) {
171 return getOrRethrow(rpcDataByClass, rpcInputOrOutput);
174 RpcInputCodec<?> getRpc(final SchemaPath notification) {
175 return getOrRethrow(rpcDataByPath, notification);
178 private DataContainerCodecContext<?,?> createDataTreeChildContext(final Class<?> key) {
179 final QName qname = BindingReflections.findQName(key);
180 final DataSchemaNode childSchema = childNonNull(getSchema().getDataChildByName(qname), key,
181 "%s is not top-level item.", key);
182 return DataContainerCodecPrototype.from(key, childSchema, factory()).get();
185 private ContainerNodeCodecContext<?> createRpcDataContext(final Class<?> key) {
186 Preconditions.checkArgument(DataContainer.class.isAssignableFrom(key));
187 final QName qname = BindingReflections.findQName(key);
188 final QNameModule module = qname.getModule();
189 RpcDefinition rpc = null;
190 for (final RpcDefinition potential : getSchema().getOperations()) {
191 final QName potentialQName = potential.getQName();
193 * Check if rpc and class represents data from same module and then
194 * checks if rpc local name produces same class name as class name
195 * appended with Input/Output based on QName associated with bidning
198 * FIXME: Rework this to have more precise logic regarding Binding
201 if (module.equals(potentialQName.getModule())
202 && key.getSimpleName().equals(
203 BindingMapping.getClassName(potentialQName) + BindingMapping.getClassName(qname))) {
208 Preconditions.checkArgument(rpc != null, "Supplied class %s is not valid RPC class.", key);
209 final ContainerSchemaNode schema = SchemaNodeUtils.getRpcDataSchema(rpc, qname);
210 Preconditions.checkArgument(schema != null, "Schema for %s does not define input / output.", rpc.getQName());
211 return (ContainerNodeCodecContext<?>) DataContainerCodecPrototype.from(key, schema, factory()).get();
214 private NotificationCodecContext<?> createNotificationDataContext(final Class<?> notificationType) {
215 Preconditions.checkArgument(Notification.class.isAssignableFrom(notificationType));
216 Preconditions.checkArgument(notificationType.isInterface(), "Supplied class must be interface.");
217 final QName qname = BindingReflections.findQName(notificationType);
219 * FIXME: After Lithium cleanup of yang-model-api, use direct call on schema context
220 * to retrieve notification via index.
222 final NotificationDefinition schema = SchemaContextUtil.getNotificationSchema(getSchema(),
223 SchemaPath.create(true, qname));
224 Preconditions.checkArgument(schema != null, "Supplied %s is not valid notification", notificationType);
226 return new NotificationCodecContext<>(notificationType, schema, factory());
230 protected Object deserializeObject(final NormalizedNode<?, ?> normalizedNode) {
231 throw new UnsupportedOperationException("Unable to deserialize root");
235 public InstanceIdentifier.PathArgument deserializePathArgument(final YangInstanceIdentifier.PathArgument arg) {
236 Preconditions.checkArgument(arg == null);
241 public YangInstanceIdentifier.PathArgument serializePathArgument(final InstanceIdentifier.PathArgument arg) {
242 Preconditions.checkArgument(arg == null);
246 private static <K,V> V getOrRethrow(final LoadingCache<K, V> cache, final K key) {
248 return cache.getUnchecked(key);
249 } catch (final UncheckedExecutionException e) {
250 final Throwable cause = e.getCause();
252 Throwables.throwIfUnchecked(cause);