Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/icon-project/gradle-javaee-plugin
Gradle plugin for Java Execution Environment
https://github.com/icon-project/gradle-javaee-plugin
Last synced: about 2 months ago
JSON representation
Gradle plugin for Java Execution Environment
- Host: GitHub
- URL: https://github.com/icon-project/gradle-javaee-plugin
- Owner: icon-project
- License: apache-2.0
- Created: 2020-09-24T02:14:14.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-11-01T05:30:42.000Z (11 months ago)
- Last Synced: 2024-07-23T22:03:16.172Z (about 2 months ago)
- Language: Java
- Size: 130 KB
- Stars: 5
- Watchers: 6
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-icon - gradle-javaee-plugin - Gradle plugin for ICON Java Execution Environment (Execution environment)
README
[](https://search.maven.org/search?q=g:foundation.icon%20a:gradle-javaee-plugin)
# Gradle plugin for Java Execution Environment
`gradle-javaee-plugin` is a Gradle plugin to automate the process of generating the optimized jar bundle.
The generated jar bundle can be used for deployment to ICON networks that support the Java SCORE execution environment (a.k.a. JavaEE).
## Getting Started
```groovy
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath 'foundation.icon:gradle-javaee-plugin:0.8.5'
}
}
repositories {
mavenCentral()
}
apply plugin: 'java'
apply plugin: 'foundation.icon.javaee'
```
## Configuring Tasks
The `optimizedJar` task type extends from Gradle's `Jar` type.
This means that all attributes and methods available on `Jar` are also available on `optimizedJar`.
Refer the _Gradle User Guide_ for [Jar](https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html) for details.
### Specifying a Main Class Name
`mainClassName` property is required to indicate the entry point that is used for the initial execution.
This property will be included into the generated jar bundle with the `Main-Class` header in the manifest.
```groovy
optimizedJar {
mainClassName = 'com.iconloop.score.example.HelloWorld'
}
```
#### Enabling Debug Mode
`optimizedJar` task obfuscates the Java class names by default to reduce the output jar file size.
However, this makes code analysis more difficult when debugging code by examining the stack trace.
`enableDebug` option can be used to skip this optimization for debugging purpose.
```groovy
optimizedJar {
mainClassName = 'com.iconloop.score.example.HelloWorld'
enableDebug = true
}
```
### Jar Deployment
The `deployJar` extension can be used to deploy the optimized jar to local or remote ICON networks that support the Java SCORE execution environment.
```groovy
deployJar {
endpoints {
local {
uri = 'http://localhost:9082/api/v3'
nid = 0x3
}
}
keystore = './mykey.json'
password = 'keypass'
parameters {
arg('name', 'Alice')
}
}
```
The above extension creates `deployToLocal` task automatically based on the container name of the given endpoints property.
#### Deployment for update
Starting from version `0.7.9`, you can specify `to` address to update an already deployed contract.
`to` property is optional, thus omitting this is regarded as deploying a new contract.
```groovy
deployJar {
endpoints {
local {
uri = 'http://localhost:9082/api/v3'
nid = 0x3
to = 'cxe3d5237f13530bce0b936df320c0308885d062e9'
}
}
...
}
```
## Examples
- [Java SCORE Examples](https://github.com/icon-project/java-score-examples)
## License
This project is available under the [Apache License, Version 2.0](LICENSE).