Package io.jmix.email.authentication.impl

Class GoogleOAuth2AuthorizationCodeFlow

java.lang.Object

io.jmix.email.authentication.impl.AbstractOAuth2Flow

io.jmix.email.authentication.impl.GoogleOAuth2AuthorizationCodeFlow

All Implemented Interfaces:

OAuth2AuthorizationCodeFlow

@NullMarked
public class GoogleOAuth2AuthorizationCodeFlow
extends AbstractOAuth2Flow
implements OAuth2AuthorizationCodeFlow

Authorization code flow for Google accounts. The authorization URL requests access_type=offline and prompt=consent so that the token response always contains a refresh token.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	AUTHORIZATION_ENDPOINT
protected static final String	TOKEN_ENDPOINT

Fields inherited from class io.jmix.email.authentication.impl.AbstractOAuth2Flow

emailerProperties, refreshTokenManager

Constructor Summary

Constructors

Constructor	Description
GoogleOAuth2AuthorizationCodeFlow(EmailerProperties emailerProperties, EmailRefreshTokenManager refreshTokenManager)

Method Summary

Modifier and Type	Method	Description
String	buildAuthorizationUrl(String redirectUri, String state)	Builds the provider consent page URL.
void	completeAuthorization(String authorizationCode, String redirectUri)	Exchanges the authorization code received on the callback for tokens and stores the obtained refresh token via EmailRefreshTokenManager.
protected String	getAuthorizationEndpoint()
protected String	getScope()
protected String	getTokenEndpoint()
protected String	postForm(String url, Map<String,String> formParameters)

Methods inherited from class io.jmix.email.authentication.impl.AbstractOAuth2Flow

encodeForm, getClientId, getRequiredProperty, getSecret

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

AUTHORIZATION_ENDPOINT

protected static final String AUTHORIZATION_ENDPOINT

See Also:

• Constant Field Values

TOKEN_ENDPOINT

protected static final String TOKEN_ENDPOINT

See Also:

• Constant Field Values

Constructor Details

GoogleOAuth2AuthorizationCodeFlow

public GoogleOAuth2AuthorizationCodeFlow(EmailerProperties emailerProperties,
 EmailRefreshTokenManager refreshTokenManager)

Method Details

buildAuthorizationUrl

public String buildAuthorizationUrl(String redirectUri,
 String state)

Description copied from interface: OAuth2AuthorizationCodeFlow

Builds the provider consent page URL.

Specified by:

buildAuthorizationUrl in interface OAuth2AuthorizationCodeFlow

Parameters:

redirectUri - application callback URI registered for the OAuth client

state - opaque value used to protect the round trip against CSRF

Returns:

URL to redirect the user to

completeAuthorization

public void completeAuthorization(String authorizationCode,
 String redirectUri)

Description copied from interface: OAuth2AuthorizationCodeFlow

Exchanges the authorization code received on the callback for tokens and stores the obtained refresh token via EmailRefreshTokenManager.

Specified by:

completeAuthorization in interface OAuth2AuthorizationCodeFlow

Parameters:

authorizationCode - code received on the redirect URI

redirectUri - the same redirect URI that was used to build the authorization URL

postForm

protected String postForm(String url,
 Map<String,String> formParameters)
                   throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

getScope

protected String getScope()

getAuthorizationEndpoint

protected String getAuthorizationEndpoint()

getTokenEndpoint

protected String getTokenEndpoint()