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 com.google.common.base.Preconditions;
11 import com.google.common.base.Strings;
12 import java.io.IOException;
13 import java.lang.reflect.InvocationTargetException;
14 import java.net.URISyntaxException;
15 import java.util.List;
16 import javax.xml.parsers.ParserConfigurationException;
17 import javax.xml.stream.XMLStreamException;
18 import javax.xml.transform.dom.DOMSource;
19 import org.opendaylight.yangtools.yang.binding.DataObject;
20 import org.opendaylight.yangtools.yang.binding.Identifiable;
21 import org.opendaylight.yangtools.yang.binding.Identifier;
22 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
23 import org.opendaylight.yangtools.yang.binding.util.BindingReflections;
24 import org.opendaylight.yangtools.yang.common.QName;
25 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
26 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
27 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
28 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
29 import org.opendaylight.yangtools.yang.data.codec.xml.XmlParserStream;
30 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
31 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
32 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
33 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
34 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
35 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
36 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
37 import org.osgi.service.blueprint.container.ComponentDefinitionException;
38 import org.w3c.dom.Element;
39 import org.xml.sax.SAXException;
42 * Base class to abstract binding type-specific behavior.
44 * @author Thomas Pantelis (originally; re-factored by Michael Vorburger.ch)
46 public abstract class BindingContext {
48 public static BindingContext create(final String logName, final Class<? extends DataObject> klass,
49 final String appConfigListKeyValue) {
50 if (Identifiable.class.isAssignableFrom(klass)) {
51 // The binding class corresponds to a yang list.
52 if (Strings.isNullOrEmpty(appConfigListKeyValue)) {
53 throw new ComponentDefinitionException(String.format(
54 "%s: App config binding class %s represents a yang list therefore \"%s\" must be specified",
55 logName, klass.getName(), DataStoreAppConfigMetadata.LIST_KEY_VALUE));
59 return ListBindingContext.newInstance(klass, appConfigListKeyValue);
60 } catch (InstantiationException | IllegalAccessException | IllegalArgumentException
61 | InvocationTargetException | NoSuchMethodException | SecurityException e) {
62 throw new ComponentDefinitionException(String.format(
63 "%s: Error initializing for app config list binding class %s",
64 logName, klass.getName()), e);
68 return new ContainerBindingContext(klass);
72 public final InstanceIdentifier<DataObject> appConfigPath;
73 public final Class<DataObject> appConfigBindingClass;
74 public final Class<? extends DataSchemaNode> schemaType;
75 public final QName bindingQName;
77 private BindingContext(final Class<DataObject> appConfigBindingClass,
78 final InstanceIdentifier<DataObject> appConfigPath, final Class<? extends DataSchemaNode> schemaType) {
79 this.appConfigBindingClass = appConfigBindingClass;
80 this.appConfigPath = appConfigPath;
81 this.schemaType = schemaType;
83 bindingQName = BindingReflections.findQName(appConfigBindingClass);
86 public NormalizedNode<?, ?> parseDataElement(final Element element, final DataSchemaNode dataSchema,
87 final SchemaContext schemaContext) throws XMLStreamException, IOException, ParserConfigurationException,
88 SAXException, URISyntaxException {
89 final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
90 final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
91 final XmlParserStream xmlParser = XmlParserStream.create(writer, schemaContext, dataSchema);
92 xmlParser.traverse(new DOMSource(element));
94 final NormalizedNode<?, ?> result = resultHolder.getResult();
95 if (result instanceof MapNode) {
96 final MapNode mapNode = (MapNode) result;
97 final MapEntryNode mapEntryNode = mapNode.getValue().iterator().next();
104 public abstract NormalizedNode<?, ?> newDefaultNode(DataSchemaNode dataSchema);
107 * BindingContext implementation for a container binding.
109 private static class ContainerBindingContext extends BindingContext {
110 @SuppressWarnings("unchecked")
111 ContainerBindingContext(final Class<? extends DataObject> appConfigBindingClass) {
112 super((Class<DataObject>) appConfigBindingClass,
113 InstanceIdentifier.create((Class<DataObject>) appConfigBindingClass), ContainerSchemaNode.class);
117 public NormalizedNode<?, ?> newDefaultNode(final DataSchemaNode dataSchema) {
118 return ImmutableNodes.containerNode(bindingQName);
123 * BindingContext implementation for a list binding.
125 private static class ListBindingContext extends BindingContext {
126 final String appConfigListKeyValue;
128 @SuppressWarnings("unchecked")
129 ListBindingContext(final Class<? extends DataObject> appConfigBindingClass,
130 final InstanceIdentifier<? extends DataObject> appConfigPath, final String appConfigListKeyValue) {
131 super((Class<DataObject>) appConfigBindingClass, (InstanceIdentifier<DataObject>) appConfigPath,
132 ListSchemaNode.class);
133 this.appConfigListKeyValue = appConfigListKeyValue;
136 @SuppressWarnings({ "rawtypes", "unchecked" })
137 private static ListBindingContext newInstance(final Class<? extends DataObject> bindingClass,
138 final String listKeyValue) throws InstantiationException, IllegalAccessException,
139 IllegalArgumentException, InvocationTargetException, NoSuchMethodException, SecurityException {
140 // We assume the yang list key type is string.
141 Identifier keyInstance = (Identifier) bindingClass.getMethod("getKey").getReturnType()
142 .getConstructor(String.class).newInstance(listKeyValue);
143 InstanceIdentifier appConfigPath = InstanceIdentifier.builder((Class)bindingClass, keyInstance).build();
144 return new ListBindingContext(bindingClass, appConfigPath, listKeyValue);
148 public NormalizedNode<?, ?> newDefaultNode(final DataSchemaNode dataSchema) {
149 // We assume there's only one key for the list.
150 List<QName> keys = ((ListSchemaNode)dataSchema).getKeyDefinition();
151 Preconditions.checkArgument(keys.size() == 1, "Expected only 1 key for list %s", appConfigBindingClass);
152 QName listKeyQName = keys.get(0);
153 return ImmutableNodes.mapEntryBuilder(bindingQName, listKeyQName, appConfigListKeyValue).build();