opendaylight/blueprint/src/main/java/org/opendaylight/controller/blueprint/ext/ComponentProcessor.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.Strings;
  11 import java.util.ArrayList;
  12 import java.util.Dictionary;
  13 import java.util.Hashtable;
  14 import java.util.List;
  15 import java.util.Objects;
  16 import java.util.concurrent.atomic.AtomicBoolean;
  17 import org.apache.aries.blueprint.ComponentDefinitionRegistry;
  18 import org.apache.aries.blueprint.ComponentDefinitionRegistryProcessor;
  19 import org.apache.aries.blueprint.ext.AbstractPropertyPlaceholder;
  20 import org.apache.aries.blueprint.mutable.MutableBeanMetadata;
  21 import org.apache.aries.blueprint.mutable.MutableServiceReferenceMetadata;
  22 import org.apache.aries.util.AriesFrameworkUtil;
  23 import org.gaul.modernizer_maven_annotations.SuppressModernizer;
  24 import org.opendaylight.controller.blueprint.BlueprintContainerRestartService;
  25 import org.osgi.framework.Bundle;
  26 import org.osgi.framework.Constants;
  27 import org.osgi.framework.ServiceRegistration;
  28 import org.osgi.service.blueprint.reflect.BeanProperty;
  29 import org.osgi.service.blueprint.reflect.ComponentMetadata;
  30 import org.osgi.service.blueprint.reflect.ValueMetadata;
  31 import org.osgi.service.cm.ManagedService;
  32 import org.slf4j.Logger;
  33 import org.slf4j.LoggerFactory;
  34
  35 /**
  36  * The singleton component processor that is invoked by the blueprint container to perform operations on
  37  * various component definitions prior to component creation.
  38  *
  39  * @author Thomas Pantelis
  40  */
  41 public class ComponentProcessor implements ComponentDefinitionRegistryProcessor {
  42     static final String DEFAULT_TYPE_FILTER = "(|(type=default)(!(type=*)))";
  43
  44     private static final Logger LOG = LoggerFactory.getLogger(ComponentProcessor.class);
  45     private static final String CM_PERSISTENT_ID_PROPERTY = "persistentId";
  46
  47     private final List<ServiceRegistration<?>> managedServiceRegs = new ArrayList<>();
  48     private Bundle bundle;
  49     private BlueprintContainerRestartService blueprintContainerRestartService;
  50     private boolean restartDependentsOnUpdates;
  51     private boolean useDefaultForReferenceTypes;
  52
  53     public void setBundle(final Bundle bundle) {
  54         this.bundle = bundle;
  55     }
  56
  57     public void setBlueprintContainerRestartService(final BlueprintContainerRestartService restartService) {
  58         this.blueprintContainerRestartService = restartService;
  59     }
  60
  61     public void setRestartDependentsOnUpdates(final boolean restartDependentsOnUpdates) {
  62         this.restartDependentsOnUpdates = restartDependentsOnUpdates;
  63     }
  64
  65     public void setUseDefaultForReferenceTypes(final boolean useDefaultForReferenceTypes) {
  66         this.useDefaultForReferenceTypes = useDefaultForReferenceTypes;
  67     }
  68
  69     public void destroy() {
  70         for (ServiceRegistration<?> reg: managedServiceRegs) {
  71             AriesFrameworkUtil.safeUnregisterService(reg);
  72         }
  73     }
  74
  75     @Override
  76     public void process(final ComponentDefinitionRegistry registry) {
  77         LOG.debug("{}: In process",  logName());
  78
  79         for (String name : registry.getComponentDefinitionNames()) {
  80             ComponentMetadata component = registry.getComponentDefinition(name);
  81             if (component instanceof MutableBeanMetadata) {
  82                 processMutableBeanMetadata((MutableBeanMetadata) component);
  83             } else if (component instanceof MutableServiceReferenceMetadata) {
  84                 processServiceReferenceMetadata((MutableServiceReferenceMetadata)component);
  85             }
  86         }
  87     }
  88
  89     private void processServiceReferenceMetadata(final MutableServiceReferenceMetadata serviceRef) {
  90         if (!useDefaultForReferenceTypes) {
  91             return;
  92         }
  93
  94         String filter = serviceRef.getFilter();
  95         String extFilter = serviceRef.getExtendedFilter() == null ? null :
  96             serviceRef.getExtendedFilter().getStringValue();
  97
  98         LOG.debug("{}: processServiceReferenceMetadata for {}, filter: {}, ext filter: {}", logName(),
  99                 serviceRef.getId(), filter, extFilter);
 100
 101         if (Strings.isNullOrEmpty(filter) && Strings.isNullOrEmpty(extFilter)) {
 102             serviceRef.setFilter(DEFAULT_TYPE_FILTER);
 103
 104             LOG.debug("{}: processServiceReferenceMetadata for {} set filter to {}", logName(),
 105                     serviceRef.getId(), serviceRef.getFilter());
 106         }
 107     }
 108
 109     private void processMutableBeanMetadata(final MutableBeanMetadata bean) {
 110         if (restartDependentsOnUpdates && bean.getRuntimeClass() != null
 111                 && AbstractPropertyPlaceholder.class.isAssignableFrom(bean.getRuntimeClass())) {
 112             LOG.debug("{}: Found PropertyPlaceholder bean: {}, runtime {}", logName(), bean.getId(),
 113                     bean.getRuntimeClass());
 114
 115             for (BeanProperty prop : bean.getProperties()) {
 116                 if (CM_PERSISTENT_ID_PROPERTY.equals(prop.getName())) {
 117                     if (prop.getValue() instanceof ValueMetadata) {
 118                         ValueMetadata persistentId = (ValueMetadata)prop.getValue();
 119
 120                         LOG.debug("{}: Found {} property, value : {}", logName(),
 121                                 CM_PERSISTENT_ID_PROPERTY, persistentId.getStringValue());
 122
 123                         registerManagedService(persistentId.getStringValue());
 124                     } else {
 125                         LOG.debug("{}: {} property metadata {} is not instanceof ValueMetadata",
 126                                 logName(), CM_PERSISTENT_ID_PROPERTY, prop.getValue());
 127                     }
 128
 129                     break;
 130                 }
 131             }
 132         }
 133     }
 134
 135     @SuppressModernizer
 136     private void registerManagedService(final String persistentId) {
 137         // Register a ManagedService so we get updates from the ConfigAdmin when the cfg file corresponding
 138         // to the persistentId changes.
 139         final ManagedService managedService = new ManagedService() {
 140             private final AtomicBoolean initialUpdate = new AtomicBoolean(true);
 141             private volatile Dictionary<String, ?> previousProperties;
 142
 143             @Override
 144             public void updated(final Dictionary<String, ?> properties) {
 145                 LOG.debug("{}: ManagedService updated for persistentId {}, properties: {}, initialUpdate: {}",
 146                         logName(), persistentId, properties, initialUpdate);
 147
 148                 // The first update occurs when the service is registered so ignore it as we want subsequent
 149                 // updates when it changes. The ConfigAdmin will send an update even if the cfg file doesn't
 150                 // yet exist.
 151                 if (!initialUpdate.compareAndSet(true, false) && !Objects.equals(previousProperties, properties)) {
 152                     blueprintContainerRestartService.restartContainerAndDependents(bundle);
 153                 }
 154
 155                 previousProperties = properties;
 156             }
 157         };
 158
 159         Dictionary<String, Object> props = new Hashtable<>();
 160         props.put(Constants.SERVICE_PID, persistentId);
 161         props.put(Constants.BUNDLE_SYMBOLICNAME, bundle.getSymbolicName());
 162         props.put(Constants.BUNDLE_VERSION, bundle.getHeaders().get(Constants.BUNDLE_VERSION));
 163         managedServiceRegs.add(bundle.getBundleContext().registerService(ManagedService.class, managedService, props));
 164     }
 165
 166     private String logName() {
 167         return bundle.getSymbolicName();
 168     }
 169 }