java.lang.Object
- io.vertigo.vega.plugins.authentication.aad.AzureAdWebAuthenticationPlugin

All Implemented Interfaces:

io.vertigo.core.node.component.CoreComponent, io.vertigo.core.node.component.Plugin, WebAuthenticationPlugin<com.microsoft.aad.msal4j.IAuthenticationResult>
```
public class AzureAdWebAuthenticationPlugin
extends Object
implements WebAuthenticationPlugin<com.microsoft.aad.msal4j.IAuthenticationResult>
```

Field Summary

Fields
Modifier and Type Field Description

protected static String PRINCIPAL_SESSION_NAME

protected static String TOKEN_CACHE_SESSION_ATTRIBUTE

Constructor Summary

Constructors
Constructor	Description
`AzureAdWebAuthenticationPlugin(Optional<String> urlPrefixOpt, Optional<String> urlHandlerPrefixOpt, Optional<String> connectorNameOpt, List<io.vertigo.connectors.azure.aad.AzureAdConnector> azureAdConnectors)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AuthenticationResult<com.microsoft.aad.msal4j.IAuthenticationResult>`	`doHandleCallback(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)`	Handle the callback request after login on the sso
`io.vertigo.core.lang.Tuple<AuthenticationResult<com.microsoft.aad.msal4j.IAuthenticationResult>,javax.servlet.http.HttpServletRequest>`	`doInterceptRequest(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse)`
`boolean`	`doLogout(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse)`
`void`	`doRedirectToSso(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)`	Handle the redirect to the sso login page
`static com.microsoft.aad.msal4j.IAuthenticationResult`	`getAuthSessionObject(javax.servlet.http.HttpServletRequest request)`
`String`	`getCallbackUrl()`	Returns the url for callback
`Optional<String>`	`getExternalUrlOptional()`	Return an optional external url of the application (if it is behind a firewall or a proxy)
`String`	`getLogoutUrl()`	Returns the url for logout
`Optional<String>`	`getRequestedUri(javax.servlet.http.HttpServletRequest httpRequest)`	Return the original request a user wanted before beeing redirected to the sso
`String`	`getUrlHandlerPrefix()`	Url prefix of request directly handled by the plugin
`Map<String,BiFunction<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,io.vertigo.core.lang.Tuple<Boolean,javax.servlet.http.HttpServletRequest>>>`	`getUrlHandlers()`	Register additionnal handler for specific request necessary for the plugin
`String`	`getUrlPrefix()`	Url prefix of urls that are protected with this authentication plugin

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PRINCIPAL_SESSION_NAME
```
protected static final String PRINCIPAL_SESSION_NAME
```
    See Also:
    
    Constant Field Values
  - TOKEN_CACHE_SESSION_ATTRIBUTE
```
protected static final String TOKEN_CACHE_SESSION_ATTRIBUTE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AzureAdWebAuthenticationPlugin
```
@Inject
public AzureAdWebAuthenticationPlugin(Optional<String> urlPrefixOpt,
                                      Optional<String> urlHandlerPrefixOpt,
                                      Optional<String> connectorNameOpt,
                                      List<io.vertigo.connectors.azure.aad.AzureAdConnector> azureAdConnectors)
```
- Method Detail
  - getUrlPrefix
```
public String getUrlPrefix()
```
    Url prefix of urls that are protected with this authentication plugin
    
    Specified by:
    
    getUrlPrefix in interface WebAuthenticationPlugin<com.microsoft.aad.msal4j.IAuthenticationResult>
    
    Returns:
    
    the prefix
  - getUrlHandlerPrefix
```
public String getUrlHandlerPrefix()
```
    Url prefix of request directly handled by the plugin
    
    Specified by:
    
    getUrlHandlerPrefix in interface WebAuthenticationPlugin<com.microsoft.aad.msal4j.IAuthenticationResult>
    
    Returns:
    
    the prefix
  - getCallbackUrl
```
public String getCallbackUrl()
```
    Returns the url for callback
    
    Specified by:
    
    getCallbackUrl in interface WebAuthenticationPlugin<com.microsoft.aad.msal4j.IAuthenticationResult>
    
    Returns:
    
    url for callback
  - getLogoutUrl
```
public String getLogoutUrl()
```
    Returns the url for logout
    
    Specified by:
    
    getLogoutUrl in interface WebAuthenticationPlugin<com.microsoft.aad.msal4j.IAuthenticationResult>
    
    Returns:
    
    url for logout
  - getExternalUrlOptional
```
public Optional<String> getExternalUrlOptional()
```
    Return an optional external url of the application (if it is behind a firewall or a proxy)
    
    Specified by:
    
    getExternalUrlOptional in interface WebAuthenticationPlugin<com.microsoft.aad.msal4j.IAuthenticationResult>
    
    Returns:
    
    the external url of the app : as seen by the end user
  - doInterceptRequest
```
public io.vertigo.core.lang.Tuple<AuthenticationResult<com.microsoft.aad.msal4j.IAuthenticationResult>,javax.servlet.http.HttpServletRequest> doInterceptRequest(javax.servlet.http.HttpServletRequest httpRequest,
                                                                                                                                                                       javax.servlet.http.HttpServletResponse httpResponse)
```
    Specified by:
    
    doInterceptRequest in interface WebAuthenticationPlugin<com.microsoft.aad.msal4j.IAuthenticationResult>
  - doHandleCallback
```
public AuthenticationResult<com.microsoft.aad.msal4j.IAuthenticationResult> doHandleCallback(javax.servlet.http.HttpServletRequest request,
                                                                                             javax.servlet.http.HttpServletResponse response)
```
    Description copied from interface: WebAuthenticationPlugin
    
    Handle the callback request after login on the sso
    
    Specified by:
    
    doHandleCallback in interface WebAuthenticationPlugin<com.microsoft.aad.msal4j.IAuthenticationResult>
    
    Parameters:
    
    request - the request
    
    response - the response to consume
    
    Returns:
    
    result of login challenge, providing info of the logged in user
  - doRedirectToSso
```
public void doRedirectToSso(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response)
```
    Description copied from interface: WebAuthenticationPlugin
    
    Handle the redirect to the sso login page
    
    Specified by:
    
    doRedirectToSso in interface WebAuthenticationPlugin<com.microsoft.aad.msal4j.IAuthenticationResult>
    
    Parameters:
    
    request - the request
    
    response - the response to consume
  - getAuthSessionObject
```
public static com.microsoft.aad.msal4j.IAuthenticationResult getAuthSessionObject(javax.servlet.http.HttpServletRequest request)
```
  - getUrlHandlers
```
public Map<String,BiFunction<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse,io.vertigo.core.lang.Tuple<Boolean,javax.servlet.http.HttpServletRequest>>> getUrlHandlers()
```
    Description copied from interface: WebAuthenticationPlugin
    
    Register additionnal handler for specific request necessary for the plugin
    
    Specified by:
    
    getUrlHandlers in interface WebAuthenticationPlugin<com.microsoft.aad.msal4j.IAuthenticationResult>
    
    Returns:
    
    le map of specific handlers
  - getRequestedUri
```
public Optional<String> getRequestedUri(javax.servlet.http.HttpServletRequest httpRequest)
```
    Description copied from interface: WebAuthenticationPlugin
    
    Return the original request a user wanted before beeing redirected to the sso
    
    Specified by:
    
    getRequestedUri in interface WebAuthenticationPlugin<com.microsoft.aad.msal4j.IAuthenticationResult>
    
    Parameters:
    
    httpRequest - the request
    
    Returns:
    
    the uri
  - doLogout
```
public boolean doLogout(javax.servlet.http.HttpServletRequest httpRequest,
                        javax.servlet.http.HttpServletResponse httpResponse)
```
    Specified by:
    
    doLogout in interface WebAuthenticationPlugin<com.microsoft.aad.msal4j.IAuthenticationResult>

Modifier and Type	Field	Description
`protected static String`	`PRINCIPAL_SESSION_NAME`
`protected static String`	`TOKEN_CACHE_SESSION_ATTRIBUTE`

Class AzureAdWebAuthenticationPlugin

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PRINCIPAL_SESSION_NAME

TOKEN_CACHE_SESSION_ATTRIBUTE

Constructor Detail

AzureAdWebAuthenticationPlugin

Method Detail

getUrlPrefix

getUrlHandlerPrefix

getCallbackUrl

getLogoutUrl

getExternalUrlOptional

doInterceptRequest

doHandleCallback

doRedirectToSso

getAuthSessionObject

getUrlHandlers

getRequestedUri

doLogout