X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=binding%2Fmdsal-binding-dom-codec%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fmdsal%2Fbinding%2Fdom%2Fcodec%2Fimpl%2FSchemaRootCodecContext.java;h=e309f6949a4ae0dce42855e2f53f965465b7587d;hb=8740e6979cb275efef36defa2e633b936aba48e1;hp=095d5e94ba406abef7c93c58aa49d632dd894dee;hpb=856a7b36138eca857680928cbe50b47057888493;p=mdsal.git diff --git a/binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/impl/SchemaRootCodecContext.java b/binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/impl/SchemaRootCodecContext.java index 095d5e94ba..e309f6949a 100644 --- a/binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/impl/SchemaRootCodecContext.java +++ b/binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/impl/SchemaRootCodecContext.java @@ -8,8 +8,9 @@ package org.opendaylight.mdsal.binding.dom.codec.impl; import static com.google.common.base.Preconditions.checkArgument; -import static com.google.common.base.Preconditions.checkNotNull; +import static com.google.common.base.Preconditions.checkState; import static com.google.common.base.Verify.verify; +import static java.util.Objects.requireNonNull; import com.google.common.base.Throwables; import com.google.common.base.Verify; @@ -17,10 +18,14 @@ import com.google.common.cache.CacheBuilder; import com.google.common.cache.CacheLoader; import com.google.common.cache.LoadingCache; import com.google.common.util.concurrent.UncheckedExecutionException; +import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; import java.lang.reflect.ParameterizedType; import java.lang.reflect.Type; +import java.util.Iterator; import java.util.List; import java.util.Optional; +import org.eclipse.jdt.annotation.NonNull; +import org.eclipse.jdt.annotation.Nullable; import org.opendaylight.mdsal.binding.spec.naming.BindingMapping; import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections; import org.opendaylight.yangtools.util.ClassLoaderUtils; @@ -40,101 +45,93 @@ import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgum import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; import org.opendaylight.yangtools.yang.model.api.ActionDefinition; import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode; -import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode; +import org.opendaylight.yangtools.yang.model.api.ContainerLike; import org.opendaylight.yangtools.yang.model.api.DataNodeContainer; import org.opendaylight.yangtools.yang.model.api.DataSchemaNode; +import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext; import org.opendaylight.yangtools.yang.model.api.Module; import org.opendaylight.yangtools.yang.model.api.NotificationDefinition; import org.opendaylight.yangtools.yang.model.api.RpcDefinition; -import org.opendaylight.yangtools.yang.model.api.SchemaContext; -import org.opendaylight.yangtools.yang.model.api.SchemaPath; -import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil; -import org.opendaylight.yangtools.yang.model.util.SchemaNodeUtils; - -final class SchemaRootCodecContext extends DataContainerCodecContext { - - private final LoadingCache, DataContainerCodecContext> childrenByClass = CacheBuilder.newBuilder() - .build(new CacheLoader, DataContainerCodecContext>() { - @Override - public DataContainerCodecContext load(final Class key) { - return createDataTreeChildContext(key); - } - }); +import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute; +import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement; - private final LoadingCache>, ActionCodecContext> actionsByClass = CacheBuilder - .newBuilder().build(new CacheLoader>, ActionCodecContext>() { - @Override - public ActionCodecContext load(final Class> key) { - return createActionContext(key); - } - }); +final class SchemaRootCodecContext extends DataContainerCodecContext { - private final LoadingCache, ContainerNodeCodecContext> rpcDataByClass = CacheBuilder.newBuilder().build( - new CacheLoader, ContainerNodeCodecContext>() { - @Override - public ContainerNodeCodecContext load(final Class key) { + private final LoadingCache, DataContainerCodecContext> childrenByClass = + CacheBuilder.newBuilder().build(new CacheLoader<>() { + @Override + public DataContainerCodecContext load(final Class key) { + if (Notification.class.isAssignableFrom(key)) { + return createNotificationDataContext(key); + } + if (RpcInput.class.isAssignableFrom(key) || RpcOutput.class.isAssignableFrom(key)) { return createRpcDataContext(key); } - }); + return createDataTreeChildContext(key); + } + }); - private final LoadingCache, NotificationCodecContext> notificationsByClass = CacheBuilder.newBuilder() - .build(new CacheLoader, NotificationCodecContext>() { - @Override - public NotificationCodecContext load(final Class key) { - return createNotificationDataContext(key); - } - }); + private final LoadingCache>, ActionCodecContext> actionsByClass = + CacheBuilder.newBuilder().build(new CacheLoader<>() { + @Override + public ActionCodecContext load(final Class> key) { + return createActionContext(key); + } + }); private final LoadingCache, ChoiceNodeCodecContext> choicesByClass = - CacheBuilder.newBuilder().build(new CacheLoader, ChoiceNodeCodecContext>() { - @Override - public ChoiceNodeCodecContext load(final Class key) { - return createChoiceDataContext(key); - } - }); - - private final LoadingCache> childrenByQName = CacheBuilder.newBuilder().build( - new CacheLoader>() { - @Override - public DataContainerCodecContext load(final QName qname) { - final DataSchemaNode childSchema = getSchema().getDataChildByName(qname); - childNonNull(childSchema, qname,"Argument %s is not valid child of %s", qname,getSchema()); - if (childSchema instanceof DataNodeContainer || childSchema instanceof ChoiceSchemaNode) { - @SuppressWarnings("unchecked") - final Class childCls = (Class) - factory().getRuntimeContext().getClassForSchema(childSchema); - return streamChild(childCls); - } - - throw new UnsupportedOperationException("Unsupported child type " + childSchema.getClass()); + CacheBuilder.newBuilder().build(new CacheLoader<>() { + @Override + public ChoiceNodeCodecContext load(final Class key) { + return createChoiceDataContext(key); + } + }); + + private final LoadingCache> childrenByQName = + CacheBuilder.newBuilder().build(new CacheLoader<>() { + @Override + public DataContainerCodecContext load(final QName qname) { + final DataSchemaNode childSchema = getSchema().dataChildByName(qname); + childNonNull(childSchema, qname, "Argument %s is not valid child of %s", qname, getSchema()); + if (childSchema instanceof DataNodeContainer || childSchema instanceof ChoiceSchemaNode) { + @SuppressWarnings("unchecked") + final Class childCls = (Class) + factory().getRuntimeContext().getClassForSchema(childSchema); + return streamChild(childCls); } - }); - private final LoadingCache> rpcDataByPath = CacheBuilder.newBuilder().build( - new CacheLoader>() { + throw new UnsupportedOperationException("Unsupported child type " + childSchema.getClass()); + } + }); + + private final LoadingCache> rpcDataByPath = + CacheBuilder.newBuilder().build(new CacheLoader<>() { @Override - public RpcInputCodec load(final SchemaPath key) { - final ContainerSchemaNode schema = SchemaContextUtil.getRpcDataSchema(getSchema(), key); + public RpcInputCodec load(final Absolute key) { + final ContainerLike schema = getRpcDataSchema(getSchema(), key); @SuppressWarnings("unchecked") final Class cls = (Class) - factory().getRuntimeContext().getClassForSchema(schema); + factory().getRuntimeContext().getClassForSchema(schema); return getRpc(cls); } }); - private final LoadingCache> notificationsByPath = CacheBuilder.newBuilder() - .build(new CacheLoader>() { - @Override - public NotificationCodecContext load(final SchemaPath key) { - final NotificationDefinition schema = SchemaContextUtil.getNotificationSchema(getSchema(), key); - @SuppressWarnings("unchecked") - final Class clz = (Class) - factory().getRuntimeContext().getClassForSchema(schema); - return getNotification(clz); - } - }); + private final LoadingCache> notificationsByPath = + CacheBuilder.newBuilder().build(new CacheLoader<>() { + @Override + public NotificationCodecContext load(final Absolute key) { + final SchemaTreeEffectiveStatement stmt = getSchema().findSchemaTreeNode(key) + .orElseThrow(() -> new IllegalArgumentException("Cannot find statement at " + key)); + checkArgument(stmt instanceof NotificationDefinition, "Statement %s is not a notification", stmt); + + @SuppressWarnings("unchecked") + final Class clz = (Class) + factory().getRuntimeContext().getClassForSchema((NotificationDefinition) stmt); + return getNotification(clz); + } + }); - private SchemaRootCodecContext(final DataContainerCodecPrototype dataPrototype) { + private SchemaRootCodecContext(final DataContainerCodecPrototype dataPrototype) { super(dataPrototype); } @@ -146,23 +143,13 @@ final class SchemaRootCodecContext extends DataContainerCo * @return A new root node */ static SchemaRootCodecContext create(final CodecContextFactory factory) { - final DataContainerCodecPrototype prototype = DataContainerCodecPrototype.rootPrototype(factory); - return new SchemaRootCodecContext<>(prototype); + return new SchemaRootCodecContext<>(DataContainerCodecPrototype.rootPrototype(factory)); } - @SuppressWarnings("unchecked") @Override public DataContainerCodecContext streamChild(final Class childClass) { - /* FIXME: This is still not solved for RPCs - * TODO: Probably performance wise RPC, Data and Notification loading cache - * should be merge for performance resons. Needs microbenchmark to - * determine which is faster (keeping them separate or in same cache). - */ - if (Notification.class.isAssignableFrom(childClass)) { - return (DataContainerCodecContext) getNotification((Class)childClass); - } - return (DataContainerCodecContext) getOrRethrow(childrenByClass,childClass); + return (DataContainerCodecContext) getOrRethrow(childrenByClass, childClass); } @Override @@ -177,7 +164,7 @@ final class SchemaRootCodecContext extends DataContainerCo } @Override - public D deserialize(final NormalizedNode normalizedNode) { + public D deserialize(final NormalizedNode normalizedNode) { throw new UnsupportedOperationException("Could not create Binding data representation for root"); } @@ -186,24 +173,24 @@ final class SchemaRootCodecContext extends DataContainerCo } NotificationCodecContext getNotification(final Class notification) { - return getOrRethrow(notificationsByClass, notification); + return (NotificationCodecContext) streamChild((Class)notification); } - NotificationCodecContext getNotification(final SchemaPath notification) { + NotificationCodecContext getNotification(final Absolute notification) { return getOrRethrow(notificationsByPath, notification); } ContainerNodeCodecContext getRpc(final Class rpcInputOrOutput) { - return getOrRethrow(rpcDataByClass, rpcInputOrOutput); + return (ContainerNodeCodecContext) streamChild((Class)rpcInputOrOutput); } - RpcInputCodec getRpc(final SchemaPath notification) { - return getOrRethrow(rpcDataByPath, notification); + RpcInputCodec getRpc(final Absolute containerPath) { + return getOrRethrow(rpcDataByPath, containerPath); } DataContainerCodecContext createDataTreeChildContext(final Class key) { final QName qname = BindingReflections.findQName(key); - final DataSchemaNode childSchema = childNonNull(getSchema().getDataChildByName(qname), key, + final DataSchemaNode childSchema = childNonNull(getSchema().dataChildByName(qname), key, "%s is not top-level item.", key); return DataContainerCodecPrototype.from(key, childSchema, factory()).get(); } @@ -219,8 +206,10 @@ final class SchemaRootCodecContext extends DataContainerCo private ActionCodecContext prepareActionContext(final int inputOffset, final int outputOffset, final int expectedArgsLength, final Class> action, final Class actionType) { - final ParameterizedType paramType = checkNotNull(ClassLoaderUtils.findParameterizedType(action, actionType), - "There does not exist any ParameterType in %s", action); + final Optional optParamType = ClassLoaderUtils.findParameterizedType(action, actionType); + checkState(optParamType.isPresent(), "%s does not specialize %s", action, actionType); + + final ParameterizedType paramType = optParamType.get(); final Type[] args = paramType.getActualTypeArguments(); checkArgument(args.length == expectedArgsLength, "Unexpected (%s) Action generatic arguments", args.length); final ActionDefinition schema = factory().getRuntimeContext().getActionDefinition(action); @@ -244,41 +233,77 @@ final class SchemaRootCodecContext extends DataContainerCo .orElseThrow(() -> new IllegalArgumentException("Failed to find module for " + qnameModule)); final String className = BindingMapping.getClassName(qname); - RpcDefinition rpc = null; for (final RpcDefinition potential : module.getRpcs()) { final QName potentialQName = potential.getQName(); /* - * Check if rpc and class represents data from same module and then - * checks if rpc local name produces same class name as class name - * appended with Input/Output based on QName associated with bidning - * class. + * Check if rpc and class represents data from same module and then checks if rpc local name produces same + * class name as class name appended with Input/Output based on QName associated with binding class. * - * FIXME: Rework this to have more precise logic regarding Binding - * Specification. + * FIXME: Rework this to have more precise logic regarding Binding Specification. */ if (key.getSimpleName().equals(BindingMapping.getClassName(potentialQName) + className)) { - rpc = potential; - break; + final ContainerLike schema = getRpcDataSchema(potential, qname); + checkArgument(schema != null, "Schema for %s does not define input / output.", potential.getQName()); + return (ContainerNodeCodecContext) DataContainerCodecPrototype.from(key, schema, factory()).get(); + } + } + + throw new IllegalArgumentException("Supplied class " + key + " is not valid RPC class."); + } + + /** + * Returns RPC input or output schema based on supplied QName. + * + * @param rpc RPC Definition + * @param qname input or output QName with namespace same as RPC + * @return input or output schema. Returns null if RPC does not have input/output specified. + */ + private static @Nullable ContainerLike getRpcDataSchema(final @NonNull RpcDefinition rpc, + final @NonNull QName qname) { + requireNonNull(rpc, "Rpc Schema must not be null"); + switch (requireNonNull(qname, "QName must not be null").getLocalName()) { + case "input": + return rpc.getInput(); + case "output": + return rpc.getOutput(); + default: + throw new IllegalArgumentException("Supplied qname " + qname + + " does not represent rpc input or output."); + } + } + + /** + * Returns RPC Input or Output Data container from RPC definition. + * + * @param schema SchemaContext in which lookup should be performed. + * @param path Schema path of RPC input/output data container + * @return Notification schema or null, if notification is not present in schema context. + */ + @SuppressFBWarnings(value = "UPM_UNCALLED_PRIVATE_METHOD", + justification = "https://github.com/spotbugs/spotbugs/issues/811") + private static @Nullable ContainerLike getRpcDataSchema(final @NonNull EffectiveModelContext schema, + final @NonNull Absolute path) { + requireNonNull(schema, "Schema context must not be null."); + requireNonNull(path, "Schema path must not be null."); + final Iterator it = path.getNodeIdentifiers().iterator(); + checkArgument(it.hasNext(), "Rpc must have QName."); + final QName rpcName = it.next(); + checkArgument(it.hasNext(), "input or output must be part of path."); + final QName inOrOut = it.next(); + for (final RpcDefinition potential : schema.getOperations()) { + if (rpcName.equals(potential.getQName())) { + return getRpcDataSchema(potential, inOrOut); } } - checkArgument(rpc != null, "Supplied class %s is not valid RPC class.", key); - final ContainerSchemaNode schema = SchemaNodeUtils.getRpcDataSchema(rpc, qname); - checkArgument(schema != null, "Schema for %s does not define input / output.", rpc.getQName()); - return (ContainerNodeCodecContext) DataContainerCodecPrototype.from(key, schema, factory()).get(); + return null; } NotificationCodecContext createNotificationDataContext(final Class notificationType) { checkArgument(Notification.class.isAssignableFrom(notificationType)); checkArgument(notificationType.isInterface(), "Supplied class must be interface."); final QName qname = BindingReflections.findQName(notificationType); - /** - * FIXME: After Lithium cleanup of yang-model-api, use direct call on schema context - * to retrieve notification via index. - */ - final NotificationDefinition schema = SchemaContextUtil.getNotificationSchema(getSchema(), - SchemaPath.create(true, qname)); - checkArgument(schema != null, "Supplied %s is not valid notification", notificationType); - + final NotificationDefinition schema = getSchema().findNotification(qname).orElseThrow( + () -> new IllegalArgumentException("Supplied " + notificationType + " is not valid notification")); return new NotificationCodecContext<>(notificationType, schema, factory()); } @@ -295,7 +320,7 @@ final class SchemaRootCodecContext extends DataContainerCo } @Override - protected Object deserializeObject(final NormalizedNode normalizedNode) { + protected Object deserializeObject(final NormalizedNode normalizedNode) { throw new UnsupportedOperationException("Unable to deserialize root"); } @@ -316,11 +341,10 @@ final class SchemaRootCodecContext extends DataContainerCo final List builder) { final Optional> caseType = arg.getCaseType(); if (caseType.isPresent()) { - // XXX: we use two caseType.get()s because of https://bugs.openjdk.java.net/browse/JDK-8144185, - // which makes JaCoCo blow up if we try using @NonNull on the local variable. - final ChoiceNodeCodecContext choice = choicesByClass.getUnchecked(caseType.get()); + final @NonNull Class type = caseType.orElseThrow(); + final ChoiceNodeCodecContext choice = choicesByClass.getUnchecked(type); choice.addYangPathArgument(arg, builder); - final DataContainerCodecContext caze = choice.streamChild(caseType.get()); + final DataContainerCodecContext caze = choice.streamChild(type); caze.addYangPathArgument(arg, builder); return caze.bindingPathArgumentChild(arg, builder); }