opendaylight/blueprint/src/main/java/org/opendaylight/controller/blueprint/ext/BindingContext.java

   1 /*
   2  * Copyright (c) 2016 Brocade Communications Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.controller.blueprint.ext;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11
  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;
  17 import java.util.Set;
  18 import javax.xml.parsers.ParserConfigurationException;
  19 import javax.xml.stream.XMLStreamException;
  20 import javax.xml.transform.dom.DOMSource;
  21 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
  22 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  23 import org.opendaylight.yangtools.yang.binding.DataObject;
  24 import org.opendaylight.yangtools.yang.binding.Identifiable;
  25 import org.opendaylight.yangtools.yang.binding.Identifier;
  26 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  27 import org.opendaylight.yangtools.yang.common.QName;
  28 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  29 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  30 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  31 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  32 import org.opendaylight.yangtools.yang.data.codec.xml.XmlParserStream;
  33 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  34 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  35 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
  36 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  37 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  38 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  39 import org.opendaylight.yangtools.yang.model.api.SchemaTreeInference;
  40 import org.opendaylight.yangtools.yang.model.api.stmt.KeyEffectiveStatement;
  41 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
  42 import org.osgi.service.blueprint.container.ComponentDefinitionException;
  43 import org.w3c.dom.Element;
  44 import org.xml.sax.SAXException;
  45
  46 /**
  47  * Base class to abstract binding type-specific behavior.
  48  *
  49  * @author Thomas Pantelis (originally; re-factored by Michael Vorburger.ch)
  50  */
  51 public abstract class BindingContext {
  52     public static BindingContext create(final String logName, final Class<? extends DataObject> klass,
  53             final String appConfigListKeyValue) {
  54         if (Identifiable.class.isAssignableFrom(klass)) {
  55             // The binding class corresponds to a yang list.
  56             if (Strings.isNullOrEmpty(appConfigListKeyValue)) {
  57                 throw new ComponentDefinitionException(String.format(
  58                         "%s: App config binding class %s represents a yang list therefore \"%s\" must be specified",
  59                         logName, klass.getName(), DataStoreAppConfigMetadata.LIST_KEY_VALUE));
  60             }
  61
  62             try {
  63                 return ListBindingContext.newInstance(klass, appConfigListKeyValue);
  64             } catch (InstantiationException | IllegalAccessException | IllegalArgumentException
  65                     | InvocationTargetException | NoSuchMethodException | SecurityException e) {
  66                 throw new ComponentDefinitionException(String.format(
  67                         "%s: Error initializing for app config list binding class %s",
  68                         logName, klass.getName()), e);
  69             }
  70
  71         } else {
  72             return new ContainerBindingContext(klass);
  73         }
  74     }
  75
  76     public final InstanceIdentifier<DataObject> appConfigPath;
  77     public final Class<?> appConfigBindingClass;
  78     public final Class<? extends DataSchemaNode> schemaType;
  79     public final QName bindingQName;
  80
  81     private BindingContext(final Class<?> appConfigBindingClass, final InstanceIdentifier<DataObject> appConfigPath,
  82             final Class<? extends DataSchemaNode> schemaType) {
  83         this.appConfigBindingClass = appConfigBindingClass;
  84         this.appConfigPath = appConfigPath;
  85         this.schemaType = schemaType;
  86
  87         bindingQName = BindingReflections.findQName(appConfigBindingClass);
  88     }
  89
  90     public NormalizedNode parseDataElement(final Element element, final SchemaTreeInference dataSchema)
  91             throws XMLStreamException, IOException, ParserConfigurationException, SAXException, URISyntaxException {
  92         final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
  93         final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
  94         final XmlParserStream xmlParser = XmlParserStream.create(writer, dataSchema);
  95         xmlParser.traverse(new DOMSource(element));
  96
  97         final NormalizedNode result = resultHolder.getResult();
  98         if (result instanceof MapNode) {
  99             final MapNode mapNode = (MapNode) result;
 100             final MapEntryNode mapEntryNode = mapNode.body().iterator().next();
 101             return mapEntryNode;
 102         }
 103
 104         return result;
 105     }
 106
 107     public abstract NormalizedNode newDefaultNode(SchemaTreeInference dataSchema);
 108
 109     /**
 110      * BindingContext implementation for a container binding.
 111      */
 112     private static class ContainerBindingContext extends BindingContext {
 113         @SuppressWarnings("unchecked")
 114         ContainerBindingContext(final Class<? extends DataObject> appConfigBindingClass) {
 115             super(appConfigBindingClass, InstanceIdentifier.create((Class) appConfigBindingClass),
 116                 ContainerSchemaNode.class);
 117         }
 118
 119         @Override
 120         public NormalizedNode newDefaultNode(final SchemaTreeInference dataSchema) {
 121             return ImmutableNodes.containerNode(bindingQName);
 122         }
 123     }
 124
 125     /**
 126      * BindingContext implementation for a list binding.
 127      */
 128     private static class ListBindingContext extends BindingContext {
 129         final String appConfigListKeyValue;
 130
 131         @SuppressWarnings("unchecked")
 132         ListBindingContext(final Class<? extends DataObject> appConfigBindingClass,
 133                 final InstanceIdentifier<? extends DataObject> appConfigPath, final String appConfigListKeyValue) {
 134             super((Class<DataObject>) appConfigBindingClass, (InstanceIdentifier<DataObject>) appConfigPath,
 135                     ListSchemaNode.class);
 136             this.appConfigListKeyValue = appConfigListKeyValue;
 137         }
 138
 139         @SuppressWarnings({ "rawtypes", "unchecked" })
 140         static ListBindingContext newInstance(final Class<? extends DataObject> bindingClass,
 141                 final String listKeyValue) throws InstantiationException, IllegalAccessException,
 142                 IllegalArgumentException, InvocationTargetException, NoSuchMethodException, SecurityException {
 143             // We assume the yang list key type is string.
 144             Identifier keyInstance = (Identifier) bindingClass.getMethod(BindingMapping.IDENTIFIABLE_KEY_NAME)
 145                 .getReturnType().getConstructor(String.class).newInstance(listKeyValue);
 146             InstanceIdentifier appConfigPath = InstanceIdentifier.builder((Class)bindingClass, keyInstance).build();
 147             return new ListBindingContext(bindingClass, appConfigPath, listKeyValue);
 148         }
 149
 150         @Override
 151         public NormalizedNode newDefaultNode(final SchemaTreeInference dataSchema) {
 152             final SchemaTreeEffectiveStatement<?> stmt = Iterables.getLast(dataSchema.statementPath());
 153
 154             // We assume there's only one key for the list.
 155             final Set<QName> keys = stmt.findFirstEffectiveSubstatementArgument(KeyEffectiveStatement.class)
 156                 .orElseThrow();
 157
 158             checkArgument(keys.size() == 1, "Expected only 1 key for list %s", appConfigBindingClass);
 159             QName listKeyQName = keys.iterator().next();
 160             return ImmutableNodes.mapEntryBuilder(bindingQName, listKeyQName, appConfigListKeyValue).build();
 161         }
 162     }
 163 }