AbstractClientApplicationBase.Builder<T> Klasse
- java.
lang. Object - com.
microsoft. aad. msal4j. AbstractApplicationBase. Builder<T> - com.
microsoft. aad. msal4j. AbstractClientApplicationBase. Builder<T>
- com.
- com.
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. |
| T | clientCapabilities(Set<String> capabilities) |
| T |
connectTimeoutForDefaultHttpClient(Integer val)
Legt den In https |
| 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-Dienst |
| 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. |
| T |
logPii(boolean val)
Set log |
| T |
oidcAuthority(String val)
Legen Sie eine bekannte Autorität fest, die einem generischen Open |
| 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 Https |
| T |
setTokenCacheAccessAspect(ITokenCacheAccessAspect val)
Legt den IToken-Cachezugriffsaspekt |
| T |
sslSocketFactory(SSLSocketFactory val)
Legt die SSLSocket |
| 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
Felddetails
isInstanceDiscoveryEnabled
protected boolean isInstanceDiscoveryEnabled
Details zum Konstruktor
Builder
public Builder(String clientId)
Konstruktor zum Erstellen einer Instanz des Generators der Clientanwendung
Parameter:
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:
Gibt zurück:
applicationName
public T applicationName(String val)
Legt den Anwendungsnamen für Telemetriezwecke fest.
Parameter:
Gibt zurück:
applicationVersion
public T applicationVersion(String val)
Legt die Anwendungsversion für Telemetriezwecke fest.
Parameter:
Gibt zurück:
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:
Gibt zurück:
Löst aus:
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:
Gibt zurück:
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:
Gibt zurück:
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:
Gibt zurück:
Löst aus:
clientCapabilities
public T clientCapabilities(Set<String> capabilities)
Parameter:
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:
Gibt zurück:
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:
Gibt zurück:
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:
Gibt zurück:
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:
Gibt zurück:
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:
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:
Gibt zurück:
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:
Gibt zurück:
Löst aus:
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:
Gibt zurück:
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:
Gibt zurück:
setTokenCacheAccessAspect
public T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)
Legt fest, dass ITokenCacheAccessAspect für cache_data Persistenz verwendet wird.
Parameter:
Gibt zurück:
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:
Gibt zurück:
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:
Gibt zurück: