*/
package org.opendaylight.netconf.sal.connect.netconf.schema.mapping;
+import static java.util.Objects.requireNonNull;
+import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.CREATE_SUBSCRIPTION_RPC_QNAME;
import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.IETF_NETCONF_NOTIFICATIONS;
import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_URI;
import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.toPath;
+import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
+import com.google.common.collect.ImmutableMap;
+import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Maps;
import com.google.common.collect.Multimap;
import com.google.common.collect.Multimaps;
import java.io.IOException;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.time.Instant;
+import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
-import java.util.Comparator;
-import java.util.Date;
+import java.util.List;
import java.util.Map;
-import javax.annotation.Nonnull;
+import java.util.Optional;
import javax.xml.stream.XMLStreamException;
import javax.xml.transform.dom.DOMResult;
-import org.opendaylight.controller.config.util.xml.MissingNameSpaceException;
-import org.opendaylight.controller.config.util.xml.XmlElement;
-import org.opendaylight.controller.md.sal.dom.api.DOMEvent;
-import org.opendaylight.controller.md.sal.dom.api.DOMNotification;
-import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
-import org.opendaylight.controller.md.sal.dom.spi.DefaultDOMRpcResult;
+import javax.xml.transform.dom.DOMSource;
+import org.opendaylight.mdsal.dom.api.DOMActionResult;
+import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
+import org.opendaylight.mdsal.dom.api.DOMEvent;
+import org.opendaylight.mdsal.dom.api.DOMNotification;
+import org.opendaylight.mdsal.dom.api.DOMRpcResult;
+import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
+import org.opendaylight.mdsal.dom.spi.SimpleDOMActionResult;
import org.opendaylight.netconf.api.NetconfMessage;
+import org.opendaylight.netconf.api.xml.MissingNameSpaceException;
+import org.opendaylight.netconf.api.xml.XmlElement;
import org.opendaylight.netconf.sal.connect.api.MessageTransformer;
import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
import org.opendaylight.netconf.sal.connect.util.MessageCounter;
+import org.opendaylight.yangtools.rfc8528.data.api.MountPointContext;
import org.opendaylight.yangtools.yang.common.QName;
-import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
+import org.opendaylight.yangtools.yang.common.Revision;
+import org.opendaylight.yangtools.yang.common.YangConstants;
import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
-import org.opendaylight.yangtools.yang.data.impl.codec.xml.XmlUtils;
+import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
+import org.opendaylight.yangtools.yang.data.codec.xml.XmlParserStream;
import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
-import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.parser.DomToNormalizedNodeParserFactory;
+import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
+import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
+import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
+import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
+import org.opendaylight.yangtools.yang.model.api.ActionNodeContainer;
+import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
+import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
+import org.opendaylight.yangtools.yang.model.api.OperationDefinition;
import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
import org.opendaylight.yangtools.yang.model.api.SchemaContext;
import org.opendaylight.yangtools.yang.model.api.SchemaNode;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
+import org.xml.sax.SAXException;
public class NetconfMessageTransformer implements MessageTransformer<NetconfMessage> {
-
private static final Logger LOG = LoggerFactory.getLogger(NetconfMessageTransformer.class);
- private final SchemaContext schemaContext;
+ private static final ImmutableSet<URI> BASE_OR_NOTIFICATION_NS = ImmutableSet.of(
+ NETCONF_URI,
+ IETF_NETCONF_NOTIFICATIONS.getNamespace(),
+ CREATE_SUBSCRIPTION_RPC_QNAME.getNamespace());
+
+ private final MountPointContext mountContext;
+ private final DataSchemaContextTree contextTree;
private final BaseSchema baseSchema;
private final MessageCounter counter;
- private final Map<QName, RpcDefinition> mappedRpcs;
- private final Multimap<QName, NotificationDefinition> mappedNotifications;
- private final DomToNormalizedNodeParserFactory parserFactory;
-
- public NetconfMessageTransformer(final SchemaContext schemaContext, final boolean strictParsing) {
- this(schemaContext, strictParsing, BaseSchema.BASE_NETCONF_CTX);
- }
+ private final ImmutableMap<QName, ? extends RpcDefinition> mappedRpcs;
+ private final Multimap<QName, ? extends NotificationDefinition> mappedNotifications;
+ private final boolean strictParsing;
+ private final ImmutableMap<SchemaPath, ActionDefinition> actions;
- public NetconfMessageTransformer(final SchemaContext schemaContext, final boolean strictParsing,
+ public NetconfMessageTransformer(final MountPointContext mountContext, final boolean strictParsing,
final BaseSchema baseSchema) {
this.counter = new MessageCounter();
- this.schemaContext = schemaContext;
- parserFactory = DomToNormalizedNodeParserFactory
- .getInstance(XmlUtils.DEFAULT_XML_CODEC_PROVIDER, schemaContext, strictParsing);
- mappedRpcs = Maps.uniqueIndex(schemaContext.getOperations(), SchemaNode::getQName);
- mappedNotifications = Multimaps.index(schemaContext.getNotifications(),
+ this.mountContext = requireNonNull(mountContext);
+
+ final SchemaContext schemaContext = mountContext.getSchemaContext();
+ this.contextTree = DataSchemaContextTree.from(schemaContext);
+
+ this.mappedRpcs = Maps.uniqueIndex(schemaContext.getOperations(), SchemaNode::getQName);
+ this.actions = Maps.uniqueIndex(getActions(schemaContext), ActionDefinition::getPath);
+ this.mappedNotifications = Multimaps.index(schemaContext.getNotifications(),
node -> node.getQName().withoutRevision());
this.baseSchema = baseSchema;
+ this.strictParsing = strictParsing;
+ }
+
+ @VisibleForTesting
+ static List<ActionDefinition> getActions(final SchemaContext schemaContext) {
+ final List<ActionDefinition> builder = new ArrayList<>();
+ findAction(schemaContext, builder);
+ return builder;
+ }
+
+ private static void findAction(final DataSchemaNode dataSchemaNode, final List<ActionDefinition> builder) {
+ if (dataSchemaNode instanceof ActionNodeContainer) {
+ for (ActionDefinition actionDefinition : ((ActionNodeContainer) dataSchemaNode).getActions()) {
+ builder.add(actionDefinition);
+ }
+ }
+ if (dataSchemaNode instanceof DataNodeContainer) {
+ for (DataSchemaNode innerDataSchemaNode : ((DataNodeContainer) dataSchemaNode).getChildNodes()) {
+ findAction(innerDataSchemaNode, builder);
+ }
+ } else if (dataSchemaNode instanceof ChoiceSchemaNode) {
+ for (CaseSchemaNode caze : ((ChoiceSchemaNode) dataSchemaNode).getCases()) {
+ findAction(caze, builder);
+ }
+ }
}
@Override
public synchronized DOMNotification toNotification(final NetconfMessage message) {
- final Map.Entry<Date, XmlElement> stripped = NetconfMessageTransformUtil.stripNotification(message);
+ final Map.Entry<Instant, XmlElement> stripped = NetconfMessageTransformUtil.stripNotification(message);
final QName notificationNoRev;
try {
notificationNoRev = QName.create(
throw new IllegalArgumentException(
"Unable to parse notification " + message + ", cannot find namespace", e);
}
- final Collection<NotificationDefinition> notificationDefinitions = mappedNotifications.get(notificationNoRev);
+ final Collection<? extends NotificationDefinition> notificationDefinitions =
+ mappedNotifications.get(notificationNoRev);
Preconditions.checkArgument(notificationDefinitions.size() > 0,
"Unable to parse notification %s, unknown notification. Available notifications: %s",
notificationDefinitions, mappedNotifications.keySet());
final Element element = stripped.getValue().getDomElement();
final ContainerNode content;
try {
- content = parserFactory.getContainerNodeParser().parse(Collections.singleton(element),
- notificationAsContainerSchemaNode);
- } catch (IllegalArgumentException e) {
+ final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
+ final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
+ final XmlParserStream xmlParser = XmlParserStream.create(writer, mountContext,
+ notificationAsContainerSchemaNode, strictParsing);
+ xmlParser.traverse(new DOMSource(element));
+ content = (ContainerNode) resultHolder.getResult();
+ } catch (XMLStreamException | URISyntaxException | IOException | SAXException
+ | UnsupportedOperationException e) {
throw new IllegalArgumentException(String.format("Failed to parse notification %s", element), e);
}
return new NetconfDeviceNotification(content, stripped.getKey());
}
private static NotificationDefinition getMostRecentNotification(
- final Collection<NotificationDefinition> notificationDefinitions) {
- Comparator<NotificationDefinition> cmp = (o1, o2) ->
- o1.getQName().getRevision().compareTo(o2.getQName().getRevision());
-
- return Collections.max(notificationDefinitions, cmp);
+ final Collection<? extends NotificationDefinition> notificationDefinitions) {
+ return Collections.max(notificationDefinitions, (o1, o2) ->
+ Revision.compare(o1.getQName().getRevision(), o2.getQName().getRevision()));
}
@Override
- public NetconfMessage toRpcRequest(SchemaPath rpc, final NormalizedNode<?, ?> payload) {
+ public NetconfMessage toRpcRequest(final SchemaPath rpc, final NormalizedNode<?, ?> payload) {
// In case no input for rpc is defined, we can simply construct the payload here
final QName rpcQName = rpc.getLastComponent();
- Map<QName, RpcDefinition> currentMappedRpcs = mappedRpcs;
// Determine whether a base netconf operation is being invoked
// and also check if the device exposed model for base netconf.
// If no, use pre built base netconf operations model
final boolean needToUseBaseCtx = mappedRpcs.get(rpcQName) == null && isBaseOrNotificationRpc(rpcQName);
+ final ImmutableMap<QName, ? extends RpcDefinition> currentMappedRpcs;
if (needToUseBaseCtx) {
currentMappedRpcs = baseSchema.getMappedRpcs();
+ } else {
+ currentMappedRpcs = mappedRpcs;
}
- Preconditions.checkNotNull(currentMappedRpcs.get(rpcQName),
+ final RpcDefinition mappedRpc = Preconditions.checkNotNull(currentMappedRpcs.get(rpcQName),
"Unknown rpc %s, available rpcs: %s", rpcQName, currentMappedRpcs.keySet());
- if (currentMappedRpcs.get(rpcQName).getInput().getChildNodes().isEmpty()) {
- return new NetconfMessage(NetconfMessageTransformUtil
- .prepareDomResultForRpcRequest(rpcQName, counter).getNode().getOwnerDocument());
+ if (mappedRpc.getInput().getChildNodes().isEmpty()) {
+ return new NetconfMessage(NetconfMessageTransformUtil.prepareDomResultForRpcRequest(rpcQName, counter)
+ .getNode().getOwnerDocument());
}
Preconditions.checkNotNull(payload, "Transforming an rpc with input: %s, payload cannot be null", rpcQName);
+
Preconditions.checkArgument(payload instanceof ContainerNode,
"Transforming an rpc with input: %s, payload has to be a container, but was: %s", rpcQName, payload);
-
// Set the path to the input of rpc for the node stream writer
- rpc = rpc.createChild(QName.create(rpcQName, "input").intern());
+ final SchemaPath rpcInput = rpc.createChild(YangConstants.operationInputQName(rpcQName.getModule()));
final DOMResult result = NetconfMessageTransformUtil.prepareDomResultForRpcRequest(rpcQName, counter);
try {
// If the schema context for netconf device does not contain model for base netconf operations,
// use default pre build context with just the base model
// This way operations like lock/unlock are supported even if the source for base model was not provided
- SchemaContext ctx = needToUseBaseCtx ? baseSchema.getSchemaContext() : schemaContext;
- NetconfMessageTransformUtil.writeNormalizedRpc((ContainerNode) payload, result, rpc, ctx);
+ final SchemaContext ctx = needToUseBaseCtx ? baseSchema.getSchemaContext()
+ : mountContext.getSchemaContext();
+ NetconfMessageTransformUtil.writeNormalizedRpc((ContainerNode) payload, result, rpcInput, ctx);
} catch (final XMLStreamException | IOException | IllegalStateException e) {
- throw new IllegalStateException("Unable to serialize " + rpc, e);
+ throw new IllegalStateException("Unable to serialize " + rpcInput, e);
}
final Document node = result.getNode().getOwnerDocument();
return new NetconfMessage(node);
}
- private static boolean isBaseOrNotificationRpc(final QName rpc) {
- return rpc.getNamespace().equals(NETCONF_URI)
- || rpc.getNamespace().equals(IETF_NETCONF_NOTIFICATIONS.getNamespace())
- || rpc.getNamespace().equals(NetconfMessageTransformUtil.CREATE_SUBSCRIPTION_RPC_QNAME.getNamespace());
+ @Override
+ public NetconfMessage toActionRequest(final SchemaPath action, final DOMDataTreeIdentifier domDataTreeIdentifier,
+ final NormalizedNode<?, ?> payload) {
+ final ActionDefinition actionDef = actions.get(action);
+ Preconditions.checkArgument(actionDef != null, "Action does not exist: %s", action);
+
+ final ContainerSchemaNode inputDef = actionDef.getInput();
+ if (inputDef.getChildNodes().isEmpty()) {
+ return new NetconfMessage(NetconfMessageTransformUtil.prepareDomResultForActionRequest(contextTree,
+ domDataTreeIdentifier, action, counter,
+ actionDef.getQName()).getNode().getOwnerDocument());
+ }
+
+ Preconditions.checkNotNull(payload, "Transforming an action with input: %s, payload cannot be null", action);
+ Preconditions.checkArgument(payload instanceof ContainerNode,
+ "Transforming an action with input: %s, payload has to be a container, but was: %s", action, payload);
+
+ // Set the path to the input of action for the node stream writer
+ final DOMResult result = NetconfMessageTransformUtil.prepareDomResultForActionRequest(contextTree,
+ domDataTreeIdentifier, inputDef.getPath(), counter, actionDef.getQName());
+
+ try {
+ NetconfMessageTransformUtil.writeNormalizedRpc((ContainerNode) payload, result, inputDef.getPath(),
+ mountContext.getSchemaContext());
+ } catch (final XMLStreamException | IOException | IllegalStateException e) {
+ throw new IllegalStateException("Unable to serialize " + action, e);
+ }
+
+ return new NetconfMessage(result.getNode().getOwnerDocument());
}
+ private static boolean isBaseOrNotificationRpc(final QName rpc) {
+ return BASE_OR_NOTIFICATION_NS.contains(rpc.getNamespace());
+ }
@Override
public synchronized DOMRpcResult toRpcResult(final NetconfMessage message, final SchemaPath rpc) {
final NormalizedNode<?, ?> normalizedNode;
final QName rpcQName = rpc.getLastComponent();
if (NetconfMessageTransformUtil.isDataRetrievalOperation(rpcQName)) {
- final Element xmlData = NetconfMessageTransformUtil.getDataSubtree(message.getDocument());
- final ContainerSchemaNode schemaForDataRead =
- NetconfMessageTransformUtil.createSchemaForDataRead(schemaContext);
- final ContainerNode dataNode;
-
- try {
- dataNode =
- parserFactory.getContainerNodeParser().parse(Collections.singleton(xmlData), schemaForDataRead);
- } catch (IllegalArgumentException e) {
- throw new IllegalArgumentException(String.format("Failed to parse data response %s", xmlData), e);
- }
-
normalizedNode = Builders.containerBuilder()
- .withNodeIdentifier(new YangInstanceIdentifier
- .NodeIdentifier(NetconfMessageTransformUtil.NETCONF_RPC_REPLY_QNAME))
- .withChild(dataNode).build();
+ .withNodeIdentifier(NetconfMessageTransformUtil.NETCONF_RPC_REPLY_NODEID)
+ .withChild(Builders.anyXmlBuilder()
+ .withNodeIdentifier(NetconfMessageTransformUtil.NETCONF_DATA_NODEID)
+ .withValue(new DOMSource(NetconfMessageTransformUtil.getDataSubtree(message.getDocument())))
+ .build())
+ .build();
} else {
-
- Map<QName, RpcDefinition> currentMappedRpcs = mappedRpcs;
-
// Determine whether a base netconf operation is being invoked
// and also check if the device exposed model for base netconf.
// If no, use pre built base netconf operations model
- final boolean needToUseBaseCtx = mappedRpcs.get(rpcQName) == null && isBaseOrNotificationRpc(rpcQName);
- if (needToUseBaseCtx) {
+ final ImmutableMap<QName, ? extends RpcDefinition> currentMappedRpcs;
+ if (mappedRpcs.get(rpcQName) == null && isBaseOrNotificationRpc(rpcQName)) {
currentMappedRpcs = baseSchema.getMappedRpcs();
+ } else {
+ currentMappedRpcs = mappedRpcs;
}
final RpcDefinition rpcDefinition = currentMappedRpcs.get(rpcQName);
"Unable to parse response of %s, the rpc is unknown", rpcQName);
// In case no input for rpc is defined, we can simply construct the payload here
- if (rpcDefinition.getOutput().getChildNodes().isEmpty()) {
- Preconditions.checkArgument(XmlElement.fromDomDocument(
- message.getDocument()).getOnlyChildElementWithSameNamespaceOptionally("ok").isPresent(),
- "Unexpected content in response of rpc: %s, %s", rpcDefinition.getQName(), message);
- normalizedNode = null;
- } else {
- final Element element = message.getDocument().getDocumentElement();
- try {
- normalizedNode = parserFactory.getContainerNodeParser().parse(Collections.singleton(element),
- rpcDefinition.getOutput());
- } catch (IllegalArgumentException e) {
- throw new IllegalArgumentException(String.format("Failed to parse RPC response %s", element), e);
- }
- }
+ normalizedNode = parseResult(message, rpcDefinition);
}
return new DefaultDOMRpcResult(normalizedNode);
}
+ @Override
+ public DOMActionResult toActionResult(final SchemaPath action, final NetconfMessage message) {
+ final ActionDefinition actionDefinition = actions.get(action);
+ Preconditions.checkArgument(actionDefinition != null, "Action does not exist: %s", action);
+ final ContainerNode normalizedNode = (ContainerNode) parseResult(message, actionDefinition);
+
+ if (normalizedNode == null) {
+ return new SimpleDOMActionResult(Collections.emptyList());
+ } else {
+ return new SimpleDOMActionResult(normalizedNode, Collections.emptyList());
+ }
+ }
+
+ private NormalizedNode<?, ?> parseResult(final NetconfMessage message,
+ final OperationDefinition operationDefinition) {
+ final Optional<XmlElement> okResponseElement = XmlElement.fromDomDocument(message.getDocument())
+ .getOnlyChildElementWithSameNamespaceOptionally("ok");
+ if (operationDefinition.getOutput().getChildNodes().isEmpty()) {
+ Preconditions.checkArgument(okResponseElement.isPresent(),
+ "Unexpected content in response of rpc: %s, %s", operationDefinition.getQName(), message);
+ return null;
+ } else {
+ if (okResponseElement.isPresent()) {
+ LOG.debug("Received response <ok/> for RPC with defined Output");
+ return null;
+ }
+
+ Element element = message.getDocument().getDocumentElement();
+ try {
+ final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
+ final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
+ final XmlParserStream xmlParser = XmlParserStream.create(writer, mountContext,
+ operationDefinition.getOutput(), strictParsing);
+ xmlParser.traverse(new DOMSource(element));
+ return resultHolder.getResult();
+ } catch (XMLStreamException | URISyntaxException | IOException | SAXException e) {
+ throw new IllegalArgumentException(String.format("Failed to parse RPC response %s", element), e);
+ }
+ }
+ }
+
static class NetconfDeviceNotification implements DOMNotification, DOMEvent {
private final ContainerNode content;
private final SchemaPath schemaPath;
- private final Date eventTime;
+ private final Instant eventTime;
- NetconfDeviceNotification(final ContainerNode content, final Date eventTime) {
+ NetconfDeviceNotification(final ContainerNode content, final Instant eventTime) {
this.content = content;
this.eventTime = eventTime;
this.schemaPath = toPath(content.getNodeType());
}
- @Nonnull
@Override
public SchemaPath getType() {
return schemaPath;
-
}
- @Nonnull
@Override
public ContainerNode getBody() {
return content;
}
@Override
- public Date getEventTime() {
+ public Instant getEventInstant() {
return eventTime;
}
}