From b7d8618ce593bbeca7e311d32a4d98988e27f877 Mon Sep 17 00:00:00 2001 From: Mathieu Baudier Date: Wed, 29 Dec 2021 11:29:45 +0100 Subject: [PATCH] Rename OSGi Boot to Argeo Init and introduce logging framework. --- demo/argeo_node_osgiboot.properties | 14 +- .../.classpath | 0 .../.project | 2 +- .../META-INF/.gitignore | 0 org.argeo.init/bnd.bnd | 8 + .../build.properties | 0 .../pom.xml | 4 +- .../services/java.lang.System$LoggerFinder | 1 + .../src/org/argeo/init/RuntimeContext.java | 5 + .../src/org/argeo/init/Service.java | 59 + .../org/argeo/init/StaticRuntimeContext.java | 35 + .../src/org/argeo/init}/a2/A2Branch.java | 4 +- .../src/org/argeo/init}/a2/A2Component.java | 2 +- .../org/argeo/init}/a2/A2Contribution.java | 2 +- .../src/org/argeo/init}/a2/A2Exception.java | 2 +- .../src/org/argeo/init}/a2/A2Module.java | 2 +- .../src/org/argeo/init}/a2/A2Source.java | 2 +- .../init}/a2/AbstractProvisioningSource.java | 2 +- .../org/argeo/init}/a2/ClasspathSource.java | 4 +- .../src/org/argeo/init}/a2/FsA2Source.java | 4 +- .../src/org/argeo/init}/a2/FsM2Source.java | 4 +- .../src/org/argeo/init}/a2/OsgiContext.java | 4 +- .../argeo/init}/a2/ProvisioningManager.java | 7 +- .../argeo/init}/a2/ProvisioningSource.java | 2 +- .../src/org/argeo/init}/a2/package-info.java | 2 +- .../org/argeo/init/logging/ThinLogEntry.java | 90 ++ .../argeo/init/logging/ThinLoggerFinder.java | 19 + .../org/argeo/init/logging/ThinLogging.java | 284 +++++ .../src/org/argeo/init/osgi}/Activator.java | 26 +- .../src/org/argeo/init/osgi}/AdminThread.java | 2 +- .../src/org/argeo/init/osgi}/BundlesSet.java | 2 +- .../argeo/init/osgi}/DistributionBundle.java | 20 +- .../src/org/argeo/init/osgi}/Launcher.java | 11 +- .../src/org/argeo/init/osgi}/Main.java | 2 +- .../src/org/argeo/init/osgi}/NodeRunner.java | 2 +- .../src/org/argeo/init/osgi}/OsgiBoot.java | 55 +- .../argeo/init/osgi}/OsgiBootConstants.java | 2 +- .../argeo/init/osgi}/OsgiBootDiagnostics.java | 2 +- .../org/argeo/init/osgi}/OsgiBootUtils.java | 19 +- .../src/org/argeo/init/osgi}/OsgiBuilder.java | 20 +- .../argeo/init/osgi/OsgiRuntimeContext.java | 52 + .../src/org/argeo/init/osgi}/log4j.properties | 0 .../src/org/argeo/init/osgi}/node.policy | 0 .../org/argeo/init/osgi}/package-info.java | 2 +- org.argeo.osgi.boot/bnd.bnd | 8 - .../argeo/osgi/boot/OsgiBootException.java | 18 - .../argeo/osgi/boot/equinox/EquinoxUtils.java | 22 - .../argeo/osgi/boot/equinox/package-info.java | 2 - .../internal/springutil/AntPathMatcher.java | 411 ------ .../boot/internal/springutil/Bootstrap.java | 101 -- .../internal/springutil/CollectionUtils.java | 276 ---- .../boot/internal/springutil/ObjectUtils.java | 833 ------------ .../boot/internal/springutil/PathMatcher.java | 91 -- .../boot/internal/springutil/StringUtils.java | 1113 ----------------- .../springutil/SystemPropertyUtils.java | 88 -- pom.xml | 2 +- 56 files changed, 682 insertions(+), 3064 deletions(-) rename {org.argeo.osgi.boot => org.argeo.init}/.classpath (100%) rename {org.argeo.osgi.boot => org.argeo.init}/.project (93%) rename {org.argeo.osgi.boot => org.argeo.init}/META-INF/.gitignore (100%) create mode 100644 org.argeo.init/bnd.bnd rename {org.argeo.osgi.boot => org.argeo.init}/build.properties (100%) rename {org.argeo.osgi.boot => org.argeo.init}/pom.xml (94%) create mode 100644 org.argeo.init/src/META-INF/services/java.lang.System$LoggerFinder create mode 100644 org.argeo.init/src/org/argeo/init/RuntimeContext.java create mode 100644 org.argeo.init/src/org/argeo/init/Service.java create mode 100644 org.argeo.init/src/org/argeo/init/StaticRuntimeContext.java rename {org.argeo.osgi.boot/src/org/argeo/osgi => org.argeo.init/src/org/argeo/init}/a2/A2Branch.java (96%) rename {org.argeo.osgi.boot/src/org/argeo/osgi => org.argeo.init/src/org/argeo/init}/a2/A2Component.java (98%) rename {org.argeo.osgi.boot/src/org/argeo/osgi => org.argeo.init/src/org/argeo/init}/a2/A2Contribution.java (98%) rename {org.argeo.osgi.boot/src/org/argeo/osgi => org.argeo.init/src/org/argeo/init}/a2/A2Exception.java (91%) rename {org.argeo.osgi.boot/src/org/argeo/osgi => org.argeo.init/src/org/argeo/init}/a2/A2Module.java (97%) rename {org.argeo.osgi.boot/src/org/argeo/osgi => org.argeo.init/src/org/argeo/init}/a2/A2Source.java (88%) rename {org.argeo.osgi.boot/src/org/argeo/osgi => org.argeo.init/src/org/argeo/init}/a2/AbstractProvisioningSource.java (99%) rename {org.argeo.osgi.boot/src/org/argeo/osgi => org.argeo.init/src/org/argeo/init}/a2/ClasspathSource.java (94%) rename {org.argeo.osgi.boot/src/org/argeo/osgi => org.argeo.init/src/org/argeo/init}/a2/FsA2Source.java (97%) rename {org.argeo.osgi.boot/src/org/argeo/osgi => org.argeo.init/src/org/argeo/init}/a2/FsM2Source.java (96%) rename {org.argeo.osgi.boot/src/org/argeo/osgi => org.argeo.init/src/org/argeo/init}/a2/OsgiContext.java (94%) rename {org.argeo.osgi.boot/src/org/argeo/osgi => org.argeo.init/src/org/argeo/init}/a2/ProvisioningManager.java (97%) rename {org.argeo.osgi.boot/src/org/argeo/osgi => org.argeo.init/src/org/argeo/init}/a2/ProvisioningSource.java (95%) rename {org.argeo.osgi.boot/src/org/argeo/osgi => org.argeo.init/src/org/argeo/init}/a2/package-info.java (56%) create mode 100644 org.argeo.init/src/org/argeo/init/logging/ThinLogEntry.java create mode 100644 org.argeo.init/src/org/argeo/init/logging/ThinLoggerFinder.java create mode 100644 org.argeo.init/src/org/argeo/init/logging/ThinLogging.java rename {org.argeo.osgi.boot/src/org/argeo/osgi/boot => org.argeo.init/src/org/argeo/init/osgi}/Activator.java (62%) rename {org.argeo.osgi.boot/src/org/argeo/osgi/boot => org.argeo.init/src/org/argeo/init/osgi}/AdminThread.java (97%) rename {org.argeo.osgi.boot/src/org/argeo/osgi/boot => org.argeo.init/src/org/argeo/init/osgi}/BundlesSet.java (98%) rename {org.argeo.osgi.boot/src/org/argeo/osgi/boot => org.argeo.init/src/org/argeo/init/osgi}/DistributionBundle.java (91%) rename {org.argeo.osgi.boot/src/org/argeo/osgi/boot => org.argeo.init/src/org/argeo/init/osgi}/Launcher.java (92%) rename {org.argeo.osgi.boot/src/org/argeo/osgi/boot => org.argeo.init/src/org/argeo/init/osgi}/Main.java (97%) rename {org.argeo.osgi.boot/src/org/argeo/osgi/boot => org.argeo.init/src/org/argeo/init/osgi}/NodeRunner.java (99%) rename {org.argeo.osgi.boot/src/org/argeo/osgi/boot => org.argeo.init/src/org/argeo/init/osgi}/OsgiBoot.java (94%) rename {org.argeo.osgi.boot/src/org/argeo/osgi/boot => org.argeo.init/src/org/argeo/init/osgi}/OsgiBootConstants.java (58%) rename {org.argeo.osgi.boot/src/org/argeo/osgi/boot => org.argeo.init/src/org/argeo/init/osgi}/OsgiBootDiagnostics.java (98%) rename {org.argeo.osgi.boot/src/org/argeo/osgi/boot => org.argeo.init/src/org/argeo/init/osgi}/OsgiBootUtils.java (84%) rename {org.argeo.osgi.boot/src/org/argeo/osgi/boot => org.argeo.init/src/org/argeo/init/osgi}/OsgiBuilder.java (92%) create mode 100644 org.argeo.init/src/org/argeo/init/osgi/OsgiRuntimeContext.java rename {org.argeo.osgi.boot/src/org/argeo/osgi/boot => org.argeo.init/src/org/argeo/init/osgi}/log4j.properties (100%) rename {org.argeo.osgi.boot/src/org/argeo/osgi/boot => org.argeo.init/src/org/argeo/init/osgi}/node.policy (100%) rename {org.argeo.osgi.boot/src/org/argeo/osgi/boot => org.argeo.init/src/org/argeo/init/osgi}/package-info.java (55%) delete mode 100644 org.argeo.osgi.boot/bnd.bnd delete mode 100644 org.argeo.osgi.boot/src/org/argeo/osgi/boot/OsgiBootException.java delete mode 100644 org.argeo.osgi.boot/src/org/argeo/osgi/boot/equinox/EquinoxUtils.java delete mode 100644 org.argeo.osgi.boot/src/org/argeo/osgi/boot/equinox/package-info.java delete mode 100644 org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/AntPathMatcher.java delete mode 100644 org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/Bootstrap.java delete mode 100644 org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/CollectionUtils.java delete mode 100644 org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/ObjectUtils.java delete mode 100644 org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/PathMatcher.java delete mode 100644 org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/StringUtils.java delete mode 100644 org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/SystemPropertyUtils.java diff --git a/demo/argeo_node_osgiboot.properties b/demo/argeo_node_osgiboot.properties index 64ff5d54c..2a8c3513b 100644 --- a/demo/argeo_node_osgiboot.properties +++ b/demo/argeo_node_osgiboot.properties @@ -1,16 +1,16 @@ -argeo.osgi.baseUrl=http://forge.argeo.org/data/java/argeo-2.1/ -argeo.osgi.distributionUrl=org/argeo/commons/org.argeo.dep.cms.sdk/2.1.65/org.argeo.dep.cms.sdk-2.1.65.jar +#argeo.osgi.baseUrl=http://forge.argeo.org/data/java/argeo-2.1/ +#argeo.osgi.distributionUrl=org/argeo/commons/org.argeo.dep.cms.sdk/2.1.65/org.argeo.dep.cms.sdk-2.1.65.jar #argeo.osgi.distributionUrl=org/argeo/commons/org.argeo.dep.cms.sdk/2.1.67/org.argeo.dep.cms.sdk-2.1.67.jar #argeo.osgi.distributionUrl=org/argeo/commons/org.argeo.dep.cms.sdk/2.1.68-SNAPSHOT/org.argeo.dep.cms.sdk-2.1.68-SNAPSHOT.jar -argeo.osgi.boot.debug=true +#argeo.osgi.boot.debug=true argeo.osgi.start.1.osgiboot=org.argeo.osgi.boot -argeo.osgi.start.2.node=org.eclipse.equinox.http.servlet,org.eclipse.equinox.http.jetty,org.eclipse.equinox.cm,org.eclipse.rap.rwt.osgi -argeo.osgi.start.3.node=org.argeo.cms,org.eclipse.gemini.blueprint.extender,org.eclipse.equinox.http.registry +#argeo.osgi.start.2.node=org.eclipse.equinox.http.servlet,org.eclipse.equinox.http.jetty,org.eclipse.equinox.cm,org.eclipse.rap.rwt.osgi +#argeo.osgi.start.3.node=org.argeo.cms,org.eclipse.gemini.blueprint.extender,org.eclipse.equinox.http.registry -java.security.manager= -java.security.policy=file:../../all.policy +#java.security.manager= +#java.security.policy=file:../../all.policy argeo.node.repo.type=localfs org.osgi.service.http.port=7070 diff --git a/org.argeo.osgi.boot/.classpath b/org.argeo.init/.classpath similarity index 100% rename from org.argeo.osgi.boot/.classpath rename to org.argeo.init/.classpath diff --git a/org.argeo.osgi.boot/.project b/org.argeo.init/.project similarity index 93% rename from org.argeo.osgi.boot/.project rename to org.argeo.init/.project index e145e9691..13443df6c 100644 --- a/org.argeo.osgi.boot/.project +++ b/org.argeo.init/.project @@ -1,6 +1,6 @@ - org.argeo.osgi.boot + org.argeo.init diff --git a/org.argeo.osgi.boot/META-INF/.gitignore b/org.argeo.init/META-INF/.gitignore similarity index 100% rename from org.argeo.osgi.boot/META-INF/.gitignore rename to org.argeo.init/META-INF/.gitignore diff --git a/org.argeo.init/bnd.bnd b/org.argeo.init/bnd.bnd new file mode 100644 index 000000000..f42151273 --- /dev/null +++ b/org.argeo.init/bnd.bnd @@ -0,0 +1,8 @@ +Main-Class: org.argeo.init.Service +Class-Path: org.eclipse.osgi.jar + +Bundle-Activator: org.argeo.init.osgi.Activator + +Import-Package: org.osgi.*;version=0.0.0 +Private-Package: * +Export-Package: !* diff --git a/org.argeo.osgi.boot/build.properties b/org.argeo.init/build.properties similarity index 100% rename from org.argeo.osgi.boot/build.properties rename to org.argeo.init/build.properties diff --git a/org.argeo.osgi.boot/pom.xml b/org.argeo.init/pom.xml similarity index 94% rename from org.argeo.osgi.boot/pom.xml rename to org.argeo.init/pom.xml index 554471bcc..85b43d9fe 100644 --- a/org.argeo.osgi.boot/pom.xml +++ b/org.argeo.init/pom.xml @@ -7,9 +7,9 @@ argeo-commons .. - org.argeo.osgi.boot + org.argeo.init jar - OSGi Boot + Init diff --git a/org.argeo.init/src/META-INF/services/java.lang.System$LoggerFinder b/org.argeo.init/src/META-INF/services/java.lang.System$LoggerFinder new file mode 100644 index 000000000..f63dfce29 --- /dev/null +++ b/org.argeo.init/src/META-INF/services/java.lang.System$LoggerFinder @@ -0,0 +1 @@ +org.argeo.init.logging.ThinLoggerFinder \ No newline at end of file diff --git a/org.argeo.init/src/org/argeo/init/RuntimeContext.java b/org.argeo.init/src/org/argeo/init/RuntimeContext.java new file mode 100644 index 000000000..7dd8e6c0c --- /dev/null +++ b/org.argeo.init/src/org/argeo/init/RuntimeContext.java @@ -0,0 +1,5 @@ +package org.argeo.init; + +public interface RuntimeContext extends Runnable, AutoCloseable { + void waitForStop(long timeout) throws InterruptedException; +} diff --git a/org.argeo.init/src/org/argeo/init/Service.java b/org.argeo.init/src/org/argeo/init/Service.java new file mode 100644 index 000000000..9a01cffed --- /dev/null +++ b/org.argeo.init/src/org/argeo/init/Service.java @@ -0,0 +1,59 @@ +package org.argeo.init; + +import java.lang.System.Logger; +import java.util.HashMap; +import java.util.Map; + +import org.argeo.init.osgi.OsgiRuntimeContext; + +public class Service implements Runnable, AutoCloseable { + private final static Logger log = System.getLogger(Service.class.getName()); + + private static RuntimeContext runtimeContext = null; + + protected Service(String[] args) { + } + + @Override + public void run() { + } + + @Override + public void close() throws Exception { + } + + public static void main(String[] args) { + long pid = ProcessHandle.current().pid(); + log.log(Logger.Level.DEBUG, "Starting with PID " + pid); + + // shutdown on exit + Runtime.getRuntime().addShutdownHook(new Thread(() -> { + try { + if (Service.runtimeContext != null) + Service.runtimeContext.close(); + } catch (Exception e) { + e.printStackTrace(); + System.exit(1); + } + }, "Runtime shutdown")); + + Map config = new HashMap<>(); + try { + try (OsgiRuntimeContext osgiRuntimeContext = new OsgiRuntimeContext(config)) { + osgiRuntimeContext.run(); + Service.runtimeContext = osgiRuntimeContext; + Service.runtimeContext.waitForStop(0); + } catch (NoClassDefFoundError e) { + try (StaticRuntimeContext staticRuntimeContext = new StaticRuntimeContext(config)) { + staticRuntimeContext.run(); + Service.runtimeContext = staticRuntimeContext; + Service.runtimeContext.waitForStop(0); + } + } + } catch (Exception e) { + e.printStackTrace(); + System.exit(1); + } + } + +} diff --git a/org.argeo.init/src/org/argeo/init/StaticRuntimeContext.java b/org.argeo.init/src/org/argeo/init/StaticRuntimeContext.java new file mode 100644 index 000000000..e01e6194d --- /dev/null +++ b/org.argeo.init/src/org/argeo/init/StaticRuntimeContext.java @@ -0,0 +1,35 @@ +package org.argeo.init; + +import java.util.Map; + +public class StaticRuntimeContext implements RuntimeContext { + private Map config; + + private boolean running = false; + + protected StaticRuntimeContext(Map config) { + this.config = config; + } + + @Override + public synchronized void run() { + running = true; + notifyAll(); + } + + @Override + public void waitForStop(long timeout) throws InterruptedException { + long begin = System.currentTimeMillis(); + while (running && (timeout == 0 || System.currentTimeMillis() - begin < timeout)) { + synchronized (this) { + wait(500); + } + } + } + + @Override + public synchronized void close() throws Exception { + running = false; + } + +} diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/A2Branch.java b/org.argeo.init/src/org/argeo/init/a2/A2Branch.java similarity index 96% rename from org.argeo.osgi.boot/src/org/argeo/osgi/a2/A2Branch.java rename to org.argeo.init/src/org/argeo/init/a2/A2Branch.java index 070830e57..9713d01d3 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/A2Branch.java +++ b/org.argeo.init/src/org/argeo/init/a2/A2Branch.java @@ -1,10 +1,10 @@ -package org.argeo.osgi.a2; +package org.argeo.init.a2; import java.util.Collections; import java.util.SortedMap; import java.util.TreeMap; -import org.argeo.osgi.boot.OsgiBootUtils; +import org.argeo.init.osgi.OsgiBootUtils; import org.osgi.framework.Version; /** diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/A2Component.java b/org.argeo.init/src/org/argeo/init/a2/A2Component.java similarity index 98% rename from org.argeo.osgi.boot/src/org/argeo/osgi/a2/A2Component.java rename to org.argeo.init/src/org/argeo/init/a2/A2Component.java index 0b5d13cce..2b6814f6b 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/A2Component.java +++ b/org.argeo.init/src/org/argeo/init/a2/A2Component.java @@ -1,4 +1,4 @@ -package org.argeo.osgi.a2; +package org.argeo.init.a2; import java.util.Collections; import java.util.SortedMap; diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/A2Contribution.java b/org.argeo.init/src/org/argeo/init/a2/A2Contribution.java similarity index 98% rename from org.argeo.osgi.boot/src/org/argeo/osgi/a2/A2Contribution.java rename to org.argeo.init/src/org/argeo/init/a2/A2Contribution.java index 35d5f9b03..3d33b55e2 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/A2Contribution.java +++ b/org.argeo.init/src/org/argeo/init/a2/A2Contribution.java @@ -1,4 +1,4 @@ -package org.argeo.osgi.a2; +package org.argeo.init.a2; import java.util.Collections; import java.util.Map; diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/A2Exception.java b/org.argeo.init/src/org/argeo/init/a2/A2Exception.java similarity index 91% rename from org.argeo.osgi.boot/src/org/argeo/osgi/a2/A2Exception.java rename to org.argeo.init/src/org/argeo/init/a2/A2Exception.java index 83c743afe..6ba87a7d0 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/A2Exception.java +++ b/org.argeo.init/src/org/argeo/init/a2/A2Exception.java @@ -1,4 +1,4 @@ -package org.argeo.osgi.a2; +package org.argeo.init.a2; /** Unchecked A2 provisioning exception. */ public class A2Exception extends RuntimeException { diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/A2Module.java b/org.argeo.init/src/org/argeo/init/a2/A2Module.java similarity index 97% rename from org.argeo.osgi.boot/src/org/argeo/osgi/a2/A2Module.java rename to org.argeo.init/src/org/argeo/init/a2/A2Module.java index 77f81d130..b862c5435 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/A2Module.java +++ b/org.argeo.init/src/org/argeo/init/a2/A2Module.java @@ -1,4 +1,4 @@ -package org.argeo.osgi.a2; +package org.argeo.init.a2; import org.osgi.framework.Version; diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/A2Source.java b/org.argeo.init/src/org/argeo/init/a2/A2Source.java similarity index 88% rename from org.argeo.osgi.boot/src/org/argeo/osgi/a2/A2Source.java rename to org.argeo.init/src/org/argeo/init/a2/A2Source.java index 2c88a385f..388a85012 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/A2Source.java +++ b/org.argeo.init/src/org/argeo/init/a2/A2Source.java @@ -1,4 +1,4 @@ -package org.argeo.osgi.a2; +package org.argeo.init.a2; /** A provisioning source in A2 format. */ public interface A2Source extends ProvisioningSource { diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/AbstractProvisioningSource.java b/org.argeo.init/src/org/argeo/init/a2/AbstractProvisioningSource.java similarity index 99% rename from org.argeo.osgi.boot/src/org/argeo/osgi/a2/AbstractProvisioningSource.java rename to org.argeo.init/src/org/argeo/init/a2/AbstractProvisioningSource.java index 32c175d3a..f43a6162a 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/AbstractProvisioningSource.java +++ b/org.argeo.init/src/org/argeo/init/a2/AbstractProvisioningSource.java @@ -1,4 +1,4 @@ -package org.argeo.osgi.a2; +package org.argeo.init.a2; import java.io.FileOutputStream; import java.io.IOException; diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/ClasspathSource.java b/org.argeo.init/src/org/argeo/init/a2/ClasspathSource.java similarity index 94% rename from org.argeo.osgi.boot/src/org/argeo/osgi/a2/ClasspathSource.java rename to org.argeo.init/src/org/argeo/init/a2/ClasspathSource.java index ea346663d..8a9e5e67f 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/ClasspathSource.java +++ b/org.argeo.init/src/org/argeo/init/a2/ClasspathSource.java @@ -1,4 +1,4 @@ -package org.argeo.osgi.a2; +package org.argeo.init.a2; import java.io.File; import java.io.IOException; @@ -7,7 +7,7 @@ import java.nio.file.Paths; import java.util.Arrays; import java.util.List; -import org.argeo.osgi.boot.OsgiBootUtils; +import org.argeo.init.osgi.OsgiBootUtils; import org.osgi.framework.Version; /** diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/FsA2Source.java b/org.argeo.init/src/org/argeo/init/a2/FsA2Source.java similarity index 97% rename from org.argeo.osgi.boot/src/org/argeo/osgi/a2/FsA2Source.java rename to org.argeo.init/src/org/argeo/init/a2/FsA2Source.java index eea59ded6..949dbdf81 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/FsA2Source.java +++ b/org.argeo.init/src/org/argeo/init/a2/FsA2Source.java @@ -1,4 +1,4 @@ -package org.argeo.osgi.a2; +package org.argeo.init.a2; import java.io.IOException; import java.nio.file.DirectoryStream; @@ -8,7 +8,7 @@ import java.nio.file.Paths; import java.util.SortedSet; import java.util.TreeSet; -import org.argeo.osgi.boot.OsgiBootUtils; +import org.argeo.init.osgi.OsgiBootUtils; import org.osgi.framework.Version; /** A file system {@link AbstractProvisioningSource} in A2 format. */ diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/FsM2Source.java b/org.argeo.init/src/org/argeo/init/a2/FsM2Source.java similarity index 96% rename from org.argeo.osgi.boot/src/org/argeo/osgi/a2/FsM2Source.java rename to org.argeo.init/src/org/argeo/init/a2/FsM2Source.java index a4c3ed5df..1657fad57 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/FsM2Source.java +++ b/org.argeo.init/src/org/argeo/init/a2/FsM2Source.java @@ -1,4 +1,4 @@ -package org.argeo.osgi.a2; +package org.argeo.init.a2; import java.io.File; import java.io.IOException; @@ -9,7 +9,7 @@ import java.nio.file.Paths; import java.nio.file.SimpleFileVisitor; import java.nio.file.attribute.BasicFileAttributes; -import org.argeo.osgi.boot.OsgiBootUtils; +import org.argeo.init.osgi.OsgiBootUtils; import org.osgi.framework.Version; /** A file system {@link AbstractProvisioningSource} in Maven 2 format. */ diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/OsgiContext.java b/org.argeo.init/src/org/argeo/init/a2/OsgiContext.java similarity index 94% rename from org.argeo.osgi.boot/src/org/argeo/osgi/a2/OsgiContext.java rename to org.argeo.init/src/org/argeo/init/a2/OsgiContext.java index 8630dc26d..35fbee356 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/OsgiContext.java +++ b/org.argeo.init/src/org/argeo/init/a2/OsgiContext.java @@ -1,6 +1,6 @@ -package org.argeo.osgi.a2; +package org.argeo.init.a2; -import org.argeo.osgi.boot.OsgiBootUtils; +import org.argeo.init.osgi.OsgiBootUtils; import org.osgi.framework.Bundle; import org.osgi.framework.BundleContext; import org.osgi.framework.FrameworkUtil; diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/ProvisioningManager.java b/org.argeo.init/src/org/argeo/init/a2/ProvisioningManager.java similarity index 97% rename from org.argeo.osgi.boot/src/org/argeo/osgi/a2/ProvisioningManager.java rename to org.argeo.init/src/org/argeo/init/a2/ProvisioningManager.java index d8246f18d..6012c34ee 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/ProvisioningManager.java +++ b/org.argeo.init/src/org/argeo/init/a2/ProvisioningManager.java @@ -1,4 +1,4 @@ -package org.argeo.osgi.a2; +package org.argeo.init.a2; import java.io.File; import java.net.URI; @@ -14,8 +14,7 @@ import java.util.List; import java.util.Map; import java.util.Set; -import org.argeo.osgi.boot.OsgiBootUtils; -import org.eclipse.osgi.launch.EquinoxFactory; +import org.argeo.init.osgi.OsgiBootUtils; import org.osgi.framework.Bundle; import org.osgi.framework.BundleContext; import org.osgi.framework.Constants; @@ -176,7 +175,7 @@ public class ProvisioningManager { public static void main(String[] args) { Map configuration = new HashMap<>(); configuration.put("osgi.console", "2323"); - Framework framework = OsgiBootUtils.launch(new EquinoxFactory(), configuration); + Framework framework = OsgiBootUtils.launch(configuration); try { ProvisioningManager pm = new ProvisioningManager(framework.getBundleContext()); FsA2Source context = new FsA2Source(Paths.get( diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/ProvisioningSource.java b/org.argeo.init/src/org/argeo/init/a2/ProvisioningSource.java similarity index 95% rename from org.argeo.osgi.boot/src/org/argeo/osgi/a2/ProvisioningSource.java rename to org.argeo.init/src/org/argeo/init/a2/ProvisioningSource.java index 7d6fadf7b..99356300e 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/ProvisioningSource.java +++ b/org.argeo.init/src/org/argeo/init/a2/ProvisioningSource.java @@ -1,4 +1,4 @@ -package org.argeo.osgi.a2; +package org.argeo.init.a2; import org.osgi.framework.Bundle; import org.osgi.framework.BundleContext; diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/package-info.java b/org.argeo.init/src/org/argeo/init/a2/package-info.java similarity index 56% rename from org.argeo.osgi.boot/src/org/argeo/osgi/a2/package-info.java rename to org.argeo.init/src/org/argeo/init/a2/package-info.java index b381410a4..bb8fa6e00 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/a2/package-info.java +++ b/org.argeo.init/src/org/argeo/init/a2/package-info.java @@ -1,2 +1,2 @@ /** A2 OSGi repository format. */ -package org.argeo.osgi.a2; \ No newline at end of file +package org.argeo.init.a2; \ No newline at end of file diff --git a/org.argeo.init/src/org/argeo/init/logging/ThinLogEntry.java b/org.argeo.init/src/org/argeo/init/logging/ThinLogEntry.java new file mode 100644 index 000000000..c71fb6d27 --- /dev/null +++ b/org.argeo.init/src/org/argeo/init/logging/ThinLogEntry.java @@ -0,0 +1,90 @@ +package org.argeo.init.logging; + +import java.io.Serializable; +import java.lang.System.Logger; +import java.lang.System.Logger.Level; +import java.time.Instant; +import java.util.Objects; +import java.util.Optional; +import java.util.concurrent.atomic.AtomicLong; + +/** A log entry with equals semantics based on an incremental long sequence. */ +class ThinLogEntry implements Serializable { + private static final long serialVersionUID = 5915553445193937270L; + + private final static AtomicLong next = new AtomicLong(0l); + +// private final transient Logger logger; + + private final long sequence; + private final String loggerName; + private final Instant instant; + private final Level level; + private final String message; + private final Optional throwable; + private final Optional callLocation; + + protected ThinLogEntry(Logger logger, Level level, String message, Instant instant, Throwable e, + StackTraceElement callLocation) { + // NOTE: 0 is never allocated, in order to have a concept of "null" entry + sequence = next.incrementAndGet(); +// this.logger = logger; + + this.loggerName = Objects.requireNonNull(logger).getName(); + this.instant = Objects.requireNonNull(instant); + this.level = level; + this.message = message; + this.throwable = Optional.ofNullable(e); + this.callLocation = Optional.ofNullable(callLocation); + } + + public long getSequence() { + return sequence; + } + + public Level getLevel() { + return level; + } + + public String getMessage() { + return message; + } + +// Logger getLogger() { +// return logger; +// } + + public String getLoggerName() { + return loggerName; + } + + public Instant getInstant() { + return instant; + } + + public Optional getThrowable() { + return throwable; + } + + public Optional getCallLocation() { + return callLocation; + } + + @Override + public int hashCode() { + return (int) sequence; + } + + @Override + public boolean equals(Object obj) { + if (!(obj instanceof ThinLogEntry)) + return false; + return sequence == ((ThinLogEntry) obj).sequence; + } + + @Override + public String toString() { + return message; + } + +} diff --git a/org.argeo.init/src/org/argeo/init/logging/ThinLoggerFinder.java b/org.argeo.init/src/org/argeo/init/logging/ThinLoggerFinder.java new file mode 100644 index 000000000..784930946 --- /dev/null +++ b/org.argeo.init/src/org/argeo/init/logging/ThinLoggerFinder.java @@ -0,0 +1,19 @@ +package org.argeo.init.logging; + +import java.lang.System.Logger; +import java.lang.System.LoggerFinder; + +/** Factory for Java system logging. */ +public class ThinLoggerFinder extends LoggerFinder { + private ThinLogging logging; + + public ThinLoggerFinder() { + logging = new ThinLogging(); + } + + @Override + public Logger getLogger(String name, Module module) { + return logging.getLogger(name, module); + } + +} diff --git a/org.argeo.init/src/org/argeo/init/logging/ThinLogging.java b/org.argeo.init/src/org/argeo/init/logging/ThinLogging.java new file mode 100644 index 000000000..e7edc19a8 --- /dev/null +++ b/org.argeo.init/src/org/argeo/init/logging/ThinLogging.java @@ -0,0 +1,284 @@ +package org.argeo.init.logging; + +import java.io.PrintStream; +import java.lang.System.Logger; +import java.lang.System.Logger.Level; +import java.text.MessageFormat; +import java.time.Instant; +import java.util.Map; +import java.util.NavigableMap; +import java.util.Objects; +import java.util.ResourceBundle; +import java.util.SortedMap; +import java.util.StringTokenizer; +import java.util.TreeMap; +import java.util.concurrent.Executor; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.concurrent.Flow; +import java.util.concurrent.Flow.Subscription; +import java.util.concurrent.SubmissionPublisher; +import java.util.concurrent.TimeUnit; + +/** A thin logging system based on the {@link Logger} framework. */ +class ThinLogging { +// private static ThinLogging instance; + + private SortedMap loggers = new TreeMap<>(); + private NavigableMap levels = new TreeMap<>(); + + private final ExecutorService executor; + private final LogEntryPublisher publisher; + + ThinLogging() { +// if (instance != null) +// throw new IllegalStateException("Only one logger finder cann be instantiated"); +// instance = this; + + executor = Executors.newCachedThreadPool((r) -> { + Thread t = new Thread(r); + t.setDaemon(true); + return t; + }); + publisher = new LogEntryPublisher(executor, Flow.defaultBufferSize()); + + PrintStreamSubscriber subscriber = new PrintStreamSubscriber(); + publisher.subscribe(subscriber); + + Runtime.getRuntime().addShutdownHook(new Thread(() -> close(), "Log shutdown")); + } + + protected void close() { + publisher.close(); + try { + // we ait a bit in order to make sure all messages are flushed + // TODO synchronize more efficiently + executor.awaitTermination(300, TimeUnit.MILLISECONDS); + } catch (InterruptedException e) { + // silent + } + } + + public void setDefaultLevel(Level level) { + levels.put("", level); + } + + public boolean isLoggable(String name, Level level) { + Objects.requireNonNull(name); + Objects.requireNonNull(level); + + Map.Entry entry = levels.ceilingEntry(name); + assert entry != null; + return level.getSeverity() >= entry.getValue().getSeverity(); + } + + public Logger getLogger(String name, Module module) { + if (!loggers.containsKey(name)) { + ThinLogger logger = new ThinLogger(name); + loggers.put(name, logger); + } + return loggers.get(name); + } + + class ThinLogger implements System.Logger { + private final String name; + private boolean callLocationEnabled = true; + + protected ThinLogger(String name) { + assert Objects.nonNull(name); + this.name = name; + } + + @Override + public String getName() { + return name; + } + + @Override + public boolean isLoggable(Level level) { + return ThinLogging.this.isLoggable(name, level); + } + + @Override + public void log(Level level, ResourceBundle bundle, String msg, Throwable thrown) { + // measure timestamp first + Instant now = Instant.now(); + publisher.log(this, level, bundle, msg, thrown, now, findCallLocation()); + } + + @Override + public void log(Level level, ResourceBundle bundle, String format, Object... params) { + // measure timestamp first + Instant now = Instant.now(); + String msg = MessageFormat.format(format, params); + publisher.log(this, level, bundle, msg, null, now, findCallLocation()); + } + + protected StackTraceElement findCallLocation() { + StackTraceElement callLocation = null; + if (callLocationEnabled) { +// Throwable locator = new Throwable(); +// StackTraceElement[] stack = locator.getStackTrace(); + StackTraceElement[] stack = Thread.currentThread().getStackTrace(); + // TODO make it smarter by finding the lowest logger interface in the stack + int lowestLoggerInterface = 0; + stack: for (int i = 2; i < stack.length; i++) { + String className = stack[i].getClassName(); + switch (className) { + case "java.lang.System$Logger": + case "org.apache.commons.logging.Log": + case "org.osgi.service.log.Logger": + case "org.argeo.cms.Log": + lowestLoggerInterface = i; + continue stack; + default: + } + } + if (stack.length > lowestLoggerInterface + 1) + callLocation = stack[lowestLoggerInterface + 1]; + } + return callLocation; + } + + } + + class LogEntryPublisher extends SubmissionPublisher { + + protected LogEntryPublisher(Executor executor, int maxBufferCapacity) { + super(executor, maxBufferCapacity); + } + + void log(ThinLogger logger, Level level, ResourceBundle bundle, String msg, Throwable thrown, Instant instant, + StackTraceElement callLocation) { + ThinLogEntry logEntry = new ThinLogEntry(logger, level, msg, instant, thrown, callLocation); + submit(logEntry); + } + + } + + class PrintStreamSubscriber implements Flow.Subscriber { + private PrintStream out; + private PrintStream err; + private int writeToErrLevel = Level.WARNING.getSeverity(); + + private boolean journald = false; + + protected PrintStreamSubscriber() { + this(System.out, System.err); + } + + protected PrintStreamSubscriber(PrintStream out, PrintStream err) { + this.out = out; + this.err = err; + } + + @Override + public void onSubscribe(Subscription subscription) { + subscription.request(Long.MAX_VALUE); + } + + @Override + public void onNext(ThinLogEntry item) { + if (item.getLevel().getSeverity() >= writeToErrLevel) { + err.print(toPrint(item)); + } else { + out.print(toPrint(item)); + } + } + + @Override + public void onError(Throwable throwable) { + throwable.printStackTrace(err); + } + + @Override + public void onComplete() { + out.flush(); + err.flush(); + } + + protected boolean prefixOnEachLine() { + return journald; + } + + protected String firstLinePrefix(ThinLogEntry logEntry) { + return journald ? linePrefix(logEntry) + : logEntry.getLevel().toString() + "\t" + logEntry.getInstant() + " "; + } + + protected String firstLineSuffix(ThinLogEntry logEntry) { + return " - " + (logEntry.getCallLocation().isEmpty() ? logEntry.getLoggerName() + : logEntry.getCallLocation().get()); + } + + protected String linePrefix(ThinLogEntry logEntry) { + return journald ? "<" + levelToJournald(logEntry.getLevel()) + ">" : ""; + } + + protected int levelToJournald(Level level) { + int severity = level.getSeverity(); + if (severity >= Level.ERROR.getSeverity()) + return 3; + else if (severity >= Level.WARNING.getSeverity()) + return 4; + else if (severity >= Level.INFO.getSeverity()) + return 6; + else + return 7; + } + + protected String toPrint(ThinLogEntry logEntry) { + StringBuilder sb = new StringBuilder(); + StringTokenizer st = new StringTokenizer(logEntry.getMessage(), "\r\n"); + assert st.hasMoreTokens(); + + // first line + String firstLine = st.nextToken(); + sb.append(firstLinePrefix(logEntry)); + sb.append(firstLine); + sb.append(firstLineSuffix(logEntry)); + sb.append('\n'); + + // other lines + String prefix = linePrefix(logEntry); + while (st.hasMoreTokens()) { + sb.append(prefix); + sb.append(st.nextToken()); + sb.append('\n'); + } + + if (!logEntry.getThrowable().isEmpty()) { + Throwable throwable = logEntry.getThrowable().get(); + sb.append(prefix); + addThrowable(sb, prefix, throwable); + } + return sb.toString(); + } + + protected void addThrowable(StringBuilder sb, String prefix, Throwable throwable) { + sb.append(throwable.getClass().getName()); + sb.append(": "); + sb.append(throwable.getMessage()); + sb.append('\n'); + for (StackTraceElement ste : throwable.getStackTrace()) { + sb.append(prefix); + sb.append(ste.toString()); + sb.append('\n'); + } + if (throwable.getCause() != null) { + sb.append(prefix); + sb.append("caused by "); + addThrowable(sb, prefix, throwable.getCause()); + } + } + } + + public static void main(String args[]) { + Logger logger = System.getLogger(ThinLogging.class.getName()); + logger.log(Logger.Level.INFO, "Hello log!"); + logger.log(Logger.Level.ERROR, "Hello error!"); + logger.log(Logger.Level.DEBUG, "Hello multi\nline\ndebug!"); + logger.log(Logger.Level.WARNING, "Hello exception!", new Throwable()); + } + +} diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/Activator.java b/org.argeo.init/src/org/argeo/init/osgi/Activator.java similarity index 62% rename from org.argeo.osgi.boot/src/org/argeo/osgi/boot/Activator.java rename to org.argeo.init/src/org/argeo/init/osgi/Activator.java index 516ab9080..5a9527041 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/Activator.java +++ b/org.argeo.init/src/org/argeo/init/osgi/Activator.java @@ -1,4 +1,8 @@ -package org.argeo.osgi.boot; +package org.argeo.init.osgi; + +import java.util.Enumeration; +import java.util.ResourceBundle; +import java.util.Vector; import org.osgi.framework.BundleActivator; import org.osgi.framework.BundleContext; @@ -29,4 +33,24 @@ public class Activator implements BundleActivator { public void stop(BundleContext context) throws Exception { } + + class JournaldResourceBundle extends ResourceBundle { + + @Override + protected Object handleGetObject(String key) { + switch (key) { + case "ERROR": + return "<5>"; + } + return null; + } + + @Override + public Enumeration getKeys() { + Vector keys = new Vector<>(); + keys.add("ERROR"); + return keys.elements(); + } + + } } diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/AdminThread.java b/org.argeo.init/src/org/argeo/init/osgi/AdminThread.java similarity index 97% rename from org.argeo.osgi.boot/src/org/argeo/osgi/boot/AdminThread.java rename to org.argeo.init/src/org/argeo/init/osgi/AdminThread.java index b0144a95c..fdb6fe923 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/AdminThread.java +++ b/org.argeo.init/src/org/argeo/init/osgi/AdminThread.java @@ -1,4 +1,4 @@ -package org.argeo.osgi.boot; +package org.argeo.init.osgi; import java.io.File; diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/BundlesSet.java b/org.argeo.init/src/org/argeo/init/osgi/BundlesSet.java similarity index 98% rename from org.argeo.osgi.boot/src/org/argeo/osgi/boot/BundlesSet.java rename to org.argeo.init/src/org/argeo/init/osgi/BundlesSet.java index 4a342fdbe..73ab9afa7 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/BundlesSet.java +++ b/org.argeo.init/src/org/argeo/init/osgi/BundlesSet.java @@ -1,4 +1,4 @@ -package org.argeo.osgi.boot; +package org.argeo.init.osgi; import java.io.File; import java.io.IOException; diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/DistributionBundle.java b/org.argeo.init/src/org/argeo/init/osgi/DistributionBundle.java similarity index 91% rename from org.argeo.osgi.boot/src/org/argeo/osgi/boot/DistributionBundle.java rename to org.argeo.init/src/org/argeo/init/osgi/DistributionBundle.java index a336b6446..35b66e6b7 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/DistributionBundle.java +++ b/org.argeo.init/src/org/argeo/init/osgi/DistributionBundle.java @@ -1,4 +1,4 @@ -package org.argeo.osgi.boot; +package org.argeo.init.osgi; import java.io.BufferedReader; import java.io.IOException; @@ -56,9 +56,9 @@ public class DistributionBundle { public DistributionBundle(String baseUrl, String relativeUrl, String localCache) { if (baseUrl == null || !baseUrl.endsWith("/")) - throw new OsgiBootException("Base url " + baseUrl + " badly formatted"); + throw new IllegalArgumentException("Base url " + baseUrl + " badly formatted"); if (relativeUrl.startsWith("http") || relativeUrl.startsWith("file:")) - throw new OsgiBootException("Relative URL " + relativeUrl + " badly formatted"); + throw new IllegalArgumentException("Relative URL " + relativeUrl + " badly formatted"); this.url = constructUrl(baseUrl, relativeUrl); this.baseUrl = baseUrl; this.relativeUrl = relativeUrl; @@ -82,13 +82,13 @@ public class DistributionBundle { SortedMap res = new TreeMap<>(); checkDir(basePath, pm, res); if (res.size() == 0) - throw new OsgiBootException("No file matching " + relativeUrl + " found in " + baseUrl); + throw new IllegalArgumentException("No file matching " + relativeUrl + " found in " + baseUrl); return res.get(res.firstKey()).toUri().toString(); } else { return baseUrl + relativeUrl; } } catch (Exception e) { - throw new OsgiBootException("Cannot build URL from " + baseUrl + " and " + relativeUrl, e); + throw new RuntimeException("Cannot build URL from " + baseUrl + " and " + relativeUrl, e); } } @@ -138,7 +138,7 @@ public class DistributionBundle { // list artifacts if (indexEntry == null) - throw new OsgiBootException("No index " + INDEX_FILE_NAME + " in " + url); + throw new IllegalArgumentException("No index " + INDEX_FILE_NAME + " in " + url); artifacts = listArtifacts(jarIn); jarIn.closeEntry(); @@ -155,7 +155,7 @@ public class DistributionBundle { } } } catch (Exception e) { - throw new OsgiBootException("Cannot list URLs from " + url, e); + throw new RuntimeException("Cannot list URLs from " + url, e); } finally { if (jarIn != null) try { @@ -182,7 +182,7 @@ public class DistributionBundle { osgiArtifacts.add(new OsgiArtifact(moduleName, moduleVersion, relativeUrl)); } } catch (Exception e) { - throw new OsgiBootException("Cannot list artifacts", e); + throw new RuntimeException("Cannot list artifacts", e); } return osgiArtifacts; } @@ -200,10 +200,10 @@ public class DistributionBundle { */ public List listUrls() { if (baseUrl == null) - throw new OsgiBootException("Base URL is not set"); + throw new IllegalArgumentException("Base URL is not set"); if (artifacts == null) - throw new OsgiBootException("Artifact list not initialized"); + throw new IllegalStateException("Artifact list not initialized"); List urls = new ArrayList(); for (int i = 0; i < artifacts.size(); i++) { diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/Launcher.java b/org.argeo.init/src/org/argeo/init/osgi/Launcher.java similarity index 92% rename from org.argeo.osgi.boot/src/org/argeo/osgi/boot/Launcher.java rename to org.argeo.init/src/org/argeo/init/osgi/Launcher.java index f67f45b5b..778c08a70 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/Launcher.java +++ b/org.argeo.init/src/org/argeo/init/osgi/Launcher.java @@ -1,4 +1,4 @@ -package org.argeo.osgi.boot; +package org.argeo.init.osgi; import java.io.FileInputStream; import java.io.IOException; @@ -6,10 +6,9 @@ import java.lang.reflect.Method; import java.util.ArrayList; import java.util.List; -import org.eclipse.core.runtime.adaptor.EclipseStarter; import org.osgi.framework.BundleContext; -/** Command line interface. */ +/** An OSGi launcher executing first another class in the system class path. */ public class Launcher { public static void main(String[] args) { @@ -38,7 +37,7 @@ public class Launcher { // Start Equinox BundleContext bundleContext = null; try { - bundleContext = EclipseStarter.startup(args, null); + bundleContext = OsgiBootUtils.launch(OsgiBootUtils.equinoxArgsToConfiguration(args)).getBundleContext(); } catch (Exception e) { throw new RuntimeException("Cannot start Equinox.", e); } @@ -71,8 +70,8 @@ public class Launcher { } /** - * Transform a line into an array of arguments, taking "" as single - * arguments. (nested \" are not supported) + * Transform a line into an array of arguments, taking "" as single arguments. + * (nested \" are not supported) */ private static String[] readArgumentsFromLine(String lineOrig) { String line = lineOrig.trim();// remove trailing spaces diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/Main.java b/org.argeo.init/src/org/argeo/init/osgi/Main.java similarity index 97% rename from org.argeo.osgi.boot/src/org/argeo/osgi/boot/Main.java rename to org.argeo.init/src/org/argeo/init/osgi/Main.java index 45094a7ee..ce83329b6 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/Main.java +++ b/org.argeo.init/src/org/argeo/init/osgi/Main.java @@ -1,4 +1,4 @@ -package org.argeo.osgi.boot; +package org.argeo.init.osgi; import java.lang.management.ManagementFactory; diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/NodeRunner.java b/org.argeo.init/src/org/argeo/init/osgi/NodeRunner.java similarity index 99% rename from org.argeo.osgi.boot/src/org/argeo/osgi/boot/NodeRunner.java rename to org.argeo.init/src/org/argeo/init/osgi/NodeRunner.java index 263a4cda4..336965060 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/NodeRunner.java +++ b/org.argeo.init/src/org/argeo/init/osgi/NodeRunner.java @@ -1,4 +1,4 @@ -package org.argeo.osgi.boot; +package org.argeo.init.osgi; import java.io.InputStream; import java.io.OutputStream; diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/OsgiBoot.java b/org.argeo.init/src/org/argeo/init/osgi/OsgiBoot.java similarity index 94% rename from org.argeo.osgi.boot/src/org/argeo/osgi/boot/OsgiBoot.java rename to org.argeo.init/src/org/argeo/init/osgi/OsgiBoot.java index b49e72001..aeec0b768 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/OsgiBoot.java +++ b/org.argeo.init/src/org/argeo/init/osgi/OsgiBoot.java @@ -1,11 +1,13 @@ -package org.argeo.osgi.boot; +package org.argeo.init.osgi; -import static org.argeo.osgi.boot.OsgiBootUtils.debug; -import static org.argeo.osgi.boot.OsgiBootUtils.warn; +import static org.argeo.init.osgi.OsgiBootUtils.debug; +import static org.argeo.init.osgi.OsgiBootUtils.warn; import java.io.File; +import java.nio.file.FileSystems; import java.nio.file.Files; import java.nio.file.Path; +import java.nio.file.PathMatcher; import java.nio.file.Paths; import java.util.ArrayList; import java.util.HashMap; @@ -18,11 +20,8 @@ import java.util.SortedMap; import java.util.StringTokenizer; import java.util.TreeMap; -import org.argeo.osgi.a2.A2Source; -import org.argeo.osgi.a2.ProvisioningManager; -import org.argeo.osgi.boot.internal.springutil.AntPathMatcher; -import org.argeo.osgi.boot.internal.springutil.PathMatcher; -import org.argeo.osgi.boot.internal.springutil.SystemPropertyUtils; +import org.argeo.init.a2.A2Source; +import org.argeo.init.a2.ProvisioningManager; import org.osgi.framework.Bundle; import org.osgi.framework.BundleContext; import org.osgi.framework.BundleException; @@ -267,9 +266,8 @@ public class OsgiBoot implements OsgiBootConstants { FrameworkStartLevel frameworkStartLevel = bundleContext.getBundle(0).adapt(FrameworkStartLevel.class); // default and active start levels from System properties - Integer defaultStartLevel = new Integer( - Integer.parseInt(getProperty(PROP_OSGI_BUNDLES_DEFAULTSTARTLEVEL, "4"))); - Integer activeStartLevel = new Integer(getProperty(PROP_OSGI_STARTLEVEL, "6")); + Integer defaultStartLevel = Integer.parseInt(getProperty(PROP_OSGI_BUNDLES_DEFAULTSTARTLEVEL, "4")); + Integer activeStartLevel = Integer.parseInt(getProperty(PROP_OSGI_STARTLEVEL, "6")); SortedMap> startLevels = new TreeMap>(); computeStartLevels(startLevels, properties, defaultStartLevel); @@ -323,7 +321,7 @@ public class OsgiBoot implements OsgiBootConstants { if (tokens.length > 0 && !tokens[0].trim().equals("")) try { // first token is start level - startLevel = new Integer(tokens[0]); + startLevel = Integer.parseInt(tokens[0]); } catch (NumberFormatException e) { startLevel = defaultStartLevel; } @@ -485,7 +483,7 @@ public class OsgiBoot implements OsgiBootConstants { if (bundlePatterns == null) return urls; - bundlePatterns = SystemPropertyUtils.resolvePlaceholders(bundlePatterns); +// bundlePatterns = SystemPropertyUtils.resolvePlaceholders(bundlePatterns); if (OsgiBootUtils.debug) debug(PROP_ARGEO_OSGI_BUNDLES + "=" + bundlePatterns); @@ -502,12 +500,12 @@ public class OsgiBoot implements OsgiBootConstants { // find included List included = new ArrayList(); - PathMatcher matcher = new AntPathMatcher(); +// PathMatcher matcher = new AntPathMatcher(); for (int i = 0; i < bundlesSets.size(); i++) { BundlesSet bundlesSet = (BundlesSet) bundlesSets.get(i); for (int j = 0; j < bundlesSet.getIncludes().size(); j++) { String pattern = (String) bundlesSet.getIncludes().get(j); - match(matcher, included, bundlesSet.getDir(), null, pattern); + match(included, bundlesSet.getDir(), null, pattern); } } @@ -517,7 +515,7 @@ public class OsgiBoot implements OsgiBootConstants { BundlesSet bundlesSet = (BundlesSet) bundlesSets.get(i); for (int j = 0; j < bundlesSet.getExcludes().size(); j++) { String pattern = (String) bundlesSet.getExcludes().get(j); - match(matcher, excluded, bundlesSet.getDir(), null, pattern); + match(excluded, bundlesSet.getDir(), null, pattern); } } @@ -592,7 +590,7 @@ public class OsgiBoot implements OsgiBootConstants { * HIGH LEVEL UTILITIES */ /** Actually performs the matching logic. */ - protected void match(PathMatcher matcher, List matched, String base, String currentPath, String pattern) { + protected void match(List matched, String base, String currentPath, String pattern) { if (currentPath == null) { // Init File baseDir = new File(base.replace('/', File.separatorChar)); @@ -606,13 +604,14 @@ public class OsgiBoot implements OsgiBootConstants { } for (int i = 0; i < files.length; i++) - match(matcher, matched, base, files[i].getName(), pattern); + match(matched, base, files[i].getName(), pattern); } else { + PathMatcher matcher = FileSystems.getDefault().getPathMatcher(pattern); String fullPath = base + '/' + currentPath; if (matched.contains(fullPath)) return;// don't try deeper if already matched - boolean ok = matcher.match(pattern, currentPath); + boolean ok = matcher.matches(Paths.get(currentPath)); // if (debug) // debug(currentPath + " " + (ok ? "" : " not ") // + " matched with " + pattern); @@ -627,16 +626,16 @@ public class OsgiBoot implements OsgiBootConstants { for (int i = 0; i < files.length; i++) { String newCurrentPath = currentPath + '/' + files[i].getName(); if (files[i].isDirectory()) { - if (matcher.matchStart(pattern, newCurrentPath)) { - // recurse only if start matches - match(matcher, matched, base, newCurrentPath, pattern); - } else { - if (OsgiBootUtils.debug) - debug(newCurrentPath + " does not start match with " + pattern); - - } +// if (matcher.matchStart(pattern, newCurrentPath)) { + // FIXME recurse only if start matches ? + match(matched, base, newCurrentPath, pattern); +// } else { +// if (OsgiBootUtils.debug) +// debug(newCurrentPath + " does not start match with " + pattern); +// +// } } else { - boolean nonDirectoryOk = matcher.match(pattern, newCurrentPath); + boolean nonDirectoryOk = matcher.matches(Paths.get(newCurrentPath)); if (OsgiBootUtils.debug) debug(currentPath + " " + (ok ? "" : " not ") + " matched with " + pattern); if (nonDirectoryOk) diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/OsgiBootConstants.java b/org.argeo.init/src/org/argeo/init/osgi/OsgiBootConstants.java similarity index 58% rename from org.argeo.osgi.boot/src/org/argeo/osgi/boot/OsgiBootConstants.java rename to org.argeo.init/src/org/argeo/init/osgi/OsgiBootConstants.java index e2d771920..e45f82689 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/OsgiBootConstants.java +++ b/org.argeo.init/src/org/argeo/init/osgi/OsgiBootConstants.java @@ -1,4 +1,4 @@ -package org.argeo.osgi.boot; +package org.argeo.init.osgi; public interface OsgiBootConstants { diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/OsgiBootDiagnostics.java b/org.argeo.init/src/org/argeo/init/osgi/OsgiBootDiagnostics.java similarity index 98% rename from org.argeo.osgi.boot/src/org/argeo/osgi/boot/OsgiBootDiagnostics.java rename to org.argeo.init/src/org/argeo/init/osgi/OsgiBootDiagnostics.java index 24a3317c6..72d9a3e64 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/OsgiBootDiagnostics.java +++ b/org.argeo.init/src/org/argeo/init/osgi/OsgiBootDiagnostics.java @@ -1,4 +1,4 @@ -package org.argeo.osgi.boot; +package org.argeo.init.osgi; import java.util.ArrayList; import java.util.Iterator; diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/OsgiBootUtils.java b/org.argeo.init/src/org/argeo/init/osgi/OsgiBootUtils.java similarity index 84% rename from org.argeo.osgi.boot/src/org/argeo/osgi/boot/OsgiBootUtils.java rename to org.argeo.init/src/org/argeo/init/osgi/OsgiBootUtils.java index c152ed74e..d8efe8343 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/OsgiBootUtils.java +++ b/org.argeo.init/src/org/argeo/init/osgi/OsgiBootUtils.java @@ -1,11 +1,14 @@ -package org.argeo.osgi.boot; +package org.argeo.init.osgi; import java.text.DateFormat; import java.text.SimpleDateFormat; import java.util.ArrayList; import java.util.Date; +import java.util.HashMap; import java.util.List; import java.util.Map; +import java.util.Optional; +import java.util.ServiceLoader; import java.util.StringTokenizer; import org.osgi.framework.Bundle; @@ -115,6 +118,13 @@ public class OsgiBootUtils { return comp; } + public static Framework launch(Map configuration) { + Optional frameworkFactory = ServiceLoader.load(FrameworkFactory.class).findFirst(); + if (frameworkFactory.isEmpty()) + throw new IllegalStateException("No framework factory found"); + return launch(frameworkFactory.get(), configuration); + } + /** Launch an OSGi framework. */ public static Framework launch(FrameworkFactory frameworkFactory, Map configuration) { // start OSGi @@ -122,9 +132,14 @@ public class OsgiBootUtils { try { framework.start(); } catch (BundleException e) { - throw new OsgiBootException("Cannot start OSGi framework", e); + throw new IllegalStateException("Cannot start OSGi framework", e); } return framework; } + public static Map equinoxArgsToConfiguration(String[] args) { + // FIXME implement it + return new HashMap<>(); + } + } diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/OsgiBuilder.java b/org.argeo.init/src/org/argeo/init/osgi/OsgiBuilder.java similarity index 92% rename from org.argeo.osgi.boot/src/org/argeo/osgi/boot/OsgiBuilder.java rename to org.argeo.init/src/org/argeo/init/osgi/OsgiBuilder.java index 8c460e116..39c42cbf3 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/OsgiBuilder.java +++ b/org.argeo.init/src/org/argeo/init/osgi/OsgiBuilder.java @@ -1,4 +1,4 @@ -package org.argeo.osgi.boot; +package org.argeo.init.osgi; import java.lang.reflect.Method; import java.net.URI; @@ -12,7 +12,6 @@ import java.util.Properties; import java.util.Set; import java.util.TreeMap; -import org.eclipse.osgi.launch.EquinoxFactory; import org.osgi.framework.Bundle; import org.osgi.framework.BundleContext; import org.osgi.framework.BundleEvent; @@ -21,7 +20,6 @@ import org.osgi.framework.FrameworkUtil; import org.osgi.framework.InvalidSyntaxException; import org.osgi.framework.ServiceReference; import org.osgi.framework.launch.Framework; -import org.osgi.framework.launch.FrameworkFactory; import org.osgi.util.tracker.BundleTracker; import org.osgi.util.tracker.ServiceTracker; @@ -47,13 +45,7 @@ public class OsgiBuilder { public Framework launch() { // start OSGi - FrameworkFactory frameworkFactory = new EquinoxFactory(); - framework = frameworkFactory.newFramework(configuration); - try { - framework.start(); - } catch (BundleException e) { - throw new OsgiBootException("Cannot start OSGi framework", e); - } + framework = OsgiBootUtils.launch(configuration); BundleContext bc = framework.getBundleContext(); String osgiData = bc.getProperty(OsgiBoot.INSTANCE_AREA_PROP); @@ -156,13 +148,13 @@ public class OsgiBuilder { } } if (bundle == null) - throw new OsgiBootException("Bundle " + bundleSymbolicName + " not found"); + throw new IllegalStateException("Bundle " + bundleSymbolicName + " not found"); Class c = bundle.loadClass(clss); Object[] mainArgs = { args }; Method mainMethod = c.getMethod("main", String[].class); mainMethod.invoke(null, mainArgs); } catch (Throwable e) { - throw new OsgiBootException("Cannot execute " + clssUri, e); + throw new RuntimeException("Cannot execute " + clssUri, e); } return this; } @@ -300,12 +292,12 @@ public class OsgiBuilder { private void checkLaunched() { if (!isLaunched()) - throw new OsgiBootException("OSGi runtime is not launched"); + throw new IllegalStateException("OSGi runtime is not launched"); } private void checkNotLaunched() { if (isLaunched()) - throw new OsgiBootException("OSGi runtime already launched"); + throw new IllegalStateException("OSGi runtime already launched"); } private boolean isLaunched() { diff --git a/org.argeo.init/src/org/argeo/init/osgi/OsgiRuntimeContext.java b/org.argeo.init/src/org/argeo/init/osgi/OsgiRuntimeContext.java new file mode 100644 index 000000000..91756e32b --- /dev/null +++ b/org.argeo.init/src/org/argeo/init/osgi/OsgiRuntimeContext.java @@ -0,0 +1,52 @@ +package org.argeo.init.osgi; + +import java.util.Map; +import java.util.Optional; +import java.util.ServiceLoader; + +import org.argeo.init.RuntimeContext; +import org.osgi.framework.BundleContext; +import org.osgi.framework.BundleException; +import org.osgi.framework.launch.Framework; +import org.osgi.framework.launch.FrameworkFactory; + +public class OsgiRuntimeContext implements RuntimeContext { + private Map config; + private Framework framework; + private OsgiBoot osgiBoot; + + public OsgiRuntimeContext(Map config) { + this.config = config; + } + + @Override + public void run() { + ServiceLoader sl = ServiceLoader.load(FrameworkFactory.class); + Optional opt = sl.findFirst(); + if (opt.isEmpty()) + throw new IllegalStateException("Cannot find OSGi framework"); + framework = opt.get().newFramework(config); + try { + framework.start(); + BundleContext bundleContext = framework.getBundleContext(); + osgiBoot = new OsgiBoot(bundleContext); + osgiBoot.bootstrap(); + } catch (BundleException e) { + throw new IllegalStateException("Cannot start OSGi framework", e); + } + } + + @Override + public void waitForStop(long timeout) throws InterruptedException { + if (framework == null) + throw new IllegalStateException("Framework is not initialised"); + framework.waitForStop(timeout); + } + + @Override + public void close() throws Exception { + if (framework != null) + framework.stop(); + } + +} diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/log4j.properties b/org.argeo.init/src/org/argeo/init/osgi/log4j.properties similarity index 100% rename from org.argeo.osgi.boot/src/org/argeo/osgi/boot/log4j.properties rename to org.argeo.init/src/org/argeo/init/osgi/log4j.properties diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/node.policy b/org.argeo.init/src/org/argeo/init/osgi/node.policy similarity index 100% rename from org.argeo.osgi.boot/src/org/argeo/osgi/boot/node.policy rename to org.argeo.init/src/org/argeo/init/osgi/node.policy diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/package-info.java b/org.argeo.init/src/org/argeo/init/osgi/package-info.java similarity index 55% rename from org.argeo.osgi.boot/src/org/argeo/osgi/boot/package-info.java rename to org.argeo.init/src/org/argeo/init/osgi/package-info.java index 7474d13bf..993e246cd 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/package-info.java +++ b/org.argeo.init/src/org/argeo/init/osgi/package-info.java @@ -1,2 +1,2 @@ /** Simple OSGi initialisation. */ -package org.argeo.osgi.boot; \ No newline at end of file +package org.argeo.init.osgi; \ No newline at end of file diff --git a/org.argeo.osgi.boot/bnd.bnd b/org.argeo.osgi.boot/bnd.bnd deleted file mode 100644 index fd2b18cd1..000000000 --- a/org.argeo.osgi.boot/bnd.bnd +++ /dev/null @@ -1,8 +0,0 @@ -Main-Class: org.argeo.osgi.boot.Main -Class-Path: org.eclipse.osgi.jar - -Bundle-Activator: org.argeo.osgi.boot.Activator -Import-Package: org.eclipse.*;resolution:=optional,\ -org.eclipse.osgi.launch.*;resolution:=optional,\ -org.osgi.*;version=0.0.0,\ -* diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/OsgiBootException.java b/org.argeo.osgi.boot/src/org/argeo/osgi/boot/OsgiBootException.java deleted file mode 100644 index fd6bf6546..000000000 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/OsgiBootException.java +++ /dev/null @@ -1,18 +0,0 @@ -package org.argeo.osgi.boot; - -/** OsgiBoot specific exceptions */ -class OsgiBootException extends RuntimeException { - private static final long serialVersionUID = 2414011711711425353L; - - public OsgiBootException() { - } - - public OsgiBootException(String message) { - super(message); - } - - public OsgiBootException(String message, Throwable e) { - super(message, e); - } - -} diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/equinox/EquinoxUtils.java b/org.argeo.osgi.boot/src/org/argeo/osgi/boot/equinox/EquinoxUtils.java deleted file mode 100644 index 55cd067b9..000000000 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/equinox/EquinoxUtils.java +++ /dev/null @@ -1,22 +0,0 @@ -package org.argeo.osgi.boot.equinox; - -import java.util.Map; - -import org.argeo.osgi.boot.OsgiBootUtils; -import org.eclipse.osgi.launch.EquinoxFactory; -import org.osgi.framework.launch.Framework; - -/** - * Utilities with a dependency to the Equinox OSGi runtime or its configuration. - */ -public class EquinoxUtils { - - public static Framework launch(Map configuration) { - return OsgiBootUtils.launch(new EquinoxFactory(), configuration); - } - - /** Singleton. */ - private EquinoxUtils() { - - } -} diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/equinox/package-info.java b/org.argeo.osgi.boot/src/org/argeo/osgi/boot/equinox/package-info.java deleted file mode 100644 index b503752bf..000000000 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/equinox/package-info.java +++ /dev/null @@ -1,2 +0,0 @@ -/** Simple Eclipse Equinox initialisation. */ -package org.argeo.osgi.boot.equinox; \ No newline at end of file diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/AntPathMatcher.java b/org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/AntPathMatcher.java deleted file mode 100644 index e3fc6c299..000000000 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/AntPathMatcher.java +++ /dev/null @@ -1,411 +0,0 @@ -/* - * Copyright 2002-2007 the original author or authors. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.argeo.osgi.boot.internal.springutil; - -/** - * PathMatcher implementation for Ant-style path patterns. - * Examples are provided below. - * - *

Part of this mapping code has been kindly borrowed from - * Apache Ant. - * - *

The mapping matches URLs using the following rules:
- *

    - *
  • ? matches one character
    • - *
  • * matches zero or more characters
    • - *
  • ** matches zero or more 'directories' in a path
    • - *
- * - *

Some examples:
- *

    - *
  • com/t?st.jsp - matches com/test.jsp but also - * com/tast.jsp or com/txst.jsp
    • - *
  • com/*.jsp - matches all .jsp files in the - * com directory
    • - *
  • com/**/test.jsp - matches all test.jsp - * files underneath the com path
    • - *
  • org/springframework/**/*.jsp - matches all .jsp - * files underneath the org/springframework path
    • - *
  • org/**/servlet/bla.jsp - matches - * org/springframework/servlet/bla.jsp but also - * org/springframework/testing/servlet/bla.jsp and - * org/servlet/bla.jsp
    • - *
- * - * @author Alef Arendsen - * @author Juergen Hoeller - * @author Rob Harrop - * @since 16.07.2003 - */ -public class AntPathMatcher implements PathMatcher { - - /** Default path separator: "/" */ - public static final String DEFAULT_PATH_SEPARATOR = "/"; - - private String pathSeparator = DEFAULT_PATH_SEPARATOR; - - - /** - * Set the path separator to use for pattern parsing. - * Default is "/", as in Ant. - */ - public void setPathSeparator(String pathSeparator) { - this.pathSeparator = (pathSeparator != null ? pathSeparator : DEFAULT_PATH_SEPARATOR); - } - - - public boolean isPattern(String path) { - return (path.indexOf('*') != -1 || path.indexOf('?') != -1); - } - - public boolean match(String pattern, String path) { - return doMatch(pattern, path, true); - } - - public boolean matchStart(String pattern, String path) { - return doMatch(pattern, path, false); - } - - - /** - * Actually match the given path against the given pattern. - * @param pattern the pattern to match against - * @param path the path String to test - * @param fullMatch whether a full pattern match is required - * (else a pattern match as far as the given base path goes is sufficient) - * @return true if the supplied path matched, - * false if it didn't - */ - protected boolean doMatch(String pattern, String path, boolean fullMatch) { - if (path.startsWith(this.pathSeparator) != pattern.startsWith(this.pathSeparator)) { - return false; - } - - String[] pattDirs = StringUtils.tokenizeToStringArray(pattern, this.pathSeparator); - String[] pathDirs = StringUtils.tokenizeToStringArray(path, this.pathSeparator); - - int pattIdxStart = 0; - int pattIdxEnd = pattDirs.length - 1; - int pathIdxStart = 0; - int pathIdxEnd = pathDirs.length - 1; - - // Match all elements up to the first ** - while (pattIdxStart <= pattIdxEnd && pathIdxStart <= pathIdxEnd) { - String patDir = pattDirs[pattIdxStart]; - if ("**".equals(patDir)) { - break; - } - if (!matchStrings(patDir, pathDirs[pathIdxStart])) { - return false; - } - pattIdxStart++; - pathIdxStart++; - } - - if (pathIdxStart > pathIdxEnd) { - // Path is exhausted, only match if rest of pattern is * or **'s - if (pattIdxStart > pattIdxEnd) { - return (pattern.endsWith(this.pathSeparator) ? - path.endsWith(this.pathSeparator) : !path.endsWith(this.pathSeparator)); - } - if (!fullMatch) { - return true; - } - if (pattIdxStart == pattIdxEnd && pattDirs[pattIdxStart].equals("*") && - path.endsWith(this.pathSeparator)) { - return true; - } - for (int i = pattIdxStart; i <= pattIdxEnd; i++) { - if (!pattDirs[i].equals("**")) { - return false; - } - } - return true; - } - else if (pattIdxStart > pattIdxEnd) { - // String not exhausted, but pattern is. Failure. - return false; - } - else if (!fullMatch && "**".equals(pattDirs[pattIdxStart])) { - // Path start definitely matches due to "**" part in pattern. - return true; - } - - // up to last '**' - while (pattIdxStart <= pattIdxEnd && pathIdxStart <= pathIdxEnd) { - String patDir = pattDirs[pattIdxEnd]; - if (patDir.equals("**")) { - break; - } - if (!matchStrings(patDir, pathDirs[pathIdxEnd])) { - return false; - } - pattIdxEnd--; - pathIdxEnd--; - } - if (pathIdxStart > pathIdxEnd) { - // String is exhausted - for (int i = pattIdxStart; i <= pattIdxEnd; i++) { - if (!pattDirs[i].equals("**")) { - return false; - } - } - return true; - } - - while (pattIdxStart != pattIdxEnd && pathIdxStart <= pathIdxEnd) { - int patIdxTmp = -1; - for (int i = pattIdxStart + 1; i <= pattIdxEnd; i++) { - if (pattDirs[i].equals("**")) { - patIdxTmp = i; - break; - } - } - if (patIdxTmp == pattIdxStart + 1) { - // '**/**' situation, so skip one - pattIdxStart++; - continue; - } - // Find the pattern between padIdxStart & padIdxTmp in str between - // strIdxStart & strIdxEnd - int patLength = (patIdxTmp - pattIdxStart - 1); - int strLength = (pathIdxEnd - pathIdxStart + 1); - int foundIdx = -1; - - strLoop: - for (int i = 0; i <= strLength - patLength; i++) { - for (int j = 0; j < patLength; j++) { - String subPat = (String) pattDirs[pattIdxStart + j + 1]; - String subStr = (String) pathDirs[pathIdxStart + i + j]; - if (!matchStrings(subPat, subStr)) { - continue strLoop; - } - } - foundIdx = pathIdxStart + i; - break; - } - - if (foundIdx == -1) { - return false; - } - - pattIdxStart = patIdxTmp; - pathIdxStart = foundIdx + patLength; - } - - for (int i = pattIdxStart; i <= pattIdxEnd; i++) { - if (!pattDirs[i].equals("**")) { - return false; - } - } - - return true; - } - - /** - * Tests whether or not a string matches against a pattern. - * The pattern may contain two special characters:
- * '*' means zero or more characters
- * '?' means one and only one character - * @param pattern pattern to match against. - * Must not be null. - * @param str string which must be matched against the pattern. - * Must not be null. - * @return true if the string matches against the - * pattern, or false otherwise. - */ - private boolean matchStrings(String pattern, String str) { - char[] patArr = pattern.toCharArray(); - char[] strArr = str.toCharArray(); - int patIdxStart = 0; - int patIdxEnd = patArr.length - 1; - int strIdxStart = 0; - int strIdxEnd = strArr.length - 1; - char ch; - - boolean containsStar = false; - for (int i = 0; i < patArr.length; i++) { - if (patArr[i] == '*') { - containsStar = true; - break; - } - } - - if (!containsStar) { - // No '*'s, so we make a shortcut - if (patIdxEnd != strIdxEnd) { - return false; // Pattern and string do not have the same size - } - for (int i = 0; i <= patIdxEnd; i++) { - ch = patArr[i]; - if (ch != '?') { - if (ch != strArr[i]) { - return false;// Character mismatch - } - } - } - return true; // String matches against pattern - } - - - if (patIdxEnd == 0) { - return true; // Pattern contains only '*', which matches anything - } - - // Process characters before first star - while ((ch = patArr[patIdxStart]) != '*' && strIdxStart <= strIdxEnd) { - if (ch != '?') { - if (ch != strArr[strIdxStart]) { - return false;// Character mismatch - } - } - patIdxStart++; - strIdxStart++; - } - if (strIdxStart > strIdxEnd) { - // All characters in the string are used. Check if only '*'s are - // left in the pattern. If so, we succeeded. Otherwise failure. - for (int i = patIdxStart; i <= patIdxEnd; i++) { - if (patArr[i] != '*') { - return false; - } - } - return true; - } - - // Process characters after last star - while ((ch = patArr[patIdxEnd]) != '*' && strIdxStart <= strIdxEnd) { - if (ch != '?') { - if (ch != strArr[strIdxEnd]) { - return false;// Character mismatch - } - } - patIdxEnd--; - strIdxEnd--; - } - if (strIdxStart > strIdxEnd) { - // All characters in the string are used. Check if only '*'s are - // left in the pattern. If so, we succeeded. Otherwise failure. - for (int i = patIdxStart; i <= patIdxEnd; i++) { - if (patArr[i] != '*') { - return false; - } - } - return true; - } - - // process pattern between stars. padIdxStart and patIdxEnd point - // always to a '*'. - while (patIdxStart != patIdxEnd && strIdxStart <= strIdxEnd) { - int patIdxTmp = -1; - for (int i = patIdxStart + 1; i <= patIdxEnd; i++) { - if (patArr[i] == '*') { - patIdxTmp = i; - break; - } - } - if (patIdxTmp == patIdxStart + 1) { - // Two stars next to each other, skip the first one. - patIdxStart++; - continue; - } - // Find the pattern between padIdxStart & padIdxTmp in str between - // strIdxStart & strIdxEnd - int patLength = (patIdxTmp - patIdxStart - 1); - int strLength = (strIdxEnd - strIdxStart + 1); - int foundIdx = -1; - strLoop: - for (int i = 0; i <= strLength - patLength; i++) { - for (int j = 0; j < patLength; j++) { - ch = patArr[patIdxStart + j + 1]; - if (ch != '?') { - if (ch != strArr[strIdxStart + i + j]) { - continue strLoop; - } - } - } - - foundIdx = strIdxStart + i; - break; - } - - if (foundIdx == -1) { - return false; - } - - patIdxStart = patIdxTmp; - strIdxStart = foundIdx + patLength; - } - - // All characters in the string are used. Check if only '*'s are left - // in the pattern. If so, we succeeded. Otherwise failure. - for (int i = patIdxStart; i <= patIdxEnd; i++) { - if (patArr[i] != '*') { - return false; - } - } - - return true; - } - - /** - * Given a pattern and a full path, determine the pattern-mapped part. - *

For example: - *

    - *
  • '/docs/cvs/commit.html' and '/docs/cvs/commit.html to ''
    • - *
  • '/docs/*' and '/docs/cvs/commit to 'cvs/commit'
    • - *
  • '/docs/cvs/*.html' and '/docs/cvs/commit.html to 'commit.html'
    • - *
  • '/docs/**' and '/docs/cvs/commit to 'cvs/commit'
    • - *
  • '/docs/**\/*.html' and '/docs/cvs/commit.html to 'cvs/commit.html'
    • - *
  • '/*.html' and '/docs/cvs/commit.html to 'docs/cvs/commit.html'
    • - *
  • '*.html' and '/docs/cvs/commit.html to '/docs/cvs/commit.html'
    • - *
  • '*' and '/docs/cvs/commit.html to '/docs/cvs/commit.html'
    • - *
- *

Assumes that {@link #match} returns true for 'pattern' - * and 'path', but does not enforce this. - */ - public String extractPathWithinPattern(String pattern, String path) { - String[] patternParts = StringUtils.tokenizeToStringArray(pattern, this.pathSeparator); - String[] pathParts = StringUtils.tokenizeToStringArray(path, this.pathSeparator); - - StringBuffer buffer = new StringBuffer(); - - // Add any path parts that have a wildcarded pattern part. - int puts = 0; - for (int i = 0; i < patternParts.length; i++) { - String patternPart = patternParts[i]; - if ((patternPart.indexOf('*') > -1 || patternPart.indexOf('?') > -1) && pathParts.length >= i + 1) { - if (puts > 0 || (i == 0 && !pattern.startsWith(this.pathSeparator))) { - buffer.append(this.pathSeparator); - } - buffer.append(pathParts[i]); - puts++; - } - } - - // Append any trailing path parts. - for (int i = patternParts.length; i < pathParts.length; i++) { - if (puts > 0 || i > 0) { - buffer.append(this.pathSeparator); - } - buffer.append(pathParts[i]); - } - - return buffer.toString(); - } - -} diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/Bootstrap.java b/org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/Bootstrap.java deleted file mode 100644 index 2ac4562c8..000000000 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/Bootstrap.java +++ /dev/null @@ -1,101 +0,0 @@ -package org.argeo.osgi.boot.internal.springutil; - -import java.io.InputStream; -import java.lang.reflect.Method; -import java.net.URL; -import java.net.URLClassLoader; -import java.nio.file.Files; -import java.nio.file.Path; -import java.nio.file.Paths; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -public class Bootstrap { - - public static void main(String[] args) { - try { - String configurationArea = "file:" + System.getProperty("user.dir") + "/state"; - String instanceArea = "file:" + System.getProperty("user.dir") + "/data"; - String log4jUrl = "file:" + System.getProperty("user.dir") + "/log4j.properties"; - - System.setProperty("org.osgi.service.http.port", "7070"); - System.setProperty("log4j.configuration", log4jUrl); - - System.setProperty("osgi.console", "2323"); - Map props = new HashMap(); - props.put("osgi.clean", "true"); -// props.put("osgi.console", "2323"); - props.put("osgi.configuration.area", configurationArea); - props.put("osgi.instance.area", instanceArea); - - System.setProperty("argeo.osgi.start.2.node", - "org.eclipse.equinox.console,org.eclipse.equinox.http.servlet,org.eclipse.equinox.ds," - + "org.eclipse.equinox.metatype,org.eclipse.equinox.cm,org.eclipse.rap.rwt.osgi"); - System.setProperty("argeo.osgi.start.3.node", "org.argeo.cms"); - - // URL osgiJar = - // Bootstrap.class.getClassLoader().getResource("/usr/share/osgi/boot/org.eclipse.org.jar"); - URL osgiJar = new URL( - "file:///home/mbaudier/dev/git/apache2/argeo-commons/demo/exec/cms-e4-rap/backup/share/osgi/boot/org.eclipse.org.jar"); - URL osgiBootJar = new URL( - "file:///home/mbaudier/dev/git/apache2/argeo-commons/demo/exec/cms-e4-rap/backup/share/osgi/boot/org.argeo.osgi.boot.jar"); - URL[] jarUrls = { osgiJar }; - try (URLClassLoader urlCl = new URLClassLoader(jarUrls)) { - - // Class factoryClass = - // urlCl.loadClass("/org/eclipse/osgi/launch/EquinoxFactory"); - Class factoryClass = urlCl.loadClass("org.eclipse.osgi.launch.EquinoxFactory"); - Class frameworkClass = urlCl.loadClass("org.osgi.framework.launch.Framework"); - Class bundleContextClass = urlCl.loadClass("org.osgi.framework.BundleContext"); - Class bundleClass = urlCl.loadClass("org.osgi.framework.Bundle"); - - Object factory = factoryClass.getConstructor().newInstance(); - Method newFrameworkMethod = factoryClass.getMethod("newFramework", Map.class); - Object framework = newFrameworkMethod.invoke(factory, props); - Method startFramework = frameworkClass.getMethod("start", new Class[] {}); - startFramework.invoke(framework); - Method getBundleContext = frameworkClass.getMethod("getBundleContext", new Class[] {}); - Object bundleContext = getBundleContext.invoke(framework); - Class[] installArgs = { String.class, InputStream.class }; - Method install = bundleContextClass.getMethod("installBundle", installArgs); - Method startBundle = bundleClass.getMethod("start"); - Method getSymbolicName = bundleClass.getMethod("getSymbolicName"); - - Path basePath = Paths.get( - "/home/mbaudier/dev/git/apache2/argeo-commons/demo/exec/cms-e4-rap/backup/share/osgi/boot/"); - List bundles = new ArrayList<>(); - for (Path p : Files.newDirectoryStream(basePath)) { - try (InputStream in = Files.newInputStream(p)) { - Object bundle = install.invoke(bundleContext, "file:" + p, in); - bundles.add(bundle); - System.out.println("Installed " + bundle); - } catch (Exception e) { - if (!p.getFileName().toString().startsWith("org.eclipse.osgi")) { - System.err.println(p); - e.printStackTrace(); - } - } - } - -// for (Object bundle : bundles) { -// try { -// String symbolicName = getSymbolicName.invoke(bundle).toString(); -// startBundle.invoke(bundle); -// } catch (Exception e) { -// // TODO Auto-generated catch block -// e.printStackTrace(); -// } -// } - - Object osgiBootBundle = install.invoke(bundleContext, osgiBootJar.toString(), osgiBootJar.openStream()); - startBundle.invoke(osgiBootBundle); - } - } catch (Exception e) { - e.printStackTrace(); - } - - } - -} diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/CollectionUtils.java b/org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/CollectionUtils.java deleted file mode 100644 index 18cbe16ef..000000000 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/CollectionUtils.java +++ /dev/null @@ -1,276 +0,0 @@ -/* - * Copyright 2002-2008 the original author or authors. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.argeo.osgi.boot.internal.springutil; - -import java.util.Arrays; -import java.util.Collection; -import java.util.Enumeration; -import java.util.Iterator; -import java.util.List; -import java.util.Map; -import java.util.Properties; - -/** - * Miscellaneous collection utility methods. - * Mainly for internal use within the framework. - * - * @author Juergen Hoeller - * @author Rob Harrop - * @since 1.1.3 - */ -@SuppressWarnings({ "rawtypes", "unchecked" }) -public abstract class CollectionUtils { - - /** - * Return true if the supplied Collection is null - * or empty. Otherwise, return false. - * @param collection the Collection to check - * @return whether the given Collection is empty - */ - public static boolean isEmpty(Collection collection) { - return (collection == null || collection.isEmpty()); - } - - /** - * Return true if the supplied Map is null - * or empty. Otherwise, return false. - * @param map the Map to check - * @return whether the given Map is empty - */ - public static boolean isEmpty(Map map) { - return (map == null || map.isEmpty()); - } - - /** - * Convert the supplied array into a List. A primitive array gets - * converted into a List of the appropriate wrapper type. - *

A null source value will be converted to an - * empty List. - * @param source the (potentially primitive) array - * @return the converted List result - * @see ObjectUtils#toObjectArray(Object) - */ - public static List arrayToList(Object source) { - return Arrays.asList(ObjectUtils.toObjectArray(source)); - } - - /** - * Merge the given array into the given Collection. - * @param array the array to merge (may be null) - * @param collection the target Collection to merge the array into - */ - public static void mergeArrayIntoCollection(Object array, Collection collection) { - if (collection == null) { - throw new IllegalArgumentException("Collection must not be null"); - } - Object[] arr = ObjectUtils.toObjectArray(array); - for (int i = 0; i < arr.length; i++) { - collection.add(arr[i]); - } - } - - /** - * Merge the given Properties instance into the given Map, - * copying all properties (key-value pairs) over. - *

Uses Properties.propertyNames() to even catch - * default properties linked into the original Properties instance. - * @param props the Properties instance to merge (may be null) - * @param map the target Map to merge the properties into - */ - public static void mergePropertiesIntoMap(Properties props, Map map) { - if (map == null) { - throw new IllegalArgumentException("Map must not be null"); - } - if (props != null) { - for (Enumeration en = props.propertyNames(); en.hasMoreElements();) { - String key = (String) en.nextElement(); - map.put(key, props.getProperty(key)); - } - } - } - - - /** - * Check whether the given Iterator contains the given element. - * @param iterator the Iterator to check - * @param element the element to look for - * @return true if found, false else - */ - public static boolean contains(Iterator iterator, Object element) { - if (iterator != null) { - while (iterator.hasNext()) { - Object candidate = iterator.next(); - if (ObjectUtils.nullSafeEquals(candidate, element)) { - return true; - } - } - } - return false; - } - - /** - * Check whether the given Enumeration contains the given element. - * @param enumeration the Enumeration to check - * @param element the element to look for - * @return true if found, false else - */ - public static boolean contains(Enumeration enumeration, Object element) { - if (enumeration != null) { - while (enumeration.hasMoreElements()) { - Object candidate = enumeration.nextElement(); - if (ObjectUtils.nullSafeEquals(candidate, element)) { - return true; - } - } - } - return false; - } - - /** - * Check whether the given Collection contains the given element instance. - *

Enforces the given instance to be present, rather than returning - * true for an equal element as well. - * @param collection the Collection to check - * @param element the element to look for - * @return true if found, false else - */ - public static boolean containsInstance(Collection collection, Object element) { - if (collection != null) { - for (Iterator it = collection.iterator(); it.hasNext();) { - Object candidate = it.next(); - if (candidate == element) { - return true; - } - } - } - return false; - } - - /** - * Return true if any element in 'candidates' is - * contained in 'source'; otherwise returns false. - * @param source the source Collection - * @param candidates the candidates to search for - * @return whether any of the candidates has been found - */ - public static boolean containsAny(Collection source, Collection candidates) { - if (isEmpty(source) || isEmpty(candidates)) { - return false; - } - for (Iterator it = candidates.iterator(); it.hasNext();) { - if (source.contains(it.next())) { - return true; - } - } - return false; - } - - /** - * Return the first element in 'candidates' that is contained in - * 'source'. If no element in 'candidates' is present in - * 'source' returns null. Iteration order is - * {@link Collection} implementation specific. - * @param source the source Collection - * @param candidates the candidates to search for - * @return the first present object, or null if not found - */ - public static Object findFirstMatch(Collection source, Collection candidates) { - if (isEmpty(source) || isEmpty(candidates)) { - return null; - } - for (Iterator it = candidates.iterator(); it.hasNext();) { - Object candidate = it.next(); - if (source.contains(candidate)) { - return candidate; - } - } - return null; - } - - /** - * Find a single value of the given type in the given Collection. - * @param collection the Collection to search - * @param type the type to look for - * @return a value of the given type found if there is a clear match, - * or null if none or more than one such value found - */ - public static Object findValueOfType(Collection collection, Class type) { - if (isEmpty(collection)) { - return null; - } - Object value = null; - for (Iterator it = collection.iterator(); it.hasNext();) { - Object obj = it.next(); - if (type == null || type.isInstance(obj)) { - if (value != null) { - // More than one value found... no clear single value. - return null; - } - value = obj; - } - } - return value; - } - - /** - * Find a single value of one of the given types in the given Collection: - * searching the Collection for a value of the first type, then - * searching for a value of the second type, etc. - * @param collection the collection to search - * @param types the types to look for, in prioritized order - * @return a value of one of the given types found if there is a clear match, - * or null if none or more than one such value found - */ - public static Object findValueOfType(Collection collection, Class[] types) { - if (isEmpty(collection) || ObjectUtils.isEmpty(types)) { - return null; - } - for (int i = 0; i < types.length; i++) { - Object value = findValueOfType(collection, types[i]); - if (value != null) { - return value; - } - } - return null; - } - - /** - * Determine whether the given Collection only contains a single unique object. - * @param collection the Collection to check - * @return true if the collection contains a single reference or - * multiple references to the same instance, false else - */ - public static boolean hasUniqueObject(Collection collection) { - if (isEmpty(collection)) { - return false; - } - boolean hasCandidate = false; - Object candidate = null; - for (Iterator it = collection.iterator(); it.hasNext();) { - Object elem = it.next(); - if (!hasCandidate) { - hasCandidate = true; - candidate = elem; - } - else if (candidate != elem) { - return false; - } - } - return true; - } - -} diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/ObjectUtils.java b/org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/ObjectUtils.java deleted file mode 100644 index 2c98b465c..000000000 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/ObjectUtils.java +++ /dev/null @@ -1,833 +0,0 @@ -/* - * Copyright 2002-2007 the original author or authors. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.argeo.osgi.boot.internal.springutil; - -import java.lang.reflect.Array; -import java.util.Arrays; - -/** - * Miscellaneous object utility methods. Mainly for internal use within the - * framework; consider Jakarta's Commons Lang for a more comprehensive suite - * of object utilities. - * - * @author Juergen Hoeller - * @author Keith Donald - * @author Rod Johnson - * @author Rob Harrop - * @author Alex Ruiz - * @since 19.03.2004 - */ -@SuppressWarnings({ "rawtypes", "unchecked" }) -public abstract class ObjectUtils { - - private static final int INITIAL_HASH = 7; - private static final int MULTIPLIER = 31; - - private static final String EMPTY_STRING = ""; - private static final String NULL_STRING = "null"; - private static final String ARRAY_START = "{"; - private static final String ARRAY_END = "}"; - private static final String EMPTY_ARRAY = ARRAY_START + ARRAY_END; - private static final String ARRAY_ELEMENT_SEPARATOR = ", "; - - - /** - * Return whether the given throwable is a checked exception: - * that is, neither a RuntimeException nor an Error. - * @param ex the throwable to check - * @return whether the throwable is a checked exception - * @see java.lang.Exception - * @see java.lang.RuntimeException - * @see java.lang.Error - */ - public static boolean isCheckedException(Throwable ex) { - return !(ex instanceof RuntimeException || ex instanceof Error); - } - - /** - * Check whether the given exception is compatible with the exceptions - * declared in a throws clause. - * @param ex the exception to checked - * @param declaredExceptions the exceptions declared in the throws clause - * @return whether the given exception is compatible - */ - public static boolean isCompatibleWithThrowsClause(Throwable ex, Class[] declaredExceptions) { - if (!isCheckedException(ex)) { - return true; - } - if (declaredExceptions != null) { - for (int i = 0; i < declaredExceptions.length; i++) { - if (declaredExceptions[i].isAssignableFrom(ex.getClass())) { - return true; - } - } - } - return false; - } - - /** - * Return whether the given array is empty: that is, null - * or of zero length. - * @param array the array to check - * @return whether the given array is empty - */ - public static boolean isEmpty(Object[] array) { - return (array == null || array.length == 0); - } - - /** - * Check whether the given array contains the given element. - * @param array the array to check (may be null, - * in which case the return value will always be false) - * @param element the element to check for - * @return whether the element has been found in the given array - */ - public static boolean containsElement(Object[] array, Object element) { - if (array == null) { - return false; - } - for (int i = 0; i < array.length; i++) { - if (nullSafeEquals(array[i], element)) { - return true; - } - } - return false; - } - - /** - * Append the given Object to the given array, returning a new array - * consisting of the input array contents plus the given Object. - * @param array the array to append to (can be null) - * @param obj the Object to append - * @return the new array (of the same component type; never null) - */ - public static Object[] addObjectToArray(Object[] array, Object obj) { - Class compType = Object.class; - if (array != null) { - compType = array.getClass().getComponentType(); - } - else if (obj != null) { - compType = obj.getClass(); - } - int newArrLength = (array != null ? array.length + 1 : 1); - Object[] newArr = (Object[]) Array.newInstance(compType, newArrLength); - if (array != null) { - System.arraycopy(array, 0, newArr, 0, array.length); - } - newArr[newArr.length - 1] = obj; - return newArr; - } - - /** - * Convert the given array (which may be a primitive array) to an - * object array (if necessary of primitive wrapper objects). - *

A null source value will be converted to an - * empty Object array. - * @param source the (potentially primitive) array - * @return the corresponding object array (never null) - * @throws IllegalArgumentException if the parameter is not an array - */ - public static Object[] toObjectArray(Object source) { - if (source instanceof Object[]) { - return (Object[]) source; - } - if (source == null) { - return new Object[0]; - } - if (!source.getClass().isArray()) { - throw new IllegalArgumentException("Source is not an array: " + source); - } - int length = Array.getLength(source); - if (length == 0) { - return new Object[0]; - } - Class wrapperType = Array.get(source, 0).getClass(); - Object[] newArray = (Object[]) Array.newInstance(wrapperType, length); - for (int i = 0; i < length; i++) { - newArray[i] = Array.get(source, i); - } - return newArray; - } - - - //--------------------------------------------------------------------- - // Convenience methods for content-based equality/hash-code handling - //--------------------------------------------------------------------- - - /** - * Determine if the given objects are equal, returning true - * if both are null or false if only one is - * null. - *

Compares arrays with Arrays.equals, performing an equality - * check based on the array elements rather than the array reference. - * @param o1 first Object to compare - * @param o2 second Object to compare - * @return whether the given objects are equal - * @see java.util.Arrays#equals - */ - public static boolean nullSafeEquals(Object o1, Object o2) { - if (o1 == o2) { - return true; - } - if (o1 == null || o2 == null) { - return false; - } - if (o1.equals(o2)) { - return true; - } - if (o1.getClass().isArray() && o2.getClass().isArray()) { - if (o1 instanceof Object[] && o2 instanceof Object[]) { - return Arrays.equals((Object[]) o1, (Object[]) o2); - } - if (o1 instanceof boolean[] && o2 instanceof boolean[]) { - return Arrays.equals((boolean[]) o1, (boolean[]) o2); - } - if (o1 instanceof byte[] && o2 instanceof byte[]) { - return Arrays.equals((byte[]) o1, (byte[]) o2); - } - if (o1 instanceof char[] && o2 instanceof char[]) { - return Arrays.equals((char[]) o1, (char[]) o2); - } - if (o1 instanceof double[] && o2 instanceof double[]) { - return Arrays.equals((double[]) o1, (double[]) o2); - } - if (o1 instanceof float[] && o2 instanceof float[]) { - return Arrays.equals((float[]) o1, (float[]) o2); - } - if (o1 instanceof int[] && o2 instanceof int[]) { - return Arrays.equals((int[]) o1, (int[]) o2); - } - if (o1 instanceof long[] && o2 instanceof long[]) { - return Arrays.equals((long[]) o1, (long[]) o2); - } - if (o1 instanceof short[] && o2 instanceof short[]) { - return Arrays.equals((short[]) o1, (short[]) o2); - } - } - return false; - } - - /** - * Return as hash code for the given object; typically the value of - * {@link Object#hashCode()}. If the object is an array, - * this method will delegate to any of the nullSafeHashCode - * methods for arrays in this class. If the object is null, - * this method returns 0. - * @see #nullSafeHashCode(Object[]) - * @see #nullSafeHashCode(boolean[]) - * @see #nullSafeHashCode(byte[]) - * @see #nullSafeHashCode(char[]) - * @see #nullSafeHashCode(double[]) - * @see #nullSafeHashCode(float[]) - * @see #nullSafeHashCode(int[]) - * @see #nullSafeHashCode(long[]) - * @see #nullSafeHashCode(short[]) - */ - public static int nullSafeHashCode(Object obj) { - if (obj == null) { - return 0; - } - if (obj.getClass().isArray()) { - if (obj instanceof Object[]) { - return nullSafeHashCode((Object[]) obj); - } - if (obj instanceof boolean[]) { - return nullSafeHashCode((boolean[]) obj); - } - if (obj instanceof byte[]) { - return nullSafeHashCode((byte[]) obj); - } - if (obj instanceof char[]) { - return nullSafeHashCode((char[]) obj); - } - if (obj instanceof double[]) { - return nullSafeHashCode((double[]) obj); - } - if (obj instanceof float[]) { - return nullSafeHashCode((float[]) obj); - } - if (obj instanceof int[]) { - return nullSafeHashCode((int[]) obj); - } - if (obj instanceof long[]) { - return nullSafeHashCode((long[]) obj); - } - if (obj instanceof short[]) { - return nullSafeHashCode((short[]) obj); - } - } - return obj.hashCode(); - } - - /** - * Return a hash code based on the contents of the specified array. - * If array is null, this method returns 0. - */ - public static int nullSafeHashCode(Object[] array) { - if (array == null) { - return 0; - } - int hash = INITIAL_HASH; - int arraySize = array.length; - for (int i = 0; i < arraySize; i++) { - hash = MULTIPLIER * hash + nullSafeHashCode(array[i]); - } - return hash; - } - - /** - * Return a hash code based on the contents of the specified array. - * If array is null, this method returns 0. - */ - public static int nullSafeHashCode(boolean[] array) { - if (array == null) { - return 0; - } - int hash = INITIAL_HASH; - int arraySize = array.length; - for (int i = 0; i < arraySize; i++) { - hash = MULTIPLIER * hash + hashCode(array[i]); - } - return hash; - } - - /** - * Return a hash code based on the contents of the specified array. - * If array is null, this method returns 0. - */ - public static int nullSafeHashCode(byte[] array) { - if (array == null) { - return 0; - } - int hash = INITIAL_HASH; - int arraySize = array.length; - for (int i = 0; i < arraySize; i++) { - hash = MULTIPLIER * hash + array[i]; - } - return hash; - } - - /** - * Return a hash code based on the contents of the specified array. - * If array is null, this method returns 0. - */ - public static int nullSafeHashCode(char[] array) { - if (array == null) { - return 0; - } - int hash = INITIAL_HASH; - int arraySize = array.length; - for (int i = 0; i < arraySize; i++) { - hash = MULTIPLIER * hash + array[i]; - } - return hash; - } - - /** - * Return a hash code based on the contents of the specified array. - * If array is null, this method returns 0. - */ - public static int nullSafeHashCode(double[] array) { - if (array == null) { - return 0; - } - int hash = INITIAL_HASH; - int arraySize = array.length; - for (int i = 0; i < arraySize; i++) { - hash = MULTIPLIER * hash + hashCode(array[i]); - } - return hash; - } - - /** - * Return a hash code based on the contents of the specified array. - * If array is null, this method returns 0. - */ - public static int nullSafeHashCode(float[] array) { - if (array == null) { - return 0; - } - int hash = INITIAL_HASH; - int arraySize = array.length; - for (int i = 0; i < arraySize; i++) { - hash = MULTIPLIER * hash + hashCode(array[i]); - } - return hash; - } - - /** - * Return a hash code based on the contents of the specified array. - * If array is null, this method returns 0. - */ - public static int nullSafeHashCode(int[] array) { - if (array == null) { - return 0; - } - int hash = INITIAL_HASH; - int arraySize = array.length; - for (int i = 0; i < arraySize; i++) { - hash = MULTIPLIER * hash + array[i]; - } - return hash; - } - - /** - * Return a hash code based on the contents of the specified array. - * If array is null, this method returns 0. - */ - public static int nullSafeHashCode(long[] array) { - if (array == null) { - return 0; - } - int hash = INITIAL_HASH; - int arraySize = array.length; - for (int i = 0; i < arraySize; i++) { - hash = MULTIPLIER * hash + hashCode(array[i]); - } - return hash; - } - - /** - * Return a hash code based on the contents of the specified array. - * If array is null, this method returns 0. - */ - public static int nullSafeHashCode(short[] array) { - if (array == null) { - return 0; - } - int hash = INITIAL_HASH; - int arraySize = array.length; - for (int i = 0; i < arraySize; i++) { - hash = MULTIPLIER * hash + array[i]; - } - return hash; - } - - /** - * Return the same value as {@link Boolean#hashCode()}. - * @see Boolean#hashCode() - */ - public static int hashCode(boolean bool) { - return bool ? 1231 : 1237; - } - - /** - * Return the same value as {@link Double#hashCode()}. - * @see Double#hashCode() - */ - public static int hashCode(double dbl) { - long bits = Double.doubleToLongBits(dbl); - return hashCode(bits); - } - - /** - * Return the same value as {@link Float#hashCode()}. - * @see Float#hashCode() - */ - public static int hashCode(float flt) { - return Float.floatToIntBits(flt); - } - - /** - * Return the same value as {@link Long#hashCode()}. - * @see Long#hashCode() - */ - public static int hashCode(long lng) { - return (int) (lng ^ (lng >>> 32)); - } - - - //--------------------------------------------------------------------- - // Convenience methods for toString output - //--------------------------------------------------------------------- - - /** - * Return a String representation of an object's overall identity. - * @param obj the object (may be null) - * @return the object's identity as String representation, - * or an empty String if the object was null - */ - public static String identityToString(Object obj) { - if (obj == null) { - return EMPTY_STRING; - } - return obj.getClass().getName() + "@" + getIdentityHexString(obj); - } - - /** - * Return a hex String form of an object's identity hash code. - * @param obj the object - * @return the object's identity code in hex notation - */ - public static String getIdentityHexString(Object obj) { - return Integer.toHexString(System.identityHashCode(obj)); - } - - /** - * Return a content-based String representation if obj is - * not null; otherwise returns an empty String. - *

Differs from {@link #nullSafeToString(Object)} in that it returns - * an empty String rather than "null" for a null value. - * @param obj the object to build a display String for - * @return a display String representation of obj - * @see #nullSafeToString(Object) - */ - public static String getDisplayString(Object obj) { - if (obj == null) { - return EMPTY_STRING; - } - return nullSafeToString(obj); - } - - /** - * Determine the class name for the given object. - *

Returns "null" if obj is null. - * @param obj the object to introspect (may be null) - * @return the corresponding class name - */ - public static String nullSafeClassName(Object obj) { - return (obj != null ? obj.getClass().getName() : NULL_STRING); - } - - /** - * Return a String representation of the specified Object. - *

Builds a String representation of the contents in case of an array. - * Returns "null" if obj is null. - * @param obj the object to build a String representation for - * @return a String representation of obj - */ - public static String nullSafeToString(Object obj) { - if (obj == null) { - return NULL_STRING; - } - if (obj instanceof String) { - return (String) obj; - } - if (obj instanceof Object[]) { - return nullSafeToString((Object[]) obj); - } - if (obj instanceof boolean[]) { - return nullSafeToString((boolean[]) obj); - } - if (obj instanceof byte[]) { - return nullSafeToString((byte[]) obj); - } - if (obj instanceof char[]) { - return nullSafeToString((char[]) obj); - } - if (obj instanceof double[]) { - return nullSafeToString((double[]) obj); - } - if (obj instanceof float[]) { - return nullSafeToString((float[]) obj); - } - if (obj instanceof int[]) { - return nullSafeToString((int[]) obj); - } - if (obj instanceof long[]) { - return nullSafeToString((long[]) obj); - } - if (obj instanceof short[]) { - return nullSafeToString((short[]) obj); - } - String str = obj.toString(); - return (str != null ? str : EMPTY_STRING); - } - - /** - * Return a String representation of the contents of the specified array. - *

The String representation consists of a list of the array's elements, - * enclosed in curly braces ("{}"). Adjacent elements are separated - * by the characters ", " (a comma followed by a space). Returns - * "null" if array is null. - * @param array the array to build a String representation for - * @return a String representation of array - */ - public static String nullSafeToString(Object[] array) { - if (array == null) { - return NULL_STRING; - } - int length = array.length; - if (length == 0) { - return EMPTY_ARRAY; - } - StringBuffer buffer = new StringBuffer(); - for (int i = 0; i < length; i++) { - if (i == 0) { - buffer.append(ARRAY_START); - } - else { - buffer.append(ARRAY_ELEMENT_SEPARATOR); - } - buffer.append(String.valueOf(array[i])); - } - buffer.append(ARRAY_END); - return buffer.toString(); - } - - /** - * Return a String representation of the contents of the specified array. - *

The String representation consists of a list of the array's elements, - * enclosed in curly braces ("{}"). Adjacent elements are separated - * by the characters ", " (a comma followed by a space). Returns - * "null" if array is null. - * @param array the array to build a String representation for - * @return a String representation of array - */ - public static String nullSafeToString(boolean[] array) { - if (array == null) { - return NULL_STRING; - } - int length = array.length; - if (length == 0) { - return EMPTY_ARRAY; - } - StringBuffer buffer = new StringBuffer(); - for (int i = 0; i < length; i++) { - if (i == 0) { - buffer.append(ARRAY_START); - } - else { - buffer.append(ARRAY_ELEMENT_SEPARATOR); - } - - buffer.append(array[i]); - } - buffer.append(ARRAY_END); - return buffer.toString(); - } - - /** - * Return a String representation of the contents of the specified array. - *

The String representation consists of a list of the array's elements, - * enclosed in curly braces ("{}"). Adjacent elements are separated - * by the characters ", " (a comma followed by a space). Returns - * "null" if array is null. - * @param array the array to build a String representation for - * @return a String representation of array - */ - public static String nullSafeToString(byte[] array) { - if (array == null) { - return NULL_STRING; - } - int length = array.length; - if (length == 0) { - return EMPTY_ARRAY; - } - StringBuffer buffer = new StringBuffer(); - for (int i = 0; i < length; i++) { - if (i == 0) { - buffer.append(ARRAY_START); - } - else { - buffer.append(ARRAY_ELEMENT_SEPARATOR); - } - buffer.append(array[i]); - } - buffer.append(ARRAY_END); - return buffer.toString(); - } - - /** - * Return a String representation of the contents of the specified array. - *

The String representation consists of a list of the array's elements, - * enclosed in curly braces ("{}"). Adjacent elements are separated - * by the characters ", " (a comma followed by a space). Returns - * "null" if array is null. - * @param array the array to build a String representation for - * @return a String representation of array - */ - public static String nullSafeToString(char[] array) { - if (array == null) { - return NULL_STRING; - } - int length = array.length; - if (length == 0) { - return EMPTY_ARRAY; - } - StringBuffer buffer = new StringBuffer(); - for (int i = 0; i < length; i++) { - if (i == 0) { - buffer.append(ARRAY_START); - } - else { - buffer.append(ARRAY_ELEMENT_SEPARATOR); - } - buffer.append("'").append(array[i]).append("'"); - } - buffer.append(ARRAY_END); - return buffer.toString(); - } - - /** - * Return a String representation of the contents of the specified array. - *

The String representation consists of a list of the array's elements, - * enclosed in curly braces ("{}"). Adjacent elements are separated - * by the characters ", " (a comma followed by a space). Returns - * "null" if array is null. - * @param array the array to build a String representation for - * @return a String representation of array - */ - public static String nullSafeToString(double[] array) { - if (array == null) { - return NULL_STRING; - } - int length = array.length; - if (length == 0) { - return EMPTY_ARRAY; - } - StringBuffer buffer = new StringBuffer(); - for (int i = 0; i < length; i++) { - if (i == 0) { - buffer.append(ARRAY_START); - } - else { - buffer.append(ARRAY_ELEMENT_SEPARATOR); - } - - buffer.append(array[i]); - } - buffer.append(ARRAY_END); - return buffer.toString(); - } - - /** - * Return a String representation of the contents of the specified array. - *

The String representation consists of a list of the array's elements, - * enclosed in curly braces ("{}"). Adjacent elements are separated - * by the characters ", " (a comma followed by a space). Returns - * "null" if array is null. - * @param array the array to build a String representation for - * @return a String representation of array - */ - public static String nullSafeToString(float[] array) { - if (array == null) { - return NULL_STRING; - } - int length = array.length; - if (length == 0) { - return EMPTY_ARRAY; - } - StringBuffer buffer = new StringBuffer(); - for (int i = 0; i < length; i++) { - if (i == 0) { - buffer.append(ARRAY_START); - } - else { - buffer.append(ARRAY_ELEMENT_SEPARATOR); - } - - buffer.append(array[i]); - } - buffer.append(ARRAY_END); - return buffer.toString(); - } - - /** - * Return a String representation of the contents of the specified array. - *

The String representation consists of a list of the array's elements, - * enclosed in curly braces ("{}"). Adjacent elements are separated - * by the characters ", " (a comma followed by a space). Returns - * "null" if array is null. - * @param array the array to build a String representation for - * @return a String representation of array - */ - public static String nullSafeToString(int[] array) { - if (array == null) { - return NULL_STRING; - } - int length = array.length; - if (length == 0) { - return EMPTY_ARRAY; - } - StringBuffer buffer = new StringBuffer(); - for (int i = 0; i < length; i++) { - if (i == 0) { - buffer.append(ARRAY_START); - } - else { - buffer.append(ARRAY_ELEMENT_SEPARATOR); - } - buffer.append(array[i]); - } - buffer.append(ARRAY_END); - return buffer.toString(); - } - - /** - * Return a String representation of the contents of the specified array. - *

The String representation consists of a list of the array's elements, - * enclosed in curly braces ("{}"). Adjacent elements are separated - * by the characters ", " (a comma followed by a space). Returns - * "null" if array is null. - * @param array the array to build a String representation for - * @return a String representation of array - */ - public static String nullSafeToString(long[] array) { - if (array == null) { - return NULL_STRING; - } - int length = array.length; - if (length == 0) { - return EMPTY_ARRAY; - } - StringBuffer buffer = new StringBuffer(); - for (int i = 0; i < length; i++) { - if (i == 0) { - buffer.append(ARRAY_START); - } - else { - buffer.append(ARRAY_ELEMENT_SEPARATOR); - } - buffer.append(array[i]); - } - buffer.append(ARRAY_END); - return buffer.toString(); - } - - /** - * Return a String representation of the contents of the specified array. - *

The String representation consists of a list of the array's elements, - * enclosed in curly braces ("{}"). Adjacent elements are separated - * by the characters ", " (a comma followed by a space). Returns - * "null" if array is null. - * @param array the array to build a String representation for - * @return a String representation of array - */ - public static String nullSafeToString(short[] array) { - if (array == null) { - return NULL_STRING; - } - int length = array.length; - if (length == 0) { - return EMPTY_ARRAY; - } - StringBuffer buffer = new StringBuffer(); - for (int i = 0; i < length; i++) { - if (i == 0) { - buffer.append(ARRAY_START); - } - else { - buffer.append(ARRAY_ELEMENT_SEPARATOR); - } - buffer.append(array[i]); - } - buffer.append(ARRAY_END); - return buffer.toString(); - } - -} diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/PathMatcher.java b/org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/PathMatcher.java deleted file mode 100644 index d7a23221b..000000000 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/PathMatcher.java +++ /dev/null @@ -1,91 +0,0 @@ -/* - * Copyright 2002-2007 the original author or authors. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.argeo.osgi.boot.internal.springutil; - -/** - * Strategy interface for String-based path matching. - * - *

Used by {@link org.springframework.core.io.support.PathMatchingResourcePatternResolver}, - * {@link org.springframework.web.servlet.handler.AbstractUrlHandlerMapping}, - * {@link org.springframework.web.servlet.mvc.multiaction.PropertiesMethodNameResolver}, - * and {@link org.springframework.web.servlet.mvc.WebContentInterceptor}. - * - *

The default implementation is {@link AntPathMatcher}, supporting the - * Ant-style pattern syntax. - * - * @author Juergen Hoeller - * @since 1.2 - * @see AntPathMatcher - */ -public interface PathMatcher { - - /** - * Does the given path represent a pattern that can be matched - * by an implementation of this interface? - *

If the return value is false, then the {@link #match} - * method does not have to be used because direct equality comparisons - * on the static path Strings will lead to the same result. - * @param path the path String to check - * @return true if the given path represents a pattern - */ - boolean isPattern(String path); - - /** - * Match the given path against the given pattern, - * according to this PathMatcher's matching strategy. - * @param pattern the pattern to match against - * @param path the path String to test - * @return true if the supplied path matched, - * false if it didn't - */ - boolean match(String pattern, String path); - - /** - * Match the given path against the corresponding part of the given - * pattern, according to this PathMatcher's matching strategy. - *

Determines whether the pattern at least matches as far as the given base - * path goes, assuming that a full path may then match as well. - * @param pattern the pattern to match against - * @param path the path String to test - * @return true if the supplied path matched, - * false if it didn't - */ - boolean matchStart(String pattern, String path); - - /** - * Given a pattern and a full path, determine the pattern-mapped part. - *

This method is supposed to find out which part of the path is matched - * dynamically through an actual pattern, that is, it strips off a statically - * defined leading path from the given full path, returning only the actually - * pattern-matched part of the path. - *

For example: For "myroot/*.html" as pattern and "myroot/myfile.html" - * as full path, this method should return "myfile.html". The detailed - * determination rules are specified to this PathMatcher's matching strategy. - *

A simple implementation may return the given full path as-is in case - * of an actual pattern, and the empty String in case of the pattern not - * containing any dynamic parts (i.e. the pattern parameter being - * a static path that wouldn't qualify as an actual {@link #isPattern pattern}). - * A sophisticated implementation will differentiate between the static parts - * and the dynamic parts of the given path pattern. - * @param pattern the path pattern - * @param path the full path to introspect - * @return the pattern-mapped part of the given path - * (never null) - */ - String extractPathWithinPattern(String pattern, String path); - -} diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/StringUtils.java b/org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/StringUtils.java deleted file mode 100644 index 6cbaee8f8..000000000 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/StringUtils.java +++ /dev/null @@ -1,1113 +0,0 @@ -/* - * Copyright 2002-2008 the original author or authors. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.argeo.osgi.boot.internal.springutil; - -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collection; -import java.util.Collections; -import java.util.Enumeration; -import java.util.Iterator; -import java.util.LinkedList; -import java.util.List; -import java.util.Locale; -import java.util.Properties; -import java.util.Set; -import java.util.StringTokenizer; -import java.util.TreeSet; - -/** - * Miscellaneous {@link String} utility methods. - * - *

Mainly for internal use within the framework; consider - * Jakarta's Commons Lang - * for a more comprehensive suite of String utilities. - * - *

This class delivers some simple functionality that should really - * be provided by the core Java String and {@link StringBuffer} - * classes, such as the ability to {@link #replace} all occurrences of a given - * substring in a target string. It also provides easy-to-use methods to convert - * between delimited strings, such as CSV strings, and collections and arrays. - * - * @author Rod Johnson - * @author Juergen Hoeller - * @author Keith Donald - * @author Rob Harrop - * @author Rick Evans - * @since 16 April 2001 - */ -@SuppressWarnings({ "rawtypes", "unchecked" }) -public abstract class StringUtils { - - private static final String FOLDER_SEPARATOR = "/"; - - private static final String WINDOWS_FOLDER_SEPARATOR = "\\"; - - private static final String TOP_PATH = ".."; - - private static final String CURRENT_PATH = "."; - - private static final char EXTENSION_SEPARATOR = '.'; - - - //--------------------------------------------------------------------- - // General convenience methods for working with Strings - //--------------------------------------------------------------------- - - /** - * Check that the given CharSequence is neither null nor of length 0. - * Note: Will return true for a CharSequence that purely consists of whitespace. - * 

-	 * StringUtils.hasLength(null) = false
-	 * StringUtils.hasLength("") = false
-	 * StringUtils.hasLength(" ") = true
-	 * StringUtils.hasLength("Hello") = true
-	 *
- * @param str the CharSequence to check (may be null) - * @return true if the CharSequence is not null and has length - * @see #hasText(String) - */ - public static boolean hasLength(CharSequence str) { - return (str != null && str.length() > 0); - } - - /** - * Check that the given String is neither null nor of length 0. - * Note: Will return true for a String that purely consists of whitespace. - * @param str the String to check (may be null) - * @return true if the String is not null and has length - * @see #hasLength(CharSequence) - */ - public static boolean hasLength(String str) { - return hasLength((CharSequence) str); - } - - /** - * Check whether the given CharSequence has actual text. - * More specifically, returns true if the string not null, - * its length is greater than 0, and it contains at least one non-whitespace character. - * 

-	 * StringUtils.hasText(null) = false
-	 * StringUtils.hasText("") = false
-	 * StringUtils.hasText(" ") = false
-	 * StringUtils.hasText("12345") = true
-	 * StringUtils.hasText(" 12345 ") = true
-	 *
- * @param str the CharSequence to check (may be null) - * @return true if the CharSequence is not null, - * its length is greater than 0, and it does not contain whitespace only - * @see java.lang.Character#isWhitespace - */ - public static boolean hasText(CharSequence str) { - if (!hasLength(str)) { - return false; - } - int strLen = str.length(); - for (int i = 0; i < strLen; i++) { - if (!Character.isWhitespace(str.charAt(i))) { - return true; - } - } - return false; - } - - /** - * Check whether the given String has actual text. - * More specifically, returns true if the string not null, - * its length is greater than 0, and it contains at least one non-whitespace character. - * @param str the String to check (may be null) - * @return true if the String is not null, its length is - * greater than 0, and it does not contain whitespace only - * @see #hasText(CharSequence) - */ - public static boolean hasText(String str) { - return hasText((CharSequence) str); - } - - /** - * Check whether the given CharSequence contains any whitespace characters. - * @param str the CharSequence to check (may be null) - * @return true if the CharSequence is not empty and - * contains at least 1 whitespace character - * @see java.lang.Character#isWhitespace - */ - public static boolean containsWhitespace(CharSequence str) { - if (!hasLength(str)) { - return false; - } - int strLen = str.length(); - for (int i = 0; i < strLen; i++) { - if (Character.isWhitespace(str.charAt(i))) { - return true; - } - } - return false; - } - - /** - * Check whether the given String contains any whitespace characters. - * @param str the String to check (may be null) - * @return true if the String is not empty and - * contains at least 1 whitespace character - * @see #containsWhitespace(CharSequence) - */ - public static boolean containsWhitespace(String str) { - return containsWhitespace((CharSequence) str); - } - - /** - * Trim leading and trailing whitespace from the given String. - * @param str the String to check - * @return the trimmed String - * @see java.lang.Character#isWhitespace - */ - public static String trimWhitespace(String str) { - if (!hasLength(str)) { - return str; - } - StringBuffer buf = new StringBuffer(str); - while (buf.length() > 0 && Character.isWhitespace(buf.charAt(0))) { - buf.deleteCharAt(0); - } - while (buf.length() > 0 && Character.isWhitespace(buf.charAt(buf.length() - 1))) { - buf.deleteCharAt(buf.length() - 1); - } - return buf.toString(); - } - - /** - * Trim all whitespace from the given String: - * leading, trailing, and inbetween characters. - * @param str the String to check - * @return the trimmed String - * @see java.lang.Character#isWhitespace - */ - public static String trimAllWhitespace(String str) { - if (!hasLength(str)) { - return str; - } - StringBuffer buf = new StringBuffer(str); - int index = 0; - while (buf.length() > index) { - if (Character.isWhitespace(buf.charAt(index))) { - buf.deleteCharAt(index); - } - else { - index++; - } - } - return buf.toString(); - } - - /** - * Trim leading whitespace from the given String. - * @param str the String to check - * @return the trimmed String - * @see java.lang.Character#isWhitespace - */ - public static String trimLeadingWhitespace(String str) { - if (!hasLength(str)) { - return str; - } - StringBuffer buf = new StringBuffer(str); - while (buf.length() > 0 && Character.isWhitespace(buf.charAt(0))) { - buf.deleteCharAt(0); - } - return buf.toString(); - } - - /** - * Trim trailing whitespace from the given String. - * @param str the String to check - * @return the trimmed String - * @see java.lang.Character#isWhitespace - */ - public static String trimTrailingWhitespace(String str) { - if (!hasLength(str)) { - return str; - } - StringBuffer buf = new StringBuffer(str); - while (buf.length() > 0 && Character.isWhitespace(buf.charAt(buf.length() - 1))) { - buf.deleteCharAt(buf.length() - 1); - } - return buf.toString(); - } - - /** - * Trim all occurences of the supplied leading character from the given String. - * @param str the String to check - * @param leadingCharacter the leading character to be trimmed - * @return the trimmed String - */ - public static String trimLeadingCharacter(String str, char leadingCharacter) { - if (!hasLength(str)) { - return str; - } - StringBuffer buf = new StringBuffer(str); - while (buf.length() > 0 && buf.charAt(0) == leadingCharacter) { - buf.deleteCharAt(0); - } - return buf.toString(); - } - - /** - * Trim all occurences of the supplied trailing character from the given String. - * @param str the String to check - * @param trailingCharacter the trailing character to be trimmed - * @return the trimmed String - */ - public static String trimTrailingCharacter(String str, char trailingCharacter) { - if (!hasLength(str)) { - return str; - } - StringBuffer buf = new StringBuffer(str); - while (buf.length() > 0 && buf.charAt(buf.length() - 1) == trailingCharacter) { - buf.deleteCharAt(buf.length() - 1); - } - return buf.toString(); - } - - - /** - * Test if the given String starts with the specified prefix, - * ignoring upper/lower case. - * @param str the String to check - * @param prefix the prefix to look for - * @see java.lang.String#startsWith - */ - public static boolean startsWithIgnoreCase(String str, String prefix) { - if (str == null || prefix == null) { - return false; - } - if (str.startsWith(prefix)) { - return true; - } - if (str.length() < prefix.length()) { - return false; - } - String lcStr = str.substring(0, prefix.length()).toLowerCase(); - String lcPrefix = prefix.toLowerCase(); - return lcStr.equals(lcPrefix); - } - - /** - * Test if the given String ends with the specified suffix, - * ignoring upper/lower case. - * @param str the String to check - * @param suffix the suffix to look for - * @see java.lang.String#endsWith - */ - public static boolean endsWithIgnoreCase(String str, String suffix) { - if (str == null || suffix == null) { - return false; - } - if (str.endsWith(suffix)) { - return true; - } - if (str.length() < suffix.length()) { - return false; - } - - String lcStr = str.substring(str.length() - suffix.length()).toLowerCase(); - String lcSuffix = suffix.toLowerCase(); - return lcStr.equals(lcSuffix); - } - - /** - * Test whether the given string matches the given substring - * at the given index. - * @param str the original string (or StringBuffer) - * @param index the index in the original string to start matching against - * @param substring the substring to match at the given index - */ - public static boolean substringMatch(CharSequence str, int index, CharSequence substring) { - for (int j = 0; j < substring.length(); j++) { - int i = index + j; - if (i >= str.length() || str.charAt(i) != substring.charAt(j)) { - return false; - } - } - return true; - } - - /** - * Count the occurrences of the substring in string s. - * @param str string to search in. Return 0 if this is null. - * @param sub string to search for. Return 0 if this is null. - */ - public static int countOccurrencesOf(String str, String sub) { - if (str == null || sub == null || str.length() == 0 || sub.length() == 0) { - return 0; - } - int count = 0, pos = 0, idx = 0; - while ((idx = str.indexOf(sub, pos)) != -1) { - ++count; - pos = idx + sub.length(); - } - return count; - } - - /** - * Replace all occurences of a substring within a string with - * another string. - * @param inString String to examine - * @param oldPattern String to replace - * @param newPattern String to insert - * @return a String with the replacements - */ - public static String replace(String inString, String oldPattern, String newPattern) { - if (!hasLength(inString) || !hasLength(oldPattern) || newPattern == null) { - return inString; - } - StringBuffer sbuf = new StringBuffer(); - // output StringBuffer we'll build up - int pos = 0; // our position in the old string - int index = inString.indexOf(oldPattern); - // the index of an occurrence we've found, or -1 - int patLen = oldPattern.length(); - while (index >= 0) { - sbuf.append(inString.substring(pos, index)); - sbuf.append(newPattern); - pos = index + patLen; - index = inString.indexOf(oldPattern, pos); - } - sbuf.append(inString.substring(pos)); - // remember to append any characters to the right of a match - return sbuf.toString(); - } - - /** - * Delete all occurrences of the given substring. - * @param inString the original String - * @param pattern the pattern to delete all occurrences of - * @return the resulting String - */ - public static String delete(String inString, String pattern) { - return replace(inString, pattern, ""); - } - - /** - * Delete any character in a given String. - * @param inString the original String - * @param charsToDelete a set of characters to delete. - * E.g. "az\n" will delete 'a's, 'z's and new lines. - * @return the resulting String - */ - public static String deleteAny(String inString, String charsToDelete) { - if (!hasLength(inString) || !hasLength(charsToDelete)) { - return inString; - } - StringBuffer out = new StringBuffer(); - for (int i = 0; i < inString.length(); i++) { - char c = inString.charAt(i); - if (charsToDelete.indexOf(c) == -1) { - out.append(c); - } - } - return out.toString(); - } - - - //--------------------------------------------------------------------- - // Convenience methods for working with formatted Strings - //--------------------------------------------------------------------- - - /** - * Quote the given String with single quotes. - * @param str the input String (e.g. "myString") - * @return the quoted String (e.g. "'myString'"), - * or null if the input was null - */ - public static String quote(String str) { - return (str != null ? "'" + str + "'" : null); - } - - /** - * Turn the given Object into a String with single quotes - * if it is a String; keeping the Object as-is else. - * @param obj the input Object (e.g. "myString") - * @return the quoted String (e.g. "'myString'"), - * or the input object as-is if not a String - */ - public static Object quoteIfString(Object obj) { - return (obj instanceof String ? quote((String) obj) : obj); - } - - /** - * Unqualify a string qualified by a '.' dot character. For example, - * "this.name.is.qualified", returns "qualified". - * @param qualifiedName the qualified name - */ - public static String unqualify(String qualifiedName) { - return unqualify(qualifiedName, '.'); - } - - /** - * Unqualify a string qualified by a separator character. For example, - * "this:name:is:qualified" returns "qualified" if using a ':' separator. - * @param qualifiedName the qualified name - * @param separator the separator - */ - public static String unqualify(String qualifiedName, char separator) { - return qualifiedName.substring(qualifiedName.lastIndexOf(separator) + 1); - } - - /** - * Capitalize a String, changing the first letter to - * upper case as per {@link Character#toUpperCase(char)}. - * No other letters are changed. - * @param str the String to capitalize, may be null - * @return the capitalized String, null if null - */ - public static String capitalize(String str) { - return changeFirstCharacterCase(str, true); - } - - /** - * Uncapitalize a String, changing the first letter to - * lower case as per {@link Character#toLowerCase(char)}. - * No other letters are changed. - * @param str the String to uncapitalize, may be null - * @return the uncapitalized String, null if null - */ - public static String uncapitalize(String str) { - return changeFirstCharacterCase(str, false); - } - - private static String changeFirstCharacterCase(String str, boolean capitalize) { - if (str == null || str.length() == 0) { - return str; - } - StringBuffer buf = new StringBuffer(str.length()); - if (capitalize) { - buf.append(Character.toUpperCase(str.charAt(0))); - } - else { - buf.append(Character.toLowerCase(str.charAt(0))); - } - buf.append(str.substring(1)); - return buf.toString(); - } - - /** - * Extract the filename from the given path, - * e.g. "mypath/myfile.txt" to "myfile.txt". - * @param path the file path (may be null) - * @return the extracted filename, or null if none - */ - public static String getFilename(String path) { - if (path == null) { - return null; - } - int separatorIndex = path.lastIndexOf(FOLDER_SEPARATOR); - return (separatorIndex != -1 ? path.substring(separatorIndex + 1) : path); - } - - /** - * Extract the filename extension from the given path, - * e.g. "mypath/myfile.txt" to "txt". - * @param path the file path (may be null) - * @return the extracted filename extension, or null if none - */ - public static String getFilenameExtension(String path) { - if (path == null) { - return null; - } - int sepIndex = path.lastIndexOf(EXTENSION_SEPARATOR); - return (sepIndex != -1 ? path.substring(sepIndex + 1) : null); - } - - /** - * Strip the filename extension from the given path, - * e.g. "mypath/myfile.txt" to "mypath/myfile". - * @param path the file path (may be null) - * @return the path with stripped filename extension, - * or null if none - */ - public static String stripFilenameExtension(String path) { - if (path == null) { - return null; - } - int sepIndex = path.lastIndexOf(EXTENSION_SEPARATOR); - return (sepIndex != -1 ? path.substring(0, sepIndex) : path); - } - - /** - * Apply the given relative path to the given path, - * assuming standard Java folder separation (i.e. "/" separators); - * @param path the path to start from (usually a full file path) - * @param relativePath the relative path to apply - * (relative to the full file path above) - * @return the full file path that results from applying the relative path - */ - public static String applyRelativePath(String path, String relativePath) { - int separatorIndex = path.lastIndexOf(FOLDER_SEPARATOR); - if (separatorIndex != -1) { - String newPath = path.substring(0, separatorIndex); - if (!relativePath.startsWith(FOLDER_SEPARATOR)) { - newPath += FOLDER_SEPARATOR; - } - return newPath + relativePath; - } - else { - return relativePath; - } - } - - /** - * Normalize the path by suppressing sequences like "path/.." and - * inner simple dots. - *

The result is convenient for path comparison. For other uses, - * notice that Windows separators ("\") are replaced by simple slashes. - * @param path the original path - * @return the normalized path - */ - public static String cleanPath(String path) { - if (path == null) { - return null; - } - String pathToUse = replace(path, WINDOWS_FOLDER_SEPARATOR, FOLDER_SEPARATOR); - - // Strip prefix from path to analyze, to not treat it as part of the - // first path element. This is necessary to correctly parse paths like - // "file:core/../core/io/Resource.class", where the ".." should just - // strip the first "core" directory while keeping the "file:" prefix. - int prefixIndex = pathToUse.indexOf(":"); - String prefix = ""; - if (prefixIndex != -1) { - prefix = pathToUse.substring(0, prefixIndex + 1); - pathToUse = pathToUse.substring(prefixIndex + 1); - } - if (pathToUse.startsWith(FOLDER_SEPARATOR)) { - prefix = prefix + FOLDER_SEPARATOR; - pathToUse = pathToUse.substring(1); - } - - String[] pathArray = delimitedListToStringArray(pathToUse, FOLDER_SEPARATOR); - List pathElements = new LinkedList(); - int tops = 0; - - for (int i = pathArray.length - 1; i >= 0; i--) { - String element = pathArray[i]; - if (CURRENT_PATH.equals(element)) { - // Points to current directory - drop it. - } - else if (TOP_PATH.equals(element)) { - // Registering top path found. - tops++; - } - else { - if (tops > 0) { - // Merging path element with element corresponding to top path. - tops--; - } - else { - // Normal path element found. - pathElements.add(0, element); - } - } - } - - // Remaining top paths need to be retained. - for (int i = 0; i < tops; i++) { - pathElements.add(0, TOP_PATH); - } - - return prefix + collectionToDelimitedString(pathElements, FOLDER_SEPARATOR); - } - - /** - * Compare two paths after normalization of them. - * @param path1 first path for comparison - * @param path2 second path for comparison - * @return whether the two paths are equivalent after normalization - */ - public static boolean pathEquals(String path1, String path2) { - return cleanPath(path1).equals(cleanPath(path2)); - } - - /** - * Parse the given localeString into a {@link Locale}. - *

This is the inverse operation of {@link Locale#toString Locale's toString}. - * @param localeString the locale string, following Locale's - * toString() format ("en", "en_UK", etc); - * also accepts spaces as separators, as an alternative to underscores - * @return a corresponding Locale instance - */ - public static Locale parseLocaleString(String localeString) { - String[] parts = tokenizeToStringArray(localeString, "_ ", false, false); - String language = (parts.length > 0 ? parts[0] : ""); - String country = (parts.length > 1 ? parts[1] : ""); - String variant = ""; - if (parts.length >= 2) { - // There is definitely a variant, and it is everything after the country - // code sans the separator between the country code and the variant. - int endIndexOfCountryCode = localeString.indexOf(country) + country.length(); - // Strip off any leading '_' and whitespace, what's left is the variant. - variant = trimLeadingWhitespace(localeString.substring(endIndexOfCountryCode)); - if (variant.startsWith("_")) { - variant = trimLeadingCharacter(variant, '_'); - } - } - return (language.length() > 0 ? new Locale(language, country, variant) : null); - } - - /** - * Determine the RFC 3066 compliant language tag, - * as used for the HTTP "Accept-Language" header. - * @param locale the Locale to transform to a language tag - * @return the RFC 3066 compliant language tag as String - */ - public static String toLanguageTag(Locale locale) { - return locale.getLanguage() + (hasText(locale.getCountry()) ? "-" + locale.getCountry() : ""); - } - - - //--------------------------------------------------------------------- - // Convenience methods for working with String arrays - //--------------------------------------------------------------------- - - /** - * Append the given String to the given String array, returning a new array - * consisting of the input array contents plus the given String. - * @param array the array to append to (can be null) - * @param str the String to append - * @return the new array (never null) - */ - public static String[] addStringToArray(String[] array, String str) { - if (ObjectUtils.isEmpty(array)) { - return new String[] {str}; - } - String[] newArr = new String[array.length + 1]; - System.arraycopy(array, 0, newArr, 0, array.length); - newArr[array.length] = str; - return newArr; - } - - /** - * Concatenate the given String arrays into one, - * with overlapping array elements included twice. - *

The order of elements in the original arrays is preserved. - * @param array1 the first array (can be null) - * @param array2 the second array (can be null) - * @return the new array (null if both given arrays were null) - */ - public static String[] concatenateStringArrays(String[] array1, String[] array2) { - if (ObjectUtils.isEmpty(array1)) { - return array2; - } - if (ObjectUtils.isEmpty(array2)) { - return array1; - } - String[] newArr = new String[array1.length + array2.length]; - System.arraycopy(array1, 0, newArr, 0, array1.length); - System.arraycopy(array2, 0, newArr, array1.length, array2.length); - return newArr; - } - - /** - * Merge the given String arrays into one, with overlapping - * array elements only included once. - *

The order of elements in the original arrays is preserved - * (with the exception of overlapping elements, which are only - * included on their first occurence). - * @param array1 the first array (can be null) - * @param array2 the second array (can be null) - * @return the new array (null if both given arrays were null) - */ - public static String[] mergeStringArrays(String[] array1, String[] array2) { - if (ObjectUtils.isEmpty(array1)) { - return array2; - } - if (ObjectUtils.isEmpty(array2)) { - return array1; - } - List result = new ArrayList(); - result.addAll(Arrays.asList(array1)); - for (int i = 0; i < array2.length; i++) { - String str = array2[i]; - if (!result.contains(str)) { - result.add(str); - } - } - return toStringArray(result); - } - - /** - * Turn given source String array into sorted array. - * @param array the source array - * @return the sorted array (never null) - */ - public static String[] sortStringArray(String[] array) { - if (ObjectUtils.isEmpty(array)) { - return new String[0]; - } - Arrays.sort(array); - return array; - } - - /** - * Copy the given Collection into a String array. - * The Collection must contain String elements only. - * @param collection the Collection to copy - * @return the String array (null if the passed-in - * Collection was null) - */ - public static String[] toStringArray(Collection collection) { - if (collection == null) { - return null; - } - return (String[]) collection.toArray(new String[collection.size()]); - } - - /** - * Copy the given Enumeration into a String array. - * The Enumeration must contain String elements only. - * @param enumeration the Enumeration to copy - * @return the String array (null if the passed-in - * Enumeration was null) - */ - public static String[] toStringArray(Enumeration enumeration) { - if (enumeration == null) { - return null; - } - List list = Collections.list(enumeration); - return (String[]) list.toArray(new String[list.size()]); - } - - /** - * Trim the elements of the given String array, - * calling String.trim() on each of them. - * @param array the original String array - * @return the resulting array (of the same size) with trimmed elements - */ - public static String[] trimArrayElements(String[] array) { - if (ObjectUtils.isEmpty(array)) { - return new String[0]; - } - String[] result = new String[array.length]; - for (int i = 0; i < array.length; i++) { - String element = array[i]; - result[i] = (element != null ? element.trim() : null); - } - return result; - } - - /** - * Remove duplicate Strings from the given array. - * Also sorts the array, as it uses a TreeSet. - * @param array the String array - * @return an array without duplicates, in natural sort order - */ - public static String[] removeDuplicateStrings(String[] array) { - if (ObjectUtils.isEmpty(array)) { - return array; - } - Set set = new TreeSet(); - for (int i = 0; i < array.length; i++) { - set.add(array[i]); - } - return toStringArray(set); - } - - /** - * Split a String at the first occurrence of the delimiter. - * Does not include the delimiter in the result. - * @param toSplit the string to split - * @param delimiter to split the string up with - * @return a two element array with index 0 being before the delimiter, and - * index 1 being after the delimiter (neither element includes the delimiter); - * or null if the delimiter wasn't found in the given input String - */ - public static String[] split(String toSplit, String delimiter) { - if (!hasLength(toSplit) || !hasLength(delimiter)) { - return null; - } - int offset = toSplit.indexOf(delimiter); - if (offset < 0) { - return null; - } - String beforeDelimiter = toSplit.substring(0, offset); - String afterDelimiter = toSplit.substring(offset + delimiter.length()); - return new String[] {beforeDelimiter, afterDelimiter}; - } - - /** - * Take an array Strings and split each element based on the given delimiter. - * A Properties instance is then generated, with the left of the - * delimiter providing the key, and the right of the delimiter providing the value. - *

Will trim both the key and value before adding them to the - * Properties instance. - * @param array the array to process - * @param delimiter to split each element using (typically the equals symbol) - * @return a Properties instance representing the array contents, - * or null if the array to process was null or empty - */ - public static Properties splitArrayElementsIntoProperties(String[] array, String delimiter) { - return splitArrayElementsIntoProperties(array, delimiter, null); - } - - /** - * Take an array Strings and split each element based on the given delimiter. - * A Properties instance is then generated, with the left of the - * delimiter providing the key, and the right of the delimiter providing the value. - *

Will trim both the key and value before adding them to the - * Properties instance. - * @param array the array to process - * @param delimiter to split each element using (typically the equals symbol) - * @param charsToDelete one or more characters to remove from each element - * prior to attempting the split operation (typically the quotation mark - * symbol), or null if no removal should occur - * @return a Properties instance representing the array contents, - * or null if the array to process was null or empty - */ - public static Properties splitArrayElementsIntoProperties( - String[] array, String delimiter, String charsToDelete) { - - if (ObjectUtils.isEmpty(array)) { - return null; - } - Properties result = new Properties(); - for (int i = 0; i < array.length; i++) { - String element = array[i]; - if (charsToDelete != null) { - element = deleteAny(array[i], charsToDelete); - } - String[] splittedElement = split(element, delimiter); - if (splittedElement == null) { - continue; - } - result.setProperty(splittedElement[0].trim(), splittedElement[1].trim()); - } - return result; - } - - /** - * Tokenize the given String into a String array via a StringTokenizer. - * Trims tokens and omits empty tokens. - *

The given delimiters string is supposed to consist of any number of - * delimiter characters. Each of those characters can be used to separate - * tokens. A delimiter is always a single character; for multi-character - * delimiters, consider using delimitedListToStringArray - * @param str the String to tokenize - * @param delimiters the delimiter characters, assembled as String - * (each of those characters is individually considered as delimiter). - * @return an array of the tokens - * @see java.util.StringTokenizer - * @see java.lang.String#trim() - * @see #delimitedListToStringArray - */ - public static String[] tokenizeToStringArray(String str, String delimiters) { - return tokenizeToStringArray(str, delimiters, true, true); - } - - /** - * Tokenize the given String into a String array via a StringTokenizer. - *

The given delimiters string is supposed to consist of any number of - * delimiter characters. Each of those characters can be used to separate - * tokens. A delimiter is always a single character; for multi-character - * delimiters, consider using delimitedListToStringArray - * @param str the String to tokenize - * @param delimiters the delimiter characters, assembled as String - * (each of those characters is individually considered as delimiter) - * @param trimTokens trim the tokens via String's trim - * @param ignoreEmptyTokens omit empty tokens from the result array - * (only applies to tokens that are empty after trimming; StringTokenizer - * will not consider subsequent delimiters as token in the first place). - * @return an array of the tokens (null if the input String - * was null) - * @see java.util.StringTokenizer - * @see java.lang.String#trim() - * @see #delimitedListToStringArray - */ - public static String[] tokenizeToStringArray( - String str, String delimiters, boolean trimTokens, boolean ignoreEmptyTokens) { - - if (str == null) { - return null; - } - StringTokenizer st = new StringTokenizer(str, delimiters); - List tokens = new ArrayList(); - while (st.hasMoreTokens()) { - String token = st.nextToken(); - if (trimTokens) { - token = token.trim(); - } - if (!ignoreEmptyTokens || token.length() > 0) { - tokens.add(token); - } - } - return toStringArray(tokens); - } - - /** - * Take a String which is a delimited list and convert it to a String array. - *

A single delimiter can consists of more than one character: It will still - * be considered as single delimiter string, rather than as bunch of potential - * delimiter characters - in contrast to tokenizeToStringArray. - * @param str the input String - * @param delimiter the delimiter between elements (this is a single delimiter, - * rather than a bunch individual delimiter characters) - * @return an array of the tokens in the list - * @see #tokenizeToStringArray - */ - public static String[] delimitedListToStringArray(String str, String delimiter) { - return delimitedListToStringArray(str, delimiter, null); - } - - /** - * Take a String which is a delimited list and convert it to a String array. - *

A single delimiter can consists of more than one character: It will still - * be considered as single delimiter string, rather than as bunch of potential - * delimiter characters - in contrast to tokenizeToStringArray. - * @param str the input String - * @param delimiter the delimiter between elements (this is a single delimiter, - * rather than a bunch individual delimiter characters) - * @param charsToDelete a set of characters to delete. Useful for deleting unwanted - * line breaks: e.g. "\r\n\f" will delete all new lines and line feeds in a String. - * @return an array of the tokens in the list - * @see #tokenizeToStringArray - */ - public static String[] delimitedListToStringArray(String str, String delimiter, String charsToDelete) { - if (str == null) { - return new String[0]; - } - if (delimiter == null) { - return new String[] {str}; - } - List result = new ArrayList(); - if ("".equals(delimiter)) { - for (int i = 0; i < str.length(); i++) { - result.add(deleteAny(str.substring(i, i + 1), charsToDelete)); - } - } - else { - int pos = 0; - int delPos = 0; - while ((delPos = str.indexOf(delimiter, pos)) != -1) { - result.add(deleteAny(str.substring(pos, delPos), charsToDelete)); - pos = delPos + delimiter.length(); - } - if (str.length() > 0 && pos <= str.length()) { - // Add rest of String, but not in case of empty input. - result.add(deleteAny(str.substring(pos), charsToDelete)); - } - } - return toStringArray(result); - } - - /** - * Convert a CSV list into an array of Strings. - * @param str the input String - * @return an array of Strings, or the empty array in case of empty input - */ - public static String[] commaDelimitedListToStringArray(String str) { - return delimitedListToStringArray(str, ","); - } - - /** - * Convenience method to convert a CSV string list to a set. - * Note that this will suppress duplicates. - * @param str the input String - * @return a Set of String entries in the list - */ - public static Set commaDelimitedListToSet(String str) { - Set set = new TreeSet(); - String[] tokens = commaDelimitedListToStringArray(str); - for (int i = 0; i < tokens.length; i++) { - set.add(tokens[i]); - } - return set; - } - - /** - * Convenience method to return a Collection as a delimited (e.g. CSV) - * String. E.g. useful for toString() implementations. - * @param coll the Collection to display - * @param delim the delimiter to use (probably a ",") - * @param prefix the String to start each element with - * @param suffix the String to end each element with - * @return the delimited String - */ - public static String collectionToDelimitedString(Collection coll, String delim, String prefix, String suffix) { - if (CollectionUtils.isEmpty(coll)) { - return ""; - } - StringBuffer sb = new StringBuffer(); - Iterator it = coll.iterator(); - while (it.hasNext()) { - sb.append(prefix).append(it.next()).append(suffix); - if (it.hasNext()) { - sb.append(delim); - } - } - return sb.toString(); - } - - /** - * Convenience method to return a Collection as a delimited (e.g. CSV) - * String. E.g. useful for toString() implementations. - * @param coll the Collection to display - * @param delim the delimiter to use (probably a ",") - * @return the delimited String - */ - public static String collectionToDelimitedString(Collection coll, String delim) { - return collectionToDelimitedString(coll, delim, "", ""); - } - - /** - * Convenience method to return a Collection as a CSV String. - * E.g. useful for toString() implementations. - * @param coll the Collection to display - * @return the delimited String - */ - public static String collectionToCommaDelimitedString(Collection coll) { - return collectionToDelimitedString(coll, ","); - } - - /** - * Convenience method to return a String array as a delimited (e.g. CSV) - * String. E.g. useful for toString() implementations. - * @param arr the array to display - * @param delim the delimiter to use (probably a ",") - * @return the delimited String - */ - public static String arrayToDelimitedString(Object[] arr, String delim) { - if (ObjectUtils.isEmpty(arr)) { - return ""; - } - StringBuffer sb = new StringBuffer(); - for (int i = 0; i < arr.length; i++) { - if (i > 0) { - sb.append(delim); - } - sb.append(arr[i]); - } - return sb.toString(); - } - - /** - * Convenience method to return a String array as a CSV String. - * E.g. useful for toString() implementations. - * @param arr the array to display - * @return the delimited String - */ - public static String arrayToCommaDelimitedString(Object[] arr) { - return arrayToDelimitedString(arr, ","); - } - -} diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/SystemPropertyUtils.java b/org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/SystemPropertyUtils.java deleted file mode 100644 index ff81a2219..000000000 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/internal/springutil/SystemPropertyUtils.java +++ /dev/null @@ -1,88 +0,0 @@ -/* - * Copyright 2002-2008 the original author or authors. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -package org.argeo.osgi.boot.internal.springutil; - -/** - * Helper class for resolving placeholders in texts. Usually applied to file paths. - * - *

A text may contain ${...} placeholders, to be resolved as - * system properties: e.g. ${user.dir}. - * - * @author Juergen Hoeller - * @since 1.2.5 - * @see #PLACEHOLDER_PREFIX - * @see #PLACEHOLDER_SUFFIX - * @see System#getProperty(String) - */ -public abstract class SystemPropertyUtils { - - /** Prefix for system property placeholders: "${" */ - public static final String PLACEHOLDER_PREFIX = "${"; - - /** Suffix for system property placeholders: "}" */ - public static final String PLACEHOLDER_SUFFIX = "}"; - - - /** - * Resolve ${...} placeholders in the given text, - * replacing them with corresponding system property values. - * @param text the String to resolve - * @return the resolved String - * @see #PLACEHOLDER_PREFIX - * @see #PLACEHOLDER_SUFFIX - */ - @SuppressWarnings("unused") - public static String resolvePlaceholders(String text) { - StringBuffer buf = new StringBuffer(text); - - int startIndex = buf.indexOf(PLACEHOLDER_PREFIX); - while (startIndex != -1) { - int endIndex = buf.indexOf(PLACEHOLDER_SUFFIX, startIndex + PLACEHOLDER_PREFIX.length()); - if (endIndex != -1) { - String placeholder = buf.substring(startIndex + PLACEHOLDER_PREFIX.length(), endIndex); - int nextIndex = endIndex + PLACEHOLDER_SUFFIX.length(); - try { - String propVal = System.getProperty(placeholder); - if (propVal == null) { - // Fall back to searching the system environment. - //propVal = System.getenv(placeholder);// mbaudier - 2009-07-26 - throw new Error("getenv no longer supported, use properties and -D instead: " + placeholder); - } - if (propVal != null) { - buf.replace(startIndex, endIndex + PLACEHOLDER_SUFFIX.length(), propVal); - nextIndex = startIndex + propVal.length(); - } - else { - System.err.println("Could not resolve placeholder '" + placeholder + "' in [" + text + - "] as system property: neither system property nor environment variable found"); - } - } - catch (Throwable ex) { - System.err.println("Could not resolve placeholder '" + placeholder + "' in [" + text + - "] as system property: " + ex); - } - startIndex = buf.indexOf(PLACEHOLDER_PREFIX, nextIndex); - } - else { - startIndex = -1; - } - } - - return buf.toString(); - } - -} diff --git a/pom.xml b/pom.xml index 2721905f8..d199b7ec1 100644 --- a/pom.xml +++ b/pom.xml @@ -20,7 +20,7 @@ - org.argeo.osgi.boot + org.argeo.init org.argeo.enterprise -- 2.30.2