org.opendaylight.controller.config.manager.impl.dependencyresolver

Class DependencyResolverImpl

java.lang.Object

org.opendaylight.controller.config.manager.impl.dependencyresolver.DependencyResolverImpl

All Implemented Interfaces:

Comparable<DependencyResolverImpl>, DependencyResolver, org.opendaylight.yangtools.concepts.Identifiable<ModuleIdentifier>

public final class DependencyResolverImpl
extends Object
implements DependencyResolver, Comparable<DependencyResolverImpl>

Protect Module.getInstance() by creating proxy that would throw exception if those methods are called during validation. Tracks dependencies for ordering purposes.

Constructor Summary

Constructors

Constructor and Description
DependencyResolverImpl(ModuleIdentifier currentModule, TransactionStatus transactionStatus, org.opendaylight.controller.config.manager.impl.dependencyresolver.ModulesHolder modulesHolder, ServiceReferenceReadableRegistry readableRegistry, BindingContextProvider bindingContextProvider, String transactionName, MBeanServer beanServer)

Method Summary

Modifier and Type	Method and Description
boolean	canReuseDependency(ObjectName objectName, JmxAttribute jmxAttribute) Check whether a dependency will be reused or (re)created.
int	compareTo(DependencyResolverImpl dependencyResolverImpl)
Object	getAttribute(ObjectName name, String attribute) Can be used during validation or commit phase to get attribute value of dependent module.
ModuleIdentifier	getIdentifier()
<T> T	newMXBeanProxy(ObjectName name, Class<T> interfaceClass) Helper method around.
<T extends org.opendaylight.yangtools.yang.binding.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 dependentReadOnlyON, JmxAttribute jmxAttribute) To be used during commit phase to wire actual dependencies.
void	validateDependency(Class<? extends AbstractServiceInterface> expectedServiceInterface, ObjectName dependentReadOnlyON, JmxAttribute jmxAttribute) To be used during validation phase to validate service interface of dependent module.
<T extends org.opendaylight.yangtools.yang.binding.BaseIdentity> void	validateIdentity(IdentityAttributeRef identityRef, Class<T> expectedBaseClass, JmxAttribute jmxAttribute) Validate identity-ref config attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DependencyResolverImpl

public DependencyResolverImpl(ModuleIdentifier currentModule,
                              TransactionStatus transactionStatus,
                              org.opendaylight.controller.config.manager.impl.dependencyresolver.ModulesHolder modulesHolder,
                              ServiceReferenceReadableRegistry readableRegistry,
                              BindingContextProvider bindingContextProvider,
                              String transactionName,
                              MBeanServer beanServer)

Method Detail

validateDependency

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

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

Specified by:

validateDependency in interface DependencyResolver

Parameters:

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

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

jmxAttribute - for reporting

resolveInstance

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

Description copied from interface: DependencyResolver

To be used during commit phase to wire actual dependencies.

Specified by:

resolveInstance in interface DependencyResolver

Returns:

dependency instance using Module.getInstance()

canReuseDependency

public boolean canReuseDependency(ObjectName objectName,
                                  JmxAttribute jmxAttribute)

Description copied from interface: DependencyResolver

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

Specified by:

canReuseDependency in interface DependencyResolver

Parameters:

objectName - ObjectName ID of a dependency

jmxAttribute - JMXAttribute ID of a dependency

Returns:

true if the dependency will be reused false otherwise

resolveIdentity

public <T extends org.opendaylight.yangtools.yang.binding.BaseIdentity> Class<? extends T> resolveIdentity(IdentityAttributeRef identityRef,
                                                                                                           Class<T> expectedBaseClass)

Description copied from interface: DependencyResolver

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

Specified by:

resolveIdentity in interface DependencyResolver

Returns:

actual class object generated from identity

validateIdentity

public <T extends org.opendaylight.yangtools.yang.binding.BaseIdentity> void validateIdentity(IdentityAttributeRef identityRef,
                                                                                              Class<T> expectedBaseClass,
                                                                                              JmxAttribute jmxAttribute)

Description copied from interface: DependencyResolver

Validate identity-ref config attribute.

Specified by:

validateIdentity in interface DependencyResolver

compareTo

public int compareTo(DependencyResolverImpl dependencyResolverImpl)

Specified by:

compareTo in interface Comparable<DependencyResolverImpl>

getIdentifier

public ModuleIdentifier getIdentifier()

Specified by:

getIdentifier in interface org.opendaylight.yangtools.concepts.Identifiable<ModuleIdentifier>

getAttribute

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

Description copied from interface: DependencyResolver

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

Specified by:

getAttribute in interface DependencyResolver

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

public <T> T newMXBeanProxy(ObjectName name,
                            Class<T> interfaceClass)

Description copied from interface: DependencyResolver

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.

Specified by:

newMXBeanProxy in interface DependencyResolver

Type Parameters:

T - type of proxy for type safe return value

Parameters:

name - 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