net.raphimc.minecraftauth

Class MinecraftAuth.MsaTokenBuilder

java.lang.Object

net.raphimc.minecraftauth.MinecraftAuth.MsaTokenBuilder

Enclosing class:

MinecraftAuth

public static class MinecraftAuth.MsaTokenBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
MsaTokenBuilder()

Method Summary

Modifier and Type	Method and Description
AbstractStep<MsaCodeStep.MsaCode,StepMsaToken.MsaToken>	build()
MinecraftAuth.InitialXblSessionBuilder	credentials() Logs in with a Microsoft account's credentials and gets an MSA token.
MinecraftAuth.InitialXblSessionBuilder	customMsaCodeStep(AbstractStep<?,MsaCodeStep.MsaCode> msaCodeStep) Deprecated.
MinecraftAuth.InitialXblSessionBuilder	customMsaCodeStep(java.util.function.Function<AbstractStep.ApplicationDetails,AbstractStep<?,MsaCodeStep.MsaCode>> msaCodeStepProvider) Uses the specified custom MSA code step to get an MSA token.
MinecraftAuth.InitialXblSessionBuilder	deviceCode() Uses the device code flow to get an MSA token.
MinecraftAuth.InitialXblSessionBuilder	javaFxWebView() Opens a JavaFX WebView window to get an MSA token.
MinecraftAuth.InitialXblSessionBuilder	localWebServer() Generates a URL to open in the browser to get an MSA token.
MinecraftAuth.MsaTokenBuilder	withApplicationDetails(AbstractStep.ApplicationDetails applicationDetails) Sets the application details
MinecraftAuth.MsaTokenBuilder	withClientId(java.lang.String clientId) Sets the client id of the application
MinecraftAuth.MsaTokenBuilder	withClientSecret(java.lang.String clientSecret) Sets the client secret of the application
MinecraftAuth.MsaTokenBuilder	withOAuthEnvironment(OAuthEnvironment oAuthEnvironment) Sets the OAuth environment of the application
MinecraftAuth.MsaTokenBuilder	withRedirectUri(java.lang.String redirectUri) Sets the redirect uri to use for the local webserver or credentials auth flow
MinecraftAuth.MsaTokenBuilder	withScope(java.lang.String scope) Sets the scope of the application
MinecraftAuth.MsaTokenBuilder	withTimeout(int timeout) Sets the timeout of the device code or local webserver auth flow

Methods inherited from class java.lang.Object

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

Constructor Detail

MsaTokenBuilder

public MsaTokenBuilder()

Method Detail

withClientId

public MinecraftAuth.MsaTokenBuilder withClientId(java.lang.String clientId)

Sets the client id of the application

Parameters:

clientId - The client id

Returns:

The builder

withScope

public MinecraftAuth.MsaTokenBuilder withScope(java.lang.String scope)

Sets the scope of the application

Parameters:

scope - The scope

Returns:

The builder

withClientSecret

public MinecraftAuth.MsaTokenBuilder withClientSecret(java.lang.String clientSecret)

Sets the client secret of the application

Parameters:

clientSecret - The client secret

Returns:

The builder

withRedirectUri

public MinecraftAuth.MsaTokenBuilder withRedirectUri(java.lang.String redirectUri)

Sets the redirect uri to use for the local webserver or credentials auth flow

Parameters:

redirectUri - The redirect uri

Returns:

The builder

withOAuthEnvironment

public MinecraftAuth.MsaTokenBuilder withOAuthEnvironment(OAuthEnvironment oAuthEnvironment)

Sets the OAuth environment of the application

Parameters:

oAuthEnvironment - The OAuth environment

Returns:

The builder

withApplicationDetails

public MinecraftAuth.MsaTokenBuilder withApplicationDetails(AbstractStep.ApplicationDetails applicationDetails)

Sets the application details

Parameters:

applicationDetails - The application details

Returns:

The builder

withTimeout

public MinecraftAuth.MsaTokenBuilder withTimeout(int timeout)

Sets the timeout of the device code or local webserver auth flow

Parameters:

timeout - The timeout in seconds

Returns:

The builder

deviceCode

public MinecraftAuth.InitialXblSessionBuilder deviceCode()

Uses the device code flow to get an MSA token. This is the recommended way to get an MSA token.
Needs instance of StepMsaDeviceCode.MsaDeviceCodeCallback as input when calling AbstractStep.getFromInput(HttpClient, AbstractStep.InitialInput).

Returns:

The builder

credentials

public MinecraftAuth.InitialXblSessionBuilder credentials()

Logs in with a Microsoft account's credentials and gets an MSA token.
Needs instance of StepCredentialsMsaCode.MsaCredentials as input when calling AbstractStep.getFromInput(HttpClient, AbstractStep.InitialInput).

Returns:

The builder

javaFxWebView

public MinecraftAuth.InitialXblSessionBuilder javaFxWebView()

Opens a JavaFX WebView window to get an MSA token. The window closes when the user logged in.
Optionally accepts a StepJfxWebViewMsaCode.JavaFxWebView as input when calling AbstractStep.getFromInput(HttpClient, AbstractStep.InitialInput).

Returns:

The builder

localWebServer

public MinecraftAuth.InitialXblSessionBuilder localWebServer()

Generates a URL to open in the browser to get an MSA token. The browser redirects to a localhost URL with the token as a parameter when the user logged in.
Needs instance of StepLocalWebServer.LocalWebServerCallback as input when calling AbstractStep.getFromInput(HttpClient, AbstractStep.InitialInput).

Returns:

The builder

customMsaCodeStep

public MinecraftAuth.InitialXblSessionBuilder customMsaCodeStep(java.util.function.Function<AbstractStep.ApplicationDetails,AbstractStep<?,MsaCodeStep.MsaCode>> msaCodeStepProvider)

Uses the specified custom MSA code step to get an MSA token.

Parameters:

msaCodeStepProvider - The custom MSA code step provider

Returns:

The builder

customMsaCodeStep

@Deprecated
public MinecraftAuth.InitialXblSessionBuilder customMsaCodeStep(AbstractStep<?,MsaCodeStep.MsaCode> msaCodeStep)

Deprecated.

build

public AbstractStep<MsaCodeStep.MsaCode,StepMsaToken.MsaToken> build()