IBM Support

Using Jandex with IBM WebSphere Liberty: Setting the Configuration to Enable Jandex Index Reads

How To


Summary

This article describes how to edit a Liberty server configuration to enable reads of Jandex indexes.

Objective

This article lists the steps for updating a Liberty server configuration to enable jandex index reads.

These steps are appropriate for any user who is running JavaEE applications using a Liberty Profile server and who wishes to enable a liberty server to enable reads of jandex indexes.
?

Environment

These steps are suitable for any Liberty Server environment.

These steps apply to all Liberty environments which include the capability of reading jandex indexes.

A liberty environment which can read jandex indexes has a copy of the jandex jar in the server "lib" folder, for example:

$WLP_HOME/lib/com.ibm.ws.org.jboss.jandex_1.0.21.jar
?

Steps

Jandex index reads are enabled by adding 'useJandex' attributes into the server configuration.

Reads of jandex indexes are enabled by adding a 'useJandex' attribute to the server configuration.? The attribute may be added in two locations:

First, reads of Jandex indexes may be enabled for all applications by adding the attribute 'useJandex' with a value of 'true' to the application manager element of the server configuration.? For example:
? 
<applicationManager autoExpand="true" useJandex="true"/>
Second, reads of Jandex indexes may be enabled for specific applications by adding the attribute 'useJandex' with a value of 'true' to the application element of the specific application which is to be enabled.? For example:
? 
<application name="TestApp" location="TestApp.war" type="war" useJandex="true"/>
As a special case, reads of jandex indexes may be enabled for all but for specified applications by the combination of adding the attribute 'useJandex' with a value of 'true' to the application manager element, while adding 'useJandex' with a value of 'false' to the application elements of the specific applications for which Jandex indexes are not to be read.? This is the only usual case where a 'useJandex' attribute is added with a 'false' value.

For example:
?
<applicationManager autoExpand="true" useJandex="true"/> 
<application name="TestApp" location="TestApp.war" type="war" useJandex="false"/>

Additional Information

Additional information is available.

See these additional articles for more information:

"Using Jandex with IBM WebSphere Liberty" Document Suite:

  • "Using Jandex with IBM WebSphere Liberty: Overview
  • "Using Jandex with IBM WebSphere Liberty: Generating and Storing Jandex Indexes"
  • "Using Jandex with IBM WebSphere Liberty: Setting the Configuration to Enable Jandex Index Reads"
  • "Using Jandex with IBM WebSphere Liberty: Expected Output and Troubleshooting "
IBM Knowledge Center WebSphere Liberty Jandex Documentation: Jandex Links:

[{"Business Unit":{"code":"BU051","label":"N\/A"},"Product":{"code":"SUPPORT","label":"IBM Worldwide Support"},"Component":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions","Edition":"","Line of Business":{"code":"LOB33","label":"N\/A"}}]

Document Information

Modified date:
02 November 2020

UID

ibm10744925

Page Feedback