southbound/southbound-impl/src/main/java/org/opendaylight/ovsdb/southbound/InstanceIdentifierCodec.java

   1 /*
   2  * Copyright (c) 2015 Cisco 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.ovsdb.southbound;
   9
  10 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  11 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
  12 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  13 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  14 import org.opendaylight.yangtools.yang.common.QNameModule;
  15 import org.opendaylight.yangtools.yang.common.XMLNamespace;
  16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  17 import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException;
  18 import org.opendaylight.yangtools.yang.data.util.AbstractStringInstanceIdentifierCodec;
  19 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
  20 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  21 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  22 import org.opendaylight.yangtools.yang.model.api.Module;
  23 import org.opendaylight.yangtools.yang.model.util.LeafrefResolver;
  24 import org.slf4j.Logger;
  25 import org.slf4j.LoggerFactory;
  26
  27 public class InstanceIdentifierCodec extends AbstractStringInstanceIdentifierCodec {
  28     private static final Logger LOG = LoggerFactory.getLogger(InstanceIdentifierCodec.class);
  29
  30     private final BindingNormalizedNodeSerializer bindingNormalizedNodeSerializer;
  31
  32     private DataSchemaContextTree dataSchemaContextTree;
  33     private EffectiveModelContext context = null;
  34
  35     @SuppressFBWarnings(value = "MC_OVERRIDABLE_METHOD_CALL_IN_CONSTRUCTOR", justification = "Non-final for mocking")
  36     public InstanceIdentifierCodec(final DOMSchemaService schemaService,
  37             final BindingNormalizedNodeSerializer bindingNormalizedNodeSerializer) {
  38         schemaService.registerSchemaContextListener(this::onModelContextUpdated);
  39         this.bindingNormalizedNodeSerializer = bindingNormalizedNodeSerializer;
  40     }
  41
  42     @Override
  43     protected DataSchemaContextTree getDataContextTree() {
  44         return dataSchemaContextTree;
  45     }
  46
  47     @Override
  48     protected QNameModule moduleForPrefix(final String prefix) {
  49         return context.findModules(prefix).stream().findFirst().map(Module::getQNameModule).orElse(null);
  50     }
  51
  52     @Override
  53     protected String prefixForNamespace(final XMLNamespace namespace) {
  54         return context.findModules(namespace).stream().map(Module::getName).findFirst().orElse(null);
  55     }
  56
  57     @Override
  58     protected Object deserializeKeyValue(final DataSchemaNode schemaNode, final LeafrefResolver resolver,
  59             final String value) {
  60         throw new UnsupportedOperationException("Not implemented");
  61     }
  62
  63     private void onModelContextUpdated(final EffectiveModelContext schemaContext) {
  64         this.context = schemaContext;
  65         this.dataSchemaContextTree = DataSchemaContextTree.from(schemaContext);
  66     }
  67
  68     public String serialize(final InstanceIdentifier<?> iid) {
  69         YangInstanceIdentifier normalizedIid = bindingNormalizedNodeSerializer.toYangInstanceIdentifier(iid);
  70         return serialize(normalizedIid);
  71     }
  72
  73     public YangInstanceIdentifier getYangInstanceIdentifier(final InstanceIdentifier<?> iid) {
  74         return bindingNormalizedNodeSerializer.toYangInstanceIdentifier(iid);
  75     }
  76
  77     public InstanceIdentifier<?> bindingDeserializer(final String iidString) throws DeserializationException {
  78         YangInstanceIdentifier normalizedYangIid = deserialize(iidString);
  79         return bindingNormalizedNodeSerializer.fromYangInstanceIdentifier(normalizedYangIid);
  80     }
  81
  82     public InstanceIdentifier<?> bindingDeserializer(final YangInstanceIdentifier yangIID) {
  83         return bindingNormalizedNodeSerializer.fromYangInstanceIdentifier(yangIID);
  84     }
  85
  86     public InstanceIdentifier<?> bindingDeserializerOrNull(final String iidString) {
  87         try {
  88             return bindingDeserializer(iidString);
  89         } catch (DeserializationException e) {
  90             LOG.warn("Unable to deserialize iidString", e);
  91         }
  92         return null;
  93     }
  94 }