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.Identifiable;
23 import org.opendaylight.yangtools.yang.binding.Identifier;
24 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
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.schema.MapNode;
28 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
29 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
30 import org.opendaylight.yangtools.yang.data.codec.xml.XmlParserStream;
31 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
32 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
33 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizationResultHolder;
34 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
35 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
36 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
37 import org.opendaylight.yangtools.yang.model.api.SchemaTreeInference;
38 import org.opendaylight.yangtools.yang.model.api.stmt.KeyEffectiveStatement;
39 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
40 import org.osgi.service.blueprint.container.ComponentDefinitionException;
41 import org.w3c.dom.Element;
42 import org.xml.sax.SAXException;
45 * Base class to abstract binding type-specific behavior.
47 * @author Thomas Pantelis (originally; re-factored by Michael Vorburger.ch)
49 public abstract class BindingContext {
50 public static BindingContext create(final String logName, final Class<? extends DataObject> klass,
51 final String appConfigListKeyValue) {
52 if (Identifiable.class.isAssignableFrom(klass)) {
53 // The binding class corresponds to a yang list.
54 if (Strings.isNullOrEmpty(appConfigListKeyValue)) {
55 throw new ComponentDefinitionException(String.format(
56 "%s: App config binding class %s represents a yang list therefore \"%s\" must be specified",
57 logName, klass.getName(), DataStoreAppConfigMetadata.LIST_KEY_VALUE));
61 return ListBindingContext.newInstance(klass, appConfigListKeyValue);
62 } catch (InstantiationException | IllegalAccessException | IllegalArgumentException
63 | InvocationTargetException | NoSuchMethodException | SecurityException e) {
64 throw new ComponentDefinitionException(String.format(
65 "%s: Error initializing for app config list binding class %s",
66 logName, klass.getName()), e);
70 return new ContainerBindingContext(klass);
74 public final InstanceIdentifier<DataObject> appConfigPath;
75 public final Class<?> appConfigBindingClass;
76 public final Class<? extends DataSchemaNode> schemaType;
77 public final QName bindingQName;
79 private BindingContext(final Class<?> appConfigBindingClass, final InstanceIdentifier<DataObject> appConfigPath,
80 final Class<? extends DataSchemaNode> schemaType) {
81 this.appConfigBindingClass = appConfigBindingClass;
82 this.appConfigPath = appConfigPath;
83 this.schemaType = schemaType;
85 bindingQName = BindingReflections.findQName(appConfigBindingClass);
88 public NormalizedNode parseDataElement(final Element element, final SchemaTreeInference dataSchema)
89 throws XMLStreamException, IOException, SAXException, URISyntaxException {
90 final NormalizationResultHolder resultHolder = new NormalizationResultHolder();
91 final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
92 final XmlParserStream xmlParser = XmlParserStream.create(writer, dataSchema);
93 xmlParser.traverse(new DOMSource(element));
95 final NormalizedNode result = resultHolder.getResult().data();
96 return result instanceof MapNode mapNode ? mapNode.body().iterator().next() : result;
99 public abstract NormalizedNode newDefaultNode(SchemaTreeInference dataSchema);
102 * BindingContext implementation for a container binding.
104 private static class ContainerBindingContext extends BindingContext {
105 @SuppressWarnings("unchecked")
106 ContainerBindingContext(final Class<? extends DataObject> appConfigBindingClass) {
107 super(appConfigBindingClass, InstanceIdentifier.create((Class) appConfigBindingClass),
108 ContainerSchemaNode.class);
112 public NormalizedNode newDefaultNode(final SchemaTreeInference dataSchema) {
113 return ImmutableNodes.containerNode(bindingQName);
118 * BindingContext implementation for a list binding.
120 private static class ListBindingContext extends BindingContext {
121 final String appConfigListKeyValue;
123 @SuppressWarnings("unchecked")
124 ListBindingContext(final Class<? extends DataObject> appConfigBindingClass,
125 final InstanceIdentifier<? extends DataObject> appConfigPath, final String appConfigListKeyValue) {
126 super((Class<DataObject>) appConfigBindingClass, (InstanceIdentifier<DataObject>) appConfigPath,
127 ListSchemaNode.class);
128 this.appConfigListKeyValue = appConfigListKeyValue;
131 @SuppressWarnings({ "rawtypes", "unchecked" })
132 static ListBindingContext newInstance(final Class<? extends DataObject> bindingClass,
133 final String listKeyValue) throws InstantiationException, IllegalAccessException,
134 IllegalArgumentException, InvocationTargetException, NoSuchMethodException, SecurityException {
135 // We assume the yang list key type is string.
136 Identifier keyInstance = (Identifier) bindingClass.getMethod(Naming.IDENTIFIABLE_KEY_NAME)
137 .getReturnType().getConstructor(String.class).newInstance(listKeyValue);
138 InstanceIdentifier appConfigPath = InstanceIdentifier.builder((Class)bindingClass, keyInstance).build();
139 return new ListBindingContext(bindingClass, appConfigPath, listKeyValue);
143 public NormalizedNode newDefaultNode(final SchemaTreeInference dataSchema) {
144 final SchemaTreeEffectiveStatement<?> stmt = Iterables.getLast(dataSchema.statementPath());
146 // We assume there's only one key for the list.
147 final Set<QName> keys = stmt.findFirstEffectiveSubstatementArgument(KeyEffectiveStatement.class)
150 checkArgument(keys.size() == 1, "Expected only 1 key for list %s", appConfigBindingClass);
151 QName listKeyQName = keys.iterator().next();
152 return ImmutableNodes.mapEntryBuilder(bindingQName, listKeyQName, appConfigListKeyValue).build();