1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
// Copyright 2020 Oath Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.container.core.config;
import com.yahoo.config.FileReference;
import com.yahoo.container.Container;
import com.yahoo.filedistribution.fileacquirer.FileAcquirer;
import com.yahoo.osgi.Osgi;
import org.osgi.framework.Bundle;
import org.osgi.framework.wiring.BundleRevision;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.logging.Logger;
import java.util.stream.Collectors;
/**
* Manages the set of installed and active/inactive bundles.
*
* @author gjoranv
* @author Tony Vaagenes
*/
public class BundleManager {
/* Map of file refs of active bundles (not scheduled for uninstall) to the installed bundle.
*
* Used to:
* 1. Avoid installing already installed bundles. Just an optimization, installing the same bundle location is a NOP
* 2. Start bundles (all are started every time)
* 3. Calculate the set of bundles to uninstall
*/
private final Map<FileReference, Bundle> reference2Bundle = new LinkedHashMap<>();
private final Logger log = Logger.getLogger(BundleManager.class.getName());
private final Osgi osgi;
// A custom bundle installer for non-disk bundles, to be used for testing
private BundleInstaller customBundleInstaller = null;
public BundleManager(Osgi osgi) {
this.osgi = osgi;
}
/**
* Installs the given set of bundles and returns the set of bundles that is no longer used
* by the application, and should therefore be scheduled for uninstall.
*/
public synchronized Set<Bundle> use(List<FileReference> newFileReferences) {
Set<FileReference> obsoleteReferences = getObsoleteFileReferences(newFileReferences);
Set<Bundle> bundlesToUninstall = getObsoleteBundles(obsoleteReferences);
log.info("Bundles to schedule for uninstall: " + bundlesToUninstall);
osgi.allowDuplicateBundles(bundlesToUninstall);
removeInactiveFileReferences(obsoleteReferences);
installBundles(newFileReferences);
startBundles();
log.info(installedBundlesMessage());
return bundlesToUninstall;
}
private Set<FileReference> getObsoleteFileReferences(List<FileReference> newReferences) {
Set<FileReference> obsoleteReferences = new HashSet<>(reference2Bundle.keySet());
obsoleteReferences.removeAll(newReferences);
return obsoleteReferences;
}
/**
* Returns the bundles that will not be retained by the new application generation.
*/
private Set<Bundle> getObsoleteBundles(Set<FileReference> obsoleteReferences) {
return obsoleteReferences.stream().map(reference2Bundle::get).collect(Collectors.toSet());
}
private void removeInactiveFileReferences(Set<FileReference> fileReferencesToRemove) {
fileReferencesToRemove.forEach(reference2Bundle::remove);
}
private void installBundles(List<FileReference> references) {
Set<FileReference> bundlesToInstall = new HashSet<>(references);
// This is just an optimization, as installing a bundle with the same location id returns the already installed bundle.
bundlesToInstall.removeAll(reference2Bundle.keySet());
if (!bundlesToInstall.isEmpty()) {
FileAcquirer fileAcquirer = Container.get().getFileAcquirer();
boolean hasFileDistribution = (fileAcquirer != null);
if (hasFileDistribution) {
installWithFileDistribution(bundlesToInstall, new FileAcquirerBundleInstaller(fileAcquirer));
} else if (customBundleInstaller != null) {
installWithFileDistribution(bundlesToInstall, customBundleInstaller);
} else {
log.warning("Can't retrieve bundles since file distribution is disabled.");
}
}
}
private void installWithFileDistribution(Set<FileReference> bundlesToInstall, BundleInstaller bundleInstaller) {
for (FileReference reference : bundlesToInstall) {
try {
log.info("Installing bundle with reference '" + reference.value() + "'");
List<Bundle> bundles = bundleInstaller.installBundles(reference, osgi);
if (bundles.size() > 1) {
throw new RuntimeException("Bundle '" + bundles.get(0).getSymbolicName() + "' tried to pre-install other bundles.");
}
reference2Bundle.put(reference, bundles.get(0));
}
catch(Exception e) {
throw new RuntimeException("Could not install bundle with reference '" + reference + "'", e);
}
}
}
/**
* Resolves and starts (calls the Bundles BundleActivator) all bundles. Bundle resolution must take place
* after all bundles are installed to ensure that the framework can resolve dependencies between bundles.
*/
private void startBundles() {
for (var bundle : reference2Bundle.values()) {
try {
if ( ! isFragment(bundle))
bundle.start(); // NOP for already ACTIVE bundles
} catch(Exception e) {
throw new RuntimeException("Could not start bundle '" + bundle.getSymbolicName() + "'", e);
}
}
}
private boolean isFragment(Bundle bundle) {
BundleRevision bundleRevision = bundle.adapt(BundleRevision.class);
if (bundleRevision == null)
throw new NullPointerException("Null bundle revision means that bundle has probably been uninstalled: " +
bundle.getSymbolicName() + ":" + bundle.getVersion());
return (bundleRevision.getTypes() & BundleRevision.TYPE_FRAGMENT) != 0;
}
private String installedBundlesMessage() {
StringBuilder sb = new StringBuilder("Installed bundles: {" );
for (Bundle b : osgi.getBundles())
sb.append("[" + b.getBundleId() + "]" + b.getSymbolicName() + ":" + b.getVersion() + ", ");
sb.setLength(sb.length() - 2);
sb.append("}");
return sb.toString();
}
// Only for testing
void useCustomBundleInstaller(BundleInstaller bundleInstaller) {
customBundleInstaller = bundleInstaller;
}
// Only for testing
List<FileReference> getActiveFileReferences() {
return new ArrayList<>(reference2Bundle.keySet());
}
}
|
