AbstractClientApplicationBase.Builder<T> Osztály

Csomag:
com.microsoft.aad.msal4j
Maven Artifact:
com.microsoft.azure:msal4j:1.19.1

Típusparaméterek

T

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

Mező összegzése

Módosító és típus Mező és leírás
protected boolean isInstanceDiscoveryEnabled

Konstruktor összegzése

Konstruktor Description
Builder(String clientId)

Konstruktor az ügyfélalkalmazás Builder-példányának létrehozásához

Metódus összegzése

Módosító és típus Metódus és leírás
T aadInstanceDiscoveryResponse(String val)

A bérlőfelderítési végpontok és a szolgáltatói aliasok meghatározásához használt példányfelderítési válaszadatokat állítja be.
T applicationName(String val)

Alkalmazásnév beállítása telemetriai célokra
T applicationVersion(String val)

Alkalmazásverzió beállítása telemetriai célokra
T authority(String val)

Adja meg annak a hitelesítésszolgáltatónak vagy biztonsági jogkivonat-szolgáltatásnak (STS) az URL-címét, amelyből az MSAL biztonsági jogkivonatokat szerez be.
T autoDetectRegion(boolean val)

Azt jelzi, hogy a tárnak meg kell kísérelnie felderíteni azt a Azure régiót, amelyben az alkalmazás fut a példányfelderítés metaadatainak lekérésekor.
T azureRegion(String val)

Állítsa be azt a régiót, amellyel a tár a jogkivonat-kérelmekben formázza a hatóságokat.
T b2cAuthority(String val)

Adja meg annak a hitelesítést végző B2C-szolgáltatónak az URL-címét, amelytől az MSAL jogkivonatokat szerez be Az érvényes B2C-hatóságoknak a következőképpen kell kinéznie: https://<-hitelesítés.b2clogin.com/<tenant>/<policy> MSAL Java támogatja az örökölt B2C-szolgáltatói formátumot is, amely a következőképpen néz ki: https://< host>/tfp/tenant>/<<policy> Azonban az MSAL Java végül nem támogatja az örökölt formátumot.
T clientCapabilities(Set<String> capabilities)
T connectTimeoutForDefaultHttpClient(Integer val)

Beállítja a httpsURLConnection-kapcsolatokban DefaultHttpClienthasznált kapcsolódási időtúllépési értéket, amelyet egyéni HTTP-ügyfél használata esetén nem kell megadni.
T correlationId(String val)

Állítsa be az API által használandó opcionális korrelációs azonosítót.
T executorService(ExecutorService val)

Beállítja a végrehajtószolgáltatást a kérések végrehajtásához.
T httpClient(IHttpClient val)

Beállítja a HTTP-ügyfelet, hogy az ügyfélalkalmazás az összes HTTP-kéréshez használhassa.
T instanceDiscovery(boolean val)

Az MSAL korábban a "microsoftonline"https://login. helyen található központi végponthoz kapcsolódott.com'' a metaadatok beszerzéséhez, különösen ismeretlen hatóság használata esetén.
T logPii(boolean val)

LogPii – logikai érték beállítása, amely meghatározza, hogy a Pii (személyazonosításra alkalmas adatok) be lesz-e jelentkezve.
T oidcAuthority(String val)

Állítson be egy általános OpenIdConnect-identitásszolgáltatónak megfelelő ismert szolgáltatót.
T proxy(Proxy val)

Beállítja az ügyfélalkalmazás által használandó proxykonfigurációt (alapértelmezés szerint MSAL4J) javax.net.ssl.HttpsURLConnectionaz összes hálózati kommunikációhoz.
T readTimeoutForDefaultHttpClient(Integer val)

Beállítja a HttpsURLConnection-kapcsolatokban DefaultHttpClienthasznált olvasási időtúllépési értéket, amely egyéni HTTP-ügyfél használata esetén nem szükséges
T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)

Beállítja az ITokenCachehozzáférésiaspektusát a cache_data megőrzéséhez.
T sslSocketFactory(SSLSocketFactory val)

Beállítja, hogy az SSLSocketFactoryt az ügyfélalkalmazás használja az összes hálózati kommunikációhoz.
T validateAuthority(boolean val)

Állítson be egy logikai értéket, amely közli az alkalmazással, hogy a hatóságot ellenőrizni kell-e az ismert hatóságok listájában.

A következőtől örökölt metódusok: Builder

connectTimeoutForDefaultHttpClient correlationId executorService httpClient logPii proxy readTimeoutForDefaultHttpClient sslSocketFactory

A következőtől örökölt metódusok: 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

Mező adatai

isInstanceDiscoveryEnabled

protected boolean isInstanceDiscoveryEnabled

Konstruktor adatai

Builder

public Builder(String clientId)

Konstruktor az ügyfélalkalmazás Builder-példányának létrehozásához

Paraméterek:

clientId - Az alkalmazás ügyfél-azonosítója (alkalmazásazonosító) az alkalmazásregisztrációs portálon (portal.azure.com) regisztrálva

Metódus adatai

aadInstanceDiscoveryResponse

public T aadInstanceDiscoveryResponse(String val)

A bérlőfelderítési végpontok és a szolgáltatói aliasok meghatározásához használt példányfelderítési válaszadatokat állítja be.

Vegye figyelembe, hogy a hitelesítés akkor sem történik meg, ha AbstractClientApplicationBase#validateAuthority igaz értékre van állítva.

További információért, lásd: https://aka.ms/msal4j-instance-discovery

Paraméterek:

val - JSON formátumú válaszérték az AAD-példányfelderítési végponttól

Válaszok:

annak a Szerkesztőnek a példánya, amelyen a metódust meghívták

applicationName

public T applicationName(String val)

Alkalmazásnév beállítása telemetriai célokra

Paraméterek:

val - alkalmazás neve

Válaszok:

annak a Szerkesztőnek a példánya, amelyen a metódust meghívták

applicationVersion

public T applicationVersion(String val)

Alkalmazásverzió beállítása telemetriai célokra

Paraméterek:

val - alkalmazásverzió

Válaszok:

annak a Szerkesztőnek a példánya, amelyen a metódust meghívták

authority

public T authority(String val)

Adja meg annak a hitelesítésszolgáltatónak vagy biztonsági jogkivonat-szolgáltatásnak (STS) az URL-címét, amelyből az MSAL biztonsági jogkivonatokat szerez be. Az alapértelmezett érték a következő: AbstractClientApplicationBase#DEFAULT_AUTHORITY

Paraméterek:

val - a szolgáltató sztringértéke

Válaszok:

annak a Szerkesztőnek a példánya, amelyen a metódust meghívták

Dobások:

java.net.MalformedURLException - ha a val helytelen formátumú URL-cím

autoDetectRegion

public T autoDetectRegion(boolean val)

Azt jelzi, hogy a tárnak meg kell kísérelnie felderíteni azt a Azure régiót, amelyben az alkalmazás fut a példányfelderítés metaadatainak lekérésekor. A régiók csak akkor észlelhetők, ha Azure környezetben futnak, például Azure virtuális gépen vagy más szolgáltatásban, vagy ha a környezet REGION_NAME nevű környezeti változóval rendelkezik. Bár itt és egy adott régióban AbstractClientApplicationBase#azureRegion is engedélyezheti az automatikus észlelést, a megadott AbstractClientApplicationBase#azureRegion régió prioritást élvez, ha eltérés van. A támogatott forgatókönyvekről itt talál további információt: https://aka.ms/msal4j-azure-regions

Paraméterek:

val - logikai (az alapértelmezett érték hamis)

Válaszok:

annak a Szerkesztőnek a példánya, amelyen a metódust meghívták

azureRegion

public T azureRegion(String val)

Állítsa be azt a régiót, amellyel a tár a jogkivonat-kérelmekben formázza a hatóságokat. Ha érvényes Azure régiót ad meg, a kódtár a globális ESTS-végpont helyett egy regionális ESTS-R végponton kísérli meg a jogkivonat-kéréseket. A régióknak érvényesnek Azure régióknak kell lenniük, és rövid nevüket kell használniuk, például az USA nyugati Azure régiójában a "westus", az USA középső Azure régiójának "centralus"-jának stb. Bár itt beállíthat egy adott régiót, és engedélyezheti az automatikus észleléstAbstractClientApplicationBase#autoDetectRegion, ha az itt megadott régió elsőbbséget élvez az automatikusan észlelt régióval szemben, ha eltérés van. A támogatott forgatókönyvekről itt talál további információt: https://aka.ms/msal4j-azure-regions

Paraméterek:

val - Sztringrégió neve

Válaszok:

annak a Szerkesztőnek a példánya, amelyen a metódust meghívták

b2cAuthority

public T b2cAuthority(String val)

Adja meg annak a hitelesítő B2C-szolgáltatónak az URL-címét, amelyből az MSAL jogkivonatokat szerez be Az érvényes B2C-hatóságoknak így kell kinéznie: https://< something.b2clogin.com/< tenant>/<policy> MSAL Java támogatja az örökölt B2C-szolgáltatói formátumot is, amely a következőképpen néz ki: https://< host>/tfp/tenant>/<<policy> Azonban az MSAL Java végül nem támogatja az örökölt formátumot. Az új formátumra való migrálásról itt talál további információt: https://aka.ms/msal4j-b2c

Paraméterek:

val - logikai érték az validateAuthority függvényhez

Válaszok:

annak a Szerkesztőnek a példánya, amelyen a metódust meghívták

Dobások:

java.net.MalformedURLException

clientCapabilities

public T clientCapabilities(Set<String> capabilities)

Paraméterek:

capabilities

connectTimeoutForDefaultHttpClient

public T connectTimeoutForDefaultHttpClient(Integer val)

Beállítja a httpsURLConnection-kapcsolatokban DefaultHttpClienthasznált időtúllépési értéket, amely egyéni HTTP-ügyfél használata esetén nem szükséges.

Felülbírálások:

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

Paraméterek:

val - időtúllépési érték ezredmásodpercben

Válaszok:

annak a Szerkesztőnek a példánya, amelyen a metódust meghívták

correlationId

public T correlationId(String val)

Állítsa be az API által használandó opcionális korrelációs azonosítót. Ha nincs megadva, az API véletlenszerű UUID-t hoz létre.

Felülbírálások:

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

Paraméterek:

val - a korrelációs azonosító sztringértéke

Válaszok:

annak a Szerkesztőnek a példánya, amelyen a metódust meghívták

executorService

public T executorService(ExecutorService val)

Beállítja a ExecuteorService-t a kérések végrehajtásához. A fejlesztő felelős az ExecutorService életciklusának fenntartásáért.

Felülbírálások:

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

Paraméterek:

val - Az ExecutorService egy példánya

Válaszok:

annak a Szerkesztőnek a példánya, amelyen a metódust meghívták

httpClient

public T httpClient(IHttpClient val)

Beállítja a HTTP-ügyfelet, hogy az ügyfélalkalmazás az összes HTTP-kéréshez használhassa. Lehetővé teszi a HTTP-ügyfél részletes konfigurációját.

Felülbírálások:

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

Paraméterek:

val - A IHttpClient

Válaszok:

annak a Szerkesztőnek a példánya, amelyen a metódust meghívták

instanceDiscovery

public T instanceDiscovery(boolean val)

Az MSAL korábban egy " helyenhttps://login.microsoftonline.com található központi végponthoz csatlakozik, hogy megszerezze a metaadatokat, különösen ismeretlen szolgáltató használata esetén. Ezt a viselkedést példányfelderítésnek nevezzük. Ez a paraméter alapértelmezés szerint igaz, ami lehetővé teszi a példányfelderítést. Ha korábban nem ismer bizonyos hatóságokat, de továbbra is azt szeretné, hogy az MSAL elfogadja az Ön által megadott bármely hatóságot, a "False" használatával feltétel nélkül letilthatja a példányfelderítést.

Paraméterek:

val

logPii

public T logPii(boolean val)

Adja meg a logPii logikai értékét, amely meghatározza, hogy a Pii (személyazonosításra alkalmas adatok) be lesz-e jelentkezve. Az alapértelmezett érték hamis.

Felülbírálások:

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

Paraméterek:

val - logikai érték a logPii-hoz

Válaszok:

annak a Szerkesztőnek a példánya, amelyen a metódust meghívták

oidcAuthority

public T oidcAuthority(String val)

Állítson be egy általános OpenIdConnect-identitásszolgáltatónak megfelelő ismert szolgáltatót. Az MSAL hozzáfűzi a ".well-known/openid-configuration" parancsot a szolgáltatóhoz az OIDC-metaadatok lekéréséhez és a végpontok meghatározásához.

Paraméterek:

val - a szolgáltató sztringértéke

Válaszok:

annak a Szerkesztőnek a példánya, amelyen a metódust meghívták

Dobások:

java.net.MalformedURLException

proxy

public T proxy(Proxy val)

Beállítja az ügyfélalkalmazás által használandó proxykonfigurációt (alapértelmezés szerint MSAL4J) javax.net.ssl.HttpsURLConnectionaz összes hálózati kommunikációhoz. Ha nem ad át proxyértéket, a rendszer által definiált tulajdonságokat használ. Ha a HTTP-ügyfél be van állítva az ügyfélalkalmazásban (a ClientApplication.builder().httpClient()-en keresztül), a proxykonfigurációt az átadott HTTP-ügyfélobjektumon kell elvégezni, és nem ezen a módszerrel.

Felülbírálások:

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

Paraméterek:

val - proxypéldány

Válaszok:

annak a Szerkesztőnek a példánya, amelyen a metódust meghívták

readTimeoutForDefaultHttpClient

public T readTimeoutForDefaultHttpClient(Integer val)

Beállítja a HttpsURLConnection-kapcsolatokban DefaultHttpClienthasznált olvasási időtúllépési értéket, amelyet egyéni HTTP-ügyfél használata esetén nem kell megadni.

Felülbírálások:

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

Paraméterek:

val - időtúllépési érték ezredmásodpercben

Válaszok:

annak a Szerkesztőnek a példánya, amelyen a metódust meghívták

setTokenCacheAccessAspect

public T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)

Beállítja az ITokenCacheAccessAspectet a cache_data megőrzéséhez.

Paraméterek:

val - az ITokenCacheAccessAspect egy példánya

Válaszok:

annak a Szerkesztőnek a példánya, amelyen a metódust meghívták

sslSocketFactory

public T sslSocketFactory(SSLSocketFactory val)

Beállítja az SSLSocketFactory-t, hogy az ügyfélalkalmazás az összes hálózati kommunikációhoz használhassa. Ha a HTTP-ügyfél be van állítva az ügyfélalkalmazásban (a ClientApplication.builder().httpClient()-en keresztül), az SSL bármilyen konfigurációját a HTTP-ügyfélen kell elvégezni, nem ezen a módszerrel.

Felülbírálások:

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

Paraméterek:

val - AZ SSLSocketFactory egy példánya

Válaszok:

annak a Szerkesztőnek a példánya, amelyen a metódust meghívták

validateAuthority

public T validateAuthority(boolean val)

Állítson be egy logikai értéket, amely közli az alkalmazással, hogy a hatóságot ellenőrizni kell-e az ismert hatóságok listájában. A szolgáltató csak akkor van érvényesítve, ha: 1 – Ez egy Azure Active Directory szolgáltató (nem B2C vagy ADFS) 2 – A példányfelderítés metaadatai nincsenek beállítvaAbstractClientApplicationBase#aadAadInstanceDiscoveryResponse

Az alapértelmezett érték igaz.

Paraméterek:

val - logikai érték az validateAuthority függvényhez

Válaszok:

annak a Szerkesztőnek a példánya, amelyen a metódust meghívták

A következőre érvényes: