adito5393 / java-lti-1.3

LTI 1.3 & LTI Advantage Java Library

Library implementing a full LTI Advantage tool.

Install

This library depends on two additional libraries:

• LTI 1.3 core
• LTI 1.3 JWT for testing

Install it using maven:

./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 RSAS

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 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 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

Repository info:

<repositories>
    <repository>
      <id>github-uoc-lti-core</id>
      <name>GitHub UOC Apache Maven Packages</name>
      <url>https://maven.pkg.github.com/uoc/java-lti-1.3-core</url>
    </repository>				
    <repository>
      <id>github-uoc-lti-jwt</id>
      <name>GitHub UOC Apache Maven Packages</name>
      <url>https://maven.pkg.github.com/uoc/java-lti-1.3-jwt</url>
    </repository>				
    <repository>
      <id>github-uoc-lti</id>
      <name>GitHub UOC Apache Maven Packages</name>
      <url>https://maven.pkg.github.com/uoc/java-lti-1.3</url>
    </repository>
</repositories>

2. Add the dependency to your pom.xml file:

  <dependency>
    <groupId>edu.uoc.elc.lti</groupId>
    <artifactId>lti-13</artifactId>
    <version>0.0.2</version>
  </dependency>

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