https://github.com/inrupt/solid-client-java
Java Client Libraries for Solid
https://github.com/inrupt/solid-client-java
java-library solid
Last synced: 10 months ago
JSON representation
Java Client Libraries for Solid
- Host: GitHub
- URL: https://github.com/inrupt/solid-client-java
- Owner: inrupt
- License: mit
- Created: 2022-06-30T20:08:01.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-13T17:59:05.000Z (over 1 year ago)
- Last Synced: 2024-12-14T02:29:35.078Z (over 1 year ago)
- Topics: java-library, solid
- Language: Java
- Homepage: https://docs.inrupt.com/developer-tools/java/client-libraries/
- Size: 196 MB
- Stars: 11
- Watchers: 12
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Java Client Libraries for Solid
[](CODE-OF-CONDUCT.md)
This project adheres to the Contributor Covenant [code of conduct](CODE-OF-CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [engineering@inrupt.com](mailto:engineering@inrupt.com).
The Inrupt Java Client Libraries provide highly flexible, simple components that can be used in any Java application for [Solid](https://solidproject.org/). The libraries are composed of different modules that follow a layered architectural approach.
## Using the libraries as a dependency in your own projects
To use the Inrupt Java Client Libraries in your projects make sure to visit the [Getting Started page](https://docs.inrupt.com/developer-tools/java/client-libraries/getting-started/) of the documentation.
Next we will document how to use this repository locally.
## Using this repository locally
After cloning the repository locally you can work with the code as follows:
### Code build
The project can be built with Maven and a Java 11+ build environment.
```bash
./mvnw install
```
### Running tests
The repository contains multiple tests. Each module has dedicated unit tests. And there is a module dedicated to integration testing in the [integration module](https://github.com/inrupt/solid-client-java/tree/main/integration).
By running the following command all tests (including integration tests) are run:
```bash
./mvnw test
```
The integration tests come with a dedicated Mocked Solid Server. Their configuration can be setup in such a way that the integration tests can be run also on live Solid Servers. More about their setup and configuration can be found on the [integration test README](https://github.com/inrupt/solid-client-java/blob/main/integration/README.md).
#### Code coverage
This project uses JaCoCo for generating the code coverage metric that measures how many lines of code are executed during automated tests. To generate the reports (in different formats) run:
```bash
./mvnw verify
```
The reports are then placed in the `report/target/site` folder on the project root.
## Issues & Help
### Solid Community Forum
If you have questions about working with Solid or just want to share what you’re
working on, visit the [Solid forum](https://forum.solidproject.org/). The Solid
forum is a good place to meet the rest of the community.
### Bugs and Feature Requests
- For public feedback, bug reports, and feature requests please file an issue
via [Github](https://github.com/inrupt/solid-client-java/issues/).
- For non-public feedback or support inquiries please use the [Inrupt Service
Desk](https://inrupt.atlassian.net/servicedesk).
## Documentation
- [Inrupt Java Client Libraries getting started](https://docs.inrupt.com/developer-tools/java/client-libraries/getting-started/)
- [Inrupt Java Client Libraries javadocs](https://docs.inrupt.com/developer-tools/api/java/inrupt-client/latest/)
## Changelog
See the [Release notes](https://github.com/inrupt/solid-client-java/releases)
## License
MIT © [Inrupt](https://inrupt.com)