Adobe AEM Embedding Third Party Jar as Bundle

-

 

Adobe AEM Embedding Third Party Jar as Bundle

 

Options:

  • 1.      Eclipse Plugin Project to convert Jar into Bundle with manifest file
  • 2.      Install along with AEM application using Maven Embed 

 

 Note:

In the below given example I am using my custom Adobe AEM application which needs a third party jar file “jsoup.jar” in my case. I used archetype 27 for building this maven sample aem project.In your case it can be any third party Jar file required to integrate with Adobe AEM.

1.     Eclipse Plugin Project

Step1: Open Eclipse IDE and select

File -> New à Other à Plugin from Existing JAR Archives


Step 2: In the next pop select external Jar as shown below and navigate to the downloaded third party jar in your local from maven repository.


 



Step 3: Provide project details as shown below for the new jar added


Click Finish. It might take some time couple of minutes to build project depending on your JAR size.

 Step 4: Now in Overview Select the Manifest you can see all the details.

 


Step 5: Go to Run time and select the required packages which your application might require from this third party jar as shown below

 



 


 Now go to Manifest file and save it. Now it looks like below with all the export package I selected


 

Note:

In some cases there may be version numbers in imported packages. If there are any version numbers with imported package please remove it in manifest file and save

 Example:

Step 6: Once the above steps are done. Now Go to the new plugin project we created in eclipse in above step and right click to “Export” and select “Deployable plug-ins and fragments” as shown below

 


 Step 7:

Now select the path where you want to save the bundle jar locally and click on finish. Now go to the specified location and you will find the deployable bundle.

 


Step 8:

Now go to AEM Server system console bundle where you want to install this bundle

http://localhost:4502/system/console/bundles

Example:


Click on “install/update” button on top right corner and navigate to the local bundle created in above step and install. Make sure the bundle is active once installed. In some case it may fail install in that case expand the installed bundle and look and any un resolved dependency as show below sample:

 



In such cases make sure the unresolved dependant jar file also installed as osgi bundle using same steps mentioned above.

 Utilize dep finder tool to identify the resolution of dependency

http://localhost:4502/system/console/depfinder

 

2.     Install along with AEM application using Maven Embed

 


Step 1: Search and Find the corresponding jar version in maven repository

 

Example:

https://mvnrepository.com/artifact/org.jsoup/jsoup/1.14.1

 

<!-- https://mvnrepository.com/artifact/org.jsoup/jsoup -->

<dependency>

    <groupId>org.jsoup</groupId>

    <artifactId>jsoup</artifactId>

    <version>1.14.1</version>

</dependency>

 

Step 2: Add this jar as dependency to maven Aem custom application pom.

 

In Root Pom add the below dependency of jsoup.jar under dependencies section as shown below

 

 <!-- ====================================================================== -->

    <!-- D E P E N D E N C I E S -->

    <!-- ====================================================================== -->

    <dependencyManagement>

        <dependencies>

        <dependency>

            <groupId>org.jsoup</groupId>

            <artifactId>jsoup</artifactId>

            <version>1.14.1</version>

        </dependency>

            <!-- OSGi Dependencies -->

            <dependency>

                <groupId>org.osgi</groupId>

                <artifactId>org.osgi.annotation.versioning</artifactId>

                <version>1.1.0</version>

                <scope>provided</scope>

            </dependency>

            <dependency>

                <groupId>org.osgi</groupId>

                <artifactId>org.osgi.annotation.bundle</artifactId>

                <version>1.0.0</version>

                <scope>provided</scope>

            </dependency>

            <dependency>

                <groupId>org.osgi</groupId>

                <artifactId>org.osgi.service.metatype.annotations</artifactId>

                <version>1.4.0</version>

                <scope>provided</scope>

 

 

Step 3: Next in the pom.xml which is located under your core folder add the below line of dependency for jsoup jar as shown below

 

 <dependencies>

    <!-- https://mvnrepository.com/artifact/org.jsoup/jsoup -->

        <dependency>

            <groupId>org.jsoup</groupId>

            <artifactId>jsoup</artifactId>

        </dependency>

 

        <dependency>

            <groupId>uk.org.lidalia</groupId>

            <artifactId>slf4j-test</artifactId>

            <scope>test</scope>

        </dependency>

        <!-- OSGi Dependencies -->

        <dependency>

            <groupId>org.osgi</groupId>

            <artifactId>org.osgi.annotation.versioning</artifactId>

        </dependency>

        

Step 4: Now add the embed line in pom.xml located under all (all/pom.xml)

Look for the last embed snippet shown below.Now Jsoup.jar will get added as external jar under folder path “/apps/sandboxsite-vendor-packages/application/install” along with other vendor jar like core components etc..

 

 <plugin>

                <groupId>org.apache.jackrabbit</groupId>

                <artifactId>filevault-package-maven-plugin</artifactId>

                <extensions>true</extensions>

                <configuration>

                    <group>com.sandbox</group>

                    <packageType>container</packageType>

                    <properties>

                        <cloudManagerTarget>all</cloudManagerTarget>

                    </properties>

                    <!-- skip sub package validation for now as some vendor packages like CIF apps will not pass -->

                    <skipSubPackageValidation>true</skipSubPackageValidation>

                    <embeddeds>

                        <embedded>

                            <groupId>com.sandbox</groupId>

                            <artifactId>sandboxsite.ui.apps</artifactId>

                            <type>zip</type>

                            <target>/apps/sandboxsite-packages/application/install</target>

                        </embedded>

                        <embedded>

                            <groupId>com.sandbox</groupId>

                            <artifactId>sandboxsite.core</artifactId>

                            <target>/apps/sandboxsite-packages/application/install</target>

                        </embedded>

                        <embedded>

                            <groupId>com.sandbox</groupId>

                            <artifactId>sandboxsite.ui.content</artifactId>

                            <type>zip</type>

                            <target>/apps/sandboxsite-packages/content/install</target>

                        </embedded>

                        <embedded>

                            <groupId>com.sandbox</groupId>

                            <artifactId>sandboxsite.ui.config</artifactId>

                            <type>zip</type>

                            <target>/apps/sandboxsite-packages/application/install</target>

                        </embedded>

                        <embedded>

                            <groupId>com.adobe.cq</groupId>

                            <artifactId>core.wcm.components.content</artifactId>

                            <type>zip</type>

                            <target>/apps/sandboxsite-vendor-packages/application/install</target>

                        </embedded>

                        <embedded>

                            <groupId>com.adobe.cq</groupId>

                            <artifactId>core.wcm.components.core</artifactId>

                            <target>/apps/sandboxsite-vendor-packages/application/install</target>

                        </embedded>

                        <embedded>

                            <groupId>com.adobe.cq</groupId>

                            <artifactId>core.wcm.components.config</artifactId>

                            <type>zip</type>

                            <target>/apps/sandboxsite-vendor-packages/application/install</target>

                        </embedded>

                       <embedded>

                            <groupId>org.jsoup</groupId>

                            <artifactId>jsoup</artifactId>

                            <target>/apps/sandboxsite-vendor-packages/application/install</target>

                        </embedded>                         

                    </embeddeds>

                </configuration>

 

 

Step 5: Build the Maven and Install the Package

Ø  mvn clean install -P autoInstallPackage -P adobe-public

 

Once Deployed you can see the third party jar installed as shown below along with your custom application

 

 


 

 



 

Comments

Post a Comment

Popular posts from this blog

Adobe AEM Maven Archetype 24 Error - java.nio.file.FileSystemException

-
Adobe AEM Maven Archetype 24 Error -java.nio.file.FileSystemException I tried creating a Adobe AEM Archetype 24 project by using below command mvn -B archetype:generate -D archetypeGroupId=com.adobe.aem  -D archetypeArtifactId=aem-project-archetype -D archetypeVersion=24 -D appTitle="My First Site" -D appId="myfirstsite" -D groupId="com.myfirstsite" -D aemVersion="6.5.0" I got the below error as part of Execution: ERROR  Failed to execute goal org.apache.maven.plugins:maven-archetype-plugin:3.2.0:generate (default-cli) on project standalone-pom: java.nio.file.FileSystemException: C:\Users\user1\Documents\GitHub\myfirstsite\dispatcher\src\conf.d\enabled_vhosts\aem_author.vhost: A required privilege is not held by the client. -> [Help 1] Solution: Open command prompt as Administrator and run the same command it fixes the above error. Also refer below Issue Log from Adobe Git hub for the same: https://github.com/adobe/aem-project-archetype/issues
Read more

Adobe AEM — How to Trigger Custom Workflow from Manage Publication(Manage Publish Wizard)

-
Image
  Trigger Custom Workflow from Manage Publish Wizard   Objective: There are many articles written on how to trigger a custom workflow from Manage Publish Wizard instead of the default one. But in this article, I am going to cover some of the deep insights with respect to permissions, underlying design which is not explained in many of the articles.   What is functionality of Manage Publish Wizard   Using Manage Publish we can Publish/Unpublish a content from Author to Publisher along with additional functionalities such as reference publish, scheduled Publish(Now or Later).   Underlying Architecture on Click of Manage Publish:   Permissions Required to Trigger Workflow Instead of Replication Process: User who needs to publish the content by triggering the default or custom workflow by triggering Manage Publish Wizard should not have replicate access to Content and should have minimal of read and write access to /var and /etc folder as shown below   Other
Read more

Direct integration Approaches with the Experience Cloud Identity Service

-
Image
 1.      Purpose Below approach will help the customers use the ID service on applications that does not support 1.            No Support for Adobe Launch or SDK or VisitorApi.js 2.            No Support for Adobe Launch or SDK but support for visiotrapi.js   2.      Methodologies ECID can be extracted using below methodologies 2.1 Direct trigger of API to fetch ECID(No Support for Adobe Launch or SDK or VisitorApi.js) We can fetch the ECID by directly triggering an http get to below DCS url of adobe along with corresponding Org ID.   Example: var org_id="-----------AdobeOrg";   "https://dpm.demdex.net/id?d_visid_ver=5.2.0&d_fieldgroup=MC&d_rtbd=json&d_ver=2&d_verify=1&d_nsid=0&d_orgid="+org_id; https://dpm.demdex.net/id?d_visid_ver=[VER]&d_fieldgroup=MC&d_rtbd=json&d_ver=2&d_verify=1&d_nsid=0&d_orgid=[ORGID]&ts=[TS]   ·   [VER] is the version of the JavaScript library you are trying to use. When I was testing this
Read more