Draft of the wls-helidon integration for 2.x #6946

Geetha-Savithriamma · 2023-06-05T19:56:59Z

Hello team,

This is the first draft of the wls-helidon integration doc for 2.x. It includes the following integrations:

REST
Web Services
JMS
Single Sign-on
MicroTx

We are yet to fix the comments for 3.x. The same applies to 2.x as well.
Request you to please review the MicroTx content (the last topic) only for now.

Warm regards,
Geetha.

mriccell · 2023-06-05T23:50:10Z

docs/mp/integration/wls.adoc

+
+*Dependencies for the WLS thin client JAR file*
+
+Download the Jakarta thin client JAR (`wlthint3client.jakarta`) file from https://edelivery.oracle.com/osdc/faces/Home.jspx[Oracle Software Delivery Cloud], and add it as part of the Maven dependencies:


This client is not jakarta it is called wlthint3client and can not be downloaded from edelivery. The wlthint3client is generated when WebLogic Server is installed and It is located in the WL_HOME\server\lib directory of the WebLogic Server installation.

Hi @Geetha-Savithriamma
Helidon2 is supported only with the wlthint3client jar. Jakarta thin client JAR is only for Helidon3.

Hi @mriccell
We can use the wlthint3client jar from the path WL_HOME\server\lib. But as per the latest updates from the WebLogic Development team, the multi-version wlthint3client jar also will be delivered separately along with Jakarta thin client jar. Could you please clarify this?

mriccell · 2023-06-05T23:50:40Z

docs/mp/integration/wls.adoc

+[source,xml]
+----
+<dependency>
+    <groupId>wlthint3client.jakarta</groupId>


his client is not jakarta it is called wlthint3client

Hi @Geetha-Savithriamma
In Helidon2, we need to use the wlthint3client dependency. Also, this should be added to the local Maven repo
Maven Dependency:

<dependency> <groupId>wlthint3client</groupId> <artifactId>wlthint3client</artifactId> <version>1.0</version> </dependency>

Maven Install Command:
mvn install:install-file -Dfile=<JAR_PATH>/wlthint3client.jar -DgroupId=wlthint3client -DartifactId=wlthint3client -Dversion=1.0

mriccell · 2023-06-05T23:53:03Z

docs/mp/integration/wls.adoc

+
+=== Maven Coordinates [[Web-Services-Integration-Maven-Coordinates]]
+
+Add the `com.oracle.webservices.wls.jaxws-wlswss-client.jar` client file downloaded from https://edelivery.oracle.com/osdc/faces/Home.jspx[Oracle Software Delivery Cloud], as part of the Maven dependencies:


this client should not be downloaded from edelivery. The com.oracle.webservices.wls.jaxws-wlswss-client.jar is generated when WebLogic Server is installed and It is located in the WL_HOME\server\lib directory of the WebLogic Server installation.

mriccell · 2023-06-05T23:54:05Z

docs/mp/integration/wls.adoc

+----
+<dependency>
+    <groupId>wlthint3client.jakarta</groupId>
+    <artifactId>wlthint3client-jakarta</artifactId>


this client is not jakarta it is called wlthint3client

mriccell · 2023-06-05T23:57:26Z

docs/mp/integration/wls.adoc

+
+==== Building and Deploying the Helidon Participant Application
+
+Download the image for MicroTx Free from https://container-registry.oracle.com/[Oracle Container Registry] and add the 'TmmLib' library to the local Maven repository. This library is available in the '<OTMM_BINARIES_EXTRACTED_PATH>/lib/java/' location.


Download -> Obtain or Pull the image

Hi @mriccell
As per my understanding, we need to download the complete Microtx binaries which include otmm image along with otmm library & samples. Could you please clarify this?

naradta · 2023-06-06T12:53:49Z

docs/mp/integration/wls.adoc

+}
+----
+
+For more information about this integration, see https://docs-uat.us.oracle.com/en/middleware/standalone/weblogic-server/14.1.1.0/wlshe/integrating-oracle-weblogic-server-jms-helidon.html#GUID-5E28DBC5-6CB3-49E1-B1A7-BF30191AE8AB[Integrating WebLogic JMS with Helidon 2.x]


Hi @Geetha-Savithriamma
Request you to provide reference to Helidon2 JMS Connector along with WLS Integ doc.

Helidon2 JMS Connector:
https://helidon.io/docs/v2/#/mp/reactivemessaging/05_jms

klustria · 2023-06-14T02:24:01Z

docs/mp/integration/wls.adoc

+
+==== Building and Deploying the Helidon Teller Application
+
+Download the image for MicroTx Free from https://container-registry.oracle.com/[Oracle Container Registry] and add the `TmmLib` library to the local Maven repository. This library is available in the `<OTMM_BINARIES_EXTRACTED_PATH>/lib/java/` location.


The instruction is to download the docker image for MicroTx, right? If that's the case, how would the user access <OTMM_BINARIES_EXTRACTED_PATH>/lib/java/ location? Are they going to this via a docker container? Should they rather download the distribution in https://www.oracle.com/database/transaction-manager-for-microservices/ and extract that in their local path? BTW, I found this link from a comment by Monica on this same line/topic in review.us.oracle.com.

Why is there a mention of TmmLib library and OTMM library below? Are they the same? If so, would it be better to use the same terminology?

klustria · 2023-06-14T02:29:28Z

docs/mp/integration/wls.adoc

+
+[source,shell]
+----
+mvn install:install-file -Dfile=<OTMM_BINARIES_EXTRACTED_PATH>/lib/java/TmmLib-22.3.2.jar -DpomFile=<OTMM_BINARIES_EXTRACTED_PATH>/lib/java/TmmLib-weblogic-22.3.2.pom


I tried this by downloading the zip distribution as I mentioned above and it seems that the pomfile value is wrong. What worked for me is -DPomFile=<OTMM_BINARIES_EXTRACTED_PATH>/lib/java/weblogic/TmmLib-weblogic-22.3.2.pom. Note that the pom is inside of webLogic directory under java, and not in the java directory. Can you please check this?

klustria · 2023-06-14T02:35:46Z

docs/mp/integration/wls.adoc

+oracle.tmm.PropagateTraceHeaders = false
+----
+
+Create the Docker image for the Helidon Teller Application, upload the image to the Docker registry, and then deploy the application in the Kubernetes cluster.


How do they create the Docker image? Shouldn't they run the docker build command for this on a DockerFile? I looked at the readme.md in <OTMM_BINARIES_EXTRACTED_PATH>/samples/xa/java/weblogic/teller and it has instruction on how to run the docker build to create the image. The directory also has the Dockerfile that would allow to build the image, so should it not be given as an example instruction? Like:

Go to the teller directory:
cd <OTMM_BINARIES_EXTRACTED_PATH>/samples/xa/java/weblogic/teller

Run the docker build command to create the image (fill the image_name and tag with the desired values):
docker build --network host -t <image_name>:<tag> .

klustria · 2023-06-14T02:37:15Z

docs/mp/integration/wls.adoc

+
+==== Building and Deploying the Helidon Participant Application
+
+Obtain the image for MicroTx Free from https://container-registry.oracle.com/[Oracle Container Registry] and add the 'TmmLib' library to the local Maven repository. This library is available in the '<OTMM_BINARIES_EXTRACTED_PATH>/lib/java/' location.


Same comment as above, i.e: The instruction is to download the docker image for MicroTx, right? If that's the case, how would the user access <OTMM_BINARIES_EXTRACTED_PATH>/lib/java/ location? Are they going to this via a docker container? Should they rather download the distribution in https://www.oracle.com/database/transaction-manager-for-microservices/ and extract that in their local path? BTW, I found this link from a comment by Monica on this same line/topic in review.us.oracle.com.

Why is there a mention of TmmLib library and OTMM library below? Are they the same? If so, would it be better to use the same terminology?

klustria · 2023-06-14T02:42:44Z

docs/mp/integration/wls.adoc

+oracle.tmm.xa.<rmid> = HELIDON-TX-RM-ID-FOR-MICROTX-TESTS
+----
+
+Create the Docker image for the Helidon Participant Application, upload the image to the Docker registry, and then deploy the application in the Kubernetes cluster.


Same comment as above, ie: How do they create the Docker image? Shouldn't they run the docker build command for this on a DockerFile? I looked at the readme.md in <OTMM_BINARIES_EXTRACTED_PATH>/samples/xa/java/weblogic/helidon-app and it has instruction on how to run the docker build to create the image. The directory also has the Dockerfile that would allow to build the image, so should it not be given as an example instruction? Like:

Go to the teller directory:
cd <OTMM_BINARIES_EXTRACTED_PATH>/samples/xa/java/weblogic/helidon-app

Run the docker build command to create the image (fill the image_name and tag with the desired values):
docker build --network host -t <image_name>:<tag> .

docs/mp/integration/wls.adoc

klustria · 2023-07-07T19:41:29Z

docs/mp/integration/wls.adoc

+* The JMS integration allows Helidon microservices to publish and consume messages from WebLogic JMS Server.
+* The WebLogic Web Services integration allows Helidon microservices to interact with WebLogic Server applications through SOAP (Simple Object Access Protocol) Web Service calls from Helidon to WebLogic Server.
+* The WebLogic Server and Helidon integration allows communication between a WebLogic cluster-hosted application and a Helidon microservice application by implementing Single Sign-on (SSO) authentication using Oracle Identity Cloud Service (IDCS).
+* XA Transactions Integration with {micro-tx-link} allows participating in XA transactions to both Helidon and WebLogic Server applications.


maybe worded like?

XA Transactions Integration with {micro-tx-link} allows Helidon and WebLogic Server applications to participate in in a two-phase commit.

klustria · 2023-07-07T19:50:09Z

docs/mp/integration/wls.adoc

+* The REST integration allows WebLogic Server applications and Helidon microservices to communicate through RESTful Web Service invocations.
+* The JMS integration allows Helidon microservices to publish and consume messages from WebLogic JMS Server.
+* The WebLogic Web Services integration allows Helidon microservices to interact with WebLogic Server applications through SOAP (Simple Object Access Protocol) Web Service calls from Helidon to WebLogic Server.
+* The WebLogic Server and Helidon integration allows communication between a WebLogic cluster-hosted application and a Helidon microservice application by implementing Single Sign-on (SSO) authentication using Oracle Identity Cloud Service (IDCS).


Maybe worded like?

The SSO integration allows secure access between a WebLogic cluster-hosted application and a Helidon microservice application by implementing Single Sign-on (SSO) authentication using Oracle Identity Cloud Service (IDCS).

docs/mp/integration/wls.adoc

klustria · 2023-07-07T23:05:20Z

docs/mp/integration/wls.adoc

-MicroTX ensures consistency of XA transactions using the following distributed applications as an example.
+=== Overview [[XA-Integration-Overview]]
+XA (eXtended Architecture) is a specification for distributed transactions leveraging 2PC (two-phase) commit approach.
+Helidon and Oracle WebLogic Server applications can participate in same XA transactions thanks to


comma between transactions and thanks

Helidon and Oracle WebLogic Server applications can participate in same XA transactions, thanks to

ljnelson

Mostly minor comments.

ljnelson · 2023-07-08T00:39:28Z

docs/mp/integration/wls.adoc

+* The JMS integration allows Helidon microservices to publish and consume messages from WebLogic JMS Server.
+* The WebLogic Web Services integration allows Helidon microservices to interact with WebLogic Server applications through SOAP (Simple Object Access Protocol) Web Service calls from Helidon to WebLogic Server.
+* The WebLogic Server and Helidon integration allows communication between a WebLogic cluster-hosted application and a Helidon microservice application by implementing Single Sign-on (SSO) authentication using Oracle Identity Cloud Service (IDCS).
+* XA Transactions Integration with {micro-tx-link} allows participating in XA transactions to both Helidon and WebLogic Server applications.


"XA Transactions Integration with {micro-tx-link} allows XA transactions to span Helidon and WebLogic Server applications."

Updated to "XA Transactions integration with {micro-tx-link} allows Helidon and WebLogic Server applications to participate in a two-phase commit."

ljnelson · 2023-07-08T00:39:59Z

docs/mp/integration/wls.adoc

+
+The following integrations are explained in this document:
+
+* The REST integration allows WebLogic Server applications and Helidon microservices to communicate through RESTful Web Service invocations.


(Later you call this "REST services integration"; not sure which is correct.)

docs/mp/integration/wls.adoc

ljnelson · 2023-07-08T00:43:59Z

docs/mp/integration/wls.adoc

+
+
+=== Overview [[XA-Integration-Overview]]
+XA (eXtended Architecture) is a specification for distributed transactions leveraging 2PC (two-phase) commit approach.


~~leveraging 2PC (two-phase) commit approach~~

ljnelson · 2023-07-08T00:44:33Z

docs/mp/integration/wls.adoc

+
+=== Overview [[XA-Integration-Overview]]
+XA (eXtended Architecture) is a specification for distributed transactions leveraging 2PC (two-phase) commit approach.
+Helidon and Oracle WebLogic Server applications can participate in same XA transactions thanks to


can participate in a single XA transaction

ljnelson · 2023-07-08T00:45:24Z

docs/mp/integration/wls.adoc

+<2> Refers to the Helidon Teller Application call-back URL along with context path
+<3> Resource Manager(RM) Unique Id. Make sure to replace the id value with the RM used in the application
+
+Each property can be overridden by its upper case snake case environment variable variant, example:


variant. For example:

ljnelson · 2023-07-08T00:45:40Z

docs/mp/integration/wls.adoc

+          password: <db-password>
+----
+
+XA capable datasource needs to be registered with MicroTx.


ljnelson · 2023-07-08T00:47:01Z

docs/mp/integration/wls.adoc

+    }
+}
+----
+<1> Datasource's initialization with MicroTx after CDI container start.


I don't understand this. Do you mean something like "This registers the XA data source with MicroTx at CDI container startup time."?

ljamen

All comments have been addressed. Additional doc bugs may be filed to address issues with file name changes. TBD.

ljamen · 2023-06-06T21:36:33Z

docs/mp/integration/wls.adoc

+- <<MicroTx-Integration-References, References>>
+
+
+=== Overview [[MicroTx-Integration-Overview]]


addressed by PR #6946

ljamen · 2023-06-21T14:31:06Z

docs/mp/integration/wls.adoc

+----
+mvn clean package -DskipTests=true
+----
+For information about developing the REST Service using JAX-RS and Helidon API, see https://docs-uat.us.oracle.com/en/middleware/standalone/weblogic-server/14.1.1.0/wlshe/integrating-oracle-weblogic-server-rest-services-helidon.html#GUID-AB8F2DC5-840B-40E7-89B4-7FDAD8035C88[Integrating WebLogic REST Services with Helidon 2.x].


Reminder to change link for Prod

ljamen · 2023-06-21T14:32:47Z

docs/mp/integration/wls.adoc

+  }
+----
+
+Use the IDCS *Client ID* and *Client Secret* of the WebLogic cluster application to obtain the access token to access the WebLogic cluster application SSO points.


Revise based on Daniel's updates in Oracle Review/Git.

ljamen · 2023-07-05T13:58:02Z

docs/mp/integration/wls.adoc

 == Contents

 - <<Overview, Overview>>
 - <<REST Services Integration, REST Services Integration>>
 - <<JMS Integration, JMS Integration>>
 - <<Web Services Integration, Web Services Integration>>
 - <<Single Sign-On on OCI Integration, Single Sign-On on OCI Integration>>
- <<MicroTx Integration, MicroTx Integration>>
+- <<XA Transactions Integration, XA-Transactions-Integration>>


Are we not referring to this as MicroTx?

Draft of the wls-helidon integration for 2.x

20cccd0

Geetha-Savithriamma requested a review from ljamen June 5, 2023 19:56

Geetha-Savithriamma self-assigned this Jun 5, 2023

oracle-contributor-agreement bot added the OCA Verified All contributors have signed the Oracle Contributor Agreement. label Jun 5, 2023

Update sitegen.yaml

6af3342

Geetha-Savithriamma requested review from danielkec, rstafford, barchetta, m0mus, edbratt and naradta June 5, 2023 20:12

mriccell suggested changes Jun 5, 2023

View reviewed changes

naradta reviewed Jun 6, 2023

View reviewed changes

ljamen added docs 2.x Issues for 2.x version branch labels Jun 7, 2023

Geetha-Savithriamma added 2 commits June 8, 2023 14:23

Update wls.adoc

00e6457

Update wls.adoc

b2ecaa6

klustria reviewed Jun 14, 2023

View reviewed changes

This was referenced Jun 27, 2023

WLS 1411/12214 jaxws-wlswss-client Javax Client w/H2 #6754

Closed

DOCS: Documentation to support Helidon Integration with WLS #5911

Open

Document WLS 1411/12214 JMS Java clients w/H2 - [ ] 2.x #6753

Closed

2.x: Docs: WLS Integration Code issues #5809

Closed

Wls integration alignment

c6c6a5b

klustria reviewed Jul 7, 2023

View reviewed changes

ljnelson previously approved these changes Jul 8, 2023

View reviewed changes

Incorporated reviews and made a few other edits.

b6f13bd

Geetha-Savithriamma dismissed ljnelson’s stale review via b6f13bd July 8, 2023 05:03

ljamen approved these changes Jul 12, 2023

View reviewed changes

ljamen merged commit a5fefae into helidon-io:helidon-2.x Jul 12, 2023

This was referenced Jul 12, 2023

XA Transaction coordination between WLS 14110/12214 and H 2.x #6762

Closed

SSO across WLS 14110/12214 and Helidon 2 on OCI using OIDC and IDCS #6756

Closed

Bidirectional REST calls between WLS 14110/12214 w/H2 #6758

Closed


		Dependencies for the WLS thin client JAR file

		Download the Jakarta thin client JAR (`wlthint3client.jakarta`) file from https://edelivery.oracle.com/osdc/faces/Home.jspx[Oracle Software Delivery Cloud], and add it as part of the Maven dependencies:


		=== Maven Coordinates [[Web-Services-Integration-Maven-Coordinates]]

		Add the `com.oracle.webservices.wls.jaxws-wlswss-client.jar` client file downloaded from https://edelivery.oracle.com/osdc/faces/Home.jspx[Oracle Software Delivery Cloud], as part of the Maven dependencies:


		==== Building and Deploying the Helidon Participant Application

		Download the image for MicroTx Free from https://container-registry.oracle.com/[Oracle Container Registry] and add the 'TmmLib' library to the local Maven repository. This library is available in the '<OTMM_BINARIES_EXTRACTED_PATH>/lib/java/' location.


		==== Building and Deploying the Helidon Participant Application

		Obtain the image for MicroTx Free from https://container-registry.oracle.com/[Oracle Container Registry] and add the 'TmmLib' library to the local Maven repository. This library is available in the '<OTMM_BINARIES_EXTRACTED_PATH>/lib/java/' location.


		The following integrations are explained in this document:

		* The REST integration allows WebLogic Server applications and Helidon microservices to communicate through RESTful Web Service invocations.



		=== Overview [[XA-Integration-Overview]]
		XA (eXtended Architecture) is a specification for distributed transactions leveraging 2PC (two-phase) commit approach.

		- <<MicroTx-Integration-References, References>>


		=== Overview [[MicroTx-Integration-Overview]]

Draft of the wls-helidon integration for 2.x #6946

Draft of the wls-helidon integration for 2.x #6946

Conversation

Geetha-Savithriamma commented Jun 5, 2023 • edited Loading

Choose a reason for hiding this comment

naradta Jun 6, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

naradta Jun 6, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

klustria Jul 7, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ljnelson left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ljamen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Geetha-Savithriamma commented Jun 5, 2023 •

edited

Loading

naradta Jun 6, 2023 •

edited

Loading

naradta Jun 6, 2023 •

edited

Loading

klustria Jul 7, 2023 •

edited

Loading