Share via

SystemBrowserOptions Class

  • Reference
Package:
com.microsoft.aad.msal4j
Maven Artifact:
com.microsoft.azure:msal4j:1.17.2
  • java.lang.Object
    • com.microsoft.aad.msal4j.SystemBrowserOptions

public class SystemBrowserOptions

Options for using the default OS browser as a separate process to handle interactive authentication. MSAL will listen for the OS browser to finish authenticating, but it cannot close the browser. It can however response with a HTTP 200 OK message or a 302 Redirect, which can be configured here. For more details, see https://aka.ms/msal4j-interactive-request

Method Summary

Modifier and Type Method and Description
java.net.URI browserRedirectError()

When the the user finishes authenticating, but an error occurred, MSAL will redirect the browser to the given URI.
java.net.URI browserRedirectSuccess()

When the user finishes authenticating, MSAL will redirect the browser to the given URI.
static SystemBrowserOptionsBuilder builder()

Builder for SystemBrowserOptions
java.lang.String htmlMessageError()

WHen the user finishes authenticating, but an error occurred, MSAL will respond with a Http 200 Ok message, which the browser will show to the user.
java.lang.String htmlMessageSuccess()

When the user finishes authenticating, MSAL will respond with a Http 200 OK message, which the browser will show to the user
OpenBrowserAction openBrowserAction()

Allows developers to implement their own logic for starting a browser and navigating to a specific Uri.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize 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 java.lang.Object.wait

Method Details

browserRedirectError

public URI browserRedirectError()

When the the user finishes authenticating, but an error occurred, MSAL will redirect the browser to the given URI. Takes precedence over htmlMessageError

browserRedirectSuccess

public URI browserRedirectSuccess()

When the user finishes authenticating, MSAL will redirect the browser to the given URI. Takes precedence over htmlMessageSuccess

builder

public static SystemBrowserOptions.SystemBrowserOptionsBuilder builder()

Builder for SystemBrowserOptions

htmlMessageError

public String htmlMessageError()

WHen the user finishes authenticating, but an error occurred, MSAL will respond with a Http 200 Ok message, which the browser will show to the user.

htmlMessageSuccess

public String htmlMessageSuccess()

When the user finishes authenticating, MSAL will respond with a Http 200 OK message, which the browser will show to the user

openBrowserAction

public OpenBrowserAction openBrowserAction()

Allows developers to implement their own logic for starting a browser and navigating to a specific Uri. Msal will use this when opening the browser. If not set, the user configured browser will be used.

Applies to