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.XMLNamespace;
  15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  16 import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException;
  17 import org.opendaylight.yangtools.yang.data.util.AbstractModuleStringInstanceIdentifierCodec;
  18 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
  19 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  20 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContextListener;
  21 import org.opendaylight.yangtools.yang.model.api.Module;
  22 import org.slf4j.Logger;
  23 import org.slf4j.LoggerFactory;
  24
  25 public class InstanceIdentifierCodec extends AbstractModuleStringInstanceIdentifierCodec
  26         implements EffectiveModelContextListener {
  27     private static final Logger LOG = LoggerFactory.getLogger(InstanceIdentifierCodec.class);
  28
  29     private final BindingNormalizedNodeSerializer bindingNormalizedNodeSerializer;
  30
  31     private DataSchemaContextTree dataSchemaContextTree;
  32     private EffectiveModelContext context = null;
  33
  34     @SuppressFBWarnings(value = "MC_OVERRIDABLE_METHOD_CALL_IN_CONSTRUCTOR", justification = "Non-final for mocking")
  35     public InstanceIdentifierCodec(final DOMSchemaService schemaService,
  36             final BindingNormalizedNodeSerializer bindingNormalizedNodeSerializer) {
  37         schemaService.registerSchemaContextListener(this);
  38         this.bindingNormalizedNodeSerializer = bindingNormalizedNodeSerializer;
  39     }
  40
  41     @Override
  42     protected DataSchemaContextTree getDataContextTree() {
  43         return dataSchemaContextTree;
  44     }
  45
  46     @Override
  47     protected Module moduleForPrefix(final String prefix) {
  48         return context.findModules(prefix).stream().findFirst().orElse(null);
  49     }
  50
  51     @Override
  52     protected String prefixForNamespace(final XMLNamespace namespace) {
  53         return context.findModules(namespace).stream().map(Module::getName).findFirst().orElse(null);
  54     }
  55
  56     @Override
  57     public void onModelContextUpdated(final EffectiveModelContext schemaContext) {
  58         this.context = schemaContext;
  59         this.dataSchemaContextTree = DataSchemaContextTree.from(schemaContext);
  60     }
  61
  62     public String serialize(final InstanceIdentifier<?> iid) {
  63         YangInstanceIdentifier normalizedIid = bindingNormalizedNodeSerializer.toYangInstanceIdentifier(iid);
  64         return serialize(normalizedIid);
  65     }
  66
  67     public YangInstanceIdentifier getYangInstanceIdentifier(final InstanceIdentifier<?> iid) {
  68         return bindingNormalizedNodeSerializer.toYangInstanceIdentifier(iid);
  69     }
  70
  71     public InstanceIdentifier<?> bindingDeserializer(final String iidString) throws DeserializationException {
  72         YangInstanceIdentifier normalizedYangIid = deserialize(iidString);
  73         return bindingNormalizedNodeSerializer.fromYangInstanceIdentifier(normalizedYangIid);
  74     }
  75
  76     public InstanceIdentifier<?> bindingDeserializer(final YangInstanceIdentifier yangIID) {
  77         return bindingNormalizedNodeSerializer.fromYangInstanceIdentifier(yangIID);
  78     }
  79
  80     public InstanceIdentifier<?> bindingDeserializerOrNull(final String iidString) {
  81         try {
  82             return bindingDeserializer(iidString);
  83         } catch (DeserializationException e) {
  84             LOG.warn("Unable to deserialize iidString", e);
  85         }
  86         return null;
  87     }
  88 }