org.opendaylight.mdsal.binding.api

Interface ActionProviderService

All Superinterfaces:

BindingService

All Known Implementing Classes:

ActionProviderServiceAdapter

@Beta
 @NonNullByDefault
public interface ActionProviderService
extends BindingService

Registration interface used by action implementations. Each action is defined in a YANG model, and implementations can be invoked dynamically at runtime, via ActionService. Implementations registered with this interface may throw IllegalArgumentExceptions when they encounter inconsistent input data and IllegalStateException in they are unable to service the request.

Author:

Robert Varga

Method Summary

Modifier and Type	Method and Description
default <O extends DataObject,P extends InstanceIdentifier<O>,T extends Action<P,?,?>,S extends T> org.opendaylight.yangtools.concepts.ObjectRegistration<S>	registerImplementation(Class<T> actionInterface, S implementation)
default <O extends DataObject,P extends InstanceIdentifier<O>,T extends Action<P,?,?>,S extends T> org.opendaylight.yangtools.concepts.ObjectRegistration<S>	registerImplementation(Class<T> actionInterface, S implementation, LogicalDatastoreType datastore)
<O extends DataObject,P extends InstanceIdentifier<O>,T extends Action<P,?,?>,S extends T> org.opendaylight.yangtools.concepts.ObjectRegistration<S>	registerImplementation(Class<T> actionInterface, S implementation, LogicalDatastoreType datastore, Set<DataTreeIdentifier<O>> validNodes) Register an implementation of an action, potentially constrained to a set of nodes.

Method Detail

registerImplementation

<O extends DataObject,P extends InstanceIdentifier<O>,T extends Action<P,?,?>,S extends T> org.opendaylight.yangtools.concepts.ObjectRegistration<S> registerImplementation(Class<T> actionInterface,
                                                                                                                                                                            S implementation,
                                                                                                                                                                            LogicalDatastoreType datastore,
                                                                                                                                                                            Set<DataTreeIdentifier<O>> validNodes)

Register an implementation of an action, potentially constrained to a set of nodes.

Parameters:

actionInterface - Generated Action interface

implementation - Implementation of actionInterface

datastore - LogicalDatastoreType on which the implementation operates

validNodes - Set of nodes this implementation is constrained to, empty if this implementation can handle any target node.

Returns:

An ObjectRegistration

Throws:

NullPointerException - if any of the arguments is null

IllegalArgumentException - if any of the validNodes does not match datastore

UnsupportedOperationException - if this service cannot handle requested datastore

registerImplementation

default <O extends DataObject,P extends InstanceIdentifier<O>,T extends Action<P,?,?>,S extends T> org.opendaylight.yangtools.concepts.ObjectRegistration<S> registerImplementation(Class<T> actionInterface,
                                                                                                                                                                                    S implementation,
                                                                                                                                                                                    LogicalDatastoreType datastore)

registerImplementation

default <O extends DataObject,P extends InstanceIdentifier<O>,T extends Action<P,?,?>,S extends T> org.opendaylight.yangtools.concepts.ObjectRegistration<S> registerImplementation(Class<T> actionInterface,
                                                                                                                                                                                    S implementation)