2 * Copyright (c) 2018 Pantheon Technologies, s.r.o. 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.mdsal.binding.api;
10 import com.google.common.annotations.Beta;
11 import com.google.common.collect.ImmutableSet;
13 import org.eclipse.jdt.annotation.NonNullByDefault;
14 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
15 import org.opendaylight.yangtools.concepts.ObjectRegistration;
16 import org.opendaylight.yangtools.yang.binding.Action;
17 import org.opendaylight.yangtools.yang.binding.DataObject;
20 * Registration interface used by {@code action} implementations. Each action is defined in a YANG model,
21 * and implementations can be invoked dynamically at runtime, via {@link ActionService}. Implementations registered
22 * with this interface may throw {@link IllegalArgumentException}s when they encounter inconsistent input data and
23 * {@link IllegalStateException} in they are unable to service the request.
25 * @author Robert Varga
29 public interface ActionProviderService extends BindingService {
31 * Register an implementation of an action, potentially constrained to a set of nodes.
33 * @param actionInterface Generated Action interface
34 * @param implementation Implementation of {@code actionInterface}
35 * @param datastore {@link LogicalDatastoreType} on which the implementation operates
36 * @param validNodes Set of nodes this implementation is constrained to, empty if this implementation can handle
38 * @return An {@link ObjectRegistration}
39 * @throws NullPointerException if any of the arguments is null
40 * @throws IllegalArgumentException if any of the {@code validNodes} does not match {@code datastore}
41 * @throws UnsupportedOperationException if this service cannot handle requested datastore
43 <O extends DataObject, T extends Action<O, ?, ?>, S extends T> ObjectRegistration<S> registerImplementation(
44 Class<T> actionInterface, S implementation, LogicalDatastoreType datastore,
45 Set<DataTreeIdentifier<O>> validNodes);
47 default <O extends DataObject, T extends Action<O, ?, ?>, S extends T> ObjectRegistration<S> registerImplementation(
48 final Class<T> actionInterface, final S implementation, final LogicalDatastoreType datastore) {
49 return registerImplementation(actionInterface, implementation, datastore, ImmutableSet.of());
52 default <O extends DataObject, T extends Action<O, ?, ?>, S extends T> ObjectRegistration<S> registerImplementation(
53 final Class<T> actionInterface, final S implementation) {
54 return registerImplementation(actionInterface, implementation, LogicalDatastoreType.OPERATIONAL);