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