You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by dk...@apache.org on 2021/04/22 17:56:54 UTC
[sling-org-apache-sling-superimposing] branch java-11-osgi6-compat
created (now 2639bc6)
This is an automated email from the ASF dual-hosted git repository.
dklco pushed a change to branch java-11-osgi6-compat
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-superimposing.git.
at 2639bc6 Progress on updating Sling SuperImposing to work in Java 11 and OSGi6
This branch includes the following new commits:
new 2639bc6 Progress on updating Sling SuperImposing to work in Java 11 and OSGi6
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[sling-org-apache-sling-superimposing] 01/01: Progress on updating
Sling SuperImposing to work in Java 11 and OSGi6
Posted by dk...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
dklco pushed a commit to branch java-11-osgi6-compat
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-superimposing.git
commit 2639bc6492c151d7e2caa406864d892e8cb38527
Author: Dan Klco <kl...@adobe.com>
AuthorDate: Thu Apr 22 13:56:35 2021 -0400
Progress on updating Sling SuperImposing to work in Java 11 and OSGi6
---
.gitignore | 1 +
bnd.bnd | 1 +
pom.xml | 63 ++++------
.../impl/SuperimposingManagerImpl.java | 137 ++++++++++++---------
4 files changed, 103 insertions(+), 99 deletions(-)
diff --git a/.gitignore b/.gitignore
index 5b783ed..86105a7 100644
--- a/.gitignore
+++ b/.gitignore
@@ -4,6 +4,7 @@
.metadata
.project
.settings
+.vscode/
.externalToolBuilders
maven-eclipse.xml
*.swp
diff --git a/bnd.bnd b/bnd.bnd
new file mode 100644
index 0000000..a326674
--- /dev/null
+++ b/bnd.bnd
@@ -0,0 +1 @@
+Sling-Nodetypes: SLING-INF/nodetypes/superimposing.cnd
\ No newline at end of file
diff --git a/pom.xml b/pom.xml
index cf77b8d..f29fc21 100644
--- a/pom.xml
+++ b/pom.xml
@@ -19,14 +19,13 @@
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.apache.sling</groupId>
- <artifactId>sling</artifactId>
- <version>26</version>
- <relativePath/>
+ <artifactId>sling-bundle-parent</artifactId>
+ <version>41</version>
+ <relativePath />
</parent>
<artifactId>org.apache.sling.superimposing</artifactId>
<version>0.2.1-SNAPSHOT</version>
- <packaging>bundle</packaging>
<name>Apache Sling Superimposing Resource Provider</name>
<description>
@@ -43,29 +42,9 @@
<build>
<plugins>
-
- <plugin>
- <groupId>org.apache.felix</groupId>
- <artifactId>maven-scr-plugin</artifactId>
- </plugin>
-
<plugin>
- <groupId>org.apache.felix</groupId>
- <artifactId>maven-bundle-plugin</artifactId>
- <extensions>true</extensions>
- <configuration>
- <instructions>
- <Export-Package>org.apache.sling.superimposing</Export-Package>
- <Private-Package>org.apache.sling.superimposing.impl</Private-Package>
- <DynamicImport-Package>org.apache.felix.webconsole</DynamicImport-Package>
- <Sling-Nodetypes>SLING-INF/nodetypes/superimposing.cnd</Sling-Nodetypes>
- </instructions>
- </configuration>
- </plugin>
-
- <plugin>
- <groupId>org.apache.sling</groupId>
- <artifactId>maven-sling-plugin</artifactId>
+ <groupId>biz.aQute.bnd</groupId>
+ <artifactId>bnd-maven-plugin</artifactId>
</plugin>
</plugins>
@@ -75,7 +54,7 @@
<dependency>
<groupId>org.apache.sling</groupId>
<artifactId>org.apache.sling.api</artifactId>
- <version>2.2.0</version>
+ <version>2.23.0</version>
<scope>provided</scope>
</dependency>
<dependency>
@@ -106,35 +85,39 @@
<dependency>
<groupId>org.osgi</groupId>
- <artifactId>org.osgi.core</artifactId>
- <scope>compile</scope>
+ <artifactId>osgi.core</artifactId>
+ <scope>provided</scope>
</dependency>
<dependency>
<groupId>org.osgi</groupId>
- <artifactId>org.osgi.compendium</artifactId>
- <scope>compile</scope>
+ <artifactId>osgi.cmpn</artifactId>
+ <scope>provided</scope>
</dependency>
<dependency>
+ <groupId>org.osgi</groupId>
+ <artifactId>org.osgi.service.component.annotations</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.osgi</groupId>
+ <artifactId>org.osgi.service.metatype.annotations</artifactId>
+ </dependency>
+
+ <dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
- <scope>compile</scope>
+ <scope>provided</scope>
</dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
- <scope>compile</scope>
+ <version>2.5</version>
+ <scope>provided</scope>
</dependency>
<dependency>
<groupId>javax.jcr</groupId>
<artifactId>jcr</artifactId>
<version>2.0</version>
- <scope>compile</scope>
- </dependency>
-
- <dependency>
- <groupId>org.apache.felix</groupId>
- <artifactId>org.apache.felix.scr.annotations</artifactId>
- <scope>compile</scope>
+ <scope>provided</scope>
</dependency>
<dependency>
diff --git a/src/main/java/org/apache/sling/superimposing/impl/SuperimposingManagerImpl.java b/src/main/java/org/apache/sling/superimposing/impl/SuperimposingManagerImpl.java
index 055ecfa..bdd4d2d 100644
--- a/src/main/java/org/apache/sling/superimposing/impl/SuperimposingManagerImpl.java
+++ b/src/main/java/org/apache/sling/superimposing/impl/SuperimposingManagerImpl.java
@@ -40,13 +40,6 @@ import javax.jcr.observation.EventListener;
import org.apache.commons.collections.IteratorUtils;
import org.apache.commons.lang.StringUtils;
-import org.apache.felix.scr.annotations.Activate;
-import org.apache.felix.scr.annotations.Component;
-import org.apache.felix.scr.annotations.Deactivate;
-import org.apache.felix.scr.annotations.Property;
-import org.apache.felix.scr.annotations.PropertyUnbounded;
-import org.apache.felix.scr.annotations.Reference;
-import org.apache.felix.scr.annotations.Service;
import org.apache.sling.api.resource.LoginException;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ResourceResolver;
@@ -57,40 +50,48 @@ import org.apache.sling.superimposing.SuperimposingManager;
import org.apache.sling.superimposing.SuperimposingResourceProvider;
import org.osgi.framework.BundleContext;
import org.osgi.service.component.ComponentContext;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Deactivate;
+import org.osgi.service.component.annotations.Reference;
+import org.osgi.service.metatype.annotations.AttributeDefinition;
+import org.osgi.service.metatype.annotations.Designate;
+import org.osgi.service.metatype.annotations.ObjectClassDefinition;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Manages the resource registrations for the {@link SuperimposingResourceProviderImpl}.
- * Provides read-only access to all registered providers.
+ * Manages the resource registrations for the
+ * {@link SuperimposingResourceProviderImpl}. Provides read-only access to all
+ * registered providers.
*/
-@Component(label = "Apache Sling Superimposing Resource Manager",
- description = "Manages the resource registrations for the Superimposing Resource Provider.",
- immediate = true, metatype = true)
-@Service(SuperimposingManager.class)
+@Component(service = { SuperimposingManager.class }, immediate = true)
+@Designate(ocd = SuperimposingManagerImpl.SuperimposingManagerConfig.class)
public class SuperimposingManagerImpl implements SuperimposingManager, EventListener {
- @Property(label = "Enabled", description = "Enable/Disable the superimposing functionality.", boolValue = SuperimposingManagerImpl.ENABLED_DEFAULT)
- static final String ENABLED_PROPERTY = "enabled";
- static final boolean ENABLED_DEFAULT = false;
- private boolean enabled;
+ @ObjectClassDefinition(name = "Apache Sling Superimposing Resource Manager", description = "Manages the resource registrations for the Superimposing Resource Provider")
+ public @interface SuperimposingManagerConfig {
- @Property(label = "Find all Queries", description = "List of query expressions to find all existing superimposing registrations on service startup. "
- + "Query syntax is depending on underlying resource provdider implementation. Prepend the query with query syntax name separated by \"|\".",
- value={SuperimposingManagerImpl.FINDALLQUERIES_DEFAULT}, unbounded=PropertyUnbounded.ARRAY)
- static final String FINDALLQUERIES_PROPERTY = "findAllQueries";
- static final String FINDALLQUERIES_DEFAULT = "JCR-SQL2|SELECT * FROM [" + MIXIN_SUPERIMPOSE + "] WHERE ISDESCENDANTNODE('/content')";
- private String[] findAllQueries;
+ @AttributeDefinition(name = "Enabled", description = "Enable/Disable the superimposing functionality")
+ boolean enabled() default false;
+
+ @AttributeDefinition(name = "Find all Queries", description = "List of query expressions to find all existing superimposing registrations on service startup. "
+ + "Query syntax is depending on underlying resource provdider implementation. Prepend the query with query syntax name separated by \"|\".")
+ String[] findAllQueries() default {
+ "JCR-SQL2|SELECT * FROM [" + MIXIN_SUPERIMPOSE + "] WHERE ISDESCENDANTNODE('/content')" };
+
+ @AttributeDefinition(name = "Obervation paths", description = "List of paths that should be monitored for resource events to detect superimposing content nodes")
+ String[] observationPaths() default { "/content" };
+ }
- @Property(label = "Obervation paths", description = "List of paths that should be monitored for resource events to detect superimposing content nodes.",
- value={SuperimposingManagerImpl.OBSERVATION_PATHS_DEFAULT}, unbounded=PropertyUnbounded.ARRAY)
- static final String OBSERVATION_PATHS_PROPERTY = "obervationPaths";
- static final String OBSERVATION_PATHS_DEFAULT = "/content";
+ private boolean enabled;
+ private String[] findAllQueries;
private String[] obervationPaths;
private EventListener[] observationEventListeners;
/**
- * Map for holding the superimposing mappings, with the superimpose path as key and the providers as values
+ * Map for holding the superimposing mappings, with the superimpose path as key
+ * and the providers as values
*/
private ConcurrentMap<String, SuperimposingResourceProviderImpl> superimposingProviders = new ConcurrentHashMap<String, SuperimposingResourceProviderImpl>();
@@ -103,8 +104,8 @@ public class SuperimposingManagerImpl implements SuperimposingManager, EventList
private ResourceResolver resolver;
/**
- * A reference to the initialization task. Needed to check if
- * initialization has completed.
+ * A reference to the initialization task. Needed to check if initialization has
+ * completed.
*/
Future<?> initialization;
@@ -119,8 +120,16 @@ public class SuperimposingManagerImpl implements SuperimposingManager, EventList
private static final Logger log = LoggerFactory.getLogger(SuperimposingManagerImpl.class);
+ public SuperimposingManagerImpl(@Reference
+ private ResourceResolverFactory resolverFactory){
+
+ }
+
+
/**
- * Find all existing superimposing registrations using all query defined in service configuration.
+ * Find all existing superimposing registrations using all query defined in
+ * service configuration.
+ *
* @param resolver Resource resolver
* @return All superimposing registrations
*/
@@ -129,7 +138,8 @@ public class SuperimposingManagerImpl implements SuperimposingManager, EventList
List<Resource> allResources = new ArrayList<Resource>();
for (String queryString : this.findAllQueries) {
if (!StringUtils.contains(queryString, "|")) {
- throw new IllegalArgumentException("Query string does not contain query syntax seperated by '|': " + queryString);
+ throw new IllegalArgumentException(
+ "Query string does not contain query syntax seperated by '|': " + queryString);
}
String queryLanguage = StringUtils.substringBefore(queryString, "|");
String query = StringUtils.substringAfter(queryString, "|");
@@ -167,7 +177,8 @@ public class SuperimposingManagerImpl implements SuperimposingManager, EventList
private boolean registerProvider(Resource superimposingResource) {
String superimposePath = superimposingResource.getPath();
- // use JCR API to get properties from superimposing resource to make sure superimposing does not delivery values from source node
+ // use JCR API to get properties from superimposing resource to make sure
+ // superimposing does not delivery values from source node
final String sourcePath = getJcrStringProperty(superimposePath, PROP_SUPERIMPOSE_SOURCE_PATH);
final boolean registerParent = getJcrBooleanProperty(superimposePath, PROP_SUPERIMPOSE_REGISTER_PARENT);
final boolean overlayable = getJcrBooleanProperty(superimposePath, PROP_SUPERIMPOSE_OVERLAYABLE);
@@ -176,13 +187,14 @@ public class SuperimposingManagerImpl implements SuperimposingManager, EventList
boolean valid = true;
if (StringUtils.isBlank(sourcePath)) {
valid = false;
- }
- else {
- // check whether the parent of the node should be registered as superimposing provider
+ } else {
+ // check whether the parent of the node should be registered as superimposing
+ // provider
if (registerParent) {
superimposePath = ResourceUtil.getParent(superimposePath);
}
- // target path is not valid if it equals to a parent or child of the superimposing path, or to the superimposing path itself
+ // target path is not valid if it equals to a parent or child of the
+ // superimposing path, or to the superimposing path itself
if (StringUtils.equals(sourcePath, superimposePath)
|| StringUtils.startsWith(sourcePath, superimposePath + "/")
|| StringUtils.startsWith(superimposePath, sourcePath + "/")) {
@@ -192,7 +204,8 @@ public class SuperimposingManagerImpl implements SuperimposingManager, EventList
// register valid superimposing
if (valid) {
- final SuperimposingResourceProviderImpl srp = new SuperimposingResourceProviderImpl(superimposePath, sourcePath, overlayable);
+ final SuperimposingResourceProviderImpl srp = new SuperimposingResourceProviderImpl(superimposePath,
+ sourcePath, overlayable);
final SuperimposingResourceProviderImpl oldSrp = superimposingProviders.put(superimposePath, srp);
// unregister in case there was a provider registered before
@@ -204,11 +217,13 @@ public class SuperimposingManagerImpl implements SuperimposingManager, EventList
srp.registerService(bundleContext);
return true;
} else {
- log.debug("Skipped re-registering resource provider {} because there were no relevant changes.", superimposePath);
+ log.debug("Skipped re-registering resource provider {} because there were no relevant changes.",
+ superimposePath);
}
}
- // otherwise remove previous superimposing resource provider if new superimposing definition is not valid
+ // otherwise remove previous superimposing resource provider if new
+ // superimposing definition is not valid
else {
final SuperimposingResourceProviderImpl oldSrp = superimposingProviders.remove(superimposePath);
if (null != oldSrp) {
@@ -229,8 +244,7 @@ public class SuperimposingManagerImpl implements SuperimposingManager, EventList
return null;
}
return session.getProperty(absolutePropertyPath).getString();
- }
- catch (RepositoryException ex) {
+ } catch (RepositoryException ex) {
return null;
}
}
@@ -243,8 +257,7 @@ public class SuperimposingManagerImpl implements SuperimposingManager, EventList
return false;
}
return session.getProperty(absolutePropertyPath).getBoolean();
- }
- catch (RepositoryException ex) {
+ } catch (RepositoryException ex) {
return false;
}
}
@@ -278,27 +291,30 @@ public class SuperimposingManagerImpl implements SuperimposingManager, EventList
}
// get "find all" queries
- this.findAllQueries = PropertiesUtil.toStringArray(props.get(FINDALLQUERIES_PROPERTY), new String[] { FINDALLQUERIES_DEFAULT });
- this.obervationPaths = PropertiesUtil.toStringArray(props.get(OBSERVATION_PATHS_PROPERTY), new String[] { OBSERVATION_PATHS_DEFAULT });
+ this.findAllQueries = PropertiesUtil.toStringArray(props.get(FINDALLQUERIES_PROPERTY),
+ new String[] { FINDALLQUERIES_DEFAULT });
+ this.obervationPaths = PropertiesUtil.toStringArray(props.get(OBSERVATION_PATHS_PROPERTY),
+ new String[] { OBSERVATION_PATHS_DEFAULT });
if (null == resolver) {
bundleContext = ctx.getBundleContext();
resolver = resolverFactory.getAdministrativeResourceResolver(null);
// Watch for events on the root to register/deregister superimposings at runtime
- // For each observed path create an event listener object which redirects the event to the main class
+ // For each observed path create an event listener object which redirects the
+ // event to the main class
final Session session = resolver.adaptTo(Session.class);
- if (session!=null) {
+ if (session != null) {
this.observationEventListeners = new EventListener[this.obervationPaths.length];
- for (int i=0; i<this.obervationPaths.length; i++) {
+ for (int i = 0; i < this.obervationPaths.length; i++) {
this.observationEventListeners[i] = new EventListener() {
public void onEvent(EventIterator events) {
SuperimposingManagerImpl.this.onEvent(events);
}
};
- session.getWorkspace().getObservationManager().addEventListener(
- this.observationEventListeners[i],
- Event.NODE_ADDED | Event.NODE_REMOVED | Event.PROPERTY_ADDED | Event.PROPERTY_CHANGED | Event.PROPERTY_REMOVED,
+ session.getWorkspace().getObservationManager().addEventListener(this.observationEventListeners[i],
+ Event.NODE_ADDED | Event.NODE_REMOVED | Event.PROPERTY_ADDED | Event.PROPERTY_CHANGED
+ | Event.PROPERTY_REMOVED,
this.obervationPaths[i], // absolute path
true, // isDeep
null, // uuids
@@ -309,14 +325,15 @@ public class SuperimposingManagerImpl implements SuperimposingManager, EventList
// register all superimposing definitions that already exist
initialization = Executors.newSingleThreadExecutor().submit(new Runnable() {
+
public void run() {
try {
registerAllSuperimposings();
- }
- catch (Throwable ex) {
+ } catch (Throwable ex) {
log.warn("Error registering existing superimposing resources on service startup.", ex);
}
}
+
});
}
}
@@ -330,9 +347,9 @@ public class SuperimposingManagerImpl implements SuperimposingManager, EventList
}
// de-register JCR observation
- if (resolver!=null) {
+ if (resolver != null) {
final Session session = resolver.adaptTo(Session.class);
- if (session!=null && this.observationEventListeners!=null) {
+ if (session != null && this.observationEventListeners != null) {
for (EventListener eventListener : this.observationEventListeners) {
session.getWorkspace().getObservationManager().removeEventListener(eventListener);
}
@@ -413,9 +430,11 @@ public class SuperimposingManagerImpl implements SuperimposingManager, EventList
}
/**
- * @return Iterator with all superimposing resource providers currently registered.
- * Iterator is backed by a {@link java.util.concurrent.ConcurrentHashMap} and is safe to access
- * even if superimposing resource providers are registered or unregistered at the same time.
+ * @return Iterator with all superimposing resource providers currently
+ * registered. Iterator is backed by a
+ * {@link java.util.concurrent.ConcurrentHashMap} and is safe to access
+ * even if superimposing resource providers are registered or
+ * unregistered at the same time.
*/
@SuppressWarnings("unchecked")
public Iterator<SuperimposingResourceProvider> getRegisteredProviders() {