AbstractClientApplicationBase.Builder<T> Klass

Typparametrar

T

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

Fältsammanfattning

Modifierare och typ Fält och beskrivning
protected boolean isInstanceDiscoveryEnabled

Konstruktorsammanfattning

Konstruktor Description
Builder(String clientId)

Konstruktor för att skapa en instans av Builder för klientprogram

Metodsammanfattning

Modifierare och typ Metod och beskrivning
T aadInstanceDiscoveryResponse(String val)

Anger instansidentifieringssvarsdata som ska användas för att fastställa klientidentifieringens slutpunkt och utfärdaralias.

T applicationName(String val)

Anger programnamn för telemetriändamål

T applicationVersion(String val)

Anger programversion för telemetriändamål

T authority(String val)

Ange URL för den autentiserande utfärdare eller säkerhetstokentjänst (STS) från vilken MSAL hämtar säkerhetstoken.

T autoDetectRegion(boolean val)

Anger att biblioteket ska försöka identifiera den Azure region som programmet körs i när instansidentifieringsmetadata hämtas.

T azureRegion(String val)

Ange den region som biblioteket ska använda för att formatera myndigheter i tokenbegäranden.

T b2cAuthority(String val)

Ange URL för den autentiserande B2C-utfärdare från vilken MSAL hämtar token Giltiga B2C-myndigheter bör se ut så här: https://< någonting.b2clogin.com/<tenant>/<policy> MSAL Java stöder också ett äldre B2C-utfärdarformat, som ser ut så här: https://< host>/tfp/tenant>/<<policy> Men MSAL-Java slutar så småningom att stödja det äldre formatet.

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

Anger det timeout-värde för anslutning som används i HttpsURLAnslutningsanslutningar som görs av DefaultHttpClientoch behövs inte om du använder en anpassad HTTP-klient

T correlationId(String val)

Ange valfritt korrelations-ID som ska användas av API:et.

T executorService(ExecutorService val)

Anger att ExecutorService ska användas för att köra begäranden.

T httpClient(IHttpClient val)

Anger http-klienten som ska användas av klientprogrammet för alla HTTP-begäranden.

T instanceDiscovery(boolean val)

Tidigare skulle MSAL ansluta till en central slutpunkt som finns på ''https://login.microsoftonline.com'' för att hämta vissa metadata, särskilt när du använder en obekant auktoritet.

T logPii(boolean val)

Ange logPii – booleskt värde som avgör om Pii (personligt identifierbar information) ska loggas in.

T oidcAuthority(String val)

Ange en känd utfärdare som motsvarar en allmän OpenIdConnect-identitetsprovider.

T proxy(Proxy val)

Anger proxykonfiguration som ska användas av klientprogrammet (MSAL4J använder javax.net.ssl.HttpsURLConnectionsom standard ) för all nätverkskommunikation.

T readTimeoutForDefaultHttpClient(Integer val)

Anger det timeout-värde för läsning som används i HttpsURLAnslutningsanslutningar som görs av DefaultHttpClientoch behövs inte om du använder en anpassad HTTP-klient

T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)

Anger åtkomstaspekten för ITokenCachesom ska användas för cache_data beständighet.

T sslSocketFactory(SSLSocketFactory val)

Anger att SSLSocketFactory ska användas av klientprogrammet för all nätverkskommunikation.

T validateAuthority(boolean val)

Ange ett booleskt värde som talar om för programmet om utfärdaren behöver verifieras mot en lista över kända myndigheter.

Metoder som ärvts från Builder

Metoder som ärvts från 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

Fältinformation

isInstanceDiscoveryEnabled

protected boolean isInstanceDiscoveryEnabled

Konstruktorinformation

Builder

public Builder(String clientId)

Konstruktor för att skapa en instans av Builder för klientprogram

Parametrar:

clientId - Klient-ID (program-ID) för programmet som registrerats i programregistreringsportalen (portal.azure.com)

Metodinformation

aadInstanceDiscoveryResponse

public T aadInstanceDiscoveryResponse(String val)

Anger instansidentifieringssvarsdata som ska användas för att fastställa klientidentifieringens slutpunkt och utfärdaralias.

Observera att utfärdarvalidering inte görs även om AbstractClientApplicationBase#validateAuthority den är inställd på true.

För mer information, se https://aka.ms/msal4j-instance-discovery

Parametrar:

val - JSON-formaterat värde för svar från AAD-instansidentifieringsslutpunkt

Returer:

instans av builder som metoden anropades för

applicationName

public T applicationName(String val)

Anger programnamn för telemetriändamål

Parametrar:

val - programnamn

Returer:

instans av Builder som metoden anropades för

applicationVersion

public T applicationVersion(String val)

Anger programversion för telemetriändamål

Parametrar:

val - programversion

Returer:

instans av Builder som metoden anropades för

authority

public T authority(String val)

Ange URL för den autentiserande utfärdare eller säkerhetstokentjänst (STS) från vilken MSAL hämtar säkerhetstoken. Standardvärdet är AbstractClientApplicationBase#DEFAULT_AUTHORITY

Parametrar:

val - ett strängvärde för utfärdare

Returer:

instans av builder som metoden anropades för

Kast:

java.net.MalformedURLException - om val är en felaktigt formaterad URL

autoDetectRegion

public T autoDetectRegion(boolean val)

Anger att biblioteket ska försöka identifiera den Azure region som programmet körs i när instansidentifieringsmetadata hämtas. Regioner kan bara identifieras när de körs i en Azure miljö, till exempel en Azure virtuell dator eller annan tjänst, eller om miljön har miljövariabeln med namnet REGION_NAME konfigurerad. Även om du kan aktivera både autodetection här och en specifik region med AbstractClientApplicationBase#azureRegion samtidigt, prioriteras den region som anges med AbstractClientApplicationBase#azureRegion om det finns ett matchningsfel. Mer information om scenarier som stöds finns här: https://aka.ms/msal4j-azure-regions

Parametrar:

val - booleskt värde (standardvärdet är falskt)

Returer:

instans av builder som metoden anropades för

azureRegion

public T azureRegion(String val)

Ange den region som biblioteket ska använda för att formatera myndigheter i tokenbegäranden. Om du får en giltig Azure region försöker biblioteket göra tokenbegäranden på en regional ESTS-R slutpunkt i stället för den globala ESTS-slutpunkten. Regionerna måste vara giltiga Azure regioner och deras korta namn ska användas, till exempel "westus" för regionen USA, västra Azure, "centralus" för regionen USA, centrala Azure osv. Även om du kan ange en specifik region här och aktivera autodetection med AbstractClientApplicationBase#autoDetectRegion samtidigt som den specifika regionen som anges här prioriteras över den automatiskt identifierade regionen om det finns ett matchningsfel. Mer information om scenarier som stöds finns här: https://aka.ms/msal4j-azure-regions

Parametrar:

val - Namn på strängregion

Returer:

instans av builder som metoden anropades för

b2cAuthority

public T b2cAuthority(String val)

Ange URL för den autentiserande B2C-utfärdare från vilken MSAL hämtar token Giltiga B2C-myndigheter bör se ut så här: https://< something.b2clogin.com/< tenant>/<policy> MSAL Java stöder också ett äldre B2C-utfärdarformat, vilket ser ut så här: https://< host>/tfp/<tenant>/<policy> Men MSAL Java slutar att stödja det äldre formatet. Här finns information om hur du migrerar till det nya formatet: https://aka.ms/msal4j-b2c

Parametrar:

val - ett booleskt värde för validateAuthority

Returer:

instans av Builder som metoden anropades för

Kast:

java.net.MalformedURLException

clientCapabilities

public T clientCapabilities(Set<String> capabilities)

Parametrar:

capabilities

connectTimeoutForDefaultHttpClient

public T connectTimeoutForDefaultHttpClient(Integer val)

Anger det timeout-värde för anslutning som används i HttpsURLConnection-anslutningar som görs av DefaultHttpClientoch behövs inte om du använder en anpassad HTTP-klient

Åsidosättningar:

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

Parametrar:

val - timeout-värde i millisekunder

Returer:

instans av builder som metoden anropades för

correlationId

public T correlationId(String val)

Ange valfritt korrelations-ID som ska användas av API:et. Om det inte tillhandahålls genererar API:et ett slumpmässigt UUID.

Åsidosättningar:

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

Parametrar:

val - ett strängvärde för korrelations-ID

Returer:

instans av Builder som metoden anropades för

executorService

public T executorService(ExecutorService val)

Anger Att ExecutorService ska användas för att köra begäranden. Utvecklaren ansvarar för att underhålla livscykeln för ExecutorService.

Åsidosättningar:

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

Parametrar:

val - en instans av ExecutorService

Returer:

instans av builder som metoden anropades för

httpClient

public T httpClient(IHttpClient val)

Anger http-klienten som ska användas av klientprogrammet för alla HTTP-begäranden. Tillåter detaljerad konfiguration av HTTP-klienten.

Åsidosättningar:

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

Parametrar:

val - Implementering av IHttpClient

Returer:

instans av builder som metoden anropades för

instanceDiscovery

public T instanceDiscovery(boolean val)

Tidigare skulle MSAL ansluta till en central slutpunkt som finns på ''https://login.microsoftonline.com' för att hämta vissa metadata, särskilt när du använder en obekant auktoritet. Det här beteendet kallas instansidentifiering. Den här parametern är som standard true, vilket aktiverar instansidentifieringen. Om du inte känner till vissa myndigheter i förväg, men ändå vill att MSAL ska acceptera alla utfärdare som du anger, kan du använda "False" för att ovillkorligt inaktivera identifiering av instanser.

Parametrar:

val

logPii

public T logPii(boolean val)

Ange logPii – booleskt värde som avgör om Pii (personligt identifierbar information) ska loggas in. Standardvärdet är falskt.

Åsidosättningar:

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

Parametrar:

val - ett booleskt värde för logPii

Returer:

instans av builder som metoden anropades för

oidcAuthority

public T oidcAuthority(String val)

Ange en känd utfärdare som motsvarar en allmän OpenIdConnect-identitetsprovider. MSAL lägger till ".välkänd/openid-configuration" till utfärdaren för att hämta OIDC-metadata och fastställa slutpunkterna.

Parametrar:

val - ett strängvärde för utfärdare

Returer:

instans av builder som metoden anropades för

Kast:

java.net.MalformedURLException

proxy

public T proxy(Proxy val)

Anger proxykonfiguration som ska användas av klientprogrammet (MSAL4J använder javax.net.ssl.HttpsURLConnectionsom standard ) för all nätverkskommunikation. Om inget proxyvärde skickas används systemdefinierade egenskaper. Om HTTP-klienten har angetts för klientprogrammet (via ClientApplication.builder().httpClient()) ska proxykonfigurationen utföras på HTTP-klientobjektet som skickas in och inte via den här metoden.

Åsidosättningar:

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

Parametrar:

val - en instans av proxy

Returer:

instans av Builder som metoden anropades för

readTimeoutForDefaultHttpClient

public T readTimeoutForDefaultHttpClient(Integer val)

Anger det timeout-värde för läsning som används i HttpsURLConnection-anslutningar som görs av DefaultHttpClientoch behövs inte om du använder en anpassad HTTP-klient

Åsidosättningar:

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

Parametrar:

val - timeout-värde i millisekunder

Returer:

instans av builder som metoden anropades för

setTokenCacheAccessAspect

public T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)

Anger att ITokenCacheAccessAspect ska användas för cache_data beständighet.

Parametrar:

val - en instans av ITokenCacheAccessAspect

Returer:

instans av builder som metoden anropades för

sslSocketFactory

public T sslSocketFactory(SSLSocketFactory val)

Anger att SSLSocketFactory ska användas av klientprogrammet för all nätverkskommunikation. Om HTTP-klienten har angetts för klientprogrammet (via ClientApplication.builder().httpClient()) ska alla konfigurationer av SSL göras på HTTP-klienten och inte via den här metoden.

Åsidosättningar:

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

Parametrar:

val - en instans av SSLSocketFactory

Returer:

instans av Builder som metoden anropades för

validateAuthority

public T validateAuthority(boolean val)

Ange ett booleskt värde som talar om för programmet om utfärdaren behöver verifieras mot en lista över kända myndigheter. Utfärdaren verifieras endast när: 1 – Det är en Azure Active Directory utfärdare (inte B2C eller ADFS) 2 – Metadata för instansidentifiering anges inte viaAbstractClientApplicationBase#aadAadInstanceDiscoveryResponse

Standardvärdet är sant.

Parametrar:

val - ett booleskt värde för validateAuthority

Returer:

instans av builder som metoden anropades för

Gäller för