From 8083db87842fb37b6910554ee8a8036ee01083cb Mon Sep 17 00:00:00 2001 From: Jasper Simon Date: Tue, 6 Aug 2024 09:27:10 +0200 Subject: [PATCH] Update EnsureOakIndex OSGi annotations --- .../acs/commons/oak/impl/EnsureOakIndex.java | 105 +++++++++--------- 1 file changed, 53 insertions(+), 52 deletions(-) diff --git a/bundle/src/main/java/com/adobe/acs/commons/oak/impl/EnsureOakIndex.java b/bundle/src/main/java/com/adobe/acs/commons/oak/impl/EnsureOakIndex.java index 38648c4575..d6e324caf1 100644 --- a/bundle/src/main/java/com/adobe/acs/commons/oak/impl/EnsureOakIndex.java +++ b/bundle/src/main/java/com/adobe/acs/commons/oak/impl/EnsureOakIndex.java @@ -19,23 +19,21 @@ import java.util.Collections; import java.util.List; -import java.util.Map; import java.util.concurrent.CopyOnWriteArrayList; import javax.jcr.RepositoryException; 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.ConfigurationPolicy; -import org.apache.felix.scr.annotations.Properties; -import org.apache.felix.scr.annotations.Property; -import org.apache.felix.scr.annotations.Reference; -import org.apache.felix.scr.annotations.Service; import org.apache.sling.api.resource.ResourceResolverFactory; -import org.apache.sling.commons.osgi.PropertiesUtil; import org.apache.sling.commons.scheduler.ScheduleOptions; import org.apache.sling.commons.scheduler.Scheduler; +import org.osgi.service.component.annotations.Activate; +import org.osgi.service.component.annotations.Component; +import org.osgi.service.component.annotations.ConfigurationPolicy; +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; @@ -44,55 +42,60 @@ //@formatter:off @Component( - label = "ACS AEM Commons - Ensure Oak Index", - description = "Component Factory to manage Oak indexes.", - configurationFactory = true, - policy = ConfigurationPolicy.REQUIRE, - metatype = true, + configurationPolicy = ConfigurationPolicy.REQUIRE, immediate = true ) -@Properties({ - @Property( - name = "webconsole.configurationFactory.nameHint", - value = "Definitions: {ensure-definitions.path}, Indexes: {oak-indexes.path}", - propertyPrivate = true - ) -}) -@Service +@Designate(ocd = EnsureOakIndex.Config.class, factory = true) //@formatter:on public class EnsureOakIndex implements AppliableEnsureOakIndex { static final Logger log = LoggerFactory.getLogger(EnsureOakIndex.class); //@formatter:off private static final String DEFAULT_ENSURE_DEFINITIONS_PATH = StringUtils.EMPTY; - @Property(label = "Ensure Definitions Path", - description = "The absolute path to the resource containing the " - + "ACS AEM Commons ensure definitions", - value = DEFAULT_ENSURE_DEFINITIONS_PATH) - public static final String PROP_ENSURE_DEFINITIONS_PATH = "ensure-definitions.path"; - - private static final String DEFAULT_OAK_INDEXES_PATH = "/oak:index"; - @Property(label = "Oak Indexes Path", - description = "The absolute path to the oak:index to update; Defaults to [ /oak:index ]", - value = DEFAULT_OAK_INDEXES_PATH) - public static final String PROP_OAK_INDEXES_PATH = "oak-indexes.path"; - private static final boolean DEFAULT_IMMEDIATE = true; - @Property( - label = "Immediate", - description = "Apply the indexes on startup of service. Defaults to [ true ]", - boolValue = DEFAULT_IMMEDIATE - ) + public static final String PROP_ENSURE_DEFINITIONS_PATH = "ensure-definitions.path"; + public static final String PROP_OAK_INDEXES_PATH = "oak-indexes.path"; public static final String PROP_IMMEDIATE = "immediate"; - - private static final String[] DEFAULT_ADDITIONAL_IGNORE_PROPERTIES = new String[]{}; - @Property(label = "Additional ignore properties", - description = "Property names that are to be ignored when determining if an oak index has changed, as well as what properties should be removed/updated.", - cardinality = Integer.MAX_VALUE, - value = {}) public static final String PROP_ADDITIONAL_IGNORE_PROPERTIES = "properties.ignore"; + @ObjectClassDefinition( + name = "ACS AEM Commons - Ensure Oak Index", + description = "Component Factory to manage Oak indexes." + ) + @interface Config { + + @AttributeDefinition( + name = "Ensure Definitions Path", + description = "The absolute path to the resource containing the " + + "ACS AEM Commons ensure definitions" + ) + String ensure$_$definitions_path() default DEFAULT_ENSURE_DEFINITIONS_PATH; + + @AttributeDefinition( + name = "Oak Indexes Path", + description = "The absolute path to the oak:index to update; Defaults to [ /oak:index ]" + ) + String oak$_$indexes_path() default DEFAULT_OAK_INDEXES_PATH; + + @AttributeDefinition( + name = "Immediate", + description = "Apply the indexes on startup of service. Defaults to [ true ]" + ) + boolean immediate() default DEFAULT_IMMEDIATE; + + @AttributeDefinition( + name = "Additional ignore properties", + description = "Property names that are to be ignored when determining if an oak index has changed, " + + "as well as what properties should be removed/updated.", + cardinality = Integer.MAX_VALUE + ) + String[] properties_ignore() default {}; + + String webconsole_configurationFactory_nameHint() default "Definitions: {ensure-definitions.path}, Indexes: {oak-indexes.path}"; + + } + @Reference private ChecksumGenerator checksumGenerator; @@ -113,13 +116,11 @@ public class EnsureOakIndex implements AppliableEnsureOakIndex { //@formatter:on @Activate - protected final void activate(Map config) throws RepositoryException { + protected final void activate(Config config) throws RepositoryException { - ensureDefinitionsPath = PropertiesUtil.toString(config.get(PROP_ENSURE_DEFINITIONS_PATH), - DEFAULT_ENSURE_DEFINITIONS_PATH); + ensureDefinitionsPath = config.ensure$_$definitions_path(); - oakIndexesPath = PropertiesUtil.toString(config.get(PROP_OAK_INDEXES_PATH), - DEFAULT_OAK_INDEXES_PATH); + oakIndexesPath = config.oak$_$indexes_path(); if (StringUtils.isBlank(ensureDefinitionsPath)) { throw new IllegalArgumentException("OSGi Configuration Property `" @@ -129,9 +130,9 @@ protected final void activate(Map config) throws RepositoryExcep + PROP_OAK_INDEXES_PATH + "` " + "cannot be blank."); } - this.immediate = PropertiesUtil.toBoolean(config.get(PROP_IMMEDIATE), DEFAULT_IMMEDIATE); + this.immediate = config.immediate(); - String[] ignoredProps = PropertiesUtil.toStringArray(config.get(PROP_ADDITIONAL_IGNORE_PROPERTIES), DEFAULT_ADDITIONAL_IGNORE_PROPERTIES); + String[] ignoredProps = config.properties_ignore(); String[] indexManagerIgnoredProps = getIndexManagerConfiguredIgnoreProperties(); if (ignoredProps.length == 0) {