Note: This task has a runtime dependency on IBM WebSphere Application Server Migration Toolkit for Application Binaries, which is separately licensed under IBM License Agreement for Non-Warranted Programs. For more information, see the license.
Scan the class files of an application and create a new generated-features.xml Liberty configuration file in the server configuration directory that contains the Liberty features the application requires. You can alternatively save the file in the source configuration directory of your application using the generateToSrc parameter.
This feature is best accessed through dev mode. When you start libertyDev your application will be compiled and the class files will be scanned to verify that all the required Liberty features are included in your server configuration. Then as you work, dev mode will continue to monitor the project to confirm the Liberty features configured are up to date. If you implement a new interface in Java, the scanner will determine if that API is connected to a Liberty feature, then update the configuration and install the feature. If you remove a feature from server.xml, dev mode will determine if that feature is actually necessary, and if so, add it to the generated configuration file as described below.
Feature generation is enabled through dev mode by default. If you need to disable feature generation, you can start dev mode with the parameter --generateFeatures=false. The generated features file will be saved in the server configuration directory. If you wish to save the file in the source configuration directory, you can start dev mode with the parameter --generateToSrc=true. When running dev mode, you can toggle the generation of features off and on by typing 'g' and pressing Enter. You can toggle the location of the generated file by typing 's' and pressing Enter.
Normally dev mode only scans a class file that has just been updated, but you can tell dev mode to rescan all class files by typing 'o' and pressing Enter. This will optimize the feature list in the generated configuration file.
| Parameter | Description | Required |
|---|---|---|
| generateToSrc | If set to true, place the new file generated-features.xml in the src/main/liberty directory tree rather than in the server configuration directory. The default value is false. |
No |
This task is not part of the lifecycle, so to use it in your build you will need to understand its dependencies. Since it will scan the class files of your application, it must be run after the compileJava task. This task uses the server configuration directory so it has a dependency on the libertyCreate task which will run if there is no Liberty server detected. Finally the installFeature task will run after this task.
If this task detects Liberty features used in your project but not present in your Liberty configuration, it will create a new file configDropins/overrides/generated-features.xml in the build/wlp/usr/servers/defaultServer directory or optionally in the src/main/liberty/config directory of your project. The generated-features.xml file will contain a list of features required for your project. If the generated-features.xml file has been created in the past and no additional features have been detected, this file will be retained.
If you are using devc, ensure that the generated-features.xml configuration file is copied to your Docker image via your Dockerfile.
COPY --chown=1001:0 build/wlp/usr/servers/defaultServer/configDropins/overrides/generated-features.xml /config/configDropins/overrides/If on Linux, it is recommended that you copy the entire configDropins/overrides directory to your Docker image via your Dockerfile.
COPY --chown=1001:0 build/wlp/usr/servers/defaultServer/configDropins/overrides /config/configDropins/overridesThe task examines the build.gradle dependencies to determine which version of Jakarta EE, MicroProfile or Java EE API you may be using. Compatible features will then be generated.
For Jakarta EE API, this task looks for jakarta:jakartaee-api dependency and generates features according to the version number.
For MicroProfile API, this task looks for a org.eclipse.microprofile:microprofile dependency and generates features according to the version number.
For Java EE API, this task looks for a javax:javaee-api dependency with versions 6.0, 7.0 or 8.0.
For example, if you have the following Jakarta EE and MicroProfile dependencies in your build.gradle file, features compatible with Jakarta EE 9.1.0 and MicroProfile 5.0 will be generated.
dependencies {
providedCompile 'jakarta.platform:jakarta.jakartaee-api:9.1.0'
providedCompile 'org.eclipse.microprofile:microprofile:5.0'
}This task also considers the features you have already specified in server.xml or other Liberty server configuration files (e.g. include elements and configDropins files). This task will attempt to find a working set of features that are compatible with each other.
If there are conflicts with features specified in Liberty configuration files or features used in the application code, this task will print an error message. If available, this task will also print a list of suggested features with no conflicts.
Compile the application code and generate Liberty features.
gradle compileJava generateFeatures
- When using the
serverXmlFileparameter in thebuild.gradlefile, if you specify a file not in the directorysrc/main/liberty/configand that file uses relative paths to include other files, any features in those files will not be considered for feature generation - Any features accessed using property variables (e.g.
${custom.key}/configFile.xml) are not considered for feature generation
See issues tagged with generateFeatures for further information.