Convert blueprint extensions to MDSAL APIs
[controller.git] / opendaylight / blueprint / src / main / java / org / opendaylight / controller / blueprint / ext / ActionServiceMetadata.java
1 /*
2  * Copyright (c) 2017 Cisco Systems, Inc. and others.  All rights reserved.
3  *
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
7  */
8 package org.opendaylight.controller.blueprint.ext;
9
10 import java.util.function.Predicate;
11 import org.opendaylight.mdsal.dom.spi.RpcRoutingStrategy;
12
13 /**
14  * Factory metadata corresponding to the "action-service" element. It waits for a DOM promise of registration
15  * to appear in the {@link DOMRpcService} and then acquires a dynamic proxy via RpcProviderRegistry.
16  *
17  * @author Robert Varga
18  */
19 final class ActionServiceMetadata extends AbstractInvokableServiceMetadata {
20     /*
21      * Implementation note:
22      *
23      * This implementation assumes Binding V1 semantics for actions, which means actions are packaged along with RPCs
24      * into a single interface. This has interesting implications on working with RpcServiceMetadata, which only
25      * handles the RPC side of the contract.
26      *
27      * Further interesting interactions stem from the fact that in DOM world each action is a separate entity, so the
28      * interface contract can let some actions to be invoked, while failing for others. This is a shortcoming of the
29      * Binding Specification and will be addressed in Binding V2 -- where each action is its own interface.
30      */
31     ActionServiceMetadata(final String id, final String interfaceName) {
32         super(id, interfaceName);
33     }
34
35     @Override
36     Predicate<RpcRoutingStrategy> rpcFilter() {
37         return RpcRoutingStrategy::isContextBasedRouted;
38     }
39 }