Skip to content

Commit

Permalink
Update EnsureOakIndexManagerImpl to OSGi annotations
Browse files Browse the repository at this point in the history
  • Loading branch information
Jasper Simon committed Aug 8, 2024
1 parent 3cefedb commit 49981c5
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 63 deletions.
28 changes: 16 additions & 12 deletions bundle/src/main/java/com/adobe/acs/commons/oak/impl/EnsureOakIndex.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,8 @@
*/
package com.adobe.acs.commons.oak.impl;

import java.util.Collections;
import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;

import javax.jcr.RepositoryException;

import com.adobe.acs.commons.analysis.jcrchecksum.ChecksumGenerator;
import com.adobe.acs.commons.oak.EnsureOakIndexManager;
import org.apache.commons.lang.StringUtils;
import org.apache.sling.api.resource.ResourceResolverFactory;
import org.apache.sling.commons.scheduler.ScheduleOptions;
Expand All @@ -31,19 +27,23 @@
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.component.annotations.ReferenceCardinality;
import org.osgi.service.component.annotations.ReferencePolicy;
import org.osgi.service.component.annotations.ReferencePolicyOption;
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;

import com.adobe.acs.commons.analysis.jcrchecksum.ChecksumGenerator;
import com.adobe.acs.commons.oak.EnsureOakIndexManager;
import javax.jcr.RepositoryException;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;

//@formatter:off
@Component(
configurationPolicy = ConfigurationPolicy.REQUIRE,
immediate = true
configurationPolicy = ConfigurationPolicy.REQUIRE
)
@Designate(ocd = EnsureOakIndex.Config.class, factory = true)
//@formatter:on
Expand Down Expand Up @@ -105,8 +105,12 @@ public class EnsureOakIndex implements AppliableEnsureOakIndex {
@Reference
private Scheduler scheduler;

@Reference
private EnsureOakIndexManager indexManager;
@Reference(
cardinality = ReferenceCardinality.OPTIONAL,
policy = ReferencePolicy.DYNAMIC,
policyOption = ReferencePolicyOption.GREEDY
)
private volatile EnsureOakIndexManager indexManager;

private String ensureDefinitionsPath;
private String oakIndexesPath;
Expand Down
92 changes: 41 additions & 51 deletions bundle/src/main/java/com/adobe/acs/commons/oak/impl/EnsureOakIndexManagerImpl.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,16 @@
import com.adobe.acs.commons.util.RequireAem;
import com.adobe.granite.jmx.annotation.AnnotatedStandardMBean;
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.Properties;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Reference;
import org.apache.felix.scr.annotations.ReferenceCardinality;
import org.apache.felix.scr.annotations.ReferencePolicy;
import org.apache.felix.scr.annotations.Service;
import org.apache.felix.scr.annotations.ReferencePolicyOption;
import org.apache.sling.commons.osgi.PropertiesUtil;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.FieldOption;
import org.osgi.service.component.annotations.Reference;
import org.osgi.service.component.annotations.ReferenceCardinality;
import org.osgi.service.component.annotations.ReferencePolicy;
import org.osgi.service.component.annotations.ReferencePolicyOption;
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;

Expand Down Expand Up @@ -59,62 +59,52 @@

//@formatter:off
@Component(
label = "ACS AEM Commons - Ensure Oak Index Manager",
description = "Manage for ensuring oak indexes.",
service = {DynamicMBean.class, EnsureOakIndexManager.class},
immediate = true,
metatype = true
property = {
"felix.webconsole.title=Ensure Oak Index",
"felix.webconsole.label=ensureOakIndex",
"felix.webconsole.category=Sling",
"jmx.objectname=com.adobe.acs.commons.oak:type=Ensure Oak Index"
}
)
@Properties({
@Property(
name = "webconsole.configurationFactory.nameHint",
value = "Additional Ignore properties: {properties.ignore}",
propertyPrivate = true
),
@Property(
name = "felix.webconsole.title",
value = "Ensure Oak Index",
propertyPrivate = true
),
@Property(
name = "felix.webconsole.label",
value = "ensureOakIndex",
propertyPrivate = true
),
@Property(
name = "felix.webconsole.category",
value = "Sling",
propertyPrivate = true
),
@Property(
name = "jmx.objectname",
value = "com.adobe.acs.commons.oak:type=Ensure Oak Index",
propertyPrivate = true
)
})
@Service(value = {DynamicMBean.class, EnsureOakIndexManager.class})
@Designate(ocd = EnsureOakIndexManagerImpl.Config.class)
//@formatter:on
public class EnsureOakIndexManagerImpl extends AnnotatedStandardMBean implements EnsureOakIndexManager, EnsureOakIndexManagerMBean {
private static final Logger log = LoggerFactory.getLogger(EnsureOakIndexManagerImpl.class);

//@formatter:off
private static final String[] DEFAULT_ADDITIONAL_IGNORE_PROPERTIES = new String[]{};
private String[] additionalIgnoreProperties = DEFAULT_ADDITIONAL_IGNORE_PROPERTIES;
@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 Manager",
description = "Manage for ensuring oak indexes."
)
@interface Config {

@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 "Additional Ignore properties: {properties.ignore}";

}

// Disable this feature on AEM as a Cloud Service
@Reference(target="(distribution=classic)")
RequireAem requireAem;

@Reference(
cardinality = ReferenceCardinality.OPTIONAL_MULTIPLE,
policyOption = ReferencePolicyOption.GREEDY,
referenceInterface = AppliableEnsureOakIndex.class,
policy = ReferencePolicy.DYNAMIC
cardinality = ReferenceCardinality.MULTIPLE,
policyOption = ReferencePolicyOption.GREEDY,
policy = ReferencePolicy.DYNAMIC,
fieldOption = FieldOption.UPDATE
)
// Thread-safe ArrayList to track EnsureIndex service registrations
private CopyOnWriteArrayList<AppliableEnsureOakIndex> ensureIndexes =
Expand Down Expand Up @@ -218,8 +208,8 @@ public final TabularData getEnsureOakIndexes() throws OpenDataException {


@Activate
protected void activate(Map<String, Object> config) {
additionalIgnoreProperties = PropertiesUtil.toStringArray(config.get(PROP_ADDITIONAL_IGNORE_PROPERTIES), DEFAULT_ADDITIONAL_IGNORE_PROPERTIES);
protected void activate(Config config) {
additionalIgnoreProperties = config.properties_ignore();
}


Expand Down

0 comments on commit 49981c5

Please sign in to comment.