import static java.util.Objects.requireNonNull;
-import com.google.common.annotations.Beta;
import com.google.common.collect.ClassToInstanceMap;
import com.google.common.collect.ImmutableSet;
+import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
+import java.util.List;
import java.util.Set;
+import java.util.stream.Collectors;
import org.eclipse.jdt.annotation.NonNullByDefault;
-import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.mdsal.binding.api.ActionProviderService;
+import org.opendaylight.mdsal.binding.api.ActionSpec;
import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
import org.opendaylight.mdsal.binding.dom.adapter.BindingDOMAdapterBuilder.Factory;
-import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
import org.opendaylight.mdsal.dom.api.DOMActionImplementation;
+import org.opendaylight.mdsal.dom.api.DOMActionInstance;
import org.opendaylight.mdsal.dom.api.DOMActionProviderService;
import org.opendaylight.mdsal.dom.api.DOMActionResult;
import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
import org.opendaylight.mdsal.dom.api.DOMService;
+import org.opendaylight.mdsal.dom.spi.SimpleDOMActionResult;
import org.opendaylight.yangtools.concepts.AbstractObjectRegistration;
import org.opendaylight.yangtools.concepts.ObjectRegistration;
import org.opendaylight.yangtools.yang.binding.Action;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.opendaylight.yangtools.yang.common.ErrorTag;
+import org.opendaylight.yangtools.yang.common.ErrorType;
import org.opendaylight.yangtools.yang.common.RpcResult;
+import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
import org.opendaylight.yangtools.yang.common.YangConstants;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
-import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
-@Beta
@NonNullByDefault
-// FIXME: make this class non-public once the controller user is gone
public final class ActionProviderServiceAdapter extends AbstractBindingAdapter<DOMActionProviderService>
implements ActionProviderService {
private static final class Builder extends BindingDOMAdapterBuilder<ActionProviderService> {
+ Builder(final AdapterContext adapterContext) {
+ super(adapterContext);
+ }
+
@Override
- protected ActionProviderService createInstance(final @Nullable BindingToNormalizedNodeCodec codec,
- final ClassToInstanceMap<DOMService> delegates) {
- final DOMActionProviderService domAction = delegates.getInstance(DOMActionProviderService.class);
- return new ActionProviderServiceAdapter(requireNonNull(codec), domAction);
+ protected ActionProviderService createInstance(final ClassToInstanceMap<DOMService> delegates) {
+ return new ActionProviderServiceAdapter(adapterContext(),
+ delegates.getInstance(DOMActionProviderService.class));
}
@Override
}
}
- static final Factory<ActionProviderService> BUILDER_FACTORY = Builder::new;
+ private static final Logger LOG = LoggerFactory.getLogger(ActionProviderServiceAdapter.class);
- ActionProviderServiceAdapter(final BindingToNormalizedNodeCodec codec, final DOMActionProviderService delegate) {
- super(codec, delegate);
- }
+ static final Factory<ActionProviderService> BUILDER_FACTORY = Builder::new;
- @Deprecated
- public static ActionProviderServiceAdapter create(final BindingToNormalizedNodeCodec codec,
- final DOMActionProviderService delegate) {
- return new ActionProviderServiceAdapter(codec, delegate);
+ ActionProviderServiceAdapter(final AdapterContext adapterContext, final DOMActionProviderService delegate) {
+ super(adapterContext, delegate);
}
@Override
- public <O extends DataObject, P extends InstanceIdentifier<O>,
- T extends org.opendaylight.yangtools.yang.binding.Action<P, ?, ?>, S extends T>
- ObjectRegistration<S> registerImplementation(final Class<T> actionInterface, final S implementation,
- final LogicalDatastoreType datastore, final Set<DataTreeIdentifier<O>> validNodes) {
- final SchemaPath path = getCodec().getActionPath(actionInterface);
- final ObjectRegistration<DOMActionImplementation> reg = getDelegate().registerActionImplementation(
- new Impl(getCodec(),
- NodeIdentifier.create(YangConstants.operationOutputQName(path.getLastComponent().getModule())),
- actionInterface, implementation), ImmutableSet.of());
- return new AbstractObjectRegistration<S>(implementation) {
+ public <P extends DataObject, A extends Action<? extends InstanceIdentifier<P>, ?, ?>, S extends A>
+ ObjectRegistration<S> registerImplementation(final ActionSpec<A, P> spec, final S implementation,
+ final LogicalDatastoreType datastore, final Set<? extends InstanceIdentifier<P>> validNodes) {
+ final CurrentAdapterSerializer serializer = currentSerializer();
+ final Absolute actionPath = serializer.getActionPath(spec);
+ final Impl impl = new Impl(adapterContext(), actionPath, spec.type(), implementation);
+ final DOMActionInstance instance = validNodes.isEmpty()
+ // Register on the entire datastore
+ ? DOMActionInstance.of(actionPath, new DOMDataTreeIdentifier(datastore, YangInstanceIdentifier.empty()))
+ // Register on specific instances
+ : DOMActionInstance.of(actionPath, validNodes.stream()
+ .map(node -> serializer.toDOMDataTreeIdentifier(DataTreeIdentifier.create(datastore, node)))
+ .collect(Collectors.toUnmodifiableSet()));
+
+
+ final ObjectRegistration<?> reg = getDelegate().registerActionImplementation(impl, instance);
+
+ return new AbstractObjectRegistration<>(implementation) {
@Override
protected void removeRegistration() {
reg.close();
private static final class Impl implements DOMActionImplementation {
private final Class<? extends Action<?, ?, ?>> actionInterface;
+ private final AdapterContext adapterContext;
+ @SuppressWarnings("rawtypes")
private final Action implementation;
- private final BindingNormalizedNodeSerializer codec;
private final NodeIdentifier outputName;
- Impl(final BindingNormalizedNodeSerializer codec, final NodeIdentifier outputName,
+ Impl(final AdapterContext adapterContext, final Absolute actionPath,
final Class<? extends Action<?, ?, ?>> actionInterface, final Action<?, ?, ?> implementation) {
- this.codec = requireNonNull(codec);
- this.outputName = requireNonNull(outputName);
+ this.adapterContext = requireNonNull(adapterContext);
+ outputName = NodeIdentifier.create(
+ YangConstants.operationOutputQName(actionPath.lastNodeIdentifier().getModule()));
this.actionInterface = requireNonNull(actionInterface);
this.implementation = requireNonNull(implementation);
}
@Override
@SuppressWarnings({ "rawtypes", "unchecked" })
- public ListenableFuture<? extends DOMActionResult> invokeAction(final SchemaPath type,
+ public ListenableFuture<? extends DOMActionResult> invokeAction(final Absolute type,
final DOMDataTreeIdentifier path, final ContainerNode input) {
- final ListenableFuture<RpcResult<?>> userFuture = implementation.invoke(
- codec.fromYangInstanceIdentifier(path.getRootIdentifier()),
+ final CurrentAdapterSerializer codec = adapterContext.currentSerializer();
+ final InstanceIdentifier<DataObject> instance = codec.fromYangInstanceIdentifier(path.getRootIdentifier());
+ if (instance == null) {
+ // Not representable: return an error
+ LOG.debug("Path {} is not representable in binding, rejecting invocation", path);
+ return Futures.immediateFuture(new SimpleDOMActionResult(List.of(RpcResultBuilder.newError(
+ ErrorType.APPLICATION, ErrorTag.INVALID_VALUE, "Supplied path cannot be represented"))));
+ }
+ if (instance.isWildcarded()) {
+ // A wildcard path: return an error
+ LOG.debug("Path {} maps to a wildcard {}, rejecting invocation", path, instance);
+ return Futures.immediateFuture(new SimpleDOMActionResult(List.of(RpcResultBuilder.newError(
+ ErrorType.APPLICATION, ErrorTag.INVALID_VALUE,
+ "Supplied path does not identify a concrete instance"))));
+ }
+
+ final ListenableFuture<RpcResult<?>> userFuture = implementation.invoke(instance,
codec.fromNormalizedNodeActionInput(actionInterface, input));
if (userFuture instanceof BindingOperationFluentFuture) {
// If we are looping back through our future we can skip wrapping. This can happen if application
return (BindingOperationFluentFuture) userFuture;
}
- return new BindingOperationFluentFuture(userFuture, actionInterface, outputName, codec);
+ return new BindingOperationFluentFuture(userFuture, actionInterface, outputName, adapterContext);
}
}
}