org.imsglobal.lti.launch.LtiSigner Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of basiclti-util Show documentation

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.

The newest version!

package org.imsglobal.lti.launch;

import org.apache.http.HttpRequest;

import java.util.Map;

/**
 * This interface contains methods that sign HttpRequests
 * and generic request parameters according to the LTI
 * specification.
 * @author  Paul Gray
 * @since   1.1
*/
public 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.
     * @param request the HttpRequest that will be signed
     * @param key the key that will be added to the request.
     * @param secret the secret to be used
     * @return a signed HttpRequest object
     * @throws LtiSigningException
     */
    public HttpRequest sign(HttpRequest request, String key, String secret) 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.
     * @param parameters the parameters that will be signed. mapped by key & value
     * @param key the key that will be added to the request.
     * @param secret the secret to be sign the parameters with
     * @return a map of signed parameters (including the signature)
     * @throws LtiSigningException
     */
    public Map signParameters(Map parameters, String key, String secret, String url, String method) throws LtiSigningException;

}