OAuth2AbstractProviderService (Grails 8.0.0-SNAPSHOT)

grails.plugin.springsecurity.oauth2.service.OAuth2AbstractProviderService

All Implemented Interfaces and Traits:

OAuth2ProviderService
```
abstract class OAuth2AbstractProviderService
extends java.lang.Object
implements OAuth2ProviderService
```
Always code as if the guy who ends up maintaining your code will be a violent psychopath who knows where you live. Code for readability. John F. Woods Created by Johannes on 06.04.2016.

Constructor Summary

Constructors
Constructor and description
`OAuth2AbstractProviderService()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`OAuth20Service`	`buildScribeService(OAuth2ProviderConfiguration providerConfiguration)` Create the scribe service to make oAuthCalls with
	`abstract OAuth2SpringToken`	`createSpringAuthToken(OAuth2AccessToken accessToken)` @return Parameters: accessToken
	`OAuth2AccessToken`	`getAccessToken(java.lang.String authCode)` Get the access token from the oAuth2 Service
	`abstract java.lang.Class<? extends DefaultApi20>`	`getApiClass()` A scribeJava API class to use for the oAuth Request or any other class that extends the @link{DefaultApi20}* Returns: The ApiClass that is to use
	`OAuth20Service`	`getAuthService()`
	`java.lang.String`	`getAuthUrl(java.util.Map<java.lang.String, java.lang.String> params)` Get the authorization URL
	`java.lang.String`	`getFailureUrl()` Returns: The configure failureUrl
	`abstract java.lang.String`	`getProfileScope()` Path to the OAuthScope that is returning the UserIdentifier i.e 'https://graph.facebook.com/me' for facebook
	`OAuth2ProviderConfiguration`	`getProviderConfiguration()`
	`abstract java.lang.String`	`getProviderID()` Returns: The ProviderID
	`Response`	`getResponse(OAuth2AccessToken accessToken)` Get the response from OAuthServer
	`abstract java.lang.String`	`getScopeSeparator()` Get separator string for concatenating the mandatory and the optional scopes
	`abstract java.lang.String`	`getScopes()` The scopes that are at least required by the oauth2 provider, to get an email-address Additional scopes can be configured in the application.yml
	`java.lang.String`	`getSuccessUrl()` Returns: The configured successUrl
	`void`	`init(OAuth2ProviderConfiguration oAuth2ProviderConfiguration)` Initialize the service with a configuration

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int)`

- Constructor Detail
  - OAuth2AbstractProviderService()
- Method Detail
  - OAuth20Service buildScribeService(OAuth2ProviderConfiguration providerConfiguration)
    
    Create the scribe service to make oAuthCalls with
    Parameters:
    providerConfiguration
    Returns:
    a scribejava service builder
  - abstract OAuth2SpringToken createSpringAuthToken(OAuth2AccessToken accessToken)
    
    @return
    Parameters:
    accessToken
  - OAuth2AccessToken getAccessToken(java.lang.String authCode)
    
    Get the access token from the oAuth2 Service @return
    Parameters:
    authCode
  - abstract java.lang.Class<? extends DefaultApi20> getApiClass()
    
    A scribeJava API class to use for the oAuth Request or any other class that extends the @link{DefaultApi20}*
    Returns:
    The ApiClass that is to use
  - OAuth20Service getAuthService()
  - java.lang.String getAuthUrl(java.util.Map<java.lang.String, java.lang.String> params)
    
    Get the authorization URL @return
    Parameters:
    params - Additional params for the url call
  - java.lang.String getFailureUrl()
    
    Returns:
    The configure failureUrl
  - abstract java.lang.String getProfileScope()
    
    Path to the OAuthScope that is returning the UserIdentifier i.e 'https://graph.facebook.com/me' for facebook
  - OAuth2ProviderConfiguration getProviderConfiguration()
  - abstract java.lang.String getProviderID()
    
    Returns:
    The ProviderID
  - Response getResponse(OAuth2AccessToken accessToken)
    
    Get the response from OAuthServer @return
    Parameters:
    profileUrl
    accessToken
  - abstract java.lang.String getScopeSeparator()
    
    Get separator string for concatenating the mandatory and the optional scopes
  - abstract java.lang.String getScopes()
    
    The scopes that are at least required by the oauth2 provider, to get an email-address Additional scopes can be configured in the application.yml
  - java.lang.String getSuccessUrl()
    
    Returns:
    The configured successUrl
  - void init(OAuth2ProviderConfiguration oAuth2ProviderConfiguration)
    
    Initialize the service with a configuration
    Parameters:
    oAuth2ProviderConfiguration

Summary:
Constructor
Method

| Detail:
Constructor
Method

[Groovy] Class OAuth2AbstractProviderService

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

OAuth2AbstractProviderService()

Method Detail

OAuth20Service buildScribeService(OAuth2ProviderConfiguration providerConfiguration)

abstract OAuth2SpringToken createSpringAuthToken(OAuth2AccessToken accessToken)

OAuth2AccessToken getAccessToken(java.lang.String authCode)

abstract java.lang.Class<? extends DefaultApi20> getApiClass()

OAuth20Service getAuthService()

java.lang.String getAuthUrl(java.util.Map<java.lang.String, java.lang.String> params)

java.lang.String getFailureUrl()

abstract java.lang.String getProfileScope()

OAuth2ProviderConfiguration getProviderConfiguration()

abstract java.lang.String getProviderID()

Response getResponse(OAuth2AccessToken accessToken)

abstract java.lang.String getScopeSeparator()

abstract java.lang.String getScopes()

java.lang.String getSuccessUrl()

void init(OAuth2ProviderConfiguration oAuth2ProviderConfiguration)