Remove yang-test

[controller.git] / opendaylight / config / config-api / src / main / java / org / opendaylight / controller / config / api / DependencyResolver.java

diff --git a/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/DependencyResolver.java b/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/DependencyResolver.java
index 39845454ef5ed17d108255dbf5e47f5b774ab93b..e9b63e6f051b8564a948c7efaafd632d2a9e74b9 100644 (file)
--- a/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/DependencyResolver.java
+++ b/opendaylight/config/config-api/src/main/java/org/opendaylight/controller/config/api/DependencyResolver.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
+ * Copyright (c) 2013, 2017 Cisco Systems, Inc. and others.  All rights reserved.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
@@ -7,10 +7,14 @@
  */
 package org.opendaylight.controller.config.api;
 
+import javax.management.AttributeNotFoundException;
+import javax.management.InstanceNotFoundException;
+import javax.management.MBeanException;
 import javax.management.ObjectName;
-
+import javax.management.ReflectionException;
 import org.opendaylight.controller.config.api.annotations.AbstractServiceInterface;
 import org.opendaylight.yangtools.concepts.Identifiable;
+import org.opendaylight.yangtools.yang.binding.BaseIdentity;
 
 /**
  * Each new {@link org.opendaylight.controller.config.spi.Module} can receive
@@ -22,8 +26,8 @@ import org.opendaylight.yangtools.concepts.Identifiable;
 public interface DependencyResolver extends Identifiable<ModuleIdentifier> {
 
     /**
-     * To be used during validation phase to validate serice interface of
-     * dependent module.
+     * To be used during validation phase to validate service interface of dependent
+     * module.
      *
      * @param expectedServiceInterface
      *            MBean/MXBean interface which will back the proxy object.
@@ -31,22 +35,82 @@ public interface DependencyResolver extends Identifiable<ModuleIdentifier> {
      *            ObjectName of dependent module without transaction name
      *            (platformON).
      * @param jmxAttribute
-     * @throws {@link IllegalArgumentException} when module is not found
-     * @throws {@link IllegalStateException} if module does not export this
-     *         service interface.
+     *            for reporting
+     * @throws IllegalArgumentException
+     *             when module is not found
+     * @throws IllegalStateException
+     *             if module does not export this service interface.
      */
-    void validateDependency(
-            Class<? extends AbstractServiceInterface> expectedServiceInterface,
-            ObjectName objectName, JmxAttribute jmxAttribute);
+    void validateDependency(Class<? extends AbstractServiceInterface> expectedServiceInterface, ObjectName objectName,
+            JmxAttribute jmxAttribute);
 
     /**
      * To be used during commit phase to wire actual dependencies.
      *
      * @return dependency instance using
      *         {@link org.opendaylight.controller.config.spi.Module#getInstance()}
-     * @throws {@link IllegalArgumentException} when module is not found
+     * @throws IllegalArgumentException
+     *             when module is not found
+     */
+    <T> T resolveInstance(Class<T> expectedType, ObjectName objectName, JmxAttribute jmxAttribute);
+
+    /**
+     * To be used during commit phase to resolve identity-ref config attributes.
+     *
+     * @return actual class object generated from identity
      */
-    <T> T resolveInstance(Class<T> expectedType, ObjectName objectName,
+    <T extends BaseIdentity> Class<? extends T> resolveIdentity(IdentityAttributeRef identityRef,
+            Class<T> expectedBaseClass);
+
+    /**
+     * Validate identity-ref config attribute.
+     */
+    <T extends BaseIdentity> void validateIdentity(IdentityAttributeRef identityRef, Class<T> expectedBaseClass,
             JmxAttribute jmxAttribute);
 
+    /**
+     * Can be used during validation or commit phase to get attribute value of
+     * dependent module.
+     *
+     * @param name
+     *            either direct ObjectName of a Module (type=Module) or service
+     *            reference (type=ServiceReference) of dependent Module
+     * @param attribute
+     *            String identifying attribute name in JMX. Note that attributes
+     *            start with upper case. See
+     *            {@link org.opendaylight.controller.config.api.JmxAttribute#getAttributeName()}
+     */
+    Object getAttribute(ObjectName name, String attribute)
+            throws MBeanException, AttributeNotFoundException, InstanceNotFoundException, ReflectionException;
+
+    /**
+     * Helper method around.
+     * {@link javax.management
+     * .JMX#newMXBeanProxy(javax.management.MBeanServerConnection, javax.management.ObjectName, Class)}}.
+     *
+     * Returns MXBean proxy for dependent module. Can be used during validation or
+     * commit phase to inspect dependent module's attributes.
+     *
+     * @param objectName
+     *            either direct ObjectName of a Module (type=Module) or service
+     *            reference (type=ServiceReference) of dependent Module
+     * @param interfaceClass
+     *            MXBean interface to be used as a proxy
+     * @param <T>
+     *            type of proxy for type safe return value
+     * @return instance of MXBean proxy
+     */
+    <T> T newMXBeanProxy(ObjectName objectName, Class<T> interfaceClass);
+
+    /**
+     * Check whether a dependency will be reused or (re)created. Useful when
+     * deciding if current module could be also reused.
+     *
+     * @param objectName
+     *            ObjectName ID of a dependency
+     * @param jmxAttribute
+     *            JMXAttribute ID of a dependency
+     * @return true if the dependency will be reused false otherwise
+     */
+    boolean canReuseDependency(ObjectName objectName, JmxAttribute jmxAttribute);
 }