OAuth2Resource

All Superinterfaces:: Resource

public interface OAuth2Resource
extends Resource

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class OAuth2Resource.OAuth2ProfileDetails
This contains the information about the authenticated profile

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Object`	`authenticate(OAuth2Resource.OAuth2ProfileDetails profile)`	Called when an oauth2 login response has been received, with details received from the remote server.
`Map<String,OAuth2Provider>`	`getOAuth2Providers()`

Methods inherited from interface io.milton.resource.Resource
authenticate, authorise, checkRedirect, getModifiedDate, getName, getRealm, getUniqueId

- Method Detail
  - authenticate
```
Object authenticate(OAuth2Resource.OAuth2ProfileDetails profile)
```
    Called when an oauth2 login response has been received, with details received from the remote server. The method should return an application specific object representing the user if one exists OR if the application chooses to create one. Or return null to indicate that this resource cannot authenticate the request. In that case the AuthenticationService may continue looking for other authentication providers which are able to authenticate the request. A typical workflow is that an OAuth response will be received, the current user will be authenticated from the CookieAuthenticationHandler, and the application will then choose to link the oauth credentials to the current user. Subsequently the user is then able to authenticat with oauth.
    
    Parameters:
    
    profile - - the details about the current user as provided by the remote authentication server
    
    Returns:
    
    an object which represents the current principal, or null to reject the login
  - getOAuth2Providers
```
Map<String,OAuth2Provider> getOAuth2Providers()
```