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.sal.binding.api.rpc;
12 import org.opendaylight.controller.md.sal.common.api.routing.RouteChangePublisher;
13 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.RoutedRpcRegistration;
14 import org.opendaylight.controller.sal.binding.api.BindingAwareBroker.RpcRegistration;
15 import org.opendaylight.yangtools.yang.binding.BaseIdentity;
16 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
17 import org.opendaylight.yangtools.yang.binding.RpcService;
20 * RpcRouter is responsible for selecting RpcService based on provided routing
21 * context identifier {@link RpcRoutingTable#getContextIdentifier()} and path in
22 * overal data tree (@link {@link InstanceIdentifier}.
25 * @author Tony Tkacik <ttkacik@cisco.com>
28 * Type of RpcService for which router provides routing information
29 * and route selection.
31 public interface RpcRouter<T extends RpcService> extends //
32 RouteChangePublisher<Class<? extends BaseIdentity>, InstanceIdentifier<?>> {
35 * Returns a type of RpcService which is served by this instance of router.
37 * @return type of RpcService which is served by this instance of router.
39 Class<T> getServiceType();
43 * Returns a instance of T which is associated with this router instance
44 * and routes messages based on routing tables.
46 * @return type of RpcService which is served by this instance of router.
48 T getInvocationProxy();
51 * Returns a routing table for particular route context
54 * @return Routing Table for particular route context.
56 <C extends BaseIdentity> RpcRoutingTable<C, T> getRoutingTable(Class<C> routeContext);
59 * Returns an instance of RpcService which is responsible for processing
65 * Instance Identifier which is used as a selector of instance.
66 * @return instance of RpcService which is responsible for processing
69 T getService(Class<? extends BaseIdentity> context, InstanceIdentifier<?> path);
72 * Returns a default fallback instance of RpcService which is responsible
73 * for handling all unknown imports.
75 * @return default instance responsible for processing RPCs.
77 T getDefaultService();
79 Set<Class<? extends BaseIdentity>> getContexts();
81 RoutedRpcRegistration<T> addRoutedRpcImplementation(T service);
83 RpcRegistration<T> registerDefaultService(T service);