import static com.google.common.base.Preconditions.checkArgument;
import static java.util.Objects.requireNonNull;
+import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.COMMIT_RPC_CONTENT;
import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.EDIT_CONTENT_NODEID;
-import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_CANDIDATE_QNAME;
+import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.GET_RPC_CONTENT;
+import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_CANDIDATE_NODEID;
+import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_COMMIT_QNAME;
import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_COPY_CONFIG_NODEID;
-import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_COPY_CONFIG_PATH;
+import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_COPY_CONFIG_QNAME;
import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_DEFAULT_OPERATION_NODEID;
-import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_DISCARD_CHANGES_PATH;
+import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_DISCARD_CHANGES_QNAME;
import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_EDIT_CONFIG_NODEID;
-import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_EDIT_CONFIG_PATH;
+import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_EDIT_CONFIG_QNAME;
import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_ERROR_OPTION_NODEID;
import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_CONFIG_NODEID;
-import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_CONFIG_PATH;
+import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_CONFIG_QNAME;
import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_NODEID;
-import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_PATH;
+import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_QNAME;
import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_LOCK_NODEID;
-import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_LOCK_PATH;
-import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_RUNNING_QNAME;
+import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_LOCK_QNAME;
+import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_RUNNING_NODEID;
import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_SOURCE_NODEID;
import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_TARGET_NODEID;
import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_UNLOCK_NODEID;
-import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_UNLOCK_PATH;
+import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_UNLOCK_QNAME;
import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_VALIDATE_NODEID;
+import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_VALIDATE_QNAME;
import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.ROLLBACK_ON_ERROR_OPTION;
import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.toFilterStructure;
-import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.toId;
+import com.google.common.collect.Iterables;
import com.google.common.util.concurrent.FutureCallback;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.MoreExecutors;
-import java.util.Locale;
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+import java.util.Map.Entry;
import java.util.Optional;
+import java.util.stream.Collectors;
+import org.eclipse.jdt.annotation.NonNull;
import org.opendaylight.mdsal.dom.api.DOMRpcResult;
-import org.opendaylight.mdsal.dom.api.DOMRpcService;
import org.opendaylight.netconf.api.ModifyAction;
-import org.opendaylight.netconf.sal.connect.netconf.sal.KeepaliveSalFacade.KeepaliveDOMRpcService;
-import org.opendaylight.netconf.sal.connect.netconf.sal.SchemalessNetconfDeviceRpc;
+import org.opendaylight.netconf.sal.connect.api.NetconfRpcService;
+import org.opendaylight.netconf.sal.connect.api.RemoteDeviceServices.Rpcs;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.copy.config.input.target.ConfigTarget;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.get.config.input.source.ConfigSource;
+import org.opendaylight.yangtools.rfc8528.data.api.MountPointContext;
import org.opendaylight.yangtools.yang.common.Empty;
-import org.opendaylight.yangtools.yang.common.QName;
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.ChoiceNode;
import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
-import org.opendaylight.yangtools.yang.data.api.schema.DOMSourceAnyxmlNode;
import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
+import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
-import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
-import org.opendaylight.yangtools.yang.model.api.SchemaContext;
+import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
/**
- * Provides base operations for netconf e.g. get, get-config, edit-config, (un)lock, commit etc.
- * According to RFC-6241
+ * Provides base operations for NETCONF e.g. {@code get}, {@code get-config}, {@code edit-config}, {@code commit} etc.
+ * as per <a href="https://www.rfc-editor.org/rfc/rfc6241#section-7">RFC6241 Protocol Operations</a>.
*/
+// FIXME: turn Optional arguments to @Nullable
public final class NetconfBaseOps {
private static final NodeIdentifier CONFIG_SOURCE_NODEID = NodeIdentifier.create(ConfigSource.QNAME);
private static final NodeIdentifier CONFIG_TARGET_NODEID = NodeIdentifier.create(ConfigTarget.QNAME);
+ private static final LeafNode<String> NETCONF_ERROR_OPTION_ROLLBACK =
+ ImmutableNodes.leafNode(NETCONF_ERROR_OPTION_NODEID, ROLLBACK_ON_ERROR_OPTION);
- private final DOMRpcService rpc;
- private final SchemaContext schemaContext;
+ private final NetconfRpcService rpc;
+ private final MountPointContext mountContext;
private final RpcStructureTransformer transformer;
- public NetconfBaseOps(final DOMRpcService rpc, final SchemaContext schemaContext) {
- this.rpc = rpc;
- this.schemaContext = schemaContext;
+ public NetconfBaseOps(final Rpcs rpc, final MountPointContext mountContext) {
+ this.rpc = requireNonNull(rpc);
+ this.mountContext = requireNonNull(mountContext);
- if (rpc instanceof KeepaliveDOMRpcService
- && ((KeepaliveDOMRpcService) rpc).getDeviceRpc() instanceof SchemalessNetconfDeviceRpc) {
- this.transformer = new SchemalessRpcStructureTransformer();
+ if (rpc instanceof Rpcs.Schemaless) {
+ transformer = new SchemalessRpcStructureTransformer();
+ } else if (rpc instanceof Rpcs.Normalized) {
+ transformer = new NetconfRpcStructureTransformer(mountContext);
} else {
- this.transformer = new NetconfRpcStructureTransformer(schemaContext);
+ throw new IllegalStateException("Unhandled rpcs " + rpc);
}
}
- public ListenableFuture<DOMRpcResult> lock(final FutureCallback<DOMRpcResult> callback, final QName datastore) {
- requireNonNull(callback);
- requireNonNull(datastore);
-
- final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_LOCK_PATH, getLockContent(datastore));
- Futures.addCallback(future, callback, MoreExecutors.directExecutor());
- return future;
+ public ListenableFuture<? extends DOMRpcResult> lock(final FutureCallback<DOMRpcResult> callback,
+ final NodeIdentifier datastore) {
+ return addCallback(requireNonNull(callback), rpc.invokeNetconf(NETCONF_LOCK_QNAME, getLockContent(datastore)));
}
- public ListenableFuture<DOMRpcResult> lockCandidate(final FutureCallback<DOMRpcResult> callback) {
- final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_LOCK_PATH,
- getLockContent(NETCONF_CANDIDATE_QNAME));
+ private static <T> ListenableFuture<T> addCallback(final FutureCallback<? super T> callback,
+ final ListenableFuture<T> future) {
Futures.addCallback(future, callback, MoreExecutors.directExecutor());
return future;
}
- public ListenableFuture<DOMRpcResult> lockRunning(final FutureCallback<DOMRpcResult> callback) {
- final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_LOCK_PATH,
- getLockContent(NETCONF_RUNNING_QNAME));
- Futures.addCallback(future, callback, MoreExecutors.directExecutor());
- return future;
+ public ListenableFuture<? extends DOMRpcResult> lockCandidate(final FutureCallback<DOMRpcResult> callback) {
+ return addCallback(requireNonNull(callback), rpc.invokeNetconf(NETCONF_LOCK_QNAME,
+ getLockContent(NETCONF_CANDIDATE_NODEID)));
}
- public ListenableFuture<DOMRpcResult> unlock(final FutureCallback<DOMRpcResult> callback, final QName datastore) {
- requireNonNull(callback);
- requireNonNull(datastore);
-
- final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_UNLOCK_PATH, getUnLockContent(datastore));
- Futures.addCallback(future, callback, MoreExecutors.directExecutor());
- return future;
+ public ListenableFuture<? extends DOMRpcResult> lockRunning(final FutureCallback<DOMRpcResult> callback) {
+ return addCallback(requireNonNull(callback), rpc.invokeNetconf(NETCONF_LOCK_QNAME,
+ getLockContent(NETCONF_RUNNING_NODEID)));
}
- public ListenableFuture<DOMRpcResult> unlockRunning(final FutureCallback<DOMRpcResult> callback) {
- final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_UNLOCK_PATH,
- getUnLockContent(NETCONF_RUNNING_QNAME));
- Futures.addCallback(future, callback, MoreExecutors.directExecutor());
- return future;
+ public ListenableFuture<? extends DOMRpcResult> unlock(final FutureCallback<DOMRpcResult> callback,
+ final NodeIdentifier datastore) {
+ return addCallback(requireNonNull(callback), rpc.invokeNetconf(NETCONF_UNLOCK_QNAME,
+ getUnLockContent(datastore)));
}
- public ListenableFuture<DOMRpcResult> unlockCandidate(final FutureCallback<DOMRpcResult> callback) {
- final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_UNLOCK_PATH,
- getUnLockContent(NETCONF_CANDIDATE_QNAME));
- Futures.addCallback(future, callback, MoreExecutors.directExecutor());
- return future;
+ public ListenableFuture<? extends DOMRpcResult> unlockRunning(final FutureCallback<DOMRpcResult> callback) {
+ return addCallback(requireNonNull(callback), rpc.invokeNetconf(NETCONF_UNLOCK_QNAME,
+ getUnLockContent(NETCONF_RUNNING_NODEID)));
}
- public ListenableFuture<DOMRpcResult> discardChanges(final FutureCallback<DOMRpcResult> callback) {
- requireNonNull(callback);
-
- final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_DISCARD_CHANGES_PATH, null);
- Futures.addCallback(future, callback, MoreExecutors.directExecutor());
- return future;
+ public ListenableFuture<? extends DOMRpcResult> unlockCandidate(final FutureCallback<DOMRpcResult> callback) {
+ return addCallback(requireNonNull(callback), rpc.invokeNetconf(NETCONF_UNLOCK_QNAME,
+ getUnLockContent(NETCONF_CANDIDATE_NODEID)));
}
- public ListenableFuture<DOMRpcResult> commit(final FutureCallback<DOMRpcResult> callback) {
- requireNonNull(callback);
-
- final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NetconfMessageTransformUtil.NETCONF_COMMIT_PATH,
- NetconfMessageTransformUtil.COMMIT_RPC_CONTENT);
- Futures.addCallback(future, callback, MoreExecutors.directExecutor());
- return future;
+ public ListenableFuture<? extends DOMRpcResult> discardChanges(final FutureCallback<DOMRpcResult> callback) {
+ // FIXME: eliminate null
+ return addCallback(requireNonNull(callback), rpc.invokeNetconf(NETCONF_DISCARD_CHANGES_QNAME, null));
}
- public ListenableFuture<DOMRpcResult> validate(final FutureCallback<DOMRpcResult> callback, final QName datastore) {
- requireNonNull(callback);
-
- final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NetconfMessageTransformUtil.NETCONF_VALIDATE_PATH,
- getValidateContent(requireNonNull(datastore)));
- Futures.addCallback(future, callback, MoreExecutors.directExecutor());
- return future;
+ public ListenableFuture<? extends DOMRpcResult> commit(final FutureCallback<DOMRpcResult> callback) {
+ return addCallback(requireNonNull(callback), rpc.invokeNetconf(NETCONF_COMMIT_QNAME, COMMIT_RPC_CONTENT));
}
- public ListenableFuture<DOMRpcResult> validateCandidate(final FutureCallback<DOMRpcResult> callback) {
- return validate(callback, NETCONF_CANDIDATE_QNAME);
+ public ListenableFuture<? extends DOMRpcResult> validate(final FutureCallback<DOMRpcResult> callback,
+ final NodeIdentifier datastore) {
+ return addCallback(requireNonNull(callback), rpc.invokeNetconf(NETCONF_VALIDATE_QNAME,
+ getValidateContent(requireNonNull(datastore))));
}
- public ListenableFuture<DOMRpcResult> validateRunning(final FutureCallback<DOMRpcResult> callback) {
- return validate(callback, NETCONF_RUNNING_QNAME);
+ public ListenableFuture<? extends DOMRpcResult> validateCandidate(final FutureCallback<DOMRpcResult> callback) {
+ return validate(callback, NETCONF_CANDIDATE_NODEID);
}
- public ListenableFuture<DOMRpcResult> copyConfig(final FutureCallback<DOMRpcResult> callback,
- final QName source, final QName target) {
- requireNonNull(callback);
-
- final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_COPY_CONFIG_PATH,
- getCopyConfigContent(requireNonNull(source), requireNonNull(target)));
- Futures.addCallback(future, callback, MoreExecutors.directExecutor());
- return future;
+ public ListenableFuture<? extends DOMRpcResult> validateRunning(final FutureCallback<DOMRpcResult> callback) {
+ return validate(callback, NETCONF_RUNNING_NODEID);
}
- public ListenableFuture<DOMRpcResult> copyRunningToCandidate(final FutureCallback<DOMRpcResult> callback) {
- return copyConfig(callback, NETCONF_RUNNING_QNAME, NETCONF_CANDIDATE_QNAME);
+ public ListenableFuture<? extends DOMRpcResult> copyConfig(final FutureCallback<DOMRpcResult> callback,
+ final NodeIdentifier sourceDatastore, final NodeIdentifier targetDatastore) {
+ return addCallback(requireNonNull(callback), rpc.invokeNetconf(NETCONF_COPY_CONFIG_QNAME,
+ getCopyConfigContent(sourceDatastore, targetDatastore)));
}
- public ListenableFuture<DOMRpcResult> getConfig(final FutureCallback<DOMRpcResult> callback, final QName datastore,
- final Optional<YangInstanceIdentifier> filterPath) {
- requireNonNull(callback);
- requireNonNull(datastore);
-
- final ListenableFuture<DOMRpcResult> future;
- if (isFilterPresent(filterPath)) {
- final DataContainerChild<?, ?> node = transformer.toFilterStructure(filterPath.get());
- future = rpc.invokeRpc(NETCONF_GET_CONFIG_PATH,
- NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_NODEID, getSourceNode(datastore), node));
- } else {
- future = rpc.invokeRpc(NETCONF_GET_CONFIG_PATH,
- NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_NODEID, getSourceNode(datastore)));
- }
-
- Futures.addCallback(future, callback, MoreExecutors.directExecutor());
- return future;
+ public ListenableFuture<? extends DOMRpcResult> copyRunningToCandidate(
+ final FutureCallback<DOMRpcResult> callback) {
+ return copyConfig(callback, NETCONF_RUNNING_NODEID, NETCONF_CANDIDATE_NODEID);
}
- public ListenableFuture<Optional<NormalizedNode<?, ?>>> getConfigRunningData(
- final FutureCallback<DOMRpcResult> callback, final Optional<YangInstanceIdentifier> filterPath) {
- final ListenableFuture<DOMRpcResult> configRunning = getConfigRunning(callback, filterPath);
- return extractData(filterPath, configRunning);
+ public ListenableFuture<? extends DOMRpcResult> getConfig(final FutureCallback<DOMRpcResult> callback,
+ final NodeIdentifier datastore, final Optional<YangInstanceIdentifier> filterPath) {
+ final var source = getSourceNode(datastore);
+ return addCallback(requireNonNull(callback), rpc.invokeNetconf(NETCONF_GET_CONFIG_QNAME,
+ nonEmptyFilter(filterPath)
+ .map(path -> NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_NODEID, source,
+ transformer.toFilterStructure(path)))
+ .orElseGet(() -> NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_NODEID, source))));
}
- public ListenableFuture<Optional<NormalizedNode<?, ?>>> getData(final FutureCallback<DOMRpcResult> callback,
- final Optional<YangInstanceIdentifier> filterPath) {
- final ListenableFuture<DOMRpcResult> configRunning = get(callback, filterPath);
- return extractData(filterPath, configRunning);
+ private ListenableFuture<? extends DOMRpcResult> getConfig(final FutureCallback<DOMRpcResult> callback,
+ final NodeIdentifier datastore, final Optional<YangInstanceIdentifier> filterPath,
+ final List<YangInstanceIdentifier> fields) {
+ final ContainerNode rpcInput;
+ if (nonEmptyFilter(filterPath).isPresent()) {
+ rpcInput = NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_NODEID, getSourceNode(datastore),
+ transformer.toFilterStructure(List.of(FieldsFilter.of(filterPath.orElseThrow(), fields))));
+ } else if (containsEmptyPath(fields)) {
+ rpcInput = NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_NODEID, getSourceNode(datastore));
+ } else {
+ rpcInput = NetconfMessageTransformUtil.wrap(NETCONF_GET_CONFIG_NODEID,
+ getSourceNode(datastore), getSubtreeFilterFromRootFields(fields));
+ }
+ return addCallback(requireNonNull(callback), rpc.invokeNetconf(NETCONF_GET_CONFIG_QNAME, rpcInput));
+ }
+
+ /**
+ * Calling GET-CONFIG RPC with subtree filter that is specified by {@link YangInstanceIdentifier}.
+ *
+ * @param callback RPC response callback
+ * @param filterPath path to requested data
+ * @return asynchronous completion token with read {@link NormalizedNode} wrapped in {@link Optional} instance
+ */
+ public ListenableFuture<Optional<NormalizedNode>> getConfigRunningData(final FutureCallback<DOMRpcResult> callback,
+ final Optional<YangInstanceIdentifier> filterPath) {
+ return extractData(filterPath, getConfigRunning(callback, filterPath));
+ }
+
+ /**
+ * Calling GET-CONFIG RPC with subtree filter tha tis specified by parent {@link YangInstanceIdentifier} and list
+ * of specific fields that caller would like to read. Field paths are relative to parent path.
+ *
+ * @param callback RPC response callback
+ * @param filterPath parent path to requested data
+ * @param fields paths to specific fields that are selected under parent path
+ * @return asynchronous completion token with read {@link NormalizedNode} wrapped in {@link Optional} instance
+ */
+ public ListenableFuture<Optional<NormalizedNode>> getConfigRunningData(final FutureCallback<DOMRpcResult> callback,
+ final Optional<YangInstanceIdentifier> filterPath, final List<YangInstanceIdentifier> fields) {
+ if (fields.isEmpty()) {
+ // RFC doesn't allow to build subtree filter that would expect just empty element in response
+ return Futures.immediateFailedFuture(new IllegalArgumentException(
+ "Failed to build NETCONF GET-CONFIG RPC: provided list of fields is empty; filter path: "
+ + filterPath));
+ }
+ return extractData(filterPath, getConfigRunning(callback, filterPath, fields));
+ }
+
+ /**
+ * Calling GET RPC with subtree filter that is specified by {@link YangInstanceIdentifier}.
+ *
+ * @param callback RPC response callback
+ * @param filterPath path to requested data
+ * @return asynchronous completion token with read {@link NormalizedNode} wrapped in {@link Optional} instance
+ */
+ public ListenableFuture<Optional<NormalizedNode>> getData(final FutureCallback<DOMRpcResult> callback,
+ final Optional<YangInstanceIdentifier> filterPath) {
+ return extractData(filterPath, get(callback, filterPath));
+ }
+
+ /**
+ * Calling GET RPC with subtree filter tha tis specified by parent {@link YangInstanceIdentifier} and list
+ * of specific fields that caller would like to read. Field paths are relative to parent path.
+ *
+ * @param callback RPC response callback
+ * @param filterPath parent path to requested data
+ * @param fields paths to specific fields that are selected under parent path
+ * @return asynchronous completion token with read {@link NormalizedNode} wrapped in {@link Optional} instance
+ */
+ public ListenableFuture<Optional<NormalizedNode>> getData(final FutureCallback<DOMRpcResult> callback,
+ final Optional<YangInstanceIdentifier> filterPath, final List<YangInstanceIdentifier> fields) {
+ if (fields.isEmpty()) {
+ // RFC doesn't allow to build subtree filter that would expect just empty element in response
+ return Futures.immediateFailedFuture(new IllegalArgumentException(
+ "Failed to build NETCONF GET RPC: provided list of fields is empty; filter path: " + filterPath));
+ }
+ return extractData(filterPath, get(callback, filterPath, fields));
}
- private ListenableFuture<Optional<NormalizedNode<?, ?>>> extractData(
- final Optional<YangInstanceIdentifier> path, final ListenableFuture<DOMRpcResult> configRunning) {
+ private ListenableFuture<Optional<NormalizedNode>> extractData(final Optional<YangInstanceIdentifier> path,
+ final ListenableFuture<? extends DOMRpcResult> configRunning) {
return Futures.transform(configRunning, result -> {
- checkArgument(result.getErrors().isEmpty(), "Unable to read data: %s, errors: %s", path,
- result.getErrors());
- final DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> dataNode =
- ((ContainerNode) result.getResult()).getChild(NetconfMessageTransformUtil.NETCONF_DATA_NODEID)
- .get();
- return transformer.selectFromDataStructure(dataNode, path.get());
+ final var errors = result.errors();
+ checkArgument(errors.isEmpty(), "Unable to read data: %s, errors: %s", path, errors);
+ return transformer.selectFromDataStructure(result.value()
+ .getChildByArg(NetconfMessageTransformUtil.NETCONF_DATA_NODEID), path.orElseThrow());
}, MoreExecutors.directExecutor());
}
- public ListenableFuture<DOMRpcResult> getConfigRunning(final FutureCallback<DOMRpcResult> callback,
- final Optional<YangInstanceIdentifier> filterPath) {
- return getConfig(callback, NETCONF_RUNNING_QNAME, filterPath);
+ public ListenableFuture<? extends DOMRpcResult> getConfigRunning(final FutureCallback<DOMRpcResult> callback,
+ final Optional<YangInstanceIdentifier> filterPath) {
+ return getConfig(callback, NETCONF_RUNNING_NODEID, filterPath);
}
- public ListenableFuture<DOMRpcResult> getConfigCandidate(final FutureCallback<DOMRpcResult> callback,
- final Optional<YangInstanceIdentifier> filterPath) {
- return getConfig(callback, NETCONF_CANDIDATE_QNAME, filterPath);
+ private ListenableFuture<? extends DOMRpcResult> getConfigRunning(final FutureCallback<DOMRpcResult> callback,
+ final Optional<YangInstanceIdentifier> filterPath, final List<YangInstanceIdentifier> fields) {
+ return getConfig(callback, NETCONF_RUNNING_NODEID, filterPath, fields);
}
- public ListenableFuture<DOMRpcResult> get(final FutureCallback<DOMRpcResult> callback,
- final Optional<YangInstanceIdentifier> filterPath) {
- requireNonNull(callback);
+ public ListenableFuture<? extends DOMRpcResult> getConfigCandidate(final FutureCallback<DOMRpcResult> callback,
+ final Optional<YangInstanceIdentifier> filterPath) {
+ return getConfig(callback, NETCONF_CANDIDATE_NODEID, filterPath);
+ }
- final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_GET_PATH, isFilterPresent(filterPath)
- ? NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, toFilterStructure(filterPath.get(), schemaContext))
- : NetconfMessageTransformUtil.GET_RPC_CONTENT);
- Futures.addCallback(future, callback, MoreExecutors.directExecutor());
- return future;
+ public ListenableFuture<? extends DOMRpcResult> get(final FutureCallback<DOMRpcResult> callback,
+ final Optional<YangInstanceIdentifier> filterPath) {
+ return addCallback(requireNonNull(callback), rpc.invokeNetconf(NETCONF_GET_QNAME,
+ nonEmptyFilter(filterPath)
+ .map(path -> NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID,
+ toFilterStructure(path, mountContext.getEffectiveModelContext())))
+ .orElse(NetconfMessageTransformUtil.GET_RPC_CONTENT)));
}
- private static boolean isFilterPresent(final Optional<YangInstanceIdentifier> filterPath) {
- return filterPath.isPresent() && !filterPath.get().isEmpty();
+ private ListenableFuture<? extends DOMRpcResult> get(final FutureCallback<DOMRpcResult> callback,
+ final Optional<YangInstanceIdentifier> filterPath, final List<YangInstanceIdentifier> fields) {
+ final ContainerNode rpcInput;
+ if (nonEmptyFilter(filterPath).isPresent()) {
+ rpcInput = NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, transformer.toFilterStructure(
+ Collections.singletonList(FieldsFilter.of(filterPath.orElseThrow(), fields))));
+ } else if (containsEmptyPath(fields)) {
+ rpcInput = GET_RPC_CONTENT;
+ } else {
+ rpcInput = NetconfMessageTransformUtil.wrap(NETCONF_GET_NODEID, getSubtreeFilterFromRootFields(fields));
+ }
+ return addCallback(requireNonNull(callback), rpc.invokeNetconf(NETCONF_GET_QNAME, rpcInput));
}
- public ListenableFuture<DOMRpcResult> editConfigCandidate(final FutureCallback<? super DOMRpcResult> callback,
- final DataContainerChild<?, ?> editStructure,
- final ModifyAction modifyAction, final boolean rollback) {
- return editConfig(callback, NETCONF_CANDIDATE_QNAME, editStructure, Optional.of(modifyAction), rollback);
+ private static boolean containsEmptyPath(final List<YangInstanceIdentifier> fields) {
+ return fields.stream().anyMatch(YangInstanceIdentifier::isEmpty);
}
- public ListenableFuture<DOMRpcResult> editConfigCandidate(final FutureCallback<? super DOMRpcResult> callback,
- final DataContainerChild<?, ?> editStructure,
- final boolean rollback) {
- return editConfig(callback, NETCONF_CANDIDATE_QNAME, editStructure, Optional.empty(), rollback);
+ private DataContainerChild getSubtreeFilterFromRootFields(final List<YangInstanceIdentifier> fields) {
+ return transformer.toFilterStructure(fields.stream()
+ .map(fieldPath -> Map.entry(
+ YangInstanceIdentifier.create(Iterables.limit(fieldPath.getPathArguments(), 1)),
+ YangInstanceIdentifier.create(Iterables.skip(fieldPath.getPathArguments(), 1))))
+ .collect(Collectors.groupingBy(Entry::getKey,
+ Collectors.mapping(Entry::getValue, Collectors.toUnmodifiableList())))
+ .entrySet().stream()
+ .map(entry -> FieldsFilter.of(entry.getKey(), entry.getValue()))
+ .collect(Collectors.toUnmodifiableList()));
}
- public ListenableFuture<DOMRpcResult> editConfigRunning(final FutureCallback<? super DOMRpcResult> callback,
- final DataContainerChild<?, ?> editStructure,
- final ModifyAction modifyAction, final boolean rollback) {
- return editConfig(callback, NETCONF_RUNNING_QNAME, editStructure, Optional.of(modifyAction), rollback);
+ private static Optional<YangInstanceIdentifier> nonEmptyFilter(final Optional<YangInstanceIdentifier> filterPath) {
+ return filterPath.filter(path -> !path.isEmpty());
}
- public ListenableFuture<DOMRpcResult> editConfigRunning(final FutureCallback<? super DOMRpcResult> callback,
- final DataContainerChild<?, ?> editStructure,
- final boolean rollback) {
- return editConfig(callback, NETCONF_RUNNING_QNAME, editStructure, Optional.empty(), rollback);
+ public ListenableFuture<? extends DOMRpcResult> editConfigCandidate(
+ final FutureCallback<? super DOMRpcResult> callback, final DataContainerChild editStructure,
+ final ModifyAction modifyAction, final boolean rollback) {
+ return editConfig(callback, NETCONF_CANDIDATE_NODEID, editStructure, Optional.of(modifyAction), rollback);
}
- public ListenableFuture<DOMRpcResult> editConfig(
- final FutureCallback<? super DOMRpcResult> callback, final QName datastore,
- final DataContainerChild<?, ?> editStructure, final Optional<ModifyAction> modifyAction,
+ public ListenableFuture<? extends DOMRpcResult> editConfigCandidate(
+ final FutureCallback<? super DOMRpcResult> callback, final DataContainerChild editStructure,
final boolean rollback) {
- requireNonNull(callback);
+ return editConfig(callback, NETCONF_CANDIDATE_NODEID, editStructure, Optional.empty(), rollback);
+ }
- final ListenableFuture<DOMRpcResult> future = rpc.invokeRpc(NETCONF_EDIT_CONFIG_PATH,
- getEditConfigContent(requireNonNull(datastore), requireNonNull(editStructure), modifyAction, rollback));
+ public ListenableFuture<? extends DOMRpcResult> editConfigRunning(
+ final FutureCallback<? super DOMRpcResult> callback, final DataContainerChild editStructure,
+ final ModifyAction modifyAction, final boolean rollback) {
+ return editConfig(callback, NETCONF_RUNNING_NODEID, editStructure, Optional.of(modifyAction), rollback);
+ }
- Futures.addCallback(future, callback, MoreExecutors.directExecutor());
- return future;
+ public ListenableFuture<? extends DOMRpcResult> editConfigRunning(
+ final FutureCallback<? super DOMRpcResult> callback, final DataContainerChild editStructure,
+ final boolean rollback) {
+ return editConfig(callback, NETCONF_RUNNING_NODEID, editStructure, Optional.empty(), rollback);
}
- public DataContainerChild<?, ?> createEditConfigStrcture(final Optional<NormalizedNode<?, ?>> lastChild,
- final Optional<ModifyAction> operation,
- final YangInstanceIdentifier dataPath) {
- final DOMSourceAnyxmlNode configContent = transformer.createEditConfigStructure(lastChild, dataPath, operation);
- return Builders.choiceBuilder().withNodeIdentifier(EDIT_CONTENT_NODEID).withChild(configContent).build();
+ public ListenableFuture<? extends DOMRpcResult> editConfig(
+ final FutureCallback<? super DOMRpcResult> callback, final NodeIdentifier datastore,
+ final DataContainerChild editStructure, final Optional<ModifyAction> modifyAction,
+ final boolean rollback) {
+ return addCallback(requireNonNull(callback), rpc.invokeNetconf(NETCONF_EDIT_CONFIG_QNAME,
+ getEditConfigContent(requireNonNull(datastore), requireNonNull(editStructure), modifyAction, rollback)));
}
- private static ContainerNode getEditConfigContent(
- final QName datastore, final DataContainerChild<?, ?> editStructure,
- final Optional<ModifyAction> defaultOperation, final boolean rollback) {
- final DataContainerNodeBuilder<YangInstanceIdentifier.NodeIdentifier, ContainerNode> editBuilder =
- Builders.containerBuilder().withNodeIdentifier(NETCONF_EDIT_CONFIG_NODEID);
+ public ChoiceNode createEditConfigStructure(final Optional<NormalizedNode> lastChild,
+ final Optional<ModifyAction> operation, final YangInstanceIdentifier dataPath) {
+ return Builders.choiceBuilder()
+ .withNodeIdentifier(EDIT_CONTENT_NODEID)
+ .withChild(transformer.createEditConfigStructure(lastChild, dataPath, operation))
+ .build();
+ }
- // Target
- editBuilder.withChild(getTargetNode(datastore));
+ private static ContainerNode getEditConfigContent(final NodeIdentifier datastore,
+ final DataContainerChild editStructure, final Optional<ModifyAction> defaultOperation,
+ final boolean rollback) {
+ final var editBuilder = Builders.containerBuilder()
+ .withNodeIdentifier(NETCONF_EDIT_CONFIG_NODEID)
+ // Target
+ .withChild(getTargetNode(datastore));
// Default operation
- if (defaultOperation.isPresent()) {
- final String opString = defaultOperation.get().name().toLowerCase(Locale.ROOT);
- editBuilder.withChild(Builders.leafBuilder().withNodeIdentifier(NETCONF_DEFAULT_OPERATION_NODEID)
- .withValue(opString).build());
- }
+ defaultOperation.ifPresent(op -> {
+ editBuilder.withChild(ImmutableNodes.leafNode(NETCONF_DEFAULT_OPERATION_NODEID, op.xmlValue()));
+ });
// Error option
if (rollback) {
- editBuilder.withChild(Builders.leafBuilder().withNodeIdentifier(NETCONF_ERROR_OPTION_NODEID)
- .withValue(ROLLBACK_ON_ERROR_OPTION).build());
+ editBuilder.withChild(NETCONF_ERROR_OPTION_ROLLBACK);
}
// Edit content
- editBuilder.withChild(editStructure);
- return editBuilder.build();
+ return editBuilder.withChild(editStructure).build();
}
- public static DataContainerChild<?, ?> getSourceNode(final QName datastore) {
- return Builders.containerBuilder().withNodeIdentifier(NETCONF_SOURCE_NODEID)
- .withChild(Builders.choiceBuilder().withNodeIdentifier(CONFIG_SOURCE_NODEID).withChild(
- Builders.leafBuilder().withNodeIdentifier(toId(datastore)).withValue(Empty.getInstance()).build())
- .build()).build();
+ public static @NonNull ContainerNode getSourceNode(final NodeIdentifier datastore) {
+ return Builders.containerBuilder()
+ .withNodeIdentifier(NETCONF_SOURCE_NODEID)
+ .withChild(Builders.choiceBuilder()
+ .withNodeIdentifier(CONFIG_SOURCE_NODEID)
+ .withChild(ImmutableNodes.leafNode(datastore, Empty.value()))
+ .build())
+ .build();
}
- public static ContainerNode getLockContent(final QName datastore) {
- return Builders.containerBuilder().withNodeIdentifier(NETCONF_LOCK_NODEID)
- .withChild(getTargetNode(datastore)).build();
+ public static @NonNull ContainerNode getLockContent(final NodeIdentifier datastore) {
+ return Builders.containerBuilder()
+ .withNodeIdentifier(NETCONF_LOCK_NODEID)
+ .withChild(getTargetNode(datastore))
+ .build();
}
- public static DataContainerChild<?, ?> getTargetNode(final QName datastore) {
- return Builders.containerBuilder().withNodeIdentifier(NETCONF_TARGET_NODEID)
- .withChild(Builders.choiceBuilder().withNodeIdentifier(CONFIG_TARGET_NODEID).withChild(
- Builders.leafBuilder().withNodeIdentifier(toId(datastore)).withValue(Empty.getInstance()).build())
- .build()).build();
+ public static @NonNull ContainerNode getTargetNode(final NodeIdentifier datastore) {
+ return Builders.containerBuilder()
+ .withNodeIdentifier(NETCONF_TARGET_NODEID)
+ .withChild(Builders.choiceBuilder()
+ .withNodeIdentifier(CONFIG_TARGET_NODEID)
+ .withChild(ImmutableNodes.leafNode(datastore, Empty.value()))
+ .build())
+ .build();
}
- public static NormalizedNode<?, ?> getCopyConfigContent(final QName source, final QName target) {
- return Builders.containerBuilder().withNodeIdentifier(NETCONF_COPY_CONFIG_NODEID)
- .withChild(getTargetNode(target)).withChild(getSourceNode(source)).build();
+ public static @NonNull ContainerNode getCopyConfigContent(final NodeIdentifier sourceDatastore,
+ final NodeIdentifier targetDatastore) {
+ return Builders.containerBuilder()
+ .withNodeIdentifier(NETCONF_COPY_CONFIG_NODEID)
+ .withChild(getTargetNode(targetDatastore))
+ .withChild(getSourceNode(sourceDatastore))
+ .build();
}
- public static NormalizedNode<?, ?> getValidateContent(final QName source) {
- return Builders.containerBuilder().withNodeIdentifier(NETCONF_VALIDATE_NODEID)
- .withChild(getSourceNode(source)).build();
+ public static @NonNull ContainerNode getValidateContent(final NodeIdentifier sourceDatastore) {
+ return Builders.containerBuilder()
+ .withNodeIdentifier(NETCONF_VALIDATE_NODEID)
+ .withChild(getSourceNode(sourceDatastore))
+ .build();
}
- public static NormalizedNode<?, ?> getUnLockContent(final QName datastore) {
- return Builders.containerBuilder().withNodeIdentifier(NETCONF_UNLOCK_NODEID)
- .withChild(getTargetNode(datastore)).build();
+ public static @NonNull ContainerNode getUnLockContent(final NodeIdentifier datastore) {
+ return Builders.containerBuilder()
+ .withNodeIdentifier(NETCONF_UNLOCK_NODEID)
+ .withChild(getTargetNode(datastore))
+ .build();
}
-
}
Code Review / netconf.git / blobdiff