org.activemath.webapp.base.external
Interface ExternalAuthenticationService

public interface ExternalAuthenticationService

Interface for an SSO service. A class implementing this interface provides SSO to a host LMS system (such as Moodle, Sakai or Clix).

Method Summary

ExternalAuthenticationData

extractAuthData(HttpServletRequest request) Determine if a request provides SSO information for an external LMS host.

Method Detail

extractAuthData

ExternalAuthenticationData extractAuthData(HttpServletRequest request)
                                           throws ExternalAuthenticationException

Determine if a request provides SSO information for an external LMS host.

If this request does not provide SSO data, it needs to return fast.

If this methods finds SSO data in the request, it fills out an ExternalAuthenticationData object, which contains the the userId to be used for the ActiveMath login, and possibly also the current UserData from the host system.

Parameters:

request - - the login request that might contain SSO information

Returns:

the user data determined from the request, or null.

Throws:

ExternalAuthenticationException - can provide detailed error diagnosis