org.imsglobal.lti2

Class LTI2Servlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.imsglobal.lti2.LTI2Servlet

All Implemented Interfaces:

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

public class LTI2Servlet
extends javax.servlet.http.HttpServlet

Notes: This is a sample "Hello World" servlet for LTI2. It is a simple UI - mostly intended to exercise the APIs and show the way for servlet-based LTI2 code. Here are the web.xml entries:

 
  <servlet>
    <servlet-name>SampleServlet</servlet-name>
    <servlet-class>org.imsglobal.lti2.LTI2Servlet</servlet-class>
  </servlet>
  <servlet-mapping>
    <servlet-name>SampleServlet</servlet-name>
    <url-pattern>/sample/*</url-pattern>
  </servlet-mapping>
 
 

Then navigate to: http://localhost/testservlet/sample/register A PHP endpoint is available at: https://source.sakaiproject.org/svn/basiclti/trunk/basiclti-docs/resources/docs/sakai-api-test The tp.php script is the Tool Provider registration endpoint in the PHP code

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ServiceOffered	LTI2LtiLinkSettings
protected ServiceOffered	LTI2ResultItem
protected ServiceOffered	LTI2ToolProxyBindingSettings
protected ServiceOffered	LTI2ToolProxySettings

Constructor Summary

Constructors

Constructor and Description
LTI2Servlet()

Method Summary

Modifier and Type	Method and Description
protected ToolConsumer	buildToolConsumerProfile(javax.servlet.http.HttpServletRequest request, Map<String,Object> deploy, String profile_id)
void	destroy()
void	doErrorJSON(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, IMSJSONRequest json, String message, Exception e)
protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	doLaunch(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	doPut(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	doRegister(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	doRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
String	getServiceURL(javax.servlet.http.HttpServletRequest request)
protected void	getToolConsumerProfile(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String profile_id)
void	handleResultRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String sourcedid)
void	handleSettingsRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String[] parts)
void	init(javax.servlet.ServletConfig config)
void	registerToolProviderProfile(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String profile_id)

Methods inherited from class javax.servlet.http.HttpServlet

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

Methods inherited from class javax.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Field Detail

LTI2ResultItem

protected ServiceOffered LTI2ResultItem

LTI2LtiLinkSettings

protected ServiceOffered LTI2LtiLinkSettings

LTI2ToolProxyBindingSettings

protected ServiceOffered LTI2ToolProxyBindingSettings

LTI2ToolProxySettings

protected ServiceOffered LTI2ToolProxySettings

Constructor Detail

LTI2Servlet

public LTI2Servlet()

Method Detail

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

doPut

protected void doPut(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws javax.servlet.ServletException,
                     IOException

Overrides:

doPut in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

doGet

protected void doGet(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws javax.servlet.ServletException,
                     IOException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

doPost

protected void doPost(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws javax.servlet.ServletException,
                      IOException

Overrides:

doPost in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

doRequest

protected void doRequest(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws javax.servlet.ServletException,
                         IOException

Throws:

javax.servlet.ServletException

IOException

doRegister

protected void doRegister(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)

doLaunch

protected void doLaunch(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)

getToolConsumerProfile

protected void getToolConsumerProfile(javax.servlet.http.HttpServletRequest request,
                                      javax.servlet.http.HttpServletResponse response,
                                      String profile_id)

buildToolConsumerProfile

protected ToolConsumer buildToolConsumerProfile(javax.servlet.http.HttpServletRequest request,
                                                Map<String,Object> deploy,
                                                String profile_id)

registerToolProviderProfile

public void registerToolProviderProfile(javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response,
                                        String profile_id)
                                 throws IOException

Throws:

IOException

getServiceURL

public String getServiceURL(javax.servlet.http.HttpServletRequest request)

handleResultRequest

public void handleResultRequest(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response,
                                String sourcedid)
                         throws IOException

Throws:

IOException

handleSettingsRequest

public void handleSettingsRequest(javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response,
                                  String[] parts)
                           throws IOException

Throws:

IOException

doErrorJSON

public void doErrorJSON(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response,
                        IMSJSONRequest json,
                        String message,
                        Exception e)
                 throws IOException

Throws:

IOException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet