Skip to content

[KARAF-7098] Add R7 configuration style support #1369

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jbonofre merged 1 commit into from
May 7, 2021
Merged

[KARAF-7098] Add R7 configuration style support #1369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions config/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@
org.apache.karaf.config.core.impl,
org.apache.karaf.config.core.impl.osgi,
org.apache.karaf.util,
org.apache.karaf.util.config,
org.apache.felix.utils.collections
</Private-Package>
</instructions>
Expand Down
60 changes: 28 additions & 32 deletions config/src/main/java/org/apache/karaf/config/core/impl/JsonConfigInstaller.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import org.apache.felix.fileinstall.ArtifactInstaller;
import org.apache.felix.fileinstall.internal.DirectoryWatcher;
import org.apache.felix.utils.collections.DictionaryAsMap;
import org.apache.karaf.util.config.ConfigurationPID;
import org.osgi.framework.Constants;
import org.osgi.service.cm.Configuration;
import org.osgi.service.cm.ConfigurationAdmin;
Expand All @@ -37,12 +38,13 @@
import java.net.URL;
import java.util.Dictionary;
import java.util.Hashtable;
import java.util.Objects;

public class JsonConfigInstaller implements ArtifactInstaller, ConfigurationListener {

private final static Logger LOGGER = LoggerFactory.getLogger(JsonConfigInstaller.class);

private ConfigurationAdmin configurationAdmin;
private final ConfigurationAdmin configurationAdmin;

public JsonConfigInstaller(ConfigurationAdmin configurationAdmin) {
this.configurationAdmin = configurationAdmin;
Expand All @@ -69,9 +71,9 @@ public void uninstall(File artifact) throws Exception {
}

private void setConfig(File artifact) throws Exception {
String name = artifact.getName();
String pid[] = parsePid(name);
Configuration configuration = getConfiguration(toConfigKey(artifact), pid[0], pid[1]);
final String filename = artifact.getName();
final ConfigurationPID configurationPID = ConfigurationPID.parseFilename(filename);
Configuration configuration = getConfiguration(toConfigKey(artifact), configurationPID);
Dictionary<String, Object> props = configuration.getProperties();
Hashtable<String, Object> old = props != null ? new Hashtable<>(new DictionaryAsMap<>(props)) : null;
Hashtable<String, Object> properties = Configurations.buildReader().build(new FileReader(artifact)).readConfiguration();
Expand All @@ -84,20 +86,22 @@ private void setConfig(File artifact) throws Exception {
if (old == null || !old.equals(properties)) {
properties.put(DirectoryWatcher.FILENAME, toConfigKey(artifact));
if (old == null) {
LOGGER.info("Creating configuration from " + pid[0] + (pid[1] == null ? "" : "-" + pid[1]) + ".json");
LOGGER.info("Creating configuration from {}", artifact.getName());
} else {
LOGGER.info("Updating configuration from " + pid[0] + (pid[1] == null ? "" : "-" + pid[1]) + ".json");
LOGGER.info("Updating configuration from {}", artifact.getName());
}
configuration.update(properties);
}
}

boolean deleteConfig(File f) throws Exception {
String pid[] = parsePid(f.getName());
LOGGER.info("Deleting configuration from " + pid[0] + (pid[1] == null ? "" : "-" + pid[1]) + ".json");
Configuration config = getConfiguration(toConfigKey(f), pid[0], pid[1]);
config.delete();
return true;
void deleteConfig(File artifact) throws Exception {
Configuration config = findExistingConfiguration(toConfigKey(artifact));
if (Objects.nonNull(config)) {
config.delete();
LOGGER.info("Configuration for {} found and deleted", artifact.getName());
} else {
LOGGER.info("Configuration for {} not found, unable to delete", artifact.getName());
}
}

@Override
Expand Down Expand Up @@ -140,41 +144,33 @@ private File getCfgFileFromProperty(Object val) throws URISyntaxException, Malfo
return null;
}

String[] parsePid(String path) {
String pid = path.substring(0, path.lastIndexOf('.'));
int n = pid.indexOf('-');
if (n > 0) {
String factoryPid = pid.substring(n + 1);
pid = pid.substring(0, n);
return new String[]{pid, factoryPid};
} else {
return new String[]{pid, null};
}
}

String toConfigKey(File f) {
return f.getAbsoluteFile().toURI().toString();
}

Configuration getConfiguration(String fileName, String pid, String factoryPid) throws Exception {
Configuration oldConfiguration = findExistingConfiguration(fileName);
Configuration getConfiguration(String configKey, ConfigurationPID configurationPID) throws Exception {
Configuration oldConfiguration = findExistingConfiguration(configKey);
Configuration cachedConfiguration = oldConfiguration != null ?
configurationAdmin.getConfiguration(oldConfiguration.getPid(), null) : null;
if (cachedConfiguration != null) {
return cachedConfiguration;
} else {
Configuration newConfiguration;
if (factoryPid != null) {
newConfiguration = configurationAdmin.createFactoryConfiguration(pid, "?");
final Configuration newConfiguration;
if (configurationPID.isFactory()) {
if (configurationPID.isR7()) {
newConfiguration = configurationAdmin.getFactoryConfiguration(configurationPID.getFactoryPid(), configurationPID.getName(), "?");
} else {
newConfiguration = configurationAdmin.createFactoryConfiguration(configurationPID.getFactoryPid(), "?");
}
} else {
newConfiguration = configurationAdmin.getConfiguration(pid, "?");
newConfiguration = configurationAdmin.getConfiguration(configurationPID.getPid(), "?");
}
return newConfiguration;
}
}

Configuration findExistingConfiguration(String fileName) throws Exception {
String filter = "(" + DirectoryWatcher.FILENAME + "=" + escapeFilterValue(fileName) + ")";
Configuration findExistingConfiguration(String configKey) throws Exception {
String filter = "(" + DirectoryWatcher.FILENAME + "=" + escapeFilterValue(configKey) + ")";
Configuration[] configurations = configurationAdmin.listConfigurations(filter);
if (configurations != null && configurations.length > 0) {
return configurations[0];
Expand Down