2 * Copyright (c) 2015 Cisco Systems, Inc. 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
9 package org.opendaylight.controller.cluster.datastore.node.utils.transformer;
11 import com.google.common.annotations.VisibleForTesting;
12 import com.google.common.base.Preconditions;
13 import java.io.IOException;
15 import java.util.HashSet;
16 import java.util.LinkedList;
17 import java.util.List;
19 import javax.xml.transform.dom.DOMSource;
20 import org.opendaylight.yangtools.yang.common.QName;
21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
22 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
23 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
24 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
25 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeContainerBuilder;
26 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
29 * The NormalizedNodePruner removes all nodes from the input NormalizedNode that do not have a corresponding
30 * schema element in the passed in SchemaContext
33 public class NormalizedNodePruner implements NormalizedNodeStreamWriter {
35 public static final URI BASE_NAMESPACE = URI.create("urn:ietf:params:xml:ns:netconf:base:1.0");
36 private final SimpleStack<NormalizedNodeBuilderWrapper> stack = new SimpleStack<>();
37 private NormalizedNode<?,?> normalizedNode;
38 private final Set<URI> validNamespaces;
39 private boolean sealed = false;
41 public NormalizedNodePruner(SchemaContext schemaContext) {
42 this(NormalizedNodePruner.namespaces(schemaContext));
45 public NormalizedNodePruner(Set<URI> validNamespaces) {
46 this.validNamespaces = validNamespaces;
50 public void leafNode(YangInstanceIdentifier.NodeIdentifier nodeIdentifier, Object o) throws IOException, IllegalArgumentException {
54 if(!isValidNamespace(nodeIdentifier)){
57 NormalizedNodeBuilderWrapper parent = stack.peek();
58 Preconditions.checkState(parent != null, "leafNode has no parent");
60 .addChild(Builders.leafBuilder()
61 .withNodeIdentifier(nodeIdentifier)
67 public void startLeafSet(YangInstanceIdentifier.NodeIdentifier nodeIdentifier, int i) throws IOException, IllegalArgumentException {
71 addBuilder(Builders.leafSetBuilder().withNodeIdentifier(nodeIdentifier), nodeIdentifier);
75 public void startOrderedLeafSet(YangInstanceIdentifier.NodeIdentifier nodeIdentifier, int i) throws IOException, IllegalArgumentException {
79 addBuilder(Builders.orderedLeafSetBuilder().withNodeIdentifier(nodeIdentifier), nodeIdentifier);
83 public void leafSetEntryNode(Object o) throws IOException, IllegalArgumentException {
87 NormalizedNodeBuilderWrapper parent = stack.peek();
88 Preconditions.checkState(parent != null, "leafSetEntryNode has no parent");
89 if(!isValidNamespace(parent.identifier())){
94 .addChild(Builders.leafSetEntryBuilder()
96 .withNodeIdentifier(new YangInstanceIdentifier.NodeWithValue(parent.nodeType(), o))
101 public void startContainerNode(YangInstanceIdentifier.NodeIdentifier nodeIdentifier, int i) throws IOException, IllegalArgumentException {
105 addBuilder(Builders.containerBuilder().withNodeIdentifier(nodeIdentifier), nodeIdentifier);
109 public void startUnkeyedList(YangInstanceIdentifier.NodeIdentifier nodeIdentifier, int i) throws IOException, IllegalArgumentException {
113 addBuilder(Builders.unkeyedListBuilder().withNodeIdentifier(nodeIdentifier), nodeIdentifier);
117 public void startUnkeyedListItem(YangInstanceIdentifier.NodeIdentifier nodeIdentifier, int i) throws IOException, IllegalStateException {
121 addBuilder(Builders.unkeyedListEntryBuilder().withNodeIdentifier(nodeIdentifier), nodeIdentifier);
125 public void startMapNode(YangInstanceIdentifier.NodeIdentifier nodeIdentifier, int i) throws IOException, IllegalArgumentException {
129 addBuilder(Builders.mapBuilder().withNodeIdentifier(nodeIdentifier), nodeIdentifier);
133 public void startMapEntryNode(YangInstanceIdentifier.NodeIdentifierWithPredicates nodeIdentifierWithPredicates, int i) throws IOException, IllegalArgumentException {
137 addBuilder(Builders.mapEntryBuilder().withNodeIdentifier(nodeIdentifierWithPredicates), nodeIdentifierWithPredicates);
141 public void startOrderedMapNode(YangInstanceIdentifier.NodeIdentifier nodeIdentifier, int i) throws IOException, IllegalArgumentException {
145 addBuilder(Builders.orderedMapBuilder().withNodeIdentifier(nodeIdentifier), nodeIdentifier);
149 public void startChoiceNode(YangInstanceIdentifier.NodeIdentifier nodeIdentifier, int i) throws IOException, IllegalArgumentException {
153 addBuilder(Builders.choiceBuilder().withNodeIdentifier(nodeIdentifier), nodeIdentifier);
157 public void startAugmentationNode(YangInstanceIdentifier.AugmentationIdentifier augmentationIdentifier) throws IOException, IllegalArgumentException {
161 addBuilder(Builders.augmentationBuilder().withNodeIdentifier(augmentationIdentifier), augmentationIdentifier);
165 public void anyxmlNode(YangInstanceIdentifier.NodeIdentifier nodeIdentifier, Object o) throws IOException, IllegalArgumentException {
169 if(!isValidNamespace(nodeIdentifier)){
172 NormalizedNodeBuilderWrapper parent = stack.peek();
173 Preconditions.checkState(parent != null, "anyxmlNode has no parent");
174 parent.builder().addChild(Builders.anyXmlBuilder().withNodeIdentifier(nodeIdentifier).withValue((DOMSource) o).build());
178 public void endNode() throws IOException, IllegalStateException {
182 NormalizedNodeBuilderWrapper child = stack.pop();
184 Preconditions.checkState(child != null, "endNode called on an empty stack");
186 if(!isValidNamespace(child.identifier())){
189 NormalizedNode<?,?> normalizedNode = child.builder().build();
191 if(stack.size() > 0){
192 NormalizedNodeBuilderWrapper parent = stack.peek();
193 parent.builder().addChild(normalizedNode);
195 this.normalizedNode = normalizedNode;
201 public void close() throws IOException {
206 public void flush() throws IOException {
210 public NormalizedNode<?,?> normalizedNode(){
211 return normalizedNode;
214 private void checkNotSealed(){
215 Preconditions.checkState(!sealed, "Pruner can be used only once");
218 private boolean isValidNamespace(QName qName){
219 return validNamespaces.contains(qName.getNamespace());
222 private boolean isValidNamespace(YangInstanceIdentifier.AugmentationIdentifier augmentationIdentifier){
223 Set<QName> possibleChildNames = augmentationIdentifier.getPossibleChildNames();
225 for(QName qName : possibleChildNames){
226 if(isValidNamespace(qName)){
234 private boolean isValidNamespace(YangInstanceIdentifier.PathArgument identifier){
235 if(identifier instanceof YangInstanceIdentifier.AugmentationIdentifier){
236 return isValidNamespace((YangInstanceIdentifier.AugmentationIdentifier) identifier);
239 return isValidNamespace(identifier.getNodeType());
242 private NormalizedNodeBuilderWrapper addBuilder(NormalizedNodeContainerBuilder<?,?,?,?> builder, YangInstanceIdentifier.PathArgument identifier){
243 NormalizedNodeBuilderWrapper wrapper = new NormalizedNodeBuilderWrapper(builder, identifier);
249 static class SimpleStack<E> {
250 List<E> stack = new LinkedList<>();
252 void push(E element){
260 return stack.remove(stack.size() - 1);
268 return stack.get(stack.size() - 1);
277 SimpleStack<NormalizedNodeBuilderWrapper> stack(){
281 public static Set<URI> namespaces(SchemaContext schemaContext){
282 Set<URI> namespaces = new HashSet<>(schemaContext.getModules().size());
283 namespaces.add(BASE_NAMESPACE);
284 for(org.opendaylight.yangtools.yang.model.api.Module module : schemaContext.getModules()){
285 namespaces.add(module.getNamespace());