Package org.opencastproject.lti

Class LtiServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.opencastproject.lti.LtiServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class LtiServlet
extends javax.servlet.http.HttpServlet

A servlet to accept an LTI login via POST. The actual authentication happens in LtiProcessingFilter. GET requests produce JSON containing the LTI parameters passed during LTI launch.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONSUMER_CONTACT	See the LTI specification
static final String	CONSUMER_DESCRIPTION	See the LTI specification
static final String	CONSUMER_GUID	See the LTI specification
static final String	CONSUMER_NAME	See the LTI specification
static final String	CONSUMER_URL	See the LTI specification
static final String	CONTEXT_ID	See the LTI specification
static final String	CONTEXT_LABEL	See the LTI specification
static final String	CONTEXT_TITLE	See the LTI specification
static final String	CONTEXT_TYPE	See the LTI specification
static final String	COURSE_OFFERING	See the LTI specification
static final String	COURSE_SECTION	See the LTI specification
static final String	EMAIL	See the LTI specification
static final String	FAMILY_NAME	See the LTI specification
static final String	FULL_NAME	See the LTI specification
static final String	GIVEN_NAME	See the LTI specification
static final String	HEIGHT	See the LTI specification
static final String	LOCALE	See the LTI specification
static final SortedSet<String>	LTI_CONSTANTS
static final String	LTI_MESSAGE_TYPE	See the LTI specification
static final String	LTI_VERSION	See the LTI specification
static final String	RESOURCE_LINK_DESCRIPTION	See the LTI specification
static final String	RESOURCE_LINK_ID	See the LTI specification
static final String	RESOURCE_LINK_TITLE	See the LTI specification
static final String	RETURN_URL	See the LTI specification
static final String	ROLES	See the LTI specification
static final String	SESSION_ATTRIBUTE_KEY	The key used to store the LTI attributes in the HTTP session
static final String	TARGET	See the LTI specification
static final String	USER_ID	See the LTI specification
static final String	USER_IMAGE	See the LTI specification
static final String	WIDTH	See the LTI specification

Constructor Summary

Constructors

Constructor	Description
LtiServlet()

Method Summary

Modifier and Type	Method	Description
protected void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
protected void	doPost(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
protected Map<String,String>	getLtiValuesAsMap(javax.servlet.http.HttpServletRequest req)	Builds a map of LTI parameters

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

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

Field Details

SESSION_ATTRIBUTE_KEY

public static final String SESSION_ATTRIBUTE_KEY

The key used to store the LTI attributes in the HTTP session

See Also:

• Constant Field Values

LTI_MESSAGE_TYPE

public static final String LTI_MESSAGE_TYPE

See the LTI specification

See Also:

• Constant Field Values

LTI_VERSION

public static final String LTI_VERSION

See the LTI specification

See Also:

• Constant Field Values

RESOURCE_LINK_ID

public static final String RESOURCE_LINK_ID

See the LTI specification

See Also:

• Constant Field Values

RESOURCE_LINK_TITLE

public static final String RESOURCE_LINK_TITLE

See the LTI specification

See Also:

• Constant Field Values

RESOURCE_LINK_DESCRIPTION

public static final String RESOURCE_LINK_DESCRIPTION

See the LTI specification

See Also:

• Constant Field Values

USER_ID

public static final String USER_ID

See the LTI specification

See Also:

• Constant Field Values

USER_IMAGE

public static final String USER_IMAGE

See the LTI specification

See Also:

• Constant Field Values

ROLES

public static final String ROLES

See the LTI specification

See Also:

• Constant Field Values

GIVEN_NAME

public static final String GIVEN_NAME

See the LTI specification

See Also:

• Constant Field Values

FAMILY_NAME

public static final String FAMILY_NAME

See the LTI specification

See Also:

• Constant Field Values

FULL_NAME

public static final String FULL_NAME

See the LTI specification

See Also:

• Constant Field Values

EMAIL

public static final String EMAIL

See the LTI specification

See Also:

• Constant Field Values

CONTEXT_ID

public static final String CONTEXT_ID

See the LTI specification

See Also:

• Constant Field Values

CONTEXT_TYPE

public static final String CONTEXT_TYPE

See the LTI specification

See Also:

• Constant Field Values

CONTEXT_TITLE

public static final String CONTEXT_TITLE

See the LTI specification

See Also:

• Constant Field Values

CONTEXT_LABEL

public static final String CONTEXT_LABEL

See the LTI specification

See Also:

• Constant Field Values

LOCALE

public static final String LOCALE

See the LTI specification

See Also:

• Constant Field Values

TARGET

public static final String TARGET

See the LTI specification

See Also:

• Constant Field Values

WIDTH

public static final String WIDTH

See the LTI specification

See Also:

• Constant Field Values

HEIGHT

public static final String HEIGHT

See the LTI specification

See Also:

• Constant Field Values

RETURN_URL

public static final String RETURN_URL

See the LTI specification

See Also:

• Constant Field Values

CONSUMER_GUID

public static final String CONSUMER_GUID

See the LTI specification

See Also:

• Constant Field Values

CONSUMER_NAME

public static final String CONSUMER_NAME

See the LTI specification

See Also:

• Constant Field Values

CONSUMER_DESCRIPTION

public static final String CONSUMER_DESCRIPTION

See the LTI specification

See Also:

• Constant Field Values

CONSUMER_URL

public static final String CONSUMER_URL

See the LTI specification

See Also:

• Constant Field Values

CONSUMER_CONTACT

public static final String CONSUMER_CONTACT

See the LTI specification

See Also:

• Constant Field Values

COURSE_OFFERING

public static final String COURSE_OFFERING

See the LTI specification

See Also:

• Constant Field Values

COURSE_SECTION

public static final String COURSE_SECTION

See the LTI specification

See Also:

• Constant Field Values

LTI_CONSTANTS

public static final SortedSet<String> LTI_CONSTANTS

Constructor Details

LtiServlet

public LtiServlet()

Method Details

doPost

protected void doPost(javax.servlet.http.HttpServletRequest req,
 javax.servlet.http.HttpServletResponse resp)
               throws javax.servlet.ServletException,
IOException

Overrides:

doPost in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

See Also:

• HttpServlet.doPost(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

getLtiValuesAsMap

protected Map<String,String> getLtiValuesAsMap(javax.servlet.http.HttpServletRequest req)

Builds a map of LTI parameters

Parameters:

req - the LTI Launch HttpServletRequest

Returns:

the map of LTI parameters to the values for this launch

doGet

protected void doGet(javax.servlet.http.HttpServletRequest req,
 javax.servlet.http.HttpServletResponse resp)
              throws javax.servlet.ServletException,
IOException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

See Also:

• HttpServlet.doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)