Package io.jmix.email.authentication.impl

Class MicrosoftOAuth2DeviceCodeFlow

java.lang.Object

io.jmix.email.authentication.impl.AbstractOAuth2Flow

io.jmix.email.authentication.impl.MicrosoftOAuth2DeviceCodeFlow

All Implemented Interfaces:

OAuth2DeviceCodeFlow

@NullMarked
public class MicrosoftOAuth2DeviceCodeFlow
extends AbstractOAuth2Flow
implements OAuth2DeviceCodeFlow

Device code flow for Microsoft accounts. Runs on a public client application with the same client id, so the app registration must have "Allow public client flows" enabled.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final long	DEVICE_CODE_INIT_TIMEOUT_SEC
protected final SystemAuthenticator	systemAuthenticator

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

emailerProperties, refreshTokenManager

Constructor Summary

Constructors

Constructor	Description
MicrosoftOAuth2DeviceCodeFlow(EmailerProperties emailerProperties, EmailRefreshTokenManager refreshTokenManager, SystemAuthenticator systemAuthenticator)

Method Summary

Modifier and Type	Method	Description
protected CompletableFuture<com.microsoft.aad.msal4j.IAuthenticationResult>	acquireDeviceCodeToken(RefreshTokenCapturingCacheAspect cacheAspect, Consumer<com.microsoft.aad.msal4j.DeviceCode> deviceCodeConsumer)
protected void	awaitInitialization(CountDownLatch initLatch, OAuth2DeviceCodeSession session)
protected String	buildAuthorityUrl()
protected void	completeSession(OAuth2DeviceCodeSession session, RefreshTokenCapturingCacheAspect cacheAspect)	Stores the obtained refresh token.
protected String	getBaseAuthorityUrl()
protected @Nullable String	getCapturedRefreshToken(RefreshTokenCapturingCacheAspect cacheAspect)
protected Set<String>	getScopes()
protected String	getTenant()
protected String	rootMessage(Throwable throwable)
OAuth2DeviceCodeSession	start()	Starts the device code flow and returns a session carrying the user instructions (verification URI and user code).

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

DEVICE_CODE_INIT_TIMEOUT_SEC

protected static final long DEVICE_CODE_INIT_TIMEOUT_SEC

See Also:

• Constant Field Values

systemAuthenticator

protected final SystemAuthenticator systemAuthenticator

Constructor Details

MicrosoftOAuth2DeviceCodeFlow

public MicrosoftOAuth2DeviceCodeFlow(EmailerProperties emailerProperties,
 EmailRefreshTokenManager refreshTokenManager,
 SystemAuthenticator systemAuthenticator)

Method Details

start

public OAuth2DeviceCodeSession start()

Description copied from interface: OAuth2DeviceCodeFlow

Starts the device code flow and returns a session carrying the user instructions (verification URI and user code).

The flow completes asynchronously — track it via OAuth2DeviceCodeSession.getStatus(). On successful completion the obtained refresh token is stored via EmailRefreshTokenManager.

Specified by:

start in interface OAuth2DeviceCodeFlow

Returns:

started session

completeSession

protected void completeSession(OAuth2DeviceCodeSession session,
 RefreshTokenCapturingCacheAspect cacheAspect)

Stores the obtained refresh token. Runs on an MSAL callback thread without a security context, so the token is stored under system authentication.

acquireDeviceCodeToken

protected CompletableFuture<com.microsoft.aad.msal4j.IAuthenticationResult> acquireDeviceCodeToken(RefreshTokenCapturingCacheAspect cacheAspect,
 Consumer<com.microsoft.aad.msal4j.DeviceCode> deviceCodeConsumer)
                                                                                            throws Exception

Throws:

Exception

awaitInitialization

protected void awaitInitialization(CountDownLatch initLatch,
 OAuth2DeviceCodeSession session)

rootMessage

protected String rootMessage(Throwable throwable)

getCapturedRefreshToken

protected @Nullable String getCapturedRefreshToken(RefreshTokenCapturingCacheAspect cacheAspect)

getScopes

protected Set<String> getScopes()

buildAuthorityUrl

protected String buildAuthorityUrl()

getBaseAuthorityUrl

protected String getBaseAuthorityUrl()

getTenant

protected String getTenant()