2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.config.api;
10 import javax.management.ObjectName;
12 import org.opendaylight.controller.config.api.annotations.AbstractServiceInterface;
15 * Each new {@link org.opendaylight.controller.config.spi.Module} can receive
16 * resolver from {@link org.opendaylight.controller.config.spi.ModuleFactory}
17 * for looking up dependencies during validation and second phase commit.
19 * @see org.opendaylight.controller.config.spi.Module
21 public interface DependencyResolver {
24 * To be used during validation phase to validate serice interface of
27 * @param expectedServiceInterface
28 * MBean/MXBean interface which will back the proxy object.
30 * ObjectName of dependent module without transaction name
33 * @throws {@link IllegalArgumentException} when module is not found
34 * @throws {@link IllegalStateException} if module does not export this
37 void validateDependency(
38 Class<? extends AbstractServiceInterface> expectedServiceInterface,
39 ObjectName objectName, JmxAttribute jmxAttribute);
42 // TODO remove once all config code is generated
43 void validateDependency(
44 Class<? extends AbstractServiceInterface> expectedServiceInterface,
45 ObjectName objectName, String attributeNameForErrorReporting);
48 * To be used during commit phase to wire actual dependencies.
50 * @return dependency instance using
51 * {@link org.opendaylight.controller.config.spi.Module#getInstance()}
52 * @throws {@link IllegalArgumentException} when module is not found
54 <T> T resolveInstance(Class<T> expectedType, ObjectName objectName,
55 JmxAttribute jmxAttribute);
58 <T> T resolveInstance(Class<T> expectedType, ObjectName objectName);