org.opendaylight.controller.config.api

Interface DependencyResolver

All Superinterfaces:

org.opendaylight.yangtools.concepts.Identifiable<ModuleIdentifier>

public interface DependencyResolver
extends org.opendaylight.yangtools.concepts.Identifiable<ModuleIdentifier>

Each new Module can receive resolver from ModuleFactory for looking up dependencies during validation and second phase commit.

See Also:

Module

Method Summary

Modifier and Type	Method and Description
boolean	canReuseDependency(ObjectName objectName, JmxAttribute jmxAttribute) Check whether a dependency will be reused or (re)created.
Object	getAttribute(ObjectName name, String attribute) Can be used during validation or commit phase to get attribute value of dependent module.
<T> T	newMXBeanProxy(ObjectName objectName, Class<T> interfaceClass) Helper method around JMX.newMXBeanProxy(javax.management.MBeanServerConnection, javax.management.ObjectName, Class) }.
<T extends BaseIdentity> Class<? extends T>	resolveIdentity(IdentityAttributeRef identityRef, Class<T> expectedBaseClass) To be used during commit phase to resolve identity-ref config attributes.
<T> T	resolveInstance(Class<T> expectedType, ObjectName objectName, JmxAttribute jmxAttribute) To be used during commit phase to wire actual dependencies.
void	validateDependency(Class<? extends AbstractServiceInterface> expectedServiceInterface, ObjectName objectName, JmxAttribute jmxAttribute) To be used during validation phase to validate serice interface of dependent module.
<T extends BaseIdentity> void	validateIdentity(IdentityAttributeRef identityRef, Class<T> expectedBaseClass, JmxAttribute jmxAttribute) Validate identity-ref config attribute.

Methods inherited from interface org.opendaylight.yangtools.concepts.Identifiable

getIdentifier

Method Detail

validateDependency

void validateDependency(Class<? extends AbstractServiceInterface> expectedServiceInterface,
                        ObjectName objectName,
                        JmxAttribute jmxAttribute)

To be used during validation phase to validate serice interface of dependent module.

Parameters:

expectedServiceInterface - MBean/MXBean interface which will back the proxy object.

objectName - ObjectName of dependent module without transaction name (platformON).

jmxAttribute - for reporting

Throws:

IllegalArgumentException - when module is not found

IllegalStateException - if module does not export this service interface.

resolveInstance

<T> T resolveInstance(Class<T> expectedType,
                      ObjectName objectName,
                      JmxAttribute jmxAttribute)

To be used during commit phase to wire actual dependencies.

Returns:

dependency instance using Module.getInstance()

Throws:

IllegalArgumentException - when module is not found

resolveIdentity

<T extends BaseIdentity> Class<? extends T> resolveIdentity(IdentityAttributeRef identityRef,
                                                            Class<T> expectedBaseClass)

To be used during commit phase to resolve identity-ref config attributes.

Returns:

actual class object generated from identity

validateIdentity

<T extends BaseIdentity> void validateIdentity(IdentityAttributeRef identityRef,
                                               Class<T> expectedBaseClass,
                                               JmxAttribute jmxAttribute)

Validate identity-ref config attribute.

getAttribute

Object getAttribute(ObjectName name,
                    String attribute)
             throws MBeanException,
                    AttributeNotFoundException,
                    InstanceNotFoundException,
                    ReflectionException

Can be used during validation or commit phase to get attribute value of dependent module.

Parameters:

name - either direct ObjectName of a Module (type=Module) or service reference (type=ServiceReference) of dependent Module

attribute - String identifying attribute name in JMX. Note that attributes start with upper case. See JmxAttribute.getAttributeName()

Throws:

MBeanException

AttributeNotFoundException

InstanceNotFoundException

ReflectionException

newMXBeanProxy

<T> T newMXBeanProxy(ObjectName objectName,
                     Class<T> interfaceClass)

Helper method around 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.

Type Parameters:

T - type of proxy for type safe return value

Parameters:

objectName - either direct ObjectName of a Module (type=Module) or service reference (type=ServiceReference) of dependent Module

interfaceClass - MXBean interface to be used as a proxy

Returns:

instance of MXBean proxy

canReuseDependency

boolean canReuseDependency(ObjectName objectName,
                           JmxAttribute jmxAttribute)

Check whether a dependency will be reused or (re)created. Useful when deciding if current module could be also reused.

Parameters:

objectName - ObjectName ID of a dependency

jmxAttribute - JMXAttribute ID of a dependency

Returns:

true if the dependency will be reused false otherwise