org.oscelot.lti.tp

Class ToolProvider

java.lang.Object

org.oscelot.lti.tp.ToolProvider

public class ToolProvider
extends java.lang.Object

Class to represent an LTI Tool Provider.

Version:

1.1.01 (18-Jun-13)

Author:

Stephen P Vickers

Field Summary

Fields

Modifier and Type	Field and Description
static int	ID_SCOPE_CONTEXT Prefix the ID with the consumer key and context ID.
static int	ID_SCOPE_GLOBAL Prefix an ID with the consumer key.
static int	ID_SCOPE_ID_ONLY Use ID value only.
static int	ID_SCOPE_RESOURCE Prefix the ID with the consumer key and resource link ID.
static char	ID_SCOPE_SEPARATOR Character used to separate each element of an ID.
static java.lang.String	LTI_VERSION LTI version for messages.

Constructor Summary

Constructors

Constructor and Description
ToolProvider(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Callback callbackHandler, DataConnector dataConnector) Constructs a ToolProvider object for handling an LTI launch request.
ToolProvider(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.util.Map<java.lang.String,Callback> callbackHandlers, DataConnector dataConnector) Constructs a ToolProvider object for handling an LTI launch request.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	execute() Process a launch request
ToolConsumer	getConsumer() Returns the tool consumer object relating to the source of the launch request.
java.util.List<ToolConsumer>	getConsumers() Get a list of tool consumers defined in this tool provider.
java.lang.String	getDefaultEmail() Returns the default email domain to be used when auto-generating email addresses.
int	getIdScope() Returns the default scope to use when generating user IDs.
java.lang.String	getMessage() Returns a default message returned from an invalid launch.
java.lang.String	getReason() Returns an explanation for the error identified in the launch.
java.lang.String	getRedirectUrl() Returns the URL to which the user should be redirected on successful completion of processing the request.
javax.servlet.http.HttpServletRequest	getRequest() Returns the HTTP request object relating to the current launch request.
ResourceLink	getResourceLink() Returns the ResourceLink object relating to the source of the launch request.
java.lang.String	getReturnUrl() Returns the URL provided on launch to use when returning a user to the tool consumer.
User	getUser() Returns the User object relating to the user performing launch request.
boolean	isAllowSharing() Returns true if the sharing facility is to be permitted.
boolean	isOk() Returns true if no errors have been encountered.
void	setAllowSharing(boolean allowSharing) Set whether the sharing facility is permitted for launch requests.
void	setDefaultEmail(java.lang.String defaultEmail) Set the the default email domain to be used when auto-generating email addresses.
void	setIdScope(int idScope) Set the default scope to use when generating user IDs.
void	setMessage(java.lang.String message) Set the default message to return on an invalid launch.
void	setParameterConstraint(java.lang.String name, boolean required, java.lang.Integer maxLength) Add a parameter constraint to be validated on launch.
void	setReason(java.lang.String reason) Set the explanation for an error identified in the launch.
void	setRedirectUrl(java.lang.String redirectUrl) Set the URL to which users should be redirected on successful completion of a launch request.

Methods inherited from class java.lang.Object

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

Field Detail

LTI_VERSION

public static final java.lang.String LTI_VERSION

LTI version for messages.

See Also:

Constant Field Values

ID_SCOPE_ID_ONLY

public static final int ID_SCOPE_ID_ONLY

Use ID value only.

See Also:

Constant Field Values

ID_SCOPE_GLOBAL

public static final int ID_SCOPE_GLOBAL

Prefix an ID with the consumer key.

See Also:

Constant Field Values

ID_SCOPE_CONTEXT

public static final int ID_SCOPE_CONTEXT

Prefix the ID with the consumer key and context ID.

See Also:

Constant Field Values

ID_SCOPE_RESOURCE

public static final int ID_SCOPE_RESOURCE

Prefix the ID with the consumer key and resource link ID.

See Also:

Constant Field Values

ID_SCOPE_SEPARATOR

public static final char ID_SCOPE_SEPARATOR

Character used to separate each element of an ID.

See Also:

Constant Field Values

Constructor Detail

ToolProvider

public ToolProvider(javax.servlet.http.HttpServletRequest request,
            javax.servlet.http.HttpServletResponse response,
            Callback callbackHandler,
            DataConnector dataConnector)

Constructs a ToolProvider object for handling an LTI launch request.

Parameters:

request - User's HTTP request object

response - User's HTTP response object

callbackHandler - Callback function for a connect request

dataConnector - DataConnector object representing the database connection to use for accessing the tables used by the package

ToolProvider

public ToolProvider(javax.servlet.http.HttpServletRequest request,
            javax.servlet.http.HttpServletResponse response,
            java.util.Map<java.lang.String,Callback> callbackHandlers,
            DataConnector dataConnector)

Constructs a ToolProvider object for handling an LTI launch request.

Parameters:

request - User's HTTP request object

response - User's HTTP response object

callbackHandlers - Map containing callback functions for each request type (e.g. connect, error)

dataConnector - DataConnector object representing the database connection to use for accessing the tables used by the package

Method Detail

execute

public boolean execute()

Process a launch request

Returns:

true if the launch request was successful

isOk

public boolean isOk()

Returns true if no errors have been encountered.

Returns:

true if there have not been any errors

getConsumer

public ToolConsumer getConsumer()

Returns the tool consumer object relating to the source of the launch request.

Returns:

ToolConsumer object

getUser

public User getUser()

Returns the User object relating to the user performing launch request.

Returns:

user object

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Returns the HTTP request object relating to the current launch request.

Returns:

HTTP request object

getResourceLink

public ResourceLink getResourceLink()

Returns the ResourceLink object relating to the source of the launch request.

Returns:

ResourceLink object

getReturnUrl

public java.lang.String getReturnUrl()

Returns the URL provided on launch to use when returning a user to the tool consumer.

Returns:

return URL

getRedirectUrl

public java.lang.String getRedirectUrl()

Returns the URL to which the user should be redirected on successful completion of processing the request.

Returns:

redirect URL

setRedirectUrl

public void setRedirectUrl(java.lang.String redirectUrl)

Set the URL to which users should be redirected on successful completion of a launch request.

Parameters:

redirectUrl - redirect URL, may be null

getDefaultEmail

public java.lang.String getDefaultEmail()

Returns the default email domain to be used when auto-generating email addresses.

When the domain starts with @ the user's ID will be added as a prefix when generating an email address.

Returns:

default email domain

setDefaultEmail

public void setDefaultEmail(java.lang.String defaultEmail)

Set the the default email domain to be used when auto-generating email addresses.

When the domain starts with @ the user's ID will be added as a prefix when generating an email address.

Parameters:

defaultEmail - default email domain

getIdScope

public int getIdScope()

Returns the default scope to use when generating user IDs.

The value is one of the pre-defined constants: ID_SCOPE_ID_ONLY, ID_SCOPE_GLOBAL, ID_SCOPE_CONTEXT, ID_SCOPE_RESOURCE.

Returns:

default scope

setIdScope

public void setIdScope(int idScope)

Set the default scope to use when generating user IDs.

The value should be one of the pre-defined constants: ID_SCOPE_ID_ONLY, ID_SCOPE_GLOBAL, ID_SCOPE_CONTEXT, ID_SCOPE_RESOURCE.

Parameters:

idScope - default scope

isAllowSharing

public boolean isAllowSharing()

Returns true if the sharing facility is to be permitted.

Sharing allows launches from different resource link IDs to all be directed to the same one.

Returns:

true if sharing is permitted

setAllowSharing

public void setAllowSharing(boolean allowSharing)

Set whether the sharing facility is permitted for launch requests.

Sharing allows launches from different resource link IDs to all be directed to the same one.

Parameters:

allowSharing - true if sharing is permitted

setParameterConstraint

public void setParameterConstraint(java.lang.String name,
                          boolean required,
                          java.lang.Integer maxLength)

Add a parameter constraint to be validated on launch.

A parameter may be validated based on its presence (required) and/or a specified maximum length.

Parameters:

name - Name of parameter to be validated

required - True if parameter is required

maxLength - Maximum permitted length of parameter value (optional, default is NULL)

getMessage

public java.lang.String getMessage()

Returns a default message returned from an invalid launch.

Returns:

message string

setMessage

public void setMessage(java.lang.String message)

Set the default message to return on an invalid launch.

Parameters:

message - message string

getReason

public java.lang.String getReason()

Returns an explanation for the error identified in the launch.

Returns:

error description (null if no error arose)

setReason

public void setReason(java.lang.String reason)

Set the explanation for an error identified in the launch.

Parameters:

reason - error description, may be null

getConsumers

public java.util.List<ToolConsumer> getConsumers()

Get a list of tool consumers defined in this tool provider.

Returns:

list of ToolConsumer objects