binding/mdsal-binding-runtime-osgi/src/main/java/org/opendaylight/mdsal/binding/runtime/osgi/impl/OSGiBindingRuntimeContextImpl.java

   1 /*
   2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. 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.mdsal.binding.runtime.osgi.impl;
   9
  10 import static com.google.common.base.Verify.verifyNotNull;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.annotations.Beta;
  14 import com.google.common.annotations.VisibleForTesting;
  15 import com.google.common.primitives.UnsignedLong;
  16 import java.util.Dictionary;
  17 import java.util.Hashtable;
  18 import java.util.Map;
  19 import org.eclipse.jdt.annotation.NonNull;
  20 import org.gaul.modernizer_maven_annotations.SuppressModernizer;
  21 import org.opendaylight.binding.runtime.api.BindingRuntimeContext;
  22 import org.opendaylight.mdsal.binding.runtime.osgi.OSGiBindingRuntimeContext;
  23 import org.osgi.framework.Constants;
  24 import org.osgi.service.component.annotations.Activate;
  25 import org.osgi.service.component.annotations.Component;
  26 import org.osgi.service.component.annotations.Deactivate;
  27 import org.slf4j.Logger;
  28 import org.slf4j.LoggerFactory;
  29
  30 /**
  31  * A Factory Component which implements {@link OSGiBindingRuntimeContext}.
  32  */
  33 @Beta
  34 @Component(factory = OSGiBindingRuntimeContextImpl.FACTORY_NAME, service = OSGiBindingRuntimeContext.class)
  35 public final class OSGiBindingRuntimeContextImpl implements OSGiBindingRuntimeContext {
  36     // OSGi DS Component Factory name
  37     static final String FACTORY_NAME = "org.opendaylight.mdsal.binding.runtime.osgi.impl.OSGiBindingRuntimeContextImpl";
  38
  39     // Keys to for activation properties
  40     @VisibleForTesting
  41     static final String GENERATION = "org.opendaylight.mdsal.binding.runtime.osgi.impl.Generation";
  42     @VisibleForTesting
  43     static final String DELEGATE = "org.opendaylight.mdsal.binding.runtime.osgi.impl.BindingRuntimeContext";
  44
  45     private static final Logger LOG = LoggerFactory.getLogger(OSGiBindingRuntimeContextImpl.class);
  46
  47     private BindingRuntimeContext delegate;
  48     private UnsignedLong generation;
  49
  50     @Override
  51     public UnsignedLong getGeneration() {
  52         return verifyNotNull(generation);
  53     }
  54
  55     @Override
  56     public BindingRuntimeContext getService() {
  57         return verifyNotNull(delegate);
  58     }
  59
  60     @Activate
  61     void activate(final Map<String, ?> properties) {
  62         generation = (UnsignedLong) verifyNotNull(properties.get(GENERATION));
  63         delegate = (BindingRuntimeContext) verifyNotNull(properties.get(DELEGATE));
  64         LOG.info("BindingRuntimeContext generation {} activated", generation);
  65     }
  66
  67     @Deactivate
  68     void deactivate() {
  69         delegate = null;
  70         LOG.info("BindingRuntimeContext generation {} deactivated", generation);
  71     }
  72
  73     @SuppressModernizer
  74     static Dictionary<String, ?> props(final @NonNull UnsignedLong generation, final @NonNull Integer ranking,
  75             final BindingRuntimeContext delegate) {
  76         final Dictionary<String, Object> ret = new Hashtable<>(4);
  77         ret.put(Constants.SERVICE_RANKING, ranking);
  78         ret.put(GENERATION, generation);
  79         ret.put(DELEGATE, requireNonNull(delegate));
  80         return ret;
  81     }
  82 }