import com.google.common.collect.LinkedHashMultimap;
import java.util.ArrayList;
import java.util.Arrays;
+import java.util.ConcurrentModificationException;
import java.util.LinkedHashSet;
import java.util.List;
+import java.util.Set;
import org.apache.karaf.features.Feature;
import org.apache.karaf.features.FeaturesService;
import org.opendaylight.controller.config.persist.api.ConfigPusher;
* Simple class to push configs to the config subsystem from Feature's configfiles
*/
public class FeatureConfigPusher {
+
private static final Logger LOG = LoggerFactory.getLogger(FeatureConfigPusher.class);
- private static final int MAX_RETRIES=100;
- private static final int RETRY_PAUSE_MILLIS=1;
- private FeaturesService featuresService = null;
- private ConfigPusher pusher = null;
+
+ private static final int MAX_RETRIES = 10;
+ private static final int RETRY_PAUSE_MILLIS = 100;
+
+ private final FeaturesService featuresService;
+ private final ConfigPusher pusher;
+
/*
* A LinkedHashSet (to preserve order and insure uniqueness) of the pushedConfigs
* This is used to prevent pushing duplicate configs if a Feature is in multiple dependency
* chains. Also, preserves the *original* Feature chain for which we pushed the config.
* (which is handy for logging).
*/
- LinkedHashSet<FeatureConfigSnapshotHolder> pushedConfigs = new LinkedHashSet<FeatureConfigSnapshotHolder>();
+ Set<FeatureConfigSnapshotHolder> pushedConfigs = new LinkedHashSet<>();
+
/*
* LinkedHashMultimap to track which configs we pushed for each Feature installation
* For future use
/*
* @param p - ConfigPusher to push ConfigSnapshotHolders
*/
- public FeatureConfigPusher(final ConfigPusher p, final FeaturesService f) {
- pusher = p;
- featuresService = f;
+ public FeatureConfigPusher(final ConfigPusher pusher, final FeaturesService featuresService) {
+ this.pusher = pusher;
+ this.featuresService = featuresService;
}
/*
* Push config files from Features to config subsystem
for (Feature feature : features) {
- LinkedHashSet<FeatureConfigSnapshotHolder> configSnapShots = pushConfig(feature);
+ Set<FeatureConfigSnapshotHolder> configSnapShots = pushConfig(feature);
if (!configSnapShots.isEmpty()) {
pushedFeatures.putAll(feature, configSnapShots);
}
return pushedFeatures;
}
- private LinkedHashSet<FeatureConfigSnapshotHolder> pushConfig(final Feature feature) throws Exception {
- LinkedHashSet<FeatureConfigSnapshotHolder> configs = new LinkedHashSet<>();
+ private Set<FeatureConfigSnapshotHolder> pushConfig(final Feature feature) throws Exception {
+ Set<FeatureConfigSnapshotHolder> configs = new LinkedHashSet<>();
if(isInstalled(feature)) {
// FIXME Workaround for BUG-2836, features service returns null for feature: standard-condition-webconsole_0_0_0, 3.0.1
if(featuresService.getFeature(feature.getName(), feature.getVersion()) == null) {
- LOG.warn("Feature: {}, {} is missing from features service. Skipping", feature.getName(), feature.getVersion());
+ LOG.debug("Feature: {}, {} is missing from features service. Skipping", feature.getName(), feature.getVersion());
} else {
ChildAwareFeatureWrapper wrappedFeature = new ChildAwareFeatureWrapper(feature, featuresService);
configs = wrappedFeature.getFeatureConfigSnapshotHolders();
}
private boolean isInstalled(final Feature feature) {
- for(int retries=0;retries<MAX_RETRIES;retries++) {
+ Exception lastException = null;
+ for (int retries = 0; retries < MAX_RETRIES; retries++) {
try {
List<Feature> installedFeatures = Arrays.asList(featuresService.listInstalledFeatures());
- if(installedFeatures.contains(feature)) {
+ if (installedFeatures.contains(feature)) {
return true;
} else {
- LOG.warn("Karaf featuresService.listInstalledFeatures() has not yet finished installing feature (retry {}) {} {}",retries,feature.getName(),feature.getVersion());
- }
- } catch (Exception e) {
- if(retries < MAX_RETRIES) {
- LOG.warn("Karaf featuresService.listInstalledFeatures() has thrown an exception, retry {}", retries, e);
- } else {
- LOG.error("Giving up on Karaf featuresService.listInstalledFeatures() which has thrown an exception, retry {}", retries, e);
- throw e;
+ LOG.warn("Karaf featuresService.listInstalledFeatures() has not yet finished installing feature (retry {}) {} {}", retries, feature.getName(), feature.getVersion());
}
+ // TODO This catch of ConcurrentModificationException may be able to simply be removed after
+ // we're fully on Karaf 4 only, as a comment in BUG-6787 indicates that (in Karaf 4) :
+ // "the 'installed' Map of FeaturesServiceImpl .. appears to be correctly synchronized/thread-safe".
+ // (Or, if it's still NOK, then it could be fixed properly upstream in Karaf once we're on recent.)
+ } catch (final ConcurrentModificationException e) {
+ // BUG-6787 experience shows that a LOG.warn (or info) here is very confusing to end-users;
+ // as we have a retry loop anyway, there is no point informing (and confusing) users of this
+ // intermediate state of, so ... NOOP, do not log here.
+ lastException = e;
}
try {
Thread.sleep(RETRY_PAUSE_MILLIS);
- } catch (InterruptedException e1) {
+ } catch (final InterruptedException e1) {
throw new IllegalStateException(e1);
}
}
- LOG.error("Giving up (after {} retries) on Karaf featuresService.listInstalledFeatures() which has not yet finished installing feature {} {}",MAX_RETRIES,feature.getName(),feature.getVersion());
+ LOG.error("Giving up (after {} retries) on Karaf featuresService.listInstalledFeatures() "
+ + "which has not yet finished installing feature {} {} (stack trace is last exception caught)",
+ MAX_RETRIES, feature.getName(), feature.getVersion(), lastException);
return false;
}
- private LinkedHashSet<FeatureConfigSnapshotHolder> pushConfig(final LinkedHashSet<FeatureConfigSnapshotHolder> configs, final Feature feature) throws InterruptedException {
- LinkedHashSet<FeatureConfigSnapshotHolder> configsToPush = new LinkedHashSet<FeatureConfigSnapshotHolder>(configs);
+ private Set<FeatureConfigSnapshotHolder> pushConfig(final Set<FeatureConfigSnapshotHolder> configs, final Feature feature)
+ throws InterruptedException {
+ Set<FeatureConfigSnapshotHolder> configsToPush = new LinkedHashSet<>(configs);
configsToPush.removeAll(pushedConfigs);
if (!configsToPush.isEmpty()) {
pushedConfigs.addAll(configsToPush);
}
- LinkedHashSet<FeatureConfigSnapshotHolder> configsPushed = new LinkedHashSet<FeatureConfigSnapshotHolder>(pushedConfigs);
+ Set<FeatureConfigSnapshotHolder> configsPushed = new LinkedHashSet<>(pushedConfigs);
configsPushed.retainAll(configs);
return configsPushed;
}
Code Review / controller.git / blobdiff