Set OSGi Component properties dynamically using OCD - Use case with Sling ResourceChangeListener

This post demonstrates the use of Object Class Definition(OCD) in setting the OSGi component properties.


In general, per OSGi R6 annotations and above, we can set OSGi component properties via

  • property attribute of @Component annotation (Static values) or
  • Dynamically using @ObjectClassDefinition together with @AttributeDefinition  (property amends in run time via Config Admin or /system/console/configMgr)
    • AttributeDefinition should be framed such that it evaluates to the property name correctly (underscores are converted to dots/period)
    • Association of OCD with OSGi component happens via annotation named @Designate

Example : Component properties like service.ranking and in case of specific implementations like say WorkflowProcess, we set property named process.label and for EventHandler, it is EventConstants.EVENT_TOPIC and examples add on in a similar fashion for any OSGi Component for that matter.  

OSGi Component Properties
In order to illustrate this, I would like to consider Sling ResourceChangeListener which expects the PATHS (mandatory property) to which it should listen to and optional CHANGES (added/removed/changed) and PROPERTY_NAMES_HINT (property name on the resource)

For static property values, we would write an Implementation for Listener like below. Sling ResourceChangeListener

Now for amending properties dynamically via Config Admin, we can create OCD in a separate file or within the same OSGi component.
In this case, ResourceChangeListener.PATHS is a field for the constant value - resource.paths. Hence @AttributeDefinition would be resource_paths(). Same way for other two properties.

Complete code snippet : 


On a long run, if we are to move to AEM as a Cloud service, this use case of dynamically amending properties via Config Admin/run time changes will not be applicable. However, if there is a situation of run mode specific OSGi component properties needs, then we can create OSGi config like we usually do for custom properties. (code level changes/ no run time)

Using the same example, 
  • Generic config listens for change of jcr:lastModified property on specified Asset resource. 
  • Author listens for change of cq:lastModified property on specified Page resource

OSGi Config - ResourceChangeListener


OSGi Config - ResourceChangeListener


I had a chance to respond to similar query in the Community, sharing the respective thread for reference -  https://experienceleaguecommunities.adobe.com/t5/adobe-experience-manager/multiple-paths-handling-in-eventhandler-not-working/m-p/426921

Comments

  1. Rupesh Kumar September 5, 2022 at 9:13 AM

    https://beautyplus.rauabm.org.in

    ReplyDelete
  2. CoindevelopmentcompanyJanuary 24, 2024 at 2:37 AM

    Coin Development Company Coin Development Company is a trusted partner in cryptocurrency development, offering expert team, tailored solutions, innovative technology, security, and comprehensive support. We specialize in coin creation, token development, smart contracts, and blockchain consulting. Our team focuses on staying ahead of the curve, ensuring your coin stands out in the market, and providing ongoing maintenance and updates to keep your coin running smoothly.

    ReplyDelete

Post a Comment

Popular posts from this blog

Embedding Third party dependency/OSGi bundle in AEM application hosted in AEMasCS

Image
This post illustrate the ways of embedding third party dependency in AEM maven project. Steps are mentioned considering the project structure to be followed for AEMasCS while the same can be followed for classic versions too.  Before we begin, I would like to explain the scenario of including a dependency in our AEM maven project.  When we would like to make use of an API that is not already available in our project, we look for that in maven-central repository and specify the dependency in main pom.xml and desired module's pom.xml file. (Lets say, AWS S3 Java SDK V2 dependency) Upon updating the project in the IDE, we would see our class files (making use of those APIs) are compiled/build successfully without any errors.  Now, in the context of AEM/OSGi environment, when the same package and hence the bundle is deployed to AEM instance, dependencies that we added new might not be resolved/available in the OSGi as a bundle. Something like the below This indicates that the added dep
Read more

OSGI Factory Configuration implementation

OSGI Factory configuration is used to have many instances of an OSGI config (represented/identified via an identifier) for the single OSGI service/PID. Most often used OOB Factory configurations for example: Logger Factory/writer configuration (for log statements) Service user Mapper service Amendment (for using service resource resolver in projects) Few sample real time use case for the need of OSGI factory config: For multi tenant projects, if we have generic service used across tenants with properties/attributes specific to tenant. For single tenant, generic service targeting all locales with properties/attributes specific to locale. (where generic service -> holds logic in the lines of calling third party service for retrieving/updating information.) Implementation: ( In terms of OSGI R6 annotations ): Create Object Class Definition(OCD) defining desired properties for the OSGI service. - OSGIFactoryConfigOCD.java OSGI Service/Factory service to retrieve
Read more

Creation of Template Types for Editable templates

Image
In this post, we will create templates types which is the base for creating editable templates. Before getting to the subject directly, have added an introduction about templates in general. Template is the base for creating pages. Starting AEM 6.2, we have categorisation for templates - Static and Editable templates. Static templates :  This has been available for several versions of AEM/CQ Created using "Create Template" option with base page component as resourceType (which is responsible for rendering the page structure).  Template ( base page component as resourceType ) -> Page This cannot be edited as such. Since it just holds a reference to base page component, any changes to the page (other than authorable components), would need a change in base page component which is ultimately a work of developer. (calls for a code change) Allowed components are configured using Design mode (list being saved to etc/designs/projectfolder/templatename/jcr:content)
Read more