org.nuxeo.ecm.platform.shibboleth.service
Interface ShibbolethAuthenticationService

All Known Implementing Classes:

ShibbolethAuthenticationServiceImpl

public interface ShibbolethAuthenticationService

Method Summary

String	getLoginURL(HttpServletRequest request) Returns the computed login URL to Shibboleth , or null if no login URL is configured.
String	getLoginURL(String redirectURL) Returns the computed login URL to Shibboleth , or null if no login URL is configured.
String	getLogoutURL(HttpServletRequest request) Returns the computed logout URL to Shibboleth, or null if no logout URL is configured.
String	getLogoutURL(String redirectURL) Returns the computed logout URL to Shibboleth, or null if no logout URL is configured.
String	getUserID(HttpServletRequest httpRequest) Returns the user ID based on the source IdP.
Map<String,Object>	getUserMetadata(String idField, HttpServletRequest httpRequest) Returns a map of the user metadata based on the configuration.

Method Detail

getLoginURL

String getLoginURL(String redirectURL)

Returns the computed login URL to Shibboleth , or null if no login URL is configured.

Parameters:

redirect - URL

Returns:

login URL

getLogoutURL

String getLogoutURL(String redirectURL)

Returns the computed logout URL to Shibboleth, or null if no logout URL is configured.

Parameters:

redirect - URL

Returns:

logout URL

getLoginURL

String getLoginURL(HttpServletRequest request)

Returns the computed login URL to Shibboleth , or null if no login URL is configured.

Parameters:

HTTP - request

Returns:

login URL

getLogoutURL

String getLogoutURL(HttpServletRequest request)

Returns the computed logout URL to Shibboleth, or null if no logout URL is configured.

Parameters:

HTTP - request

Returns:

logout URL

getUserID

String getUserID(HttpServletRequest httpRequest)

Returns the user ID based on the source IdP. In the configuration is defined which HTTP header is used for each registered IdP.

Parameters:

HTTP - request

Returns:

user ID

getUserMetadata

Map<String,Object> getUserMetadata(String idField,
                                   HttpServletRequest httpRequest)

Returns a map of the user metadata based on the configuration. Keys are the field names and values coming from the HTTP headers.

Parameters:

HTTP - request

Returns:

metadata map