org.kuali.rice.kim.api.identity

Interface AuthenticationService

All Known Implementing Classes:

AuthenticationServiceImpl

public interface AuthenticationService

This service is used to extract the name of the authenticated principal from an incoming http request. Depending on the implementation of this service, it may extract information from a request which has already been authenticated (i.e. via another service like CAS or Shiboleth). Alternatively, this implementation might actually perform the authentication itself based on information available on the http request.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Methods

Modifier and Type	Method and Description
String	getPrincipalName(javax.servlet.http.HttpServletRequest request) Returns the principalName of the principal that has authenticated with the incoming HttpServletRequest.

Method Detail

getPrincipalName

String getPrincipalName(javax.servlet.http.HttpServletRequest request)

Returns the principalName of the principal that has authenticated with the incoming HttpServletRequest. Implementations of this method might perform actual authentication or merely extract the existing authenticated principal's name off of the incoming request.

Parameters:

request - the incoming HttpServletRequest

Returns:

the principalName of the authenticated principal, or null if the principal could not be authenticated