Create/build and install OSGi bundle of third party APIs/dependency using maven plugins

This post details the steps to create and deploy OSGI bundle out of third party API/dependency using relevant plugins in simple maven project.

We would have been in situation where OSGi bundle created out of third party jar is added/available in our instance and our project code base using the third party bundle being in active state. However at the time of execution, ClassNotFound or NoClassDefFound error pops up.

This is the case when the dependencies of our desired third party API is not included/available when it is added as an OSGi bundle.

We can overcome this by creating the bundle using maven-bundle-plugin which has option to include

  • direct(desired third party dependency - highlighted in red in below screenshot - 
    • * -  to include all the dependency entry in the pom.xml file or 
    • artifactId name if we would like to mention explicitly 
    • Note : There are several other possible options documented for <Embed-Dependency> in official plugin page (Mentioned the link at the end in Reference section)
  • transitive dependencies (dependencies which our third party API is dependent on - highlighted in green in below screenshot is responsible for the same)


With this plugin information in the <build> tag + third party dependency of our interest in <dependencies> section along with details like group id, artifact id in pom.xml file will help create OSGi bundle using the command - mvn package or mvn clean package

Next, to install the created bundle directly to felix console, we can make use of a plugin named sling-maven-plugin which has properties to specify

  • AEM instance felix console URL(as highlighted in green in below screenshot) + 
  • username and password details(mentioned in <properties> as <sling.user> and <sling.password> respectively) 
  • Note: One of its goal named install is used for installing the bundle to felix console. Official plugin page is mentioned at the end in Reference section.

Updated command to use : mvn clean package install


To demonstrate with specific example, I would like to pick Box API as third party dependency which was recently raised in our community forum. Link to the thread for reference - https://experienceleaguecommunities.adobe.com/t5/adobe-experience-manager/integrate-aem-with-box-com-to-store-completed-forms/qaq-p/396609

Below highlighted dependency information from Maven central for Box Java SDK is used.


Complete pom.xml file is added to my GitHub repo - https://github.com/Viji1304/aemlearnings-samples/tree/master/BOXSDK

Steps to try in your local:
  • Download the folder from above location
  • Update the instance port, user name and password per your local instance in pom.xml file and with dependency of your interest. 
  • Execute mvn clean package install  from cmd by being in pom.xml file location
  • Look for the bundle in target folder and in your local instance felix console.
As a standalone bundle: 
Based on our real time project set up + per the functionality expected out of 3rd party APIs, 

  • We can choose to have this as a separate project and hence separate bundle if you have many projects/bundle which might make use of in future or
  • If you have common code base which all other projects are making use of, this can be included as part of the same.
As part of project code base:
  • If your project's core module makes use of maven-bundle-plugin, it will work on the similar lines as explained above where desired third party dependency is added to main pom.xml and core/pom.xml + highlighted instructions in screenshot above of maven-bundle-plugin is used.
  • In recent AEM Maven archetype version, bnd-maven-plugin is used to build OSGi bundle out of core module wherein instruction named -conditionalpackage is suggested to use for the similar purpose. However, I couldn't gain success in this case for one of the third party API that I tried in my local, will update once it works.
Reference:

Comments

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