*/
package org.opendaylight.netconf.sal.connect.netconf.schema.mapping;
+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.ImmutableSet.Builder;
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.List;
import java.util.Map;
-import java.util.Set;
-import javax.xml.parsers.ParserConfigurationException;
import javax.xml.stream.XMLStreamException;
import javax.xml.transform.dom.DOMResult;
import javax.xml.transform.dom.DOMSource;
import org.opendaylight.netconf.sal.connect.util.MessageCounter;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.common.Revision;
-import org.opendaylight.yangtools.yang.common.RpcError;
-import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
+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.api.schema.stream.NormalizedNodeStreamWriter;
import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
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;
private static final Logger LOG = LoggerFactory.getLogger(NetconfMessageTransformer.class);
+ private static final ImmutableSet<URI> BASE_OR_NOTIFICATION_NS = ImmutableSet.of(
+ NETCONF_URI,
+ IETF_NETCONF_NOTIFICATIONS.getNamespace(),
+ CREATE_SUBSCRIPTION_RPC_QNAME.getNamespace());
+
private final SchemaContext schemaContext;
private final BaseSchema baseSchema;
private final MessageCounter counter;
- private final Map<QName, RpcDefinition> mappedRpcs;
+ private final ImmutableMap<QName, RpcDefinition> mappedRpcs;
private final Multimap<QName, NotificationDefinition> mappedNotifications;
private final boolean strictParsing;
- private final Set<ActionDefinition> actions;
+ private final ImmutableMap<SchemaPath, ActionDefinition> actions;
public NetconfMessageTransformer(final SchemaContext schemaContext, final boolean strictParsing) {
this(schemaContext, strictParsing, BaseSchema.BASE_NETCONF_CTX);
this.counter = new MessageCounter();
this.schemaContext = schemaContext;
this.mappedRpcs = Maps.uniqueIndex(schemaContext.getOperations(), SchemaNode::getQName);
- this.actions = getActions();
+ this.actions = Maps.uniqueIndex(getActions(schemaContext), ActionDefinition::getPath);
this.mappedNotifications = Multimaps.index(schemaContext.getNotifications(),
node -> node.getQName().withoutRevision());
this.baseSchema = baseSchema;
}
@VisibleForTesting
- Set<ActionDefinition> getActions() {
- Builder<ActionDefinition> builder = ImmutableSet.builder();
- for (DataSchemaNode dataSchemaNode : schemaContext.getChildNodes()) {
- if (dataSchemaNode instanceof ActionNodeContainer) {
- findAction(dataSchemaNode, builder);
- }
- }
- return builder.build();
+ static List<ActionDefinition> getActions(final SchemaContext schemaContext) {
+ final List<ActionDefinition> builder = new ArrayList<>();
+ findAction(schemaContext, builder);
+ return builder;
}
- private
void findAction(final DataSchemaNode dataSchemaNode, final Builder<ActionDefinition> builder) {
+ private
static void findAction(final DataSchemaNode dataSchemaNode, final List<ActionDefinition> builder) {
if (dataSchemaNode instanceof ActionNodeContainer) {
- final ActionNodeContainer containerSchemaNode = (ActionNodeContainer) dataSchemaNode;
- for (ActionDefinition actionDefinition : containerSchemaNode.getActions()) {
+ for (ActionDefinition actionDefinition : ((ActionNodeContainer) dataSchemaNode).getActions()) {
builder.add(actionDefinition);
}
}
for (DataSchemaNode innerDataSchemaNode : ((DataNodeContainer) dataSchemaNode).getChildNodes()) {
findAction(innerDataSchemaNode, builder);
}
+ } else if (dataSchemaNode instanceof ChoiceSchemaNode) {
+ for (CaseSchemaNode caze : ((ChoiceSchemaNode) dataSchemaNode).getCases().values()) {
+ findAction(caze, builder);
+ }
}
}
notificationAsContainerSchemaNode, strictParsing);
xmlParser.traverse(new DOMSource(element));
content = (ContainerNode) resultHolder.getResult();
- } catch (XMLStreamException | URISyntaxException | IOException | ParserConfigurationException
- | SAXException | UnsupportedOperationException e) {
+ } 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());
}
@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, 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() : schemaContext;
+ 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();
}
@Override
- public NetconfMessage toActionRequest(SchemaPath action, final DOMDataTreeIdentifier domDataTreeIdentifier,
+ public NetconfMessage toActionRequest(final SchemaPath action, final DOMDataTreeIdentifier domDataTreeIdentifier,
final NormalizedNode<?, ?> payload) {
- ActionDefinition actionDefinition = null;
- SchemaPath schemaPath = action;
- for (ActionDefinition actionDef : actions) {
- if (actionDef.getPath().getLastComponent().equals(action.getLastComponent())) {
- actionDefinition = actionDef;
- schemaPath = actionDef.getPath();
- }
- }
- Preconditions.checkNotNull(actionDefinition, "Action does not exist: %s", action.getLastComponent());
+ final ActionDefinition actionDef = actions.get(action);
+ Preconditions.checkArgument(actionDef != null, "Action does not exist: %s", action);
- if (actionDefinition.getInput().getChildNodes().isEmpty()) {
+ final ContainerSchemaNode inputDef = actionDef.getInput();
+ if (inputDef.getChildNodes().isEmpty()) {
return new NetconfMessage(NetconfMessageTransformUtil.prepareDomResultForActionRequest(
- domDataTreeIdentifier, action, counter, actionDefinition.getQName().getLocalName())
- .getNode().getOwnerDocument());
+ DataSchemaContextTree.from(schemaContext), domDataTreeIdentifier, action, counter,
+ actionDef.getQName().getLocalName()).getNode().getOwnerDocument());
}
- Preconditions.checkNotNull(payload, "Transforming an action with input: %s, payload cannot be null",
- action.getLastComponent());
+ Preconditions.checkNotNull(payload, "Transforming an action with input: %s, payload cannot be null", action);
Preconditions.checkArgument(payload instanceof ContainerNode,
- "Transforming an rpc with input: %s, payload has to be a container, but was: %s",
- action.getLastComponent(), payload);
- // Set the path to the input of rpc for the node stream writer
- action = action.createChild(QName.create(action.getLastComponent(), "input").intern());
+ "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(
- domDataTreeIdentifier, action, counter, actionDefinition.getQName().getLocalName());
+ DataSchemaContextTree.from(schemaContext), domDataTreeIdentifier, inputDef.getPath(), counter,
+ actionDef.getQName().getLocalName());
try {
- NetconfMessageTransformUtil.writeNormalizedRpc((ContainerNode) payload, result,
- schemaPath.createChild(QName.create(action.getLastComponent(), "input").intern()), schemaContext);
+ NetconfMessageTransformUtil.writeNormalizedRpc((ContainerNode) payload, result, inputDef.getPath(),
+ schemaContext);
} catch (final XMLStreamException | IOException | IllegalStateException e) {
throw new IllegalStateException("Unable to serialize " + action, e);
}
- final Document node = result.getNode().getOwnerDocument();
-
- return new NetconfMessage(node);
+ return new NetconfMessage(result.getNode().getOwnerDocument());
}
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());
+ return BASE_OR_NOTIFICATION_NS.contains(rpc.getNamespace());
}
@Override
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 {
- final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
- final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
- final XmlParserStream xmlParser = XmlParserStream.create(writer, schemaContext, schemaForDataRead,
- strictParsing);
- xmlParser.traverse(new DOMSource(xmlData));
- dataNode = (ContainerNode) resultHolder.getResult();
- } catch (XMLStreamException | URISyntaxException | IOException | ParserConfigurationException
- | SAXException 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, RpcDefinition> currentMappedRpcs;
+ if (mappedRpcs.get(rpcQName) == null && isBaseOrNotificationRpc(rpcQName)) {
currentMappedRpcs = baseSchema.getMappedRpcs();
+ } else {
+ currentMappedRpcs = mappedRpcs;
}
final RpcDefinition rpcDefinition = currentMappedRpcs.get(rpcQName);
@Override
public DOMActionResult toActionResult(final SchemaPath action, final NetconfMessage message) {
- ActionDefinition actionDefinition = null;
- for (ActionDefinition actionDef : actions) {
- if (actionDef.getPath().getLastComponent().equals(action.getLastComponent())) {
- actionDefinition = actionDef;
- }
- }
- Preconditions.checkNotNull(actionDefinition, "Action does not exist: %s", action);
- ContainerNode normalizedNode = (ContainerNode) parseResult(message, actionDefinition);
+ 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.<RpcError>emptyList());
+ return new SimpleDOMActionResult(Collections.emptyList());
} else {
- return new SimpleDOMActionResult(normalizedNode, Collections.<RpcError>emptyList());
+ return new SimpleDOMActionResult(normalizedNode, Collections.emptyList());
}
}
operationDefinition.getOutput(), strictParsing);
xmlParser.traverse(new DOMSource(element));
return resultHolder.getResult();
- } catch (XMLStreamException | URISyntaxException | IOException | ParserConfigurationException
- | SAXException e) {
+ } catch (XMLStreamException | URISyntaxException | IOException | SAXException e) {
throw new IllegalArgumentException(String.format("Failed to parse RPC response %s", element), e);
}
}
Code Review / netconf.git / blobdiff