AbstractClientApplicationBase.Builder<T> Třída

Balíček:
com.microsoft.aad.msal4j
Artefakt Mavenu:
com.microsoft.azure:msal4j:1.19.1

Parametry typu

T

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

Souhrn polí

Modifikátor a typ Pole a popis
protected boolean isInstanceDiscoveryEnabled

Souhrn konstruktorů

Konstruktor Description
Builder(String clientId)

Konstruktor pro vytvoření instance Tvůrce klientských aplikací

Souhrn metod

Modifikátor a typ Metoda a popis
T aadInstanceDiscoveryResponse(String val)

Nastaví data odpovědi na zjišťování instancí, která se použijí k určení koncového bodu zjišťování tenanta a aliasů autority.
T applicationName(String val)

Nastaví název aplikace pro účely telemetrie.
T applicationVersion(String val)

Nastaví verzi aplikace pro účely telemetrie.
T authority(String val)

Nastavte adresu URL ověřovací autority nebo služby tokenů zabezpečení (STS), ze které služba MSAL získá tokeny zabezpečení.
T autoDetectRegion(boolean val)

Označuje, že knihovna by se měla pokusit zjistit Azure oblasti, ve které je aplikace spuštěná při načítání metadat zjišťování instance.
T azureRegion(String val)

Nastavte oblast, kterou bude knihovna používat k formátování autorit v žádostech o tokeny.
T b2cAuthority(String val)

Nastavte adresu URL ověřovací autority B2C, ze které msAL získá tokeny Platné autority B2C, by měly vypadat takto: https://< something.b2clogin.com/<tenant>/<policy> MSAL Java podporuje také starší formát autority B2C, který vypadá takto: https://< host>/tfp/tenant>/<<policy>, ale msAL Java nakonec přestane podporovat starší formát.
T clientCapabilities(Set<String> capabilities)
T connectTimeoutForDefaultHttpClient(Integer val)

Nastaví hodnotu časového limitu připojení použitou v připojeních HTTPSURLConnection provedených DefaultHttpClientpomocí a není potřeba, pokud používáte vlastního klienta HTTP.
T correlationId(String val)

Nastavte volitelné ID korelace, které má rozhraní API používat.
T executorService(ExecutorService val)

Nastaví službu exekutoru, která se má použít ke spuštění požadavků.
T httpClient(IHttpClient val)

Nastaví klienta HTTP, který bude používat klientská aplikace pro všechny požadavky HTTP.
T instanceDiscovery(boolean val)

Služba MSAL se historicky připojuje k centrálnímu koncovému bodu umístěnému nahttps://login. adrese "microsoftonline".com'' získat určitá metadata, zejména při použití neznámé autority.
T logPii(boolean val)

Nastavit protokolPii – logická hodnota, která určuje, jestli se pii (identifikovatelné osobní údaje) zaprotokolují.
T oidcAuthority(String val)

Nastavte známou autoritu odpovídající obecnému zprostředkovateli identity OpenIdConnect.
T proxy(Proxy val)

Nastaví konfiguraci proxy serveru tak, aby ji klientská aplikace (MSAL4J ve výchozím nastavení používala javax.net.ssl.HttpsURLConnection) pro veškerou síťovou komunikaci.
T readTimeoutForDefaultHttpClient(Integer val)

Nastaví hodnotu časového limitu čtení použitou v připojeních HTTPSURLConnection provedených DefaultHttpClientpomocí a není nutná, pokud používáte vlastního klienta HTTP.
T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)

Nastaví aspekt přístupu kmezipamětiIToken, který se použije pro cache_data trvalost.
T sslSocketFactory(SSLSocketFactory val)

Nastaví službu SSLSocketFactory tak, aby ji klientská aplikace používala pro veškerou síťovou komunikaci.
T validateAuthority(boolean val)

Nastavte logickou hodnotu, která aplikaci říká, pokud je potřeba ověřit autoritu v seznamu známých autorit.

Metody zděděné od Builder

connectTimeoutForDefaultHttpClient correlationId executorService httpClient logPii proxy readTimeoutForDefaultHttpClient sslSocketFactory

Metody zděděné od 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

Podrobnosti pole

isInstanceDiscoveryEnabled

protected boolean isInstanceDiscoveryEnabled

Podrobnosti konstruktoru

Builder

public Builder(String clientId)

Konstruktor pro vytvoření instance Tvůrce klientských aplikací

Parametry:

clientId - ID klienta (ID aplikace) aplikace zaregistrované na portálu pro registraci aplikací (portal.azure.com)

Podrobnosti metody

aadInstanceDiscoveryResponse

public T aadInstanceDiscoveryResponse(String val)

Nastaví data odpovědi na zjišťování instancí, která se použijí k určení koncového bodu zjišťování tenanta a aliasů autority.

Upozorňujeme, že ověření autority se neprokončuje, i když AbstractClientApplicationBase#validateAuthority je nastavená na hodnotu true.

Další informace najdete v tématu https://aka.ms/msal4j-instance-discovery

Parametry:

val - Hodnota odpovědi z koncového bodu zjišťování instance AAD ve formátu JSON

Návraty:

instance Tvůrce, pro kterou byla volána metoda

applicationName

public T applicationName(String val)

Nastaví název aplikace pro účely telemetrie.

Parametry:

val - název aplikace

Návraty:

instance Tvůrce, pro kterou byla volána metoda

applicationVersion

public T applicationVersion(String val)

Nastaví verzi aplikace pro účely telemetrie.

Parametry:

val - verze aplikace

Návraty:

instance Tvůrce, pro kterou byla volána metoda

authority

public T authority(String val)

Nastavte adresu URL ověřovací autority nebo služby tokenů zabezpečení (STS), ze které služba MSAL získá tokeny zabezpečení. Výchozí hodnota je AbstractClientApplicationBase#DEFAULT_AUTHORITY

Parametry:

val - řetězcová hodnota autority

Návraty:

instance Tvůrce, pro kterou byla volána metoda

Vyvolání výjimek:

java.net.MalformedURLException - Pokud je hodnota val poškozená adresa URL

autoDetectRegion

public T autoDetectRegion(boolean val)

Označuje, že knihovna by se měla pokusit zjistit Azure oblasti, ve které je aplikace spuštěná při načítání metadat zjišťování instance. Oblasti lze rozpoznat pouze při spuštění v Azure prostředí, jako je Azure virtuální počítač nebo jiná služba, nebo pokud má prostředí proměnnou prostředí s názvem REGION_NAME nakonfigurována. I když tady i v konkrétní oblasti AbstractClientApplicationBase#azureRegion můžete povolit automatické rozpoznávání současně, bude mít oblast nastavenou AbstractClientApplicationBase#azureRegion prioritu, pokud dojde k neshodě. Další informace o podporovaných scénářích najdete tady: https://aka.ms/msal4j-azure-regions

Parametry:

val - logická hodnota (výchozí hodnota je false)

Návraty:

instance Tvůrce, pro kterou byla volána metoda

azureRegion

public T azureRegion(String val)

Nastavte oblast, kterou bude knihovna používat k formátování autorit v žádostech o tokeny. Pokud zadáte platnou Azure oblast, knihovna se pokusí provést žádosti o tokeny v regionálním koncovém bodu ESTS-R místo globálního koncového bodu ESTS. Oblasti musí být platné Azure oblasti a měly by se použít jejich krátké názvy, například westus pro oblast USA – západ Azure, centralus pro oblast USA – střed Azure atd. I když tady můžete nastavit konkrétní oblast a povolit automatické rozpoznávání AbstractClientApplicationBase#autoDetectRegion současně, konkrétní oblast nastavená zde bude mít prioritu oproti automaticky rozdetekované oblasti, pokud dojde k neshodě. Další informace o podporovaných scénářích najdete tady: https://aka.ms/msal4j-azure-regions

Parametry:

val - Název oblasti řetězce

Návraty:

instance Tvůrce, pro kterou byla volána metoda

b2cAuthority

public T b2cAuthority(String val)

Nastavte adresu URL ověřovací autority B2C, ze které MSAL získá tokeny Platné autority B2C by měly vypadat takto: https://< something.b2clogin.com/< tenant>/<policy> MSAL Java podporuje také starší formát autority B2C, který vypadá takto: https://< host>/tfp/tenant>/<<policy>, ale msAL Java nakonec přestane podporovat starší formát. Informace o migraci do nového formátu najdete tady: https://aka.ms/msal4j-b2c

Parametry:

val - Logická hodnota pro validateAuthority

Návraty:

instance Tvůrce, pro kterou byla volána metoda

Vyvolání výjimek:

java.net.MalformedURLException

clientCapabilities

public T clientCapabilities(Set<String> capabilities)

Parametry:

capabilities

connectTimeoutForDefaultHttpClient

public T connectTimeoutForDefaultHttpClient(Integer val)

Nastaví hodnotu časového limitu připojení použitou v připojeních HttpsURLConnection provedených DefaultHttpClientpomocí a není nutná, pokud používáte vlastního klienta HTTP.

Přepsání:

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

Parametry:

val - Hodnota časového limitu v milisekundách

Návraty:

instance Tvůrce, pro kterou byla volána metoda

correlationId

public T correlationId(String val)

Nastavte volitelné ID korelace, které má rozhraní API používat. Pokud není k dispozici, rozhraní API vygeneruje náhodné UUID.

Přepsání:

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

Parametry:

val - řetězcová hodnota ID korelace

Návraty:

instance Tvůrce, pro kterou byla volána metoda

executorService

public T executorService(ExecutorService val)

Nastaví ExecutorService, který se má použít ke spuštění požadavků. Vývojář zodpovídá za údržbu životního cyklu služby ExecutorService.

Přepsání:

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

Parametry:

val - instance ExecutorService

Návraty:

instance Tvůrce, pro kterou byla volána metoda

httpClient

public T httpClient(IHttpClient val)

Nastaví klienta HTTP, který bude používat klientská aplikace pro všechny požadavky HTTP. Umožňuje jemně odstupňovanou konfiguraci klienta HTTP.

Přepsání:

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

Parametry:

val - Provádění IHttpClient

Návraty:

instance Tvůrce, pro kterou byla volána metoda

instanceDiscovery

public T instanceDiscovery(boolean val)

Služba MSAL se historicky připojuje k centrálnímu koncovému bodu umístěnému na adrese ''https://login.microsoftonline.com'' za účelem získání některých metadat, zejména při použití neznámé autority. Toto chování se označuje jako zjišťování instancí. Tento parametr má výchozí hodnotu true, což umožňuje zjišťování instancí. Pokud některé autority předem neznáte, přesto chcete, aby služba MSAL přijala jakoukoli autoritu, kterou poskytnete, můžete k bezpodmínečnému zákazu zjišťování instancí použít false.

Parametry:

val

logPii

public T logPii(boolean val)

Nastavit logPii – logická hodnota, která určuje, jestli se pii (identifikovatelné osobní údaje) zaprotokolují. Výchozí hodnota je false.

Přepsání:

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

Parametry:

val - Logická hodnota pro logPii

Návraty:

instance Tvůrce, pro kterou byla volána metoda

oidcAuthority

public T oidcAuthority(String val)

Nastavte známou autoritu odpovídající obecnému zprostředkovateli identity OpenIdConnect. KNIHOVNA MSAL připojí k autoritě ".well-known/openid-configuration", aby načetla metadata OIDC a určila koncové body.

Parametry:

val - řetězcová hodnota autority

Návraty:

instance Tvůrce, pro kterou byla volána metoda

Vyvolání výjimek:

java.net.MalformedURLException

proxy

public T proxy(Proxy val)

Nastaví konfiguraci proxy serveru tak, aby ji klientská aplikace (MSAL4J ve výchozím nastavení používala javax.net.ssl.HttpsURLConnection) pro veškerou síťovou komunikaci. Pokud se nepředá žádná hodnota proxy serveru, použijí se vlastnosti definované systémem. Pokud je klient HTTP nastavený v klientské aplikaci (prostřednictvím ClientApplication.builder().httpClient()), konfigurace proxy serveru by měla být provedena u předávaného objektu klienta HTTP, a ne prostřednictvím této metody.

Přepsání:

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

Parametry:

val - instance proxy serveru

Návraty:

instance Tvůrce, pro kterou byla volána metoda

readTimeoutForDefaultHttpClient

public T readTimeoutForDefaultHttpClient(Integer val)

Nastaví hodnotu časového limitu čtení použitou v připojeních HttpsURLConnection vytvořených DefaultHttpClientpomocí a není nutná, pokud používáte vlastního klienta HTTP.

Přepsání:

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

Parametry:

val - Hodnota časového limitu v milisekundách

Návraty:

instance Tvůrce, pro kterou byla volána metoda

setTokenCacheAccessAspect

public T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)

Nastaví ITokenCacheAccessAspect pro cache_data trvalost.

Parametry:

val - instance ITokenCacheAccessAspect

Návraty:

instance Tvůrce, pro kterou byla volána metoda

sslSocketFactory

public T sslSocketFactory(SSLSocketFactory val)

Nastaví protokol SSLSocketFactory tak, aby ji klientská aplikace používala pro veškerou síťovou komunikaci. Pokud je klient HTTP nastavený v klientské aplikaci (přes ClientApplication.builder().httpClient()), měla by být v klientovi HTTP provedena jakákoli konfigurace PROTOKOLU SSL, a ne prostřednictvím této metody.

Přepsání:

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

Parametry:

val - instance SSLSocketFactory

Návraty:

instance Tvůrce, pro kterou byla volána metoda

validateAuthority

public T validateAuthority(boolean val)

Nastavte logickou hodnotu, která aplikaci říká, pokud je potřeba ověřit autoritu v seznamu známých autorit. Autorita se ověřuje pouze v těchto případech: 1 – jedná se o autoritu Azure Active Directory (nikoli B2C nebo ADFS) 2 – Metadata zjišťování instancí se nenastavují prostřednictvímAbstractClientApplicationBase#aadAadInstanceDiscoveryResponse

Výchozí hodnota je true.

Parametry:

val - Logická hodnota pro validateAuthority

Návraty:

instance Tvůrce, pro kterou byla volána metoda

Platí pro