ShibbolethAuthenticationService (Nuxeo 2021.1.19 API Documentation)

All Known Implementing Classes:

ShibbolethAuthenticationServiceImpl
```
public interface ShibbolethAuthenticationService
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getLoginURL(String redirectURL)`	Returns the computed login URL to Shibboleth , or `null` if no login URL is configured.
`String`	`getLoginURL(javax.servlet.http.HttpServletRequest request)`	Returns the computed login URL to Shibboleth , or `null` if no login URL is configured.
`String`	`getLogoutURL(String redirectURL)`	Returns the computed logout URL to Shibboleth, or `null` if no logout URL is configured.
`String`	`getLogoutURL(javax.servlet.http.HttpServletRequest request)`	Returns the computed logout URL to Shibboleth, or `null` if no logout URL is configured.
`String`	`getUserID(javax.servlet.http.HttpServletRequest httpRequest)`	Returns the user ID based on the source IdP.
`com.google.common.collect.BiMap<String,String>`	`getUserMetadata()`	Returns a bi-map of the user metadata {response headers, values} based on the configuration.
`Map<String,Object>`	`getUserMetadata(String idField, javax.servlet.http.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.
  - getLogoutURL
```
String getLogoutURL(String redirectURL)
```
    Returns the computed logout URL to Shibboleth, or null if no logout URL is configured.
  - getLoginURL
```
String getLoginURL(javax.servlet.http.HttpServletRequest request)
```
    Returns the computed login URL to Shibboleth , or null if no login URL is configured.
  - getLogoutURL
```
String getLogoutURL(javax.servlet.http.HttpServletRequest request)
```
    Returns the computed logout URL to Shibboleth, or null if no logout URL is configured.
  - getUserID
```
String getUserID(javax.servlet.http.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.
  - getUserMetadata
```
Map<String,Object> getUserMetadata(String idField,
                                         javax.servlet.http.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.
  - getUserMetadata
```
com.google.common.collect.BiMap<String,String> getUserMetadata()
```
    Returns a bi-map of the user metadata {response headers, values} based on the configuration.
    
    Since:
    
    8.3