OSGI dynamic scheduler + configurationFactory

Hello cqlearner,

How could you expect the activate method of Scheduler to be called on every config add/change in FactoryConfigService, both are separate OSGI components and have their own lifecycle.

Now I am explaining a couple of ways to solve it.

1. Via ManagedServiceFactory - Recommended One.

/** * SchedulerManagedServiceFactory * * @author Rakesh.Kumar, NextEon Solutions. */ @Service(ManagedServiceFactory.class) @Component(immediate = true, metatype = true, label = "SchedulerManagedServiceFactory", configurationFactory = true) public class SchedulerManagedServiceFactory implements ManagedServiceFactory { /** * Map that will hold the Managed Instances. */ private final ConcurrentMap<String, ManagedScheduler> managedSchedulers = new ConcurrentHashMap<>(); /** * Configurable Property cronExpr. */ @Property( label = "Cron Expression", description = "Cron Expression for the job : See - http://docs.oracle.com/cd/E12058_01/doc/doc.1014/e12030/cron_expressions.htm") private static final String CRON_EXPRESSION = "cronExpr"; /** * Sling Scheduler. */ @Reference private Scheduler scheduler; @Override public String getName() { return "Simple Scheduler ManagedServiceFactory"; } @Override public void updated(String pid, Dictionary<String, ?> properties) throws ConfigurationException { String cronExpr = PropertiesUtil.toString(properties.get(CRON_EXPRESSION), ""); ManagedScheduler managedScheduler = this.managedSchedulers.get(pid); // Means a new configuration. if (managedScheduler == null) { // Create a new one and put into the managedSchedulers map SchedulerConfig schedulerConfig = new SchedulerConfig(cronExpr); ManagedScheduler ms = new ManagedScheduler(this.scheduler, schedulerConfig); boolean isScheduled = ms.schedule(pid, schedulerConfig); if (isScheduled) { this.managedSchedulers.put(pid, ms); } else { // Take you action } } else { // configuration already exists. // Check if cronExpr changed, you may want to re-schedule it. } } @Override public void deleted(String pid) { ManagedScheduler managedScheduler = this.managedSchedulers.remove(pid); if (managedSchedulers != null) { managedSchedulers.unschedule(pid); } } } /** * @author Rakesh.Kumar, NextEon Solutions. */ public class ManagedScheduler { // Sling Scheduler - org.apache.sling.commons.scheduler.Scheduler private Scheduler scheduler; // To maintain the configs from SchedulerManagedServiceFactory. private SchedulerConfig config; public ManagedScheduler(Scheduler scheduler, SchedulerConfig config) { this.scheduler = scheduler; this.setConfig(config); } public boolean schedule(String jobName, SchedulerConfig config) { ScheduleOptions scheduleOptions = this.scheduler.EXPR(config.getCronExpr()); scheduleOptions.name(jobName); Map<String, Serializable> configMap = new HashMap<>(); configMap.put("blah", "blah"); scheduleOptions.config(configMap); return this.scheduler.schedule(new SimpleJob(), scheduleOptions); } public boolean unschedule(String pid) { return this.scheduler.unschedule(pid); } } /** * Simple Sling Job Implementation to be passed to a scheduler. * * @author Rakesh.Kumar, NextEon Solutions. */ public class SimpleJob implements org.apache.sling.commons.scheduler.Job { /** * Execute this job. * * @param context *            - The context of the job. */ @Override public void execute(JobContext jobContext) { // Do your stuff here. } } /** * @author Rakesh.Kumar, NextEon Solutions. */ public class SchedulerConfig { private String cronExpr; // Other configs /** * @param cronExpr */ public SchedulerConfig(String cronExpr) { this.cronExpr = cronExpr; } /** * @return the cronExpr */ public String getCronExpr() { return cronExpr; } /** * @param cronExpr *            the cronExpr to set */ public void setCronExpr(String cronExpr) { this.cronExpr = cronExpr; } }

2. Via ComponentFactory

/** * ComponentFactory * * @author Rakesh.Kumar, NextEon Solutions. */ @Component(factory = "scheduler.componentInstance") public class SchedulerComponent { @Activate protected void activate(ComponentContext context) { Dictionary<?,?> props = context.getProperties(); // do with configs } // More relevant methods. Like schedule/unschedule } // Now in you FactoryConfigService Inject a ComponentFactory which get the factory component registered above. @Reference(target = "(component.factory=scheduler.componentInstance)") private ComponentFactory factory; // Then in activate of FactoryConfigService /** * Map that will hold the ComponentInstance against a key, may be cronExpr. */ private final ConcurrentMap<String, ComponentInstance> componentInstances = new ConcurrentHashMap<>(); @Activate protected void activate(ComponentContext context) { Dictionary<?,?> props = context.getProperties(); this.instance = factory.newInstance(props); ComponentInstance instance = instance.getInstance(); SchedulerComponent comp = (SchedulerComponent)instance; // you may want to call any method on SchedulerComponent here this.componentInstances.put("your key - may be cron itself", instance); } @Deactivate public void deactivate(ComponentContext context) { // You should dispose of all the ComponentInstance this.componentInstances.forEach((cron, compInstance) -> compInstance.dispose()); }

This is the most comprehensive example i could give and hoping this will help you.

Please let me know if you want to discuss anything

Thanks,

Rakesh