An open API service indexing awesome lists of open source software.

https://github.com/pfgray/basiclti-util-java


https://github.com/pfgray/basiclti-util-java

Last synced: 2 months ago
JSON representation

Awesome Lists containing this project

README

        

#IMS Global - BasicLTI Utilities

[![Build Status](https://travis-ci.org/pfgray/basiclti-util-java.svg?branch=master)](https://travis-ci.org/pfgray/basiclti-util-java)

What is it?
-----------

BasicLTI Utilities are a set of utility classes to aid in the development
of BasicLTI consumers and providers. They deal with much of the heavy lifting
and make the process more opaque to the developer.

How to use:
-----------
Install via Maven:
```
git clone https://github.com/pfgray/basiclti-util-java.git
cd basiclti-util-java/
mvn clean install
```
Include in your project's `pom.xml`:

```xml

org.imsglobal
basiclti-util
1.0.0

```
Examples:
---------

LTI Producer:

Spring Controller (LTI Producer):
```java
@Lti
@RequestMapping(value = "/lti", method = RequestMethod.POST)
public String ltiEntry(HttpServletRequest request, LtiVerificationResult result) {
if(!result.getSuccess()){
return "error";
} else {
return "success";
}
}
```
KeyService Implementation:
```java
public class MockKeyService implements LtiKeySecretService {
public String getSecretForKey(String key) {
return "secret";
}
}
```

Spring Context xml:
```xml



```
How to Contribute:
------------------
1. Fork the repo
2. Add changes
3. Send a pull request with those changes

TODO List:
--------------

- [ ] Write Unit tests for LTI Consumer code
- [ ] Write Unit tests for LTI 2 code