binding/mdsal-binding-runtime-api/src/main/java/org/opendaylight/mdsal/binding/runtime/api/BindingRuntimeContext.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.mdsal.binding.runtime.api;
   9
  10 import com.google.common.annotations.Beta;
  11 import org.eclipse.jdt.annotation.NonNull;
  12 import org.eclipse.jdt.annotation.Nullable;
  13 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
  14 import org.opendaylight.mdsal.binding.model.api.Type;
  15 import org.opendaylight.yangtools.concepts.Immutable;
  16 import org.opendaylight.yangtools.yang.binding.Action;
  17 import org.opendaylight.yangtools.yang.binding.Augmentation;
  18 import org.opendaylight.yangtools.yang.binding.BaseIdentity;
  19 import org.opendaylight.yangtools.yang.binding.RpcInput;
  20 import org.opendaylight.yangtools.yang.binding.RpcOutput;
  21 import org.opendaylight.yangtools.yang.common.QName;
  22 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  23 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  24 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  25 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContextProvider;
  26 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  27 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  28
  29 /**
  30  * Runtime Context for Java YANG Binding classes. It provides information derived from the backing effective model,
  31  * which is not captured in generated classes (and hence cannot be obtained from {@code BindingReflections}.
  32  */
  33 @Beta
  34 // FIXME: refactor return to follow foo()/getFoo()/findFoo() naming
  35 public interface BindingRuntimeContext extends EffectiveModelContextProvider, Immutable {
  36     @NonNull BindingRuntimeTypes getTypes();
  37
  38     @NonNull <T> Class<T> loadClass(JavaTypeName type) throws ClassNotFoundException;
  39
  40     default @NonNull <T> Class<T> loadClass(final Type type) throws ClassNotFoundException {
  41         return loadClass(type.getIdentifier());
  42     }
  43
  44     @Override
  45     default EffectiveModelContext getEffectiveModelContext() {
  46         return getTypes().getEffectiveModelContext();
  47     }
  48
  49     /**
  50      * Returns schema of augmentation.
  51      *
  52      * <p>Returned schema is schema definition from which augmentation class was generated.
  53      * This schema is isolated from other augmentations. This means it contains
  54      * augmentation definition as was present in original YANG module.
  55      *
  56      * <p>Children of returned schema does not contain any additional augmentations,
  57      * which may be present in runtime for them, thus returned schema is unsuitable
  58      * for use for validation of data.
  59      *
  60      * @param <T> Augmentation class type
  61      * @param augClass Augmentation class
  62      * @return Schema of augmentation or null if augmentation is not known in this context
  63      * @throws NullPointerException if {@code augClass} is null
  64      */
  65     <T extends Augmentation<?>> @Nullable AugmentRuntimeType getAugmentationDefinition(Class<T> augClass);
  66
  67     /**
  68      * Returns defining {@link DataSchemaNode} for supplied class.
  69      *
  70      * <p>Returned schema is schema definition from which class was generated.
  71      * This schema may be isolated from augmentations, if supplied class
  72      * represent node, which was child of grouping or augmentation.
  73      *
  74      * <p>For getting augmentation schema from augmentation class use
  75      * {@link #getAugmentationDefinition(Class)} instead.
  76      *
  77      * @param cls Class which represents list, container, choice or case.
  78      * @return Schema node, from which class was generated.
  79      */
  80     @Nullable CompositeRuntimeType getSchemaDefinition(Class<?> cls);
  81
  82     @Nullable ActionRuntimeType getActionDefinition(Class<? extends Action<?, ?, ?>> cls);
  83
  84     /**
  85      * Returns schema ({@link DataSchemaNode}, {@link AugmentationSchemaNode} or {@link TypeDefinition})
  86      * from which supplied class was generated. Returned schema may be augmented with
  87      * additional information, which was not available at compile type
  88      * (e.g. third party augmentations).
  89      *
  90      * @param type Binding Class for which schema should be retrieved.
  91      * @return Instance of generated type (definition of Java API), along with
  92      *     {@link DataSchemaNode}, {@link AugmentationSchemaNode} or {@link TypeDefinition}
  93      *     which was used to generate supplied class.
  94      */
  95     @NonNull RuntimeType getTypeWithSchema(Class<?> type);
  96
  97     @NonNull Class<? extends RpcInput> getRpcInput(QName rpcName);
  98
  99     @NonNull Class<? extends RpcOutput> getRpcOutput(QName rpcName);
 100
 101     // FIXME: 9.0.0: this needs to accept an EffectiveStatementInference
 102     @NonNull Class<?> getClassForSchema(Absolute schema);
 103
 104     @NonNull Class<? extends BaseIdentity> getIdentityClass(QName input);
 105 }