[CAM-14761] WAS Liberty doesn't read JNDI-defined bpm-platform location

Type: Bug Report
Resolution: Unresolved
Priority: L3 - Default
Fix Version/s: None
Affects Version/s: None
Component/s: engine
Labels:
- was-liberty

Environment (Required on creation):

WebSphere Liberty 22.0.0.3

Description (Required on creation; please attach any relevant screenshots, stacktraces, log files, etc. to the ticket):

Camunda Platform 7 allows defining a custom location of the bpm-platform.xml configuration file through a JNDI entry with the label java:comp/env/bpm-platform-xml

Steps to reproduce (Required on creation):

Define a jndiEntry in the server.xml of the Camunda Platform 7 WAS Liberty installation.

<jndiEntry jndiName="java:comp/env/bpm-platform-xml" value='"${server.config.dir}/bpm-platform.xml"' />

<enterpriseApplication id="camundaBpmPlatform" 
                 name="camunda-bpm-platform"
                 location="${server.config.dir}/apps/camunda-ibm-websphere-ear-7.18.0-SNAPSHOT.ear" >
        <classloader commonLibraryRef="Camunda"/>
        <ejb-jar-bnd moduleName="camunda-ibm-websphere-service">
            <session name="EjbBpmPlatformBootstrap">
                <resource-ref name="java:comp/env/bpm-platform-xml" binding-name="bpm-platform-xml" />
            </session>
        </ejb-jar-bnd>
    </enterpriseApplication>

The JNDI entry must be added in the ejb-jar-bnd application section (or the ibm-ejb-jar-bnd.xml) to be available through the java:comp/env/ namespace.

Observed Behavior (Required on creation):

A NameNotFoundException is thrown when the engine attempts to look-up a JNDI entry called java:comp/env/bpm-platform-xml.

Expected behavior (Required on creation):

The JNDI entry is successfully found.

Root Cause (Required on prioritization):

Solution Ideas (Optional):

Hints (optional):

WAS Liberty had a bug related to comp/env JNDI entries, but it was resolved (ref, ref2).

This is the controller panel for Smart Panels app

Nikola Koevski created issue - 06/Jul/22 4:52 PM

Nikola Koevski made changes - 06/Jul/22 4:52 PM

Link

New: This issue is depended on by ~~CAM-13102~~ [ ~~CAM-13102~~ ]

Nikola Koevski made changes - 06/Jul/22 4:52 PM

Status

Original: Open [ 1 ]

New: In Progress [ 3 ]

Nikola Koevski made changes - 06/Jul/22 4:59 PM

Description

Original: h3. Environment (Required on creation):
WebSphere Liberty 22.0.0.3

h3. Description (Required on creation; please attach any relevant screenshots, stacktraces, log files, etc. to the ticket):

Camunda Platform 7 allows defining a custom location of the {{bpm-platform.xml}} configuration file through a JNDI entry with the label {{java:comp/env/bpm-platform-xml}}

h3. Steps to reproduce (Required on creation):
Define a {{jndiEntry}} in the {{server.xml}} of the Camunda Platform 7 WAS Liberty installation.
{code}
<jndiEntry jndiName="java:comp/env/bpm-platform-xml" value='"${server.config.dir}/bpm-platform.xml"' />

<enterpriseApplication id="camundaBpmPlatform"
                 name="camunda-bpm-platform"
                 location="${server.config.dir}/apps/camunda-ibm-websphere-ear-7.18.0-SNAPSHOT.ear" >
        <classloader commonLibraryRef="Camunda"/>
        <ejb-jar-bnd moduleName="camunda-ibm-websphere-service">
            <session name="EjbBpmPlatformBootstrap">
                <resource-ref name="java:comp/env/bpm-platform-xml" binding-name="bpm-platform-xml" />
                
            </session>
        </ejb-jar-bnd>
    </enterpriseApplication>
{code}

h3. Observed Behavior (Required on creation):
A {{NameNotFoundException}} is thrown when the engine attempts to look-up a JNDI entry called {{java:comp/env/bpm-platform-xml}}.

h3. Expected behavior (Required on creation):
The JNDI entry is successfully found.

h3. Root Cause (Required on prioritization):

h3. Solution Ideas (Optional):

h3. Hints (optional):
WAS Liberty had a bug related to {{comp/env}} JNDI entries, but it was resolved ([ref|https://github.com/OpenLiberty/open-liberty/issues/11044]).

New: h3. Environment (Required on creation):
WebSphere Liberty 22.0.0.3

h3. Description (Required on creation; please attach any relevant screenshots, stacktraces, log files, etc. to the ticket):

Camunda Platform 7 allows defining a custom location of the {{bpm-platform.xml}} configuration file through a JNDI entry with the label {{java:comp/env/bpm-platform-xml}}

h3. Steps to reproduce (Required on creation):
Define a {{jndiEntry}} in the {{server.xml}} of the Camunda Platform 7 WAS Liberty installation.
{code}
<jndiEntry jndiName="java:comp/env/bpm-platform-xml" value='"${server.config.dir}/bpm-platform.xml"' />

<enterpriseApplication id="camundaBpmPlatform"
                 name="camunda-bpm-platform"
                 location="${server.config.dir}/apps/camunda-ibm-websphere-ear-7.18.0-SNAPSHOT.ear" >
        <classloader commonLibraryRef="Camunda"/>
        <ejb-jar-bnd moduleName="camunda-ibm-websphere-service">
            <session name="EjbBpmPlatformBootstrap">
                <resource-ref name="java:comp/env/bpm-platform-xml" binding-name="bpm-platform-xml" />
                
            </session>
        </ejb-jar-bnd>
    </enterpriseApplication>
{code}

The JNDI entry must be added in the {{ejb-jar-bnd}} application section (or the ibm-ejb-jar-bnd.xml) to be available through the {{java:comp/env/}} namespace.

h3. Observed Behavior (Required on creation):
A {{NameNotFoundException}} is thrown when the engine attempts to look-up a JNDI entry called {{java:comp/env/bpm-platform-xml}}.

h3. Expected behavior (Required on creation):
The JNDI entry is successfully found.

h3. Root Cause (Required on prioritization):

h3. Solution Ideas (Optional):

h3. Hints (optional):
WAS Liberty had a bug related to {{comp/env}} JNDI entries, but it was resolved ([ref|https://github.com/OpenLiberty/open-liberty/issues/11044], [ref2|https://www.ibm.com/support/pages/apar/PI63821]).

Nikola Koevski made changes - 06/Jul/22 5:00 PM

Description

Original: h3. Environment (Required on creation):
WebSphere Liberty 22.0.0.3

h3. Description (Required on creation; please attach any relevant screenshots, stacktraces, log files, etc. to the ticket):

Camunda Platform 7 allows defining a custom location of the {{bpm-platform.xml}} configuration file through a JNDI entry with the label {{java:comp/env/bpm-platform-xml}}

h3. Steps to reproduce (Required on creation):
Define a {{jndiEntry}} in the {{server.xml}} of the Camunda Platform 7 WAS Liberty installation.
{code}
<jndiEntry jndiName="java:comp/env/bpm-platform-xml" value='"${server.config.dir}/bpm-platform.xml"' />

<enterpriseApplication id="camundaBpmPlatform"
                 name="camunda-bpm-platform"
                 location="${server.config.dir}/apps/camunda-ibm-websphere-ear-7.18.0-SNAPSHOT.ear" >
        <classloader commonLibraryRef="Camunda"/>
        <ejb-jar-bnd moduleName="camunda-ibm-websphere-service">
            <session name="EjbBpmPlatformBootstrap">
                <resource-ref name="java:comp/env/bpm-platform-xml" binding-name="bpm-platform-xml" />
                
            </session>
        </ejb-jar-bnd>
    </enterpriseApplication>
{code}

The JNDI entry must be added in the {{ejb-jar-bnd}} application section (or the ibm-ejb-jar-bnd.xml) to be available through the {{java:comp/env/}} namespace.

h3. Observed Behavior (Required on creation):
A {{NameNotFoundException}} is thrown when the engine attempts to look-up a JNDI entry called {{java:comp/env/bpm-platform-xml}}.

h3. Expected behavior (Required on creation):
The JNDI entry is successfully found.

h3. Root Cause (Required on prioritization):

h3. Solution Ideas (Optional):

h3. Hints (optional):
WAS Liberty had a bug related to {{comp/env}} JNDI entries, but it was resolved ([ref|https://github.com/OpenLiberty/open-liberty/issues/11044], [ref2|https://www.ibm.com/support/pages/apar/PI63821]).

New: h3. Environment (Required on creation):
WebSphere Liberty 22.0.0.3

h3. Description (Required on creation; please attach any relevant screenshots, stacktraces, log files, etc. to the ticket):

Camunda Platform 7 allows defining a custom location of the {{bpm-platform.xml}} configuration file through a JNDI entry with the label {{java:comp/env/bpm-platform-xml}}

h3. Steps to reproduce (Required on creation):
Define a {{jndiEntry}} in the {{server.xml}} of the Camunda Platform 7 WAS Liberty installation.
{code}
<jndiEntry jndiName="java:comp/env/bpm-platform-xml" value='"${server.config.dir}/bpm-platform.xml"' />

<enterpriseApplication id="camundaBpmPlatform"
                 name="camunda-bpm-platform"
                 location="${server.config.dir}/apps/camunda-ibm-websphere-ear-7.18.0-SNAPSHOT.ear" >
        <classloader commonLibraryRef="Camunda"/>
        <ejb-jar-bnd moduleName="camunda-ibm-websphere-service">
            <session name="EjbBpmPlatformBootstrap">
                <resource-ref name="java:comp/env/bpm-platform-xml" binding-name="bpm-platform-xml" />
            </session>
        </ejb-jar-bnd>
    </enterpriseApplication>
{code}

The JNDI entry must be added in the {{ejb-jar-bnd}} application section (or the ibm-ejb-jar-bnd.xml) to be available through the {{java:comp/env/}} namespace.

h3. Observed Behavior (Required on creation):
A {{NameNotFoundException}} is thrown when the engine attempts to look-up a JNDI entry called {{java:comp/env/bpm-platform-xml}}.

h3. Expected behavior (Required on creation):
The JNDI entry is successfully found.

h3. Root Cause (Required on prioritization):

h3. Solution Ideas (Optional):

h3. Hints (optional):
WAS Liberty had a bug related to {{comp/env}} JNDI entries, but it was resolved ([ref|https://github.com/OpenLiberty/open-liberty/issues/11044], [ref2|https://www.ibm.com/support/pages/apar/PI63821]).

Nikola Koevski added a comment - 21/Jul/22 2:28 PM - edited

Internal note:

The bpm-platform.xml JNDI entry is java:comp/env/bpm-platform-xml (src). In WebSphere Liberty, JNDI entries in the java:comp/env/ context are not directly available, and a JNDI reference must be made in one of the application's descriptor files (e.g. ibm-ejb-jar-bnd.xml}} (see ref). This should be easily doable through the server.xml using application bindings (see ref) to a WAS Liberty admin.
An alternative is to define the system environment variable BPM_PLATFORM_XML in the server.env file.

Note

The failure to detect the java:comp/env/bpm-platform-xml JNDI entry is not a bug in Camunda Platform 7. WAS Liberty requires additional configuration to be able to pass JNDI entries in the java:comp/env context. This "additional configuration" is currently not clear.

We also need to make clear that while Tomcat defines the java:/comp/env/ context, in Liberty it is java:comp/env.

Nikola Koevski added a comment - 21/Jul/22 2:28 PM - edited Internal note: The bpm-platform.xml JNDI entry is java:comp/env/bpm-platform-xml ( src ). In WebSphere Liberty, JNDI entries in the java:comp/env/ context are not directly available, and a JNDI reference must be made in one of the application's descriptor files (e.g. ibm-ejb-jar-bnd.xml}} (see ref ). This should be easily doable through the server.xml using application bindings (see ref ) to a WAS Liberty admin. An alternative is to define the system environment variable BPM_PLATFORM_XML in the server.env file. Note The failure to detect the java:comp/env/bpm-platform-xml JNDI entry is not a bug in Camunda Platform 7. WAS Liberty requires additional configuration to be able to pass JNDI entries in the java:comp/env context. This "additional configuration" is currently not clear. We also need to make clear that while Tomcat defines the java:/comp/env/ context, in Liberty it is java:comp/env .

Nikola Koevski made changes - 21/Jul/22 2:30 PM

Status

Original: In Progress [ 3 ]

New: Ready [ 10005 ]

Nikola Koevski made changes - 29/Aug/22 2:54 PM

Assignee

Original: Nikola Koevski [ nikola.koevski ]

Nikola Koevski made changes - 29/Aug/22 2:55 PM

Fix Version/s

Original: 7.18.0 [ 17394 ]

Nikola Koevski made changes - 15/Sep/22 8:25 AM

Link

New: This issue is related to ~~CAM-13102~~ [ ~~CAM-13102~~ ]

Assignee:: Unassigned

Reporter:: Nikola Koevski

Votes:: 0 Vote for this issue

Watchers:: 2 Start watching this issue

Created:: 06/Jul/22 4:52 PM

Updated:: 12/Oct/22 12:07 PM

Details

Description

Environment (Required on creation):

Description (Required on creation; please attach any relevant screenshots, stacktraces, log files, etc. to the ticket):

Steps to reproduce (Required on creation):

Observed Behavior (Required on creation):

Expected behavior (Required on creation):

Root Cause (Required on prioritization):

Solution Ideas (Optional):

Hints (optional):

mgm-controller-panel

This is the controller panel for Smart Panels app

Attachments

Activity

Collapse comment: Nikola Koevski added a comment - 21/Jul/22 2:28 PM, Edited by Nikola Koevski - 29/Aug/22 2:54 PM

Note

Expand comment: Nikola Koevski added a comment - 21/Jul/22 2:28 PM, Edited by Nikola Koevski - 29/Aug/22 2:54 PM

People

Dates

Salesforce