Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/UOC/java-lti-1.3
https://github.com/UOC/java-lti-1.3
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/UOC/java-lti-1.3
- Owner: UOC
- License: mit
- Created: 2019-12-04T10:51:52.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-07-17T19:27:22.000Z (11 months ago)
- Last Synced: 2024-01-25T19:07:45.195Z (5 months ago)
- Language: Java
- Size: 332 KB
- Stars: 21
- Watchers: 10
- Forks: 12
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-lti - LTI 1.3 and LTI Advantage `lti-13`
- awesome-lti - LTI 1.3 and LTI Advantage `lti-13`
README
# LTI 1.3 & LTI Advantage Java Library
Library implementing a full [LTI Advantage](https://www.imsglobal.org/activity/learning-tools-interoperability) tool.
## Install
This library depends on two additional libraries:
* [LTI 1.3 core](https://github.com/UOC/java-lti-1.3-core)
* [LTI 1.3 JWT](https://github.com/UOC/java-lti-1.3-jwt) for testing
Install it using maven:
```bash
./mvnw install
```
## Documentation
The basic class in the library is `edu.uoc.elc.lti.tool.Tool`, which defines a Tool. It has the basic methods:
* `public boolean validate(String token, String state)`
* `public AccessTokenResponse getAccessToken() throws IOException, BadToolProviderConfigurationException`
* `public NamesRoleService getNameRoleService()`
* `public DeepLinkingClient getDeepLinkingClient()`
* `public AssignmentGradeService getAssignmentGradeService()`
It also has utility methods for getting claims in an agnostic way
## Configuration
Configuration of the Tool is made through the classes `edu.uoc.elc.lti.tool.Registration`, `edu.uoc.elc.lti.tool.KeySet`, `edu.uoc.elc.lti.tool.Key` and `edu.uoc.elc.lti.tool.Deployment`.
There you can set the following parameters of the tool:
### Key
* `id`: id of the key
* `privateKey`: private key of the key
* `publicKey`: public key of the key
* `algorithm`: algorithm of the key, usually `RSA`S
## KeySet
* `id`: id of the keyset
* `keys`: list of keys of the keyset
## Deployment
* `deploymentId`: Id of the deployment
## Registration
* `clientId`
* `name`: Name of the tool
* `platform`: Name of the platform
* `keySetUrl`: URL of the platform's keyset
* `accessTokenUrl`: URL of the platform's access token
* `oidcAuthUrl`: URL of the platform's OIDC auth
* `deployments`: List of deployments
* `keySet`: KeySet
Tool uses [LTI 1.3 core](https://github.com/UOC/java-lti-1.3-core#about) interfaces for dealing
with requests and JWT generation. The definition of the implementations of these interfaces are
in the `edu.uoc.elc.lti.tool.ToolBuilders` class
## Usage
1. Set your maven installation to work with Github packages, following the [Github Docs](https://help.github.com/en/packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages#authenticating-to-github-packages). Add the following configuration to your maven `settings.xml` file:
```xml
github-uoc-lti
USERNAME
GITHUB_TOKEN
github-uoc-lti-core
USERNAME
GITHUB_TOKEN
github-uoc-lti-jwt
USERNAME
GITHUB_TOKEN
```
2. Add the dependency to your `pom.xml` file:
```xml
edu.uoc.elc.lti
lti-13
1.0.0
```
3. Add the following repositories to your `pom.xml` file & verify that the repositories's IDs matches the server's IDs (set at step 1):
```xml
github-uoc-lti-core
GitHub UOC Apache Maven Packages
https://maven.pkg.github.com/uoc/java-lti-1.3-core
github-uoc-lti-jwt
GitHub UOC Apache Maven Packages
https://maven.pkg.github.com/uoc/java-lti-1.3-jwt
github-uoc-lti
GitHub UOC Apache Maven Packages
https://maven.pkg.github.com/uoc/java-lti-1.3
```
## Contributing
Thanks for being interested in this project. The way of contributing is the common for almost all projects:
1. Fork the project to your account
2. Implement your changes
3. Make a pull request
If you need further information contact to `xaracil at uoc dot edu`