org.imsglobal.lti.launch

Class LtiOauthSigner

java.lang.Object

org.imsglobal.lti.launch.LtiOauthSigner

All Implemented Interfaces:

LtiSigner

public class LtiOauthSigner
extends Object
implements LtiSigner

This class signs LTI requests according to the Oauth 1.0 spec

Since:

1.1

Author:

Paul Gray

Constructor Summary

Constructors

Constructor and Description
LtiOauthSigner()

Method Summary

Methods

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LtiOauthSigner

public LtiOauthSigner()

Method Detail

sign

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

Description copied from interface: LtiSigner

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.

Specified by:

sign in interface LtiSigner

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

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

Description copied from interface: LtiSigner

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.

Specified by:

signParameters in interface LtiSigner

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