Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Binary scanner license #782

Merged
merged 6 commits into from
Sep 30, 2022
Merged

Binary scanner license #782

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4c6aa6d
Add binary scanner license to README
TrevCraw Sep 30, 2022
d60072c
Add binary scanner license to libertyDev.md
TrevCraw Sep 30, 2022
4da1da3
Add binary scanner license to generateFeatures.md
TrevCraw Sep 30, 2022
51fec70
Update README.md
TrevCraw Sep 30, 2022
1991069
Update libertyDev.md
TrevCraw Sep 30, 2022
7341fb3
Update generateFeatures.md
TrevCraw Sep 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,13 @@ The Liberty plugin provides the following tasks for your project:
| [cleanDirs](docs/clean.md#clean-task) | Cleans the Liberty server logs, workarea, and applications folders.|
| [compileJsp](docs/compileJsp.md) | Compiles the JSP files from the src/main/webapp directory into the build/classes directory. |
| [deploy](docs/deploy.md#deploy-task) | Deploys one or more applications to a Liberty server. |
| [generateFeatures](docs/generateFeatures.md#generateFeatures-task) | Scan the class files of an application and create a Liberty configuration file in the source configuration directory containing the Liberty features the application requires. |
| [generateFeatures](docs/generateFeatures.md#generateFeatures-task) | Scan the class files of an application and create a Liberty configuration file in the source configuration directory that contains the Liberty features the application requires.* |
| [installFeature](docs/installFeature.md#installfeature-task) | Installs an additional feature to the Liberty runtime. |
| [installLiberty](docs/installLiberty.md#installliberty-task) | Installs the Liberty runtime from a repository. |
| [libertyCreate](docs/libertyCreate.md#libertycreate-task) | Creates a Liberty server. |
| [libertyDebug](docs/libertyDebug.md) | Runs the Liberty server in the console foreground after a debugger connects to the debug port (default: 7777). |
| [libertyDev](docs/libertyDev.md) | Start a Liberty server in dev mode. |
| [libertyDevc](docs/libertyDev.md#libertydevc-task-container-mode) | Start a Liberty server in dev mode in a container. |
| [libertyDev](docs/libertyDev.md) | Start a Liberty server in dev mode.* |
| [libertyDevc](docs/libertyDev.md#libertydevc-task-container-mode) | Start a Liberty server in dev mode in a container.* |
| [libertyDump](docs/libertyDump.md#libertydump-task) | Dumps diagnostic information from the Liberty server into an archive. |
| [libertyJavaDump](docs/libertyJavaDump.md#libertyjavadump-task) | Dumps diagnostic information from the Liberty server JVM. |
| [libertyPackage](docs/libertyPackage.md#libertypackage-task) | Packages a Liberty server. |
Expand All @@ -112,6 +112,9 @@ The Liberty plugin provides the following tasks for your project:
| [undeploy](docs/undeploy.md#undeploy-task) | Removes applications from the Liberty server. |
| [uninstallFeature](docs/uninstallFeature.md#uninstallfeature-task) | Remove a feature from the Liberty runtime. |

*The `libertyDev`, `libertyDevc`, and `generateFeatures` tasks have 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](https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/wasdev/license/wamt).
Note: The `libertyDev` and `libertyDevc` tasks have this dependency only when auto-generation of features is turned on. By default, auto-generation of features is turned off.

### Task ordering

The Liberty Gradle plugin defines a built-in task order to allow a user to call an end task without worrying about calling the necessary tasks in between. By having the plugin manage tasks and their order of execution we can easily avoid some simple human errors. For example, in order to have a majority of the tasks function, the principal task `installLiberty` must be called, which our plugin would do for you.
Expand Down
4 changes: 2 additions & 2 deletions docs/generateFeatures.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
## generateFeatures task
---

**This task will modify the source configuration directory of your application.**
**This task modifies the source configuration directory of your application.** 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](https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/wasdev/license/wamt).

Scan the class files of an application and create a new `generated-features.xml` Liberty configuration file within the source directory containing the features the application requires.
Scan the class files of an application and create a new `generated-features.xml` Liberty configuration file in the source configuration directory that contains the Liberty features the application requires.

This feature is best accessed through [dev mode](libertyDev.md). 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.

Expand Down
2 changes: 1 addition & 1 deletion docs/libertyDev.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Start a Liberty instance in dev mode. This task also invokes the `libertyCreate`, `installFeature`, and `deploy` tasks before starting the runtime.
**Note:** This task is designed to be executed directly from the Gradle command line.

N.B. starting in 3.4.1, dev mode invokes `generateFeatures` if the `generateFeatures` configuration parameter is set to `true` (default is `false`). **This task will modify the source configuration directory of your application.** See [generateFeatures](generateFeatures.md) for details.
Starting in version 3.4.1, dev mode invokes the `generateFeatures` task when the `generateFeatures` configuration parameter is set to `true`. **This task modifies the source configuration directory of your application.** See [generateFeatures](generateFeatures.md) for details. The default value for the `generateFeatures` parameter is `false`. When auto-generation of features is turned on, dev mode 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](https://public.dhe.ibm.com/ibmdl/export/pub/software/websphere/wasdev/license/wamt).

**Limitations:** This task is not supported with Spring Boot applications.

Expand Down