AbstractClientApplicationBase.Builder<T> Klasse

Typparameter

T

public abstract static class AbstractClientApplicationBase.Builder<T>
extends Builder<T>

Feldzusammenfassung

Modifizierer und Typ Feld und Beschreibung
protected boolean isInstanceDiscoveryEnabled

Zusammenfassung zum Konstruktor

Konstruktor Beschreibung
Builder(String clientId)

Konstruktor zum Erstellen einer Instanz des Generators der Clientanwendung

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
T aadInstanceDiscoveryResponse(String val)

Legt Instanzermittlungsantwortdaten fest, die für die Ermittlung von Mandantenermittlungsendpunkt und Autoritätsaliasen verwendet werden.

T applicationName(String val)

Legt den Anwendungsnamen für Telemetriezwecke fest.

T applicationVersion(String val)

Legt die Anwendungsversion für Telemetriezwecke fest.

T authority(String val)

Legen Sie die URL der authentifizierenden Autorität oder des Sicherheitstokendiensts (Security Token Service, STS) fest, von der MSAL Sicherheitstoken abruft.

T autoDetectRegion(boolean val)

Gibt an, dass die Bibliothek versuchen soll, die Azure Region zu ermitteln, in der die Anwendung ausgeführt wird, wenn sie die Instanzermittlungsmetadaten abruft.

T azureRegion(String val)

Legen Sie die Region fest, die von der Bibliothek zum Formatieren von Rechtsgrundlagen in Tokenanforderungen verwendet wird.

T b2cAuthority(String val)

Legen Sie die URL der authentifizierenden B2C-Autorität fest, von der MSAL Token erhält Gültige B2C-Autoritäten sollten wie folgt aussehen: https://< something.b2clogin.com/<tenant>/<policy> MSAL Java unterstützt auch ein älteres B2C-Autoritätsformat, das wie folgt aussieht: https://< host>/tfp/tenant>/<<policy>. MSAL Java wird jedoch die Unterstützung des Legacyformats beenden.

T clientCapabilities(Set<String> capabilities)
T connectTimeoutForDefaultHttpClient(Integer val)

Legt den In httpsURLConnection-Verbindungen DefaultHttpClientverwendeten Verbindungstimeoutwert fest, der bei Verwendung eines benutzerdefinierten HTTP-Clients nicht erforderlich ist.

T correlationId(String val)

Legen Sie die optionale Korrelations-ID fest, die von der API verwendet werden soll.

T executorService(ExecutorService val)

Legt den Executor-Dienstfest, der zum Ausführen der Anforderungen verwendet werden soll.

T httpClient(IHttpClient val)

Legt den HTTP-Client fest, der von der Clientanwendung für alle HTTP-Anforderungen verwendet werden soll.

T instanceDiscovery(boolean val)

In der Vergangenheit würde MSAL eine Verbindung mit einem zentralen Endpunkt herstellen, der sich auf ''microsoftonline'https://login. befindet.com'' zum Abrufen einiger Metadaten, insbesondere bei Verwendung einer unbekannten Autorität.

T logPii(boolean val)

Set logPii - boolean value, which determines whether Pii (personally identifiable information) will be logged in.

T oidcAuthority(String val)

Legen Sie eine bekannte Autorität fest, die einem generischen OpenIdConnect Identity Provider entspricht.

T proxy(Proxy val)

Legt die Proxykonfiguration fest, die von der Clientanwendung (MSAL4J standardmäßig javax.net.ssl.HttpsURLConnectionverwendet) für alle Netzwerkkommunikation verwendet wird.

T readTimeoutForDefaultHttpClient(Integer val)

Legt den in HttpsURLConnection-Verbindungen DefaultHttpClientverwendeten Lesetimeoutwert fest, der bei Verwendung eines benutzerdefinierten HTTP-Clients nicht erforderlich ist.

T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)

Legt den IToken-Cachezugriffsaspektfest, der für cache_data Persistenzverwendet werden soll.

T sslSocketFactory(SSLSocketFactory val)

Legt die SSLSocketFactory fest, die von der Clientanwendung für alle Netzwerkkommunikation verwendet werden soll.

T validateAuthority(boolean val)

Legen Sie einen booleschen Wert fest, der der Anwendung mitteilt, ob die Autorität anhand einer Liste bekannter Behörden überprüft werden muss.

Geerbte Methoden von Builder

Geerbte Methoden von 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

Felddetails

isInstanceDiscoveryEnabled

protected boolean isInstanceDiscoveryEnabled

Details zum Konstruktor

Builder

public Builder(String clientId)

Konstruktor zum Erstellen einer Instanz des Generators der Clientanwendung

Parameter:

clientId - Client-ID (Anwendungs-ID) der Anwendung, die im Anwendungsregistrierungsportal registriert ist (portal.azure.com)

Details zur Methode

aadInstanceDiscoveryResponse

public T aadInstanceDiscoveryResponse(String val)

Legt Instanzermittlungsantwortdaten fest, die für die Ermittlung von Mandantenermittlungsendpunkt und Autoritätsaliasen verwendet werden.

Beachten Sie, dass die Autoritätsüberprüfung auch dann nicht durchgeführt wird, wenn AbstractClientApplicationBase#validateAuthority sie auf "true" festgelegt ist.

Weitere Informationen finden Sie unter https://aka.ms/msal4j-instance-discovery

Parameter:

val - JSON-formatierter Wert der Antwort vom AAD-Instanzermittlungsendpunkt

Gibt zurück:

Instanz des Generators, für den die Methode aufgerufen wurde

applicationName

public T applicationName(String val)

Legt den Anwendungsnamen für Telemetriezwecke fest.

Parameter:

val - Anwendungsname

Gibt zurück:

Instanz des Generators, für den die Methode aufgerufen wurde

applicationVersion

public T applicationVersion(String val)

Legt die Anwendungsversion für Telemetriezwecke fest.

Parameter:

val - Anwendungsversion

Gibt zurück:

Instanz des Generators, für den die Methode aufgerufen wurde

authority

public T authority(String val)

Legen Sie die URL der authentifizierenden Autorität oder des Sicherheitstokendiensts (Security Token Service, STS) fest, von der MSAL Sicherheitstoken abruft. Der Standardwert ist AbstractClientApplicationBase#DEFAULT_AUTHORITY

Parameter:

val - Zeichenfolgenwert der Autorität

Gibt zurück:

Instanz des Generators, für den die Methode aufgerufen wurde

Löst aus:

java.net.MalformedURLException - wenn Val falsch formatierte URL ist

autoDetectRegion

public T autoDetectRegion(boolean val)

Gibt an, dass die Bibliothek versuchen soll, die Azure Region zu ermitteln, in der die Anwendung ausgeführt wird, wenn sie die Instanzermittlungsmetadaten abruft. Regionen können nur erkannt werden, wenn sie in einer Azure Umgebung ausgeführt werden, z. B. einer Azure VM oder einem anderen Dienst, oder wenn die Umgebung die Umgebungsvariable namens REGION_NAME konfiguriert hat. Obwohl Sie hier und eine bestimmte Region AbstractClientApplicationBase#azureRegion mit gleichzeitiger Autodetection aktivieren können, hat die region, die festgelegt AbstractClientApplicationBase#azureRegion ist, Vorrang, wenn eine Übereinstimmung besteht. Weitere Informationen zu unterstützten Szenarien finden Sie hier: https://aka.ms/msal4j-azure-regions

Parameter:

val - boolescher Wert (Standardwert ist false)

Gibt zurück:

Instanz des Generators, für den die Methode aufgerufen wurde

azureRegion

public T azureRegion(String val)

Legen Sie die Region fest, die von der Bibliothek zum Formatieren von Rechtsgrundlagen in Tokenanforderungen verwendet wird. Wenn eine gültige Azure Region angegeben ist, versucht die Bibliothek, Tokenanforderungen an einem regionalen ESTS-R Endpunkt anstelle des globalen ESTS-Endpunkts auszuführen. Regionen müssen Azure Regionen gültig sein, und ihre Kurznamen sollten verwendet werden, z. B. "Westus" für die Region West-US-Azure, "centralus" für die Region mittel-US Azure usw. Obwohl Sie hier eine bestimmte Region festlegen und die automatische Erkennung gleichzeitig aktivieren AbstractClientApplicationBase#autoDetectRegion können, hat die hier festgelegte Region Vorrang vor der automatisch erkannten Region, wenn eine Übereinstimmung besteht. Weitere Informationen zu unterstützten Szenarien finden Sie hier: https://aka.ms/msal4j-azure-regions

Parameter:

val - Name des Zeichenfolgenbereichs

Gibt zurück:

Instanz des Generators, für den die Methode aufgerufen wurde

b2cAuthority

public T b2cAuthority(String val)

Legen Sie die URL der authentifizierenden B2C-Autorität fest, von der MSAL Token erhält Gültige B2C-Autoritäten sollten wie folgt aussehen: https://< something.b2clogin.com/< tenant>/<policy> MSAL Java unterstützt auch ein älteres B2C-Autoritätsformat, das wie folgt aussieht: https://< host>/tfp/tenant>/<<policy>. MSAL Java unterstützt jedoch schließlich das Legacyformat. Informationen zum Migrieren zum neuen Format finden Sie hier: https://aka.ms/msal4j-b2c

Parameter:

val - boolescher Wert für validateAuthority

Gibt zurück:

Instanz des Generators, für den die Methode aufgerufen wurde

Löst aus:

java.net.MalformedURLException

clientCapabilities

public T clientCapabilities(Set<String> capabilities)

Parameter:

capabilities

connectTimeoutForDefaultHttpClient

public T connectTimeoutForDefaultHttpClient(Integer val)

Legt den In httpsURLConnection-Verbindungen verwendeten Verbindungstimeoutwert fest, der bei DefaultHttpClientVerwendung eines benutzerdefinierten HTTP-Clients nicht erforderlich ist.

Überschreibt:

AbstractClientApplicationBase.Builder<T>.connectTimeoutForDefaultHttpClient(Integer val)

Parameter:

val - Timeoutwert in Millisekunden

Gibt zurück:

Instanz des Generators, für den die Methode aufgerufen wurde

correlationId

public T correlationId(String val)

Legen Sie die optionale Korrelations-ID fest, die von der API verwendet werden soll. Wenn nicht angegeben, generiert die API eine zufällige UUID.

Überschreibt:

AbstractClientApplicationBase.Builder<T>.correlationId(String val)

Parameter:

val - Zeichenfolgenwert der Korrelations-ID

Gibt zurück:

Instanz des Generators, für den die Methode aufgerufen wurde

executorService

public T executorService(ExecutorService val)

Legt "ExecutorService" fest, der zum Ausführen der Anforderungen verwendet wird. Entwickler sind für die Aufrechterhaltung des Lebenszyklus des ExecutorService verantwortlich.

Überschreibt:

AbstractClientApplicationBase.Builder<T>.executorService(ExecutorService val)

Parameter:

val - eine Instanz von ExecutorService

Gibt zurück:

Instanz des Generators, für den die Methode aufgerufen wurde

httpClient

public T httpClient(IHttpClient val)

Legt den HTTP-Client fest, der von der Clientanwendung für alle HTTP-Anforderungen verwendet werden soll. Ermöglicht eine differenzierte Konfiguration des HTTP-Clients.

Überschreibt:

AbstractClientApplicationBase.Builder<T>.httpClient(IHttpClient val)

Parameter:

val - Implementierung von IHttpClient

Gibt zurück:

Instanz des Generators, für den die Methode aufgerufen wurde

instanceDiscovery

public T instanceDiscovery(boolean val)

In der Vergangenheit würde MSAL eine Verbindung mit einem zentralen Endpunkt herstellen, der sich auf "'https://login.microsoftonline.com" befindet, um einige Metadaten zu erhalten, insbesondere bei Verwendung einer unbekannten Autorität. Dieses Verhalten wird als Instance Discovery bezeichnet. Dieser Parameter ist standardmäßig auf "true" festgelegt, wodurch die Instanzermittlung aktiviert wird. Wenn Sie einige Behörden vorher noch nicht kennen, möchten Sie dennoch, dass MSAL alle von Ihnen bereitgestellten Autoritäten akzeptiert, können Sie mit einem "False"-Wert die Instanzermittlung bedingungslos deaktivieren.

Parameter:

val

logPii

public T logPii(boolean val)

Legen Sie logPii - boolescher Wert fest, der bestimmt, ob Pii (persönlich identifizierbare Informationen) angemeldet werden soll. Der Standardwert ist "false".

Überschreibt:

AbstractClientApplicationBase.Builder<T>.logPii(boolean val)

Parameter:

val - boolescher Wert für logPii

Gibt zurück:

Instanz des Generators, für den die Methode aufgerufen wurde

oidcAuthority

public T oidcAuthority(String val)

Legen Sie eine bekannte Autorität fest, die einem generischen OpenIdConnect-Identitätsanbieter entspricht. MSAL fügt ".well-known/openid-configuration" an die Autorität an, um die OIDC-Metadaten abzurufen und die Endpunkte zu bestimmen.

Parameter:

val - Zeichenfolgenwert der Autorität

Gibt zurück:

Instanz des Generators, für den die Methode aufgerufen wurde

Löst aus:

java.net.MalformedURLException

proxy

public T proxy(Proxy val)

Legt die Proxykonfiguration fest, die von der Clientanwendung (MSAL4J standardmäßig javax.net.ssl.HttpsURLConnectionverwendet) für alle Netzwerkkommunikation verwendet wird. Wenn kein Proxywert übergeben wird, werden vom System definierte Eigenschaften verwendet. Wenn der HTTP-Client für die Clientanwendung (über ClientApplication.builder().httpClient()) festgelegt ist, sollte die Proxykonfiguration für das übergebene HTTP-Clientobjekt und nicht über diese Methode erfolgen.

Überschreibt:

AbstractClientApplicationBase.Builder<T>.proxy(Proxy val)

Parameter:

val - eine Instanz von Proxy

Gibt zurück:

Instanz des Generators, für den die Methode aufgerufen wurde

readTimeoutForDefaultHttpClient

public T readTimeoutForDefaultHttpClient(Integer val)

Legt den in HttpsURLConnection-Verbindungen verwendeten Lesetimeoutwert fest, der bei DefaultHttpClientVerwendung eines benutzerdefinierten HTTP-Clients nicht erforderlich ist.

Überschreibt:

AbstractClientApplicationBase.Builder<T>.readTimeoutForDefaultHttpClient(Integer val)

Parameter:

val - Timeoutwert in Millisekunden

Gibt zurück:

Instanz des Generators, für den die Methode aufgerufen wurde

setTokenCacheAccessAspect

public T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)

Legt fest, dass ITokenCacheAccessAspect für cache_data Persistenz verwendet wird.

Parameter:

val - eine Instanz von ITokenCacheAccessAspect

Gibt zurück:

Instanz des Generators, für den die Methode aufgerufen wurde

sslSocketFactory

public T sslSocketFactory(SSLSocketFactory val)

Legt SSLSocketFactory fest, die von der Clientanwendung für alle Netzwerkkommunikation verwendet werden soll. Wenn der HTTP-Client für die Clientanwendung (über ClientApplication.builder().httpClient()) festgelegt ist, sollte eine ssl-Konfiguration auf dem HTTP-Client erfolgen und nicht über diese Methode.

Überschreibt:

AbstractClientApplicationBase.Builder<T>.sslSocketFactory(SSLSocketFactory val)

Parameter:

val - eine Instanz von SSLSocketFactory

Gibt zurück:

Instanz des Generators, für den die Methode aufgerufen wurde

validateAuthority

public T validateAuthority(boolean val)

Legen Sie einen booleschen Wert fest, der der Anwendung mitteilt, ob die Autorität anhand einer Liste bekannter Behörden überprüft werden muss. Autorität wird nur überprüft, wenn: 1 - Es handelt sich um eine Azure Active Directory Autorität (nicht B2C oder ADFS) 2 – Instanzermittlungsmetadaten werden nicht überAbstractClientApplicationBase#aadAadInstanceDiscoveryResponse

Der Standardwert lautet „true“.

Parameter:

val - boolescher Wert für validateAuthority

Gibt zurück:

Instanz des Generators, für den die Methode aufgerufen wurde

Gilt für: