import com.google.common.collect.LinkedHashMultimap;
import java.util.ArrayList;
import java.util.Arrays;
+import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
+import java.util.concurrent.TimeUnit;
import org.apache.karaf.features.Feature;
import org.apache.karaf.features.FeaturesService;
import org.opendaylight.controller.config.persist.api.ConfigPusher;
-import org.opendaylight.controller.config.persist.api.ConfigSnapshotHolder;
import org.opendaylight.controller.config.persist.storage.file.xml.XmlFileStorageAdapter;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
*/
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 static final int MAX_RETRIES = 100;
+ private static final int RETRY_PAUSE_MILLIS = 1;
+
private FeaturesService featuresService = null;
private ConfigPusher pusher = null;
+
/*
* 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).
*/
- Set<FeatureConfigSnapshotHolder> pushedConfigs = new LinkedHashSet<>();
+ private final Set<FeatureConfigSnapshotHolder> pushedConfigs = new LinkedHashSet<>();
+
/*
* LinkedHashMultimap to track which configs we pushed for each Feature installation
* For future use
*/
- LinkedHashMultimap<Feature,FeatureConfigSnapshotHolder> feature2configs = LinkedHashMultimap.create();
+ private final LinkedHashMultimap<Feature,FeatureConfigSnapshotHolder> feature2configs = LinkedHashMultimap.create();
/*
* @param p - ConfigPusher to push ConfigSnapshotHolders
* If a Feature is not in the returned LinkedHashMultimap then we couldn't push its configs
* (Ususally because it was not yet installed)
*/
- public LinkedHashMultimap<Feature, FeatureConfigSnapshotHolder> pushConfigs(final List<Feature> features) throws Exception {
+ public LinkedHashMultimap<Feature, FeatureConfigSnapshotHolder> pushConfigs(final List<Feature> features)
+ throws Exception {
LinkedHashMultimap<Feature, FeatureConfigSnapshotHolder> pushedFeatures = LinkedHashMultimap.create();
for (Feature feature : features) {
-
-
Set<FeatureConfigSnapshotHolder> configSnapShots = pushConfig(feature);
if (!configSnapShots.isEmpty()) {
pushedFeatures.putAll(feature, configSnapShots);
}
private Set<FeatureConfigSnapshotHolder> pushConfig(final Feature feature) throws Exception {
- Set<FeatureConfigSnapshotHolder> configs = new LinkedHashSet<>();
// Ignore feature conditions — these encode conditions on other features and shouldn't be processed here
if (feature.getName().contains("-condition-")) {
LOG.debug("Ignoring conditional feature {}", feature);
- } else 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.debug("Feature: {}, {} is missing from features service. Skipping", feature.getName(), feature.getVersion());
- } else {
- ChildAwareFeatureWrapper wrappedFeature = new ChildAwareFeatureWrapper(feature, featuresService);
- configs = wrappedFeature.getFeatureConfigSnapshotHolders();
- if (!configs.isEmpty()) {
- configs = pushConfig(configs, feature);
- feature2configs.putAll(feature, configs);
- }
- }
+ return Collections.emptySet();
+ }
+
+ if (!isInstalled(feature)) {
+ return Collections.emptySet();
+ }
+ // 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.debug("Feature: {}, {} is missing from features service. Skipping", feature.getName(),
+ feature.getVersion());
+ return Collections.emptySet();
+ }
+
+ ChildAwareFeatureWrapper wrappedFeature = new ChildAwareFeatureWrapper(feature, featuresService);
+ Set<FeatureConfigSnapshotHolder> configs = wrappedFeature.getFeatureConfigSnapshotHolders();
+ if (!configs.isEmpty()) {
+ configs = pushConfig(configs, feature);
+ feature2configs.putAll(feature, configs);
}
return configs;
}
- private boolean isInstalled(final Feature feature) {
+ private boolean isInstalled(final Feature feature) throws InterruptedException {
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());
}
+
+ LOG.info("Karaf Feature Service has not yet finished installing feature {}/{} (retry {})",
+ feature.getName(), feature.getVersion(), retries);
} catch (Exception e) {
LOG.warn("Karaf featuresService.listInstalledFeatures() has thrown an exception, retry {}", retries, e);
}
- try {
- Thread.sleep(RETRY_PAUSE_MILLIS);
- } catch (InterruptedException e1) {
- throw new IllegalStateException(e1);
- }
+
+ TimeUnit.MILLISECONDS.sleep(RETRY_PAUSE_MILLIS);
}
- 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 {} {}",
+ MAX_RETRIES, feature.getName(), feature.getVersion());
return false;
}
- private Set<FeatureConfigSnapshotHolder> pushConfig(final Set<FeatureConfigSnapshotHolder> configs, final Feature feature)
- throws InterruptedException {
+ 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()) {
LOG.warn("Ignoring default configuration {} for feature {}, the configuration is present in {}",
configsToPush, feature.getId(), currentCfgPusher.get());
} else {
- pusher.pushConfigs(new ArrayList<ConfigSnapshotHolder>(configsToPush));
+ pusher.pushConfigs(new ArrayList<>(configsToPush));
}
pushedConfigs.addAll(configsToPush);
Code Review / controller.git / blobdiff