au.edu.anu.portal.portlets.basiclti.adapters
Interface IBasicLTIAdapter

All Known Implementing Classes:

AbstractAdapter, ChemvantageAdapter, NoteflightAdapter, PeoplesoftAdapter, SakaiAdapter, StandardAdapter, WikispacesAdapter, WimbaAdapter

public interface IBasicLTIAdapter

IBasicLTIAdapter Interface that all Basic LTI adapters must implement.

An adapter is essentially a processor that takes data and processes it according to the requirements of the provider_type. Each Basic LTI provider_type may have specific requirements. When the portlet is configured, the provider_type is supplied as part of the configuration. The portlet checks this and calls the appropriate adapter.

To create a new adapter, identify the requirements of your provider.

Things to consider:

1. Does the URL require any specific data included?
2. Do any special parameters unique to this provider need to be sent in the launch data?
3. Do any parameters need to be adjusted before they are sent?

If yes, create an adapter that does these things by extending AbstractAdapter (which implement this class for you) and wire it up in portlet.xml.

Note: You must always add the default set of Basic LTI parameters from AbstractAdapter

Author:

Steve Swinsburg (steve.swinsburg@anu.edu.au)

Method Summary

Map<String,String>

processLaunchData(Map<String,String> params) Processes the launch data map according to the requirements of the specific provider

Method Detail

processLaunchData

Map<String,String> processLaunchData(Map<String,String> params)

Processes the launch data map according to the requirements of the specific provider

Parameters:

params - map of launch data params

Returns:

the processes Map