[refactor] Use constants for eXist-db System Properties

adamretter · adamretter · commit ea7f7639e90c · 2022-06-21T15:54:25.000+02:00
diff --git a/exist-core/src/main/java/org/exist/ExistSystemProperties.java b/exist-core/src/main/java/org/exist/ExistSystemProperties.java
@@ -37,6 +37,12 @@
 @ThreadSafe
 public class ExistSystemProperties {
 
+    public static final String PROP_PRODUCT_NAME = "product-name";
+    public static final String PROP_PRODUCT_VERSION = "product-version";
+    public static final String PROP_PRODUCT_BUILD = "product-build";
+    public static final String PROP_GIT_BRANCH = "git-branch";
+    public static final String PROP_GIT_COMMIT = "git-commit";
+
     private static final Logger LOG = LogManager.getLogger(ExistSystemProperties.class);
     private static final ExistSystemProperties instance = new ExistSystemProperties();
 
diff --git a/exist-core/src/main/java/org/exist/Version.java b/exist-core/src/main/java/org/exist/Version.java
@@ -37,11 +37,11 @@ public final class Version {
 	static {
 
 		final ExistSystemProperties existSystemProperties = ExistSystemProperties.getInstance();
-		NAME = existSystemProperties.getExistSystemProperty("product-name", "eXist");
-		VERSION = existSystemProperties.getExistSystemProperty("product-version");
-		BUILD = existSystemProperties.getExistSystemProperty("product-build");
-		GIT_BRANCH = existSystemProperties.getExistSystemProperty("git-branch");
-		GIT_COMMIT = existSystemProperties.getExistSystemProperty("git-commit");
+		NAME = existSystemProperties.getExistSystemProperty(ExistSystemProperties.PROP_PRODUCT_NAME, "eXist");
+		VERSION = existSystemProperties.getExistSystemProperty(ExistSystemProperties.PROP_PRODUCT_VERSION);
+		BUILD = existSystemProperties.getExistSystemProperty(ExistSystemProperties.PROP_PRODUCT_BUILD);
+		GIT_BRANCH = existSystemProperties.getExistSystemProperty(ExistSystemProperties.PROP_GIT_BRANCH);
+		GIT_COMMIT = existSystemProperties.getExistSystemProperty(ExistSystemProperties.PROP_GIT_COMMIT);
 	}
 	
 	public static String getProductName() {
diff --git a/exist-core/src/main/java/org/exist/client/ClientFrame.java b/exist-core/src/main/java/org/exist/client/ClientFrame.java
@@ -1724,7 +1724,7 @@ protected static Properties getLoginData(final Properties props) {
 
         final ConnectionDialog connectionDialog = new ConnectionDialog(null, true, defaultConnectionSettings, Boolean.parseBoolean(props.getProperty(InteractiveClient.LOCAL_MODE, InteractiveClient.LOCAL_MODE_DEFAULT)), Boolean.parseBoolean(props.getProperty(InteractiveClient.NO_EMBED_MODE, InteractiveClient.NO_EMBED_MODE_DEFAULT)));
 
-        connectionDialog.setTitle(ExistSystemProperties.getInstance().getExistSystemProperty("product-name", "eXist-db") + " " + ExistSystemProperties.getInstance().getExistSystemProperty("product-version", "unknown") + " Database Login");
+        connectionDialog.setTitle(ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_PRODUCT_NAME, "eXist-db") + " " + ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_PRODUCT_VERSION, "unknown") + " Database Login");
 
         connectionDialog.addDialogCompleteWithResponseCallback(connection -> {
             properties.setProperty(InteractiveClient.USER, connection.getUsername());
diff --git a/exist-core/src/main/java/org/exist/client/InteractiveClient.java b/exist-core/src/main/java/org/exist/client/InteractiveClient.java
@@ -2516,12 +2516,12 @@ public void printNotice() {
 
     public String getNotice() {
         final StringBuilder builder = new StringBuilder();
-        builder.append(ExistSystemProperties.getInstance().getExistSystemProperty("product-name", "eXist-db"));
+        builder.append(ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_PRODUCT_NAME, "eXist-db"));
         builder.append(" version ");
-        builder.append(ExistSystemProperties.getInstance().getExistSystemProperty("product-version", "unknown"));
-        if (!"".equals(ExistSystemProperties.getInstance().getExistSystemProperty("git-commit", ""))) {
+        builder.append(ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_PRODUCT_VERSION, "unknown"));
+        if (!"".equals(ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_GIT_COMMIT, ""))) {
             builder.append(" (");
-            builder.append(ExistSystemProperties.getInstance().getExistSystemProperty("git-commit", "(unknown Git commit ID)"));
+            builder.append(ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_GIT_COMMIT, "(unknown Git commit ID)"));
             builder.append(")");
         }
         builder.append(", Copyright (C) 2001-");
diff --git a/exist-core/src/main/java/org/exist/jetty/JettyStart.java b/exist-core/src/main/java/org/exist/jetty/JettyStart.java
@@ -190,9 +190,9 @@ public synchronized void run(final String[] args, final Observer observer) {
 
             logger.info("Running as user '{}'", System.getProperty("user.name", "(unknown user.name)"));
             logger.info("[eXist Home : {}]", System.getProperty("exist.home", "unknown"));
-            logger.info("[eXist Version : {}]", ExistSystemProperties.getInstance().getExistSystemProperty("product-version", "unknown"));
-            logger.info("[eXist Build : {}]", ExistSystemProperties.getInstance().getExistSystemProperty("product-build", "unknown"));
-            logger.info("[Git commit : {}]", ExistSystemProperties.getInstance().getExistSystemProperty("git-commit", "unknown"));
+            logger.info("[eXist Version : {}]", ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_PRODUCT_VERSION, "unknown"));
+            logger.info("[eXist Build : {}]", ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_PRODUCT_BUILD, "unknown"));
+            logger.info("[Git commit : {}]", ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_GIT_COMMIT, "unknown"));
 
             logger.info("[Operating System : {} {} {}]", System.getProperty("os.name"), System.getProperty("os.version"), System.getProperty("os.arch"));
             logger.info("[log4j.configurationFile : {}]", System.getProperty("log4j.configurationFile"));
diff --git a/exist-core/src/main/java/org/exist/launcher/SplashScreen.java b/exist-core/src/main/java/org/exist/launcher/SplashScreen.java
@@ -69,8 +69,8 @@ public SplashScreen(Launcher launcher) {
         final ExistSystemProperties sysProps = ExistSystemProperties.getInstance();
         final StringBuilder builder = new StringBuilder();
 	    builder.append("Version ");
-        builder.append(sysProps.getExistSystemProperty("product-version", "unknown"));
-        final String gitCommit = sysProps.getExistSystemProperty("git-commit");
+        builder.append(sysProps.getExistSystemProperty(ExistSystemProperties.PROP_PRODUCT_VERSION, "unknown"));
+        final String gitCommit = sysProps.getExistSystemProperty(ExistSystemProperties.PROP_GIT_COMMIT);
         if (gitCommit != null && !gitCommit.isEmpty()) {
             builder.append(" (");
             builder.append(gitCommit, 0, Math.min(7, gitCommit.length()));
diff --git a/exist-core/src/main/java/org/exist/management/impl/SystemInfo.java b/exist-core/src/main/java/org/exist/management/impl/SystemInfo.java
@@ -38,22 +38,22 @@ public class SystemInfo implements SystemInfoMXBean {
 
     @Override
     public String getProductName() {
-        return ExistSystemProperties.getInstance().getExistSystemProperty("product-name","eXist");
+        return ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_PRODUCT_NAME,"eXist");
     }
 
     @Override
     public String getProductVersion() {
-        return ExistSystemProperties.getInstance().getExistSystemProperty("product-version","unknown");
+        return ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_PRODUCT_VERSION,"unknown");
     }
 
     @Override
     public String getProductBuild() {
-        return ExistSystemProperties.getInstance().getExistSystemProperty("product-build","unknown");
+        return ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_PRODUCT_BUILD,"unknown");
     }
 
     @Override
     public String getGitCommit() {
-        return ExistSystemProperties.getInstance().getExistSystemProperty("git-commit", "unknown Git commit ID");
+        return ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_GIT_COMMIT, "unknown Git commit ID");
     }
 
     @Override
diff --git a/exist-core/src/main/java/org/exist/repo/ClasspathHelper.java b/exist-core/src/main/java/org/exist/repo/ClasspathHelper.java
@@ -108,7 +108,7 @@ private static void scanPackages(BrokerPool pool, Classpath classpath) {
     private static boolean isCompatible(final Package pkg) throws PackageException {
         // determine the eXist-db version this package is compatible with
         final Collection<ProcessorDependency> processorDeps = pkg.getProcessorDeps();
-        final String procVersion = ExistSystemProperties.getInstance().getExistSystemProperty("product-version", "1.0");
+        final String procVersion = ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_PRODUCT_VERSION, "1.0");
         PackageLoader.Version requiresExistVersion = null;
         for (final ProcessorDependency dependency: processorDeps) {
             if (Deployment.PROCESSOR_NAME.equals(dependency.getProcessor())) {
diff --git a/exist-core/src/main/java/org/exist/repo/Deployment.java b/exist-core/src/main/java/org/exist/repo/Deployment.java
@@ -286,7 +286,7 @@ public Optional<String> installAndDeploy(final DBBroker broker, final Txn transa
     }
 
     private void checkProcessorVersion(final PackageLoader.Version version) throws PackageException {
-        final String procVersion = ExistSystemProperties.getInstance().getExistSystemProperty("product-version", "1.0");
+        final String procVersion = ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_PRODUCT_VERSION, "1.0");
 
         final DependencyVersion depVersion = version.getDependencyVersion();
         if (!depVersion.isCompatible(procVersion)) {
diff --git a/exist-core/src/main/java/org/exist/webstart/JnlpWriter.java b/exist-core/src/main/java/org/exist/webstart/JnlpWriter.java
@@ -101,7 +101,7 @@ void writeJnlpXML(JnlpJarFiles jnlpFiles, HttpServletRequest request,
             writer.writeAttribute("codebase", codeBase);
             writer.writeAttribute("href", "exist.jnlp");
 
-            String version = ExistSystemProperties.getInstance().getExistSystemProperty("product-version", null);
+            String version = ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_PRODUCT_VERSION, null);
             if(version!=null){
                 writer.writeAttribute("version", version);
             }
diff --git a/exist-core/src/main/java/org/exist/xquery/functions/system/GetBuild.java b/exist-core/src/main/java/org/exist/xquery/functions/system/GetBuild.java
@@ -56,6 +56,6 @@ public GetBuild(XQueryContext context) {
      */
     @Override
     public Sequence eval(Sequence[] args, Sequence contextSequence) throws XPathException {
-        return new StringValue(ExistSystemProperties.getInstance().getExistSystemProperty("product-build", "unknown build"));
+        return new StringValue(ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_PRODUCT_BUILD, "unknown build"));
     }
 }
diff --git a/exist-core/src/main/java/org/exist/xquery/functions/system/GetProductName.java b/exist-core/src/main/java/org/exist/xquery/functions/system/GetProductName.java
@@ -49,6 +49,6 @@ public GetProductName(final XQueryContext context) {
 
     @Override
     public Sequence eval(final Sequence[] args, final Sequence contextSequence) throws XPathException {
-        return new StringValue(ExistSystemProperties.getInstance().getExistSystemProperty("product-name", "eXist"));
+        return new StringValue(ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_PRODUCT_NAME, "eXist"));
     }
 }
diff --git a/exist-core/src/main/java/org/exist/xquery/functions/system/GetRevision.java b/exist-core/src/main/java/org/exist/xquery/functions/system/GetRevision.java
@@ -57,6 +57,6 @@ public GetRevision(XQueryContext context) {
      */
     @Override
     public Sequence eval(Sequence[] args, Sequence contextSequence) throws XPathException {
-        return new StringValue(ExistSystemProperties.getInstance().getExistSystemProperty("git-commit", "unknown Git commit ID"));
+        return new StringValue(ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_GIT_COMMIT, "unknown Git commit ID"));
     }
 }
diff --git a/exist-core/src/main/java/org/exist/xquery/functions/system/GetVersion.java b/exist-core/src/main/java/org/exist/xquery/functions/system/GetVersion.java
@@ -56,6 +56,6 @@ public GetVersion(XQueryContext context) {
      */
     @Override
     public Sequence eval(Sequence[] args, Sequence contextSequence) throws XPathException {
-        return new StringValue(ExistSystemProperties.getInstance().getExistSystemProperty("product-version", "unknown version"));
+        return new StringValue(ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_PRODUCT_VERSION, "unknown version"));
     }
 }
diff --git a/extensions/modules/expathrepo/src/main/java/org/exist/xquery/modules/expathrepo/Deploy.java b/extensions/modules/expathrepo/src/main/java/org/exist/xquery/modules/expathrepo/Deploy.java
@@ -280,7 +280,7 @@ public RepoPackageLoader(final String repoURL) {
         @Override
         public XarSource load(final String name, final Version version) throws IOException {
             String pkgURL = repoURL + "?name=" + URLEncoder.encode(name, "UTF-8") +
-                "&processor=" + ExistSystemProperties.getInstance().getExistSystemProperty("product-version", "2.2.0");
+                "&processor=" + ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_PRODUCT_VERSION, "2.2.0");
             if (version != null) {
                 if (version.getMin() != null) {
                     pkgURL += "&semver-min=" + version.getMin();

Original file line number	Diff line number	Diff line change
`@@ -38,22 +38,22 @@ public class SystemInfo implements SystemInfoMXBean {`
`38`	`38`
`39`	`39`	`@Override`
`40`	`40`	`public String getProductName() {`
`41`		`- return ExistSystemProperties.getInstance().getExistSystemProperty("product-name","eXist");`
	`41`	`+ return ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_PRODUCT_NAME,"eXist");`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`@Override`
`45`	`45`	`public String getProductVersion() {`
`46`		`- return ExistSystemProperties.getInstance().getExistSystemProperty("product-version","unknown");`
	`46`	`+ return ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_PRODUCT_VERSION,"unknown");`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`@Override`
`50`	`50`	`public String getProductBuild() {`
`51`		`- return ExistSystemProperties.getInstance().getExistSystemProperty("product-build","unknown");`
	`51`	`+ return ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_PRODUCT_BUILD,"unknown");`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`@Override`
`55`	`55`	`public String getGitCommit() {`
`56`		`- return ExistSystemProperties.getInstance().getExistSystemProperty("git-commit", "unknown Git commit ID");`
	`56`	`+ return ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_GIT_COMMIT, "unknown Git commit ID");`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -286,7 +286,7 @@ public Optional<String> installAndDeploy(final DBBroker broker, final Txn transa`
`286`	`286`	`}`
`287`	`287`
`288`	`288`	`private void checkProcessorVersion(final PackageLoader.Version version) throws PackageException {`
`289`		`- final String procVersion = ExistSystemProperties.getInstance().getExistSystemProperty("product-version", "1.0");`
	`289`	`+ final String procVersion = ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_PRODUCT_VERSION, "1.0");`
`290`	`290`
`291`	`291`	`final DependencyVersion depVersion = version.getDependencyVersion();`
`292`	`292`	`if (!depVersion.isCompatible(procVersion)) {`
Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,7 @@ void writeJnlpXML(JnlpJarFiles jnlpFiles, HttpServletRequest request,`
`101`	`101`	`writer.writeAttribute("codebase", codeBase);`
`102`	`102`	`writer.writeAttribute("href", "exist.jnlp");`
`103`	`103`
`104`		`- String version = ExistSystemProperties.getInstance().getExistSystemProperty("product-version", null);`
	`104`	`+ String version = ExistSystemProperties.getInstance().getExistSystemProperty(ExistSystemProperties.PROP_PRODUCT_VERSION, null);`
`105`	`105`	`if(version!=null){`
`106`	`106`	`writer.writeAttribute("version", version);`
`107`	`107`	`}`