org.imsglobal.lti.launch

Interface LtiSigner

All Known Implementing Classes:

LtiOauthSigner

public interface LtiSigner

This interface contains methods that sign HttpRequests and generic request parameters according to the LTI specification.

Since:

1.1

Author:

Paul Gray

Method Summary

Modifier and Type	Method and Description
org.apache.http.HttpRequest	sign(org.apache.http.HttpRequest request, String key, String secret) This method will return a signed HttpRequest object.
Map<String,String>	signParameters(Map<String,String> parameters, String key, String secret, String url, String method) This method will return a list of signed parameters.

Method Detail

sign

org.apache.http.HttpRequest sign(org.apache.http.HttpRequest request,
                                 String key,
                                 String secret)
                          throws LtiSigningException

This method will return a signed HttpRequest object. Once returned, adding new parameters or changing the body will invalidate the signature. This method should be used for server to server connection requests. For example, posting an LTI Outcome back to the LTI Consumer.

Parameters:

request - the HttpRequest that will be signed

key - the key that will be added to the request.

secret - the secret to be used

Returns:

a signed HttpRequest object

Throws:

LtiSigningException

signParameters

Map<String,String> signParameters(Map<String,String> parameters,
                                  String key,
                                  String secret,
                                  String url,
                                  String method)
                           throws LtiSigningException

This method will return a list of signed parameters. Once returned, adding new parameters or changing the body will invalidate the signature. This method will overwrite reserved parameters from the underlying specification. For example, if you are using the Oauth implementation, oauth_signature will be removed & replaced with the generated signature from the properties.

Parameters:

parameters - the parameters that will be signed. mapped by key & value

key - the key that will be added to the request.

secret - the secret to be sign the parameters with

Returns:

a map of signed parameters (including the signature)

Throws:

LtiSigningException