org.opendaylight.mdsal.binding.api

Interface ActionService

All Superinterfaces:

BindingService

All Known Implementing Classes:

ActionServiceAdapter

@Beta
 @NonNullByDefault
public interface ActionService
extends BindingService

Provides access to registered action implementations. Each action is defined in a YANG model, and implementations are added dynamically at runtime, via ActionProviderService.

Author:

Robert Varga

Method Summary

Modifier and Type	Method and Description
default <O extends DataObject,P extends InstanceIdentifier<O>,T extends Action<P,?,?>> T	getActionHandle(Class<T> actionInterface)
default <O extends DataObject,P extends InstanceIdentifier<O>,T extends Action<P,?,?>> T	getActionHandle(Class<T> actionInterface, DataTreeIdentifier<O>... nodes)
default <O extends DataObject,P extends InstanceIdentifier<O>,T extends Action<P,?,?>> T	getActionHandle(Class<T> actionInterface, LogicalDatastoreType dataStore, P path)
default <O extends DataObject,P extends InstanceIdentifier<O>,T extends Action<P,?,?>> T	getActionHandle(Class<T> actionInterface, P path)
<O extends DataObject,T extends Action<?,?,?>> T	getActionHandle(Class<T> actionInterface, Set<DataTreeIdentifier<O>> validNodes) Returns an implementation of a requested Action.

Method Detail

getActionHandle

<O extends DataObject,T extends Action<?,?,?>> T getActionHandle(Class<T> actionInterface,
                                                                 Set<DataTreeIdentifier<O>> validNodes)

Returns an implementation of a requested Action. Returned instance is not an actual implementation of the Action service interface, but a proxy implementation of the interface that forwards to an actual implementation, if any.

The following describes the behavior of the proxy when invoking Action.invoke(InstanceIdentifier, RpcInput):

• If an actual implementation is registered with the MD-SAL, all invocations are forwarded to the registered implementation.
• If no actual implementation is registered, all invocations will fail by throwing IllegalStateException.
• Prior to invoking the actual implementation, the method arguments are are validated. If any are invalid, an IllegalArgumentException is thrown.

The returned proxy is automatically updated with the most recent registered implementation, hence there is no guarantee that multiple consecutive invocations will be handled by the same implementation.

Parameters:

actionInterface - Generated Action interface

validNodes - Set of nodes this service will be constrained to, empty if no constraints are known

Returns:

A proxy implementation of the generated interface

Throws:

NullPointerException - if actionInterface is null

IllegalArgumentException - when actionInterface does not conform to the Binding Specification

getActionHandle

default <O extends DataObject,P extends InstanceIdentifier<O>,T extends Action<P,?,?>> T getActionHandle(Class<T> actionInterface)

getActionHandle

default <O extends DataObject,P extends InstanceIdentifier<O>,T extends Action<P,?,?>> T getActionHandle(Class<T> actionInterface,
                                                                                                         LogicalDatastoreType dataStore,
                                                                                                         P path)

getActionHandle

default <O extends DataObject,P extends InstanceIdentifier<O>,T extends Action<P,?,?>> T getActionHandle(Class<T> actionInterface,
                                                                                                         P path)

getActionHandle

default <O extends DataObject,P extends InstanceIdentifier<O>,T extends Action<P,?,?>> T getActionHandle(Class<T> actionInterface,
                                                                                                         DataTreeIdentifier<O>... nodes)