org.imsglobal.lti.launch

Interface LtiVerifier

All Known Implementing Classes:

LtiOauthVerifier

public interface LtiVerifier

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

Since:

1.1

Author:

Paul Gray

Method Summary

Modifier and Type	Method and Description
LtiVerificationResult	verify(javax.servlet.http.HttpServletRequest request, String secret) This method will verify the HttpServletRequest.
LtiVerificationResult	verifyParameters(Map<String,String> parameters, String url, String method, String secret) This method will verify a list of properties (mapped by key & value).

Method Detail

verify

LtiVerificationResult verify(javax.servlet.http.HttpServletRequest request,
                             String secret)
                      throws LtiVerificationException

This method will verify the HttpServletRequest.

Parameters:

request - the HttpServletRequest that will be verified

secret - the secret to verify the properties with

Returns:

an LtiVerificationResult which will contain information about the request (whether or not it is valid, and if it is valid, contextual information about the request).

Throws:

LtiVerificationException

verifyParameters

LtiVerificationResult verifyParameters(Map<String,String> parameters,
                                       String url,
                                       String method,
                                       String secret)
                                throws LtiVerificationException

This method will verify a list of properties (mapped by key & value).

Parameters:

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

url - the url this request was made at

method - the method this url was requested with

secret - the secret to verify the propertihes with

Returns:

an LtiVerificationResult which will contain information about the request (whether or not it is valid, and if it is valid, contextual information about the request).

Throws:

LtiVerificationException