Expand my Community achievements bar.

Dive into Adobe Summit 2024! Explore curated list of AEM sessions & labs, register, connect with experts, ask questions, engage, and share insights. Don't miss the excitement.
SOLVED

Maven dependencies for Transaction & OSGiUtils

Avatar

Community Advisor

Hi All,

I'm following below forms resource and referring PDF Generator Service section on the page.

AEM 6.2 Forms Help | Using AEM Document Services Programmatically

I see the below piece of code. But I couldn't find package names/dependencies for Transaction & OSGiUtils class. 

Transaction tx = OSGiUtils.getTransactionManager().getTransaction();

    // Begin transaction

    if (tx == null)

        OSGiUtils.getTransactionManager().begin();

Please advise.

Thanks

Siva

1 Accepted Solution

Avatar

Correct answer by
Level 10

Here is the information i got back from ENG.

OSGIUtils is an internal class which is not exposed but Transaction manager is a public java class which can be imported directly. It can be used directly and no forms dependency should be required for the same.

Transaction tx = OSGiUtils.getTransactionManager().getTransaction();

    // Begin transaction

    if (tx == null)

    OSGiUtils.getTransactionManager().begin();

Should be changed to

import javax.transaction.TransactionManager;

import javax.transaction.Transaction;

TransactionManager tmx = new TransactionManager();

Transaction tx = tmx.getTransaction();

    // Begin transaction

    if (tx == null)

    tmx.begin();

View solution in original post

15 Replies

Avatar

Level 10

We asked the Doc Services team to look here.

Avatar

Level 10

There does seem to be an issue as I cannot find any Java Doc for this API - which should not be the case. All APIS in all AEM Code examples should be listed in a public Javadoc.

Avatar

Employee

You can lookup TransactionManager by declaring a reference to it:

@Reference(name = "transactionManager", referenceInterface = TransactionManager.class)

Avatar

Administrator

Thanks a lot, neerava for the information.

And sivaprasadreddys we have created a documentation issue for modifying the information within.

~kautuk



Kautuk Sahni

Avatar

Community Advisor

Thanks a lot @neerava​ for the information.

I tried to use same piece of code and the error says,TransactionManager cannot be resolved to a type.

That means, we have to import that class package. Again, to use that class, we need to add some dependency.I'm looking for that dependency. Please provide me the dependencies which resolve the issue.

Avatar

Level 10

Are you using AEM UBER JAR in your POM File?

Avatar

Community Advisor

Yes smacdonald2008​, I'm using below AEM 6.3 uber jar dependency.

<dependency>

<groupId>com.adobe.aem</groupId>

<artifactId>uber-jar</artifactId>

<version>6.3.0</version>

<classifier>apis</classifier>

<scope>provided</scope>

</dependency>

Avatar

Level 10

YOu are correct - there is missing information from the AEM Forms docs, I am trying to get a worknig example so i can build it and get full code - including POM dependencies into a HELPX community article.

Avatar

Level 10

Ok - here is what you can try - i am trying too.

See this KB - AEM 6.1 Forms Help | Using AEM Document Services Programmatically

You can download the DOC Services API JAR.

I assume this JAR file has this API in it. I am looking all the class files in it.

Then you can upload this JAR file to the Maven Repo as a local JAR file - see this (still need an end to end that explains this in a HELPX):

HOW CAN I WORK WITH CUSTOM JARS THAT ARE NOT IN THE MAVEN REPOSITORY

You can place the JAR in your local Maven Repository and then reference it in your POM file. For example, to resolve myCustomJAR_1.0.0.jar within an AEM service, the myCustomJAR_1.0.0.jar file must be located in the Maven repository. You can upload the myCustomJAR_1.0.0.jar to Maven by using this Maven command:

mvn install:install-file -Dfile=C:/plugins/myCustomJAR_1.0.0.jar-DgroupId=com.foo.reports -DartifactId=jrurbersrt1.0 -Dversion=1.0 -Dpackaging=jar -DgeneratePom=true

Notice that you must specify the location of the myCustomJAR file in the -Dfile argument. Also notice that you specify the Dgroup and DartifactID values. Once you upload the JAR to Maven using this command, you can reference this JAR file using this Dependency.

<groupId>com.foo.reports</groupId>

<artifactId>jrurbersrt1.0</artifactId>

<version>1.0</version>

<scope>system</scope>

<systemPath>C:\Users\scottm\.m2\repository\com\foo\reports\jrurbersrt1.0\1.0\myCustomJAR_1.0.0.jar</systemPath>

</dependency>

Notice that scope element is system and systemPath references the location of the JAR file in the repository. (This dependency is used later in this article to build the AEM service)

Avatar

Level 10

Looks like this JAR does not expose this API either.

Avatar

Level 10

This looks like the POM dep for this API:

<!-- https://mvnrepository.com/artifact/javax.transaction/transaction-api -->

<dependency>

    <groupId>javax.transaction</groupId>

    <artifactId>transaction-api</artifactId>

    <version>1.1-rev-1</version>

    <scope>provided</scope>

</dependency>

https://mvnrepository.com/artifact/javax.transaction/transaction-api/1.1-rev-1

It would have been much easier if the PDF Gen code example showed all import statements as we do in HELPX articles.

Avatar

Level 3

This is a Livecycle internal api for which the fully qualifed package is: com.adobe.aemds.bedrock.internal.OSGiUtils

​But not sure if it is a part of Uber jar or not.

Avatar

Correct answer by
Level 10

Here is the information i got back from ENG.

OSGIUtils is an internal class which is not exposed but Transaction manager is a public java class which can be imported directly. It can be used directly and no forms dependency should be required for the same.

Transaction tx = OSGiUtils.getTransactionManager().getTransaction();

    // Begin transaction

    if (tx == null)

    OSGiUtils.getTransactionManager().begin();

Should be changed to

import javax.transaction.TransactionManager;

import javax.transaction.Transaction;

TransactionManager tmx = new TransactionManager();

Transaction tx = tmx.getTransaction();

    // Begin transaction

    if (tx == null)

    tmx.begin();

Avatar

Level 1

Is this issue ever resolved? I tried this piece of code

import javax.transaction.TransactionManager;

import javax.transaction.Transaction;

TransactionManager tmx = new TransactionManager();Maven dependencies for Transaction &amp; OSGiUtils

Transaction tx = tmx.getTransaction();

    // Begin transaction

    if (tx == null)

    tmx.begin();

Still there is error saying, Cannot instantiate the type TransactionManager