AbstractClientApplicationBase.Builder<T> Klas

Type parameters

T

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

Veldsamenvatting

Modifier en type Veld en beschrijving
protected boolean isInstanceDiscoveryEnabled

Samenvatting van constructor

Constructor Description
Builder(String clientId)

Constructor voor het maken van een exemplaar van builder van clienttoepassing

Methodesamenvatting

Modifier en type Methode en beschrijving
T aadInstanceDiscoveryResponse(String val)

Hiermee stelt u antwoordgegevens voor instantiedetectie in die worden gebruikt voor het bepalen van tenantdetectie-eindpunten en instantiealiassen.

T applicationName(String val)

Hiermee stelt u de toepassingsnaam in voor telemetriedoeleinden

T applicationVersion(String val)

Hiermee stelt u de toepassingsversie in voor telemetriedoeleinden

T authority(String val)

Stel de URL in van de verificatie-instantie of de beveiligingstokenservice (STS) van waaruit MSAL beveiligingstokens verkrijgt.

T autoDetectRegion(boolean val)

Geeft aan dat de bibliotheek moet proberen de Azure regio te detecteren waarin de toepassing wordt uitgevoerd bij het ophalen van de metagegevens van de instantiedetectie.

T azureRegion(String val)

Stel de regio in die door de bibliotheek wordt gebruikt om bronvermeldingen in tokenaanvragen op te maken.

T b2cAuthority(String val)

Stel de URL in van de verifiërende B2C-instantie waaruit MSAL tokens verkrijgt. Geldige B2C-instanties moeten er als volgt uitzien: https://< som.b2clogin.com/<tenant>/<policy> MSAL-Java ondersteunt ook een verouderde B2C-instantieindeling, die er als volgt uitziet: https://< host>/tfp/<tenant>/<policy>. MSAL-Java zal uiteindelijk stoppen met het ondersteunen van de verouderde indeling.

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

Hiermee stelt u de time-outwaarde voor verbinding in die wordt gebruikt in HttpsURLConnection-verbindingen die zijn gemaakt door DefaultHttpClient, en is deze niet nodig als u een aangepaste HTTP-client gebruikt

T correlationId(String val)

Stel optionele correlatie-id in die moet worden gebruikt door de API.

T executorService(ExecutorService val)

Hiermee stelt u de uitvoerservicein die moet worden gebruikt om de aanvragen uit te voeren.

T httpClient(IHttpClient val)

Hiermee stelt u in dat de HTTP-client wordt gebruikt door de clienttoepassing voor alle HTTP-aanvragen.

T instanceDiscovery(boolean val)

In het verleden zou MSAL verbinding maken met een centraal eindpunt dat zich in ''https://login.microsoftonline' bevindt.com'' om bepaalde metagegevens te verkrijgen, met name wanneer u een onbekende instantie gebruikt.

T logPii(boolean val)

Stel logPii - booleaanse waarde in, waarmee wordt bepaald of Pii (persoonlijk identificeerbare informatie) wordt aangemeld.

T oidcAuthority(String val)

Stel een bekende instantie in die overeenkomt met een algemene OpenIdConnect Identity Provider.

T proxy(Proxy val)

Hiermee stelt u de proxyconfiguratie in voor gebruik door de clienttoepassing (MSAL4J standaard gebruikt javax.net.ssl.HttpsURLConnection) voor alle netwerkcommunicatie.

T readTimeoutForDefaultHttpClient(Integer val)

Hiermee stelt u de time-outwaarde voor lezen in https-URLConnection-verbindingendie zijn gemaakt door DefaultHttpClienten is deze niet nodig als u een aangepaste HTTP-client gebruikt

T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)

Hiermee stelt u het aspect ITokenCache-toegangin dat moet worden gebruikt voor cache_data persistentie.

T sslSocketFactory(SSLSocketFactory val)

Hiermee stelt u SSLSocketFactory in voor gebruik door de clienttoepassing voor alle netwerkcommunicatie.

T validateAuthority(boolean val)

Stel een Booleaanse waarde in die de toepassing aangeeft of de instantie moet worden geverifieerd op basis van een lijst met bekende autoriteiten.

Methoden overgenomen van Builder

Methoden overgenomen van 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

Velddetails

isInstanceDiscoveryEnabled

protected boolean isInstanceDiscoveryEnabled

Constructordetails

Builder

public Builder(String clientId)

Constructor voor het maken van een exemplaar van builder van clienttoepassing

Parameters:

clientId - Client-id (toepassings-id) van de toepassing zoals geregistreerd in de portal voor toepassingsregistratie (portal.azure.com)

Methodedetails

aadInstanceDiscoveryResponse

public T aadInstanceDiscoveryResponse(String val)

Hiermee stelt u antwoordgegevens voor instantiedetectie in die worden gebruikt voor het bepalen van tenantdetectie-eindpunten en instantiealiassen.

Houd er rekening mee dat autorisatievalidatie niet wordt uitgevoerd, zelfs niet als AbstractClientApplicationBase#validateAuthority deze is ingesteld op waar.

Zie https://aka.ms/msal4j-instance-discovery voor meer informatie

Parameters:

val - Met JSON opgemaakte waarde van antwoord van AAD-exemplaardetectie-eindpunt

Retouren:

exemplaar van de opbouwfunctie waarop de methode is aangeroepen

applicationName

public T applicationName(String val)

Hiermee stelt u de toepassingsnaam in voor telemetriedoeleinden

Parameters:

val - toepassingsnaam

Retouren:

exemplaar van de opbouwfunctie waarop de methode is aangeroepen

applicationVersion

public T applicationVersion(String val)

Hiermee stelt u de toepassingsversie in voor telemetriedoeleinden

Parameters:

val - toepassingsversie

Retouren:

exemplaar van de opbouwfunctie waarop de methode is aangeroepen

authority

public T authority(String val)

Stel de URL in van de verificatie-instantie of de beveiligingstokenservice (STS) van waaruit MSAL beveiligingstokens verkrijgt. De standaardwaarde is AbstractClientApplicationBase#DEFAULT_AUTHORITY.

Parameters:

val - een tekenreekswaarde van autoriteit

Retouren:

exemplaar van de opbouwfunctie waarop de methode is aangeroepen

Throws:

java.net.MalformedURLException - als val een onjuiste URL is

autoDetectRegion

public T autoDetectRegion(boolean val)

Geeft aan dat de bibliotheek moet proberen de Azure regio te detecteren waarin de toepassing wordt uitgevoerd bij het ophalen van de metagegevens van de instantiedetectie. Regio's kunnen alleen worden gedetecteerd wanneer ze worden uitgevoerd in een Azure-omgeving, zoals een Azure VM of een andere service, of als de omgeving een omgevingsvariabele heeft met de naam REGION_NAME geconfigureerd. Hoewel u hier zowel autodetection als een specifieke regio met AbstractClientApplicationBase#azureRegion tegelijkertijd kunt inschakelen, heeft de regio die AbstractClientApplicationBase#azureRegion is ingesteld prioriteit als er sprake is van een niet-overeenkomende regio. Zie hier voor meer informatie over ondersteunde scenario's: https://aka.ms/msal4j-azure-regions

Parameters:

val - Booleaanse waarde (standaard is onwaar)

Retouren:

exemplaar van de opbouwfunctie waarop de methode is aangeroepen

azureRegion

public T azureRegion(String val)

Stel de regio in die door de bibliotheek wordt gebruikt om bronvermeldingen in tokenaanvragen op te maken. Als de bibliotheek een geldige Azure regio krijgt, probeert de bibliotheek tokenaanvragen uit te voeren op een regionaal ESTS-R eindpunt in plaats van het globale ESTS-eindpunt. Regio's moeten geldig zijn Azure regio's en hun korte namen moeten worden gebruikt, zoals 'westus' voor de regio VS - west Azure, 'centralus' voor de regio VS - centraal Azure, enzovoort. Hoewel u hier een specifieke regio kunt instellen en autodetection kunt inschakelen met AbstractClientApplicationBase#autoDetectRegion tegelijkertijd de specifieke regio die hier is ingesteld, prioriteit krijgt boven de automatisch gedetecteerde regio als er sprake is van een niet-overeenkomende regio. Zie hier voor meer informatie over ondersteunde scenario's: https://aka.ms/msal4j-azure-regions

Parameters:

val - Naam van tekenreeksregio

Retouren:

exemplaar van de opbouwfunctie waarop de methode is aangeroepen

b2cAuthority

public T b2cAuthority(String val)

Stel de URL in van de verificatie van de B2C-instantie waaruit MSAL tokens verkrijgt. Geldige B2C-instanties moeten er als volgt uitzien: https://< something.b2clogin.com/< tenant>/<policy> MSAL-Java ondersteunt ook een verouderde B2C-instantieindeling. Dit ziet er als volgt uit: https://< host>/tfp/<tenant>/<policy> MSAL-Java uiteindelijk stopt met het ondersteunen van de verouderde indeling. Zie hier voor meer informatie over het migreren naar de nieuwe indeling: https://aka.ms/msal4j-b2c

Parameters:

val - een Booleaanse waarde voor validateAuthority

Retouren:

exemplaar van de opbouwfunctie waarop de methode is aangeroepen

Throws:

java.net.MalformedURLException

clientCapabilities

public T clientCapabilities(Set<String> capabilities)

Parameters:

capabilities

connectTimeoutForDefaultHttpClient

public T connectTimeoutForDefaultHttpClient(Integer val)

Hiermee stelt u de time-outwaarde voor verbinding in die wordt gebruikt in HttpsURLConnection-verbindingen die zijn gemaakt door DefaultHttpClient, en is deze niet nodig als u een aangepaste HTTP-client gebruikt

Overschrijvingen:

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

Parameters:

val - time-outwaarde in milliseconden

Retouren:

exemplaar van de opbouwfunctie waarop de methode is aangeroepen

correlationId

public T correlationId(String val)

Stel optionele correlatie-id in die moet worden gebruikt door de API. Als deze niet is opgegeven, genereert de API een willekeurige UUID.

Overschrijvingen:

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

Parameters:

val - een tekenreekswaarde van correlatie-id

Retouren:

exemplaar van de opbouwfunctie waarop de methode is aangeroepen

executorService

public T executorService(ExecutorService val)

Hiermee stelt u ExecutorService in om de aanvragen uit te voeren. Ontwikkelaar is verantwoordelijk voor het onderhouden van de levenscyclus van de ExecutorService.

Overschrijvingen:

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

Parameters:

val - een exemplaar van ExecutorService

Retouren:

exemplaar van de opbouwfunctie waarop de methode is aangeroepen

httpClient

public T httpClient(IHttpClient val)

Hiermee stelt u in dat de HTTP-client wordt gebruikt door de clienttoepassing voor alle HTTP-aanvragen. Hiermee kunt u een verfijnde configuratie van de HTTP-client uitvoeren.

Overschrijvingen:

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

Parameters:

val - Implementatie van IHttpClient

Retouren:

exemplaar van de opbouwfunctie waarop de methode is aangeroepen

instanceDiscovery

public T instanceDiscovery(boolean val)

In het verleden zou MSAL verbinding maken met een centraal eindpunt dat zich op ''https://login.microsoftonline.com' bevindt om bepaalde metagegevens te verkrijgen, met name wanneer u een onbekende instantie gebruikt. Dit gedrag wordt exemplaardetectie genoemd. Deze parameter is standaard ingesteld op true, waardoor de instantiedetectie mogelijk is. Als u niet van tevoren bepaalde autoriteiten kent, maar toch wilt dat MSAL een instantie accepteert die u opgeeft, kunt u een 'Onwaar' gebruiken om exemplaardetectie onvoorwaardelijke uit te schakelen.

Parameters:

val

logPii

public T logPii(boolean val)

Stel logPii - Booleaanse waarde in, waarmee wordt bepaald of Pii (persoonlijk identificeerbare informatie) wordt aangemeld. De standaardwaarde is onwaar.

Overschrijvingen:

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

Parameters:

val - een Booleaanse waarde voor logPii

Retouren:

exemplaar van de opbouwfunctie waarop de methode is aangeroepen

oidcAuthority

public T oidcAuthority(String val)

Stel een bekende instantie in die overeenkomt met een algemene OpenIdConnect-id-provider. MSAL voegt '.well-known/openid-configuration' toe aan de instantie om de OIDC-metagegevens op te halen en de eindpunten te bepalen.

Parameters:

val - een tekenreekswaarde van autoriteit

Retouren:

exemplaar van de opbouwfunctie waarop de methode is aangeroepen

Throws:

java.net.MalformedURLException

proxy

public T proxy(Proxy val)

Hiermee stelt u de proxyconfiguratie in voor gebruik door de clienttoepassing (MSAL4J standaard gebruikt javax.net.ssl.HttpsURLConnection) voor alle netwerkcommunicatie. Als er geen proxywaarde wordt doorgegeven, worden door het systeem gedefinieerde eigenschappen gebruikt. Als de HTTP-client is ingesteld op de clienttoepassing (via ClientApplication.builder().httpClient()), moet de proxyconfiguratie worden uitgevoerd op het HTTP-clientobject dat wordt doorgegeven en niet via deze methode.

Overschrijvingen:

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

Parameters:

val - een exemplaar van proxy

Retouren:

exemplaar van de opbouwfunctie waarop de methode is aangeroepen

readTimeoutForDefaultHttpClient

public T readTimeoutForDefaultHttpClient(Integer val)

Hiermee stelt u de time-outwaarde voor lezen in httpsURLConnection-verbindingen die zijn gemaakt door DefaultHttpClienten is deze niet nodig als u een aangepaste HTTP-client gebruikt

Overschrijvingen:

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

Parameters:

val - time-outwaarde in milliseconden

Retouren:

exemplaar van de opbouwfunctie waarop de methode is aangeroepen

setTokenCacheAccessAspect

public T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)

Hiermee stelt u ITokenCacheAccessAspect in om te worden gebruikt voor cache_data persistentie.

Parameters:

val - een exemplaar van ITokenCacheAccessAspect

Retouren:

exemplaar van de opbouwfunctie waarop de methode is aangeroepen

sslSocketFactory

public T sslSocketFactory(SSLSocketFactory val)

Hiermee stelt u SSLSocketFactory in voor gebruik door de clienttoepassing voor alle netwerkcommunicatie. Als de HTTP-client is ingesteld op de clienttoepassing (via ClientApplication.builder().httpClient()), moet elke configuratie van SSL worden uitgevoerd op de HTTP-client en niet via deze methode.

Overschrijvingen:

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

Parameters:

val - een exemplaar van SSLSocketFactory

Retouren:

exemplaar van de opbouwfunctie waarop de methode is aangeroepen

validateAuthority

public T validateAuthority(boolean val)

Stel een Booleaanse waarde in die de toepassing aangeeft of de instantie moet worden geverifieerd op basis van een lijst met bekende autoriteiten. Instantie wordt alleen gevalideerd wanneer: 1 - Het is een Azure Active Directory autoriteit (niet B2C of ADFS) 2 - Metagegevens van instantiedetectie worden niet ingesteld viaAbstractClientApplicationBase#aadAadInstanceDiscoveryResponse

De standaardwaarde is waar.

Parameters:

val - een Booleaanse waarde voor validateAuthority

Retouren:

exemplaar van de opbouwfunctie waarop de methode is aangeroepen

Van toepassing op