2 * Copyright (c) 2016 Brocade Communications 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
8 package org.opendaylight.controller.blueprint.ext;
10 import static com.google.common.base.Preconditions.checkArgument;
12 import com.google.common.base.Strings;
13 import com.google.common.collect.Iterables;
14 import java.io.IOException;
15 import java.lang.reflect.InvocationTargetException;
16 import java.net.URISyntaxException;
18 import javax.xml.stream.XMLStreamException;
19 import javax.xml.transform.dom.DOMSource;
20 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
21 import org.opendaylight.yangtools.yang.binding.DataObject;
22 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
23 import org.opendaylight.yangtools.yang.binding.Key;
24 import org.opendaylight.yangtools.yang.binding.KeyAware;
25 import org.opendaylight.yangtools.yang.binding.contract.Naming;
26 import org.opendaylight.yangtools.yang.common.QName;
27 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
29 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
30 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
31 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
32 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
33 import org.opendaylight.yangtools.yang.data.codec.xml.XmlParserStream;
34 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
35 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizationResultHolder;
36 import org.opendaylight.yangtools.yang.data.spi.node.ImmutableNodes;
37 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
38 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
39 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
40 import org.opendaylight.yangtools.yang.model.api.SchemaTreeInference;
41 import org.opendaylight.yangtools.yang.model.api.stmt.KeyEffectiveStatement;
42 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
43 import org.osgi.service.blueprint.container.ComponentDefinitionException;
44 import org.w3c.dom.Element;
45 import org.xml.sax.SAXException;
48 * Base class to abstract binding type-specific behavior.
50 * @author Thomas Pantelis (originally; re-factored by Michael Vorburger.ch)
52 public abstract class BindingContext {
53 public static BindingContext create(final String logName, final Class<? extends DataObject> klass,
54 final String appConfigListKeyValue) {
55 if (KeyAware.class.isAssignableFrom(klass)) {
56 // The binding class corresponds to a yang list.
57 if (Strings.isNullOrEmpty(appConfigListKeyValue)) {
58 throw new ComponentDefinitionException(String.format(
59 "%s: App config binding class %s represents a yang list therefore \"%s\" must be specified",
60 logName, klass.getName(), DataStoreAppConfigMetadata.LIST_KEY_VALUE));
64 return ListBindingContext.newInstance(klass, appConfigListKeyValue);
65 } catch (InstantiationException | IllegalAccessException | IllegalArgumentException
66 | InvocationTargetException | NoSuchMethodException | SecurityException e) {
67 throw new ComponentDefinitionException(String.format(
68 "%s: Error initializing for app config list binding class %s",
69 logName, klass.getName()), e);
73 return new ContainerBindingContext(klass);
77 public final InstanceIdentifier<DataObject> appConfigPath;
78 public final Class<?> appConfigBindingClass;
79 public final Class<? extends DataSchemaNode> schemaType;
80 public final QName bindingQName;
82 private BindingContext(final Class<?> appConfigBindingClass, final InstanceIdentifier<DataObject> appConfigPath,
83 final Class<? extends DataSchemaNode> schemaType) {
84 this.appConfigBindingClass = appConfigBindingClass;
85 this.appConfigPath = appConfigPath;
86 this.schemaType = schemaType;
88 bindingQName = BindingReflections.findQName(appConfigBindingClass);
91 public NormalizedNode parseDataElement(final Element element, final SchemaTreeInference dataSchema)
92 throws XMLStreamException, IOException, SAXException, URISyntaxException {
93 final NormalizationResultHolder resultHolder = new NormalizationResultHolder();
94 final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
95 final XmlParserStream xmlParser = XmlParserStream.create(writer, dataSchema);
96 xmlParser.traverse(new DOMSource(element));
98 final NormalizedNode result = resultHolder.getResult().data();
99 return result instanceof MapNode mapNode ? mapNode.body().iterator().next() : result;
102 public abstract NormalizedNode newDefaultNode(SchemaTreeInference dataSchema);
105 * BindingContext implementation for a container binding.
107 private static class ContainerBindingContext extends BindingContext {
108 @SuppressWarnings("unchecked")
109 ContainerBindingContext(final Class<? extends DataObject> appConfigBindingClass) {
110 super(appConfigBindingClass, InstanceIdentifier.create((Class) appConfigBindingClass),
111 ContainerSchemaNode.class);
115 public ContainerNode newDefaultNode(final SchemaTreeInference dataSchema) {
116 return ImmutableNodes.newContainerBuilder().withNodeIdentifier(new NodeIdentifier(bindingQName)).build();
121 * BindingContext implementation for a list binding.
123 private static class ListBindingContext extends BindingContext {
124 final String appConfigListKeyValue;
126 @SuppressWarnings("unchecked")
127 ListBindingContext(final Class<? extends DataObject> appConfigBindingClass,
128 final InstanceIdentifier<? extends DataObject> appConfigPath, final String appConfigListKeyValue) {
129 super((Class<DataObject>) appConfigBindingClass, (InstanceIdentifier<DataObject>) appConfigPath,
130 ListSchemaNode.class);
131 this.appConfigListKeyValue = appConfigListKeyValue;
134 @SuppressWarnings({ "rawtypes", "unchecked" })
135 static ListBindingContext newInstance(final Class<? extends DataObject> bindingClass,
136 final String listKeyValue) throws InstantiationException, IllegalAccessException,
137 IllegalArgumentException, InvocationTargetException, NoSuchMethodException, SecurityException {
138 // We assume the yang list key type is string.
139 Key keyInstance = (Key) bindingClass.getMethod(Naming.KEY_AWARE_KEY_NAME)
140 .getReturnType().getConstructor(String.class).newInstance(listKeyValue);
141 InstanceIdentifier appConfigPath = InstanceIdentifier.builder((Class)bindingClass, keyInstance).build();
142 return new ListBindingContext(bindingClass, appConfigPath, listKeyValue);
146 public NormalizedNode newDefaultNode(final SchemaTreeInference dataSchema) {
147 final SchemaTreeEffectiveStatement<?> stmt = Iterables.getLast(dataSchema.statementPath());
149 // We assume there's only one key for the list.
150 final Set<QName> keys = stmt.findFirstEffectiveSubstatementArgument(KeyEffectiveStatement.class)
153 checkArgument(keys.size() == 1, "Expected only 1 key for list %s", appConfigBindingClass);
154 QName listKeyQName = keys.iterator().next();
155 return ImmutableNodes.newMapEntryBuilder()
156 .withNodeIdentifier(NodeIdentifierWithPredicates.of(bindingQName, listKeyQName, appConfigListKeyValue))
157 .withChild(ImmutableNodes.leafNode(listKeyQName, appConfigListKeyValue))