SpringSecurityOauth2BaseService (Grails 8.0.0-SNAPSHOT)

grails.plugin.springsecurity.oauth2.SpringSecurityOauth2BaseService

@Transactional
@Slf4j
class SpringSecurityOauth2BaseService
extends java.lang.Object

Properties Summary

Properties
Type	Name and description
`AuthenticationManager`	`authenticationManager`
`GrailsApplication`	`grailsApplication`
`java.util.Map<java.lang.String, OAuth2AbstractProviderService>`	`providerServiceMap` Map for storing the different OAuth2Provider
`GrailsUserDetailsService`	`userDetailsService`

Constructor Summary

Constructors
Constructor and description
`SpringSecurityOauth2BaseService()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`boolean`	`authenticationIsValid(java.lang.String username, java.lang.String password)` Parameters: username
	`OAuth2SpringToken`	`createAuthToken(java.lang.String providerName, com.github.scribejava.core.model.OAuth2AccessToken scribeToken)`
	`java.lang.Object`	`getAskToLinkOrCreateAccountUri()` Returns: The uri pointing to the page ask to link or create account
	`java.lang.String`	`getAuthorizationUrl(java.lang.String providerName)` Parameters: providerName
	`java.lang.String`	`getBaseUrl()` Returns: The base url
	`java.lang.String`	`getFailureUrl(java.lang.String providerName)` Parameters: providerName
	`OAuth2AbstractProviderService`	`getProviderService(java.lang.String providerID)` Get OAuth2AbstractProviderService
	`java.lang.Object`	`getRoleNames()` Returns: The role names for a newly registered user
	`java.lang.String`	`getSuccessUrl(java.lang.String providerName)` Parameters: providerName
	`protected java.lang.Class<?>`	`lookupOAuthIdClass()` Returns: The OAuthID class
	`protected java.lang.String`	`lookupOAuthIdClassName()` Returns: The OAuthID class name
	`protected java.lang.Class<?>`	`lookupRoleClass()` Returns: The Role class
	`protected java.lang.String`	`lookupRoleClassName()` Returns: The Role class name
	`protected java.lang.Class<?>`	`lookupUserClass()` Returns: The user class
	`protected java.lang.String`	`lookupUserClassName()` Returns: The user class name
	`protected java.lang.Class<?>`	`lookupUserRoleClass()` Returns: The UserRole class
	`protected java.lang.String`	`lookupUserRoleClassName()` Returns: The UserRole class name
	`void`	`registerProvider(OAuth2ProviderService providerService)` Register the provider into the service
	`java.lang.String`	`sessionKeyForAccessToken(java.lang.String providerName)` Parameters: providerName
	`OAuth2SpringToken`	`updateOAuthToken(OAuth2SpringToken oAuthToken, java.lang.Object user)` Update the oAuthToken
	`boolean`	`usernameTaken(java.lang.String username)` Returns if a user with the given username exists in database.

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)`

- Property Detail
  - AuthenticationManager authenticationManager
  - GrailsApplication grailsApplication
  - java.util.Map<java.lang.String, OAuth2AbstractProviderService> providerServiceMap
    
    Map for storing the different OAuth2Provider
  - GrailsUserDetailsService userDetailsService
- Constructor Detail
  - SpringSecurityOauth2BaseService()
- Method Detail
  - boolean authenticationIsValid(java.lang.String username, java.lang.String password)
    
    Parameters:
    username
    password
    Returns:
    Whether the authentication is valid or not
  - OAuth2SpringToken createAuthToken(java.lang.String providerName, com.github.scribejava.core.model.OAuth2AccessToken scribeToken)
  - java.lang.Object getAskToLinkOrCreateAccountUri()
    
    Returns:
    The uri pointing to the page ask to link or create account
  - java.lang.String getAuthorizationUrl(java.lang.String providerName)
    
    Parameters:
    providerName
    Returns:
    The authorization url for the provider
  - java.lang.String getBaseUrl()
    
    Returns:
    The base url
  - java.lang.String getFailureUrl(java.lang.String providerName)
    
    Parameters:
    providerName
    Returns:
    The failureUrl for the provider service
  - OAuth2AbstractProviderService getProviderService(java.lang.String providerID)
    
    Get OAuth2AbstractProviderService
    Parameters:
    providerID
    Returns:
    An OAuth2AbstractProviderService implementation
  - java.lang.Object getRoleNames()
    
    Returns:
    The role names for a newly registered user
  - java.lang.String getSuccessUrl(java.lang.String providerName)
    
    Parameters:
    providerName
    Returns:
    The successurl for the provider service
  - protected java.lang.Class<?> lookupOAuthIdClass()
    
    Returns:
    The OAuthID class
  - protected java.lang.String lookupOAuthIdClassName()
    
    Returns:
    The OAuthID class name
  - protected java.lang.Class<?> lookupRoleClass()
    
    Returns:
    The Role class
  - protected java.lang.String lookupRoleClassName()
    
    Returns:
    The Role class name
  - protected java.lang.Class<?> lookupUserClass()
    
    Returns:
    The user class
  - protected java.lang.String lookupUserClassName()
    
    Returns:
    The user class name
  - protected java.lang.Class<?> lookupUserRoleClass()
    
    Returns:
    The UserRole class
  - protected java.lang.String lookupUserRoleClassName()
    
    Returns:
    The UserRole class name
  - void registerProvider(OAuth2ProviderService providerService)
    
    Register the provider into the service
    Parameters:
    providerService
  - java.lang.String sessionKeyForAccessToken(java.lang.String providerName)
    
    Parameters:
    providerName
    Returns:
    The session key
  - OAuth2SpringToken updateOAuthToken(OAuth2SpringToken oAuthToken, java.lang.Object user)
    
    Update the oAuthToken
    Parameters:
    oAuthToken
    user
    Returns:
    A current OAuth2SpringToken
  - boolean usernameTaken(java.lang.String username)
    
    Returns if a user with the given username exists in database.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

[Groovy] Class SpringSecurityOauth2BaseService

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

AuthenticationManager authenticationManager

GrailsApplication grailsApplication

java.util.Map<java.lang.String, OAuth2AbstractProviderService> providerServiceMap

GrailsUserDetailsService userDetailsService

Constructor Detail

SpringSecurityOauth2BaseService()

Method Detail

boolean authenticationIsValid(java.lang.String username, java.lang.String password)

OAuth2SpringToken createAuthToken(java.lang.String providerName, com.github.scribejava.core.model.OAuth2AccessToken scribeToken)

java.lang.Object getAskToLinkOrCreateAccountUri()

java.lang.String getAuthorizationUrl(java.lang.String providerName)

java.lang.String getBaseUrl()

java.lang.String getFailureUrl(java.lang.String providerName)

OAuth2AbstractProviderService getProviderService(java.lang.String providerID)

java.lang.Object getRoleNames()

java.lang.String getSuccessUrl(java.lang.String providerName)

protected java.lang.Class<?> lookupOAuthIdClass()

protected java.lang.String lookupOAuthIdClassName()

protected java.lang.Class<?> lookupRoleClass()

protected java.lang.String lookupRoleClassName()

protected java.lang.Class<?> lookupUserClass()

protected java.lang.String lookupUserClassName()

protected java.lang.Class<?> lookupUserRoleClass()

protected java.lang.String lookupUserRoleClassName()

void registerProvider(OAuth2ProviderService providerService)

java.lang.String sessionKeyForAccessToken(java.lang.String providerName)

OAuth2SpringToken updateOAuthToken(OAuth2SpringToken oAuthToken, java.lang.Object user)

boolean usernameTaken(java.lang.String username)