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