AbstractClientApplicationBase.Builder<T> Klasa

Pakiet:
com.microsoft.aad.msal4j
Artefakt Maven:
com.microsoft.azure:msal4j:1.19.1

Parametry typu

T

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

Podsumowanie pola

Modyfikator i typ Pole i opis
protected boolean isInstanceDiscoveryEnabled

Podsumowanie konstruktora

Konstruktor Opis
Builder(String clientId)

Konstruktor do tworzenia wystąpienia konstruktora aplikacji klienckiej

Podsumowanie metody

Modyfikator i typ Metoda i opis
T aadInstanceDiscoveryResponse(String val)

Ustawia dane odpowiedzi odnajdywania wystąpień, które będą używane do określania punktu końcowego odnajdywania dzierżawy i aliasów urzędu.
T applicationName(String val)

Ustawia nazwę aplikacji na potrzeby telemetrii
T applicationVersion(String val)

Ustawia wersję aplikacji na potrzeby telemetrii
T authority(String val)

Ustaw adres URL urzędu uwierzytelniania lub usługi tokenu zabezpieczającego (STS), z której biblioteka MSAL uzyska tokeny zabezpieczające.
T autoDetectRegion(boolean val)

Wskazuje, że biblioteka powinna podjąć próbę odnalezienia regionu Azure, w którym aplikacja jest uruchomiona podczas pobierania metadanych odnajdywania wystąpienia.
T azureRegion(String val)

Ustaw region, za pomocą którego biblioteka będzie formatować urzędy w żądaniach tokenów.
T b2cAuthority(String val)

Ustaw adres URL uwierzytelniania urzędu B2C, z którego biblioteka MSAL uzyska tokeny Prawidłowe urzędy B2C powinny wyglądać następująco: https://< przystojenie.b2clogin.com/<tenant>/<policy> MSAL Java obsługuje również starszy format urzędu B2C, który wygląda następująco: https://< host>/tfp/tenant>/<<policy> Jednak Java MSAL ostatecznie przestanie obsługiwać starszy format.
T clientCapabilities(Set<String> capabilities)
T connectTimeoutForDefaultHttpClient(Integer val)

Ustawia wartość limitu czasu połączenia używaną w połączeniach HTTPSURLConnection wykonanych przez DefaultHttpClientusługę i nie jest wymagana w przypadku używania niestandardowego klienta HTTP
T correlationId(String val)

Ustaw opcjonalny identyfikator korelacji, który ma być używany przez interfejs API.
T executorService(ExecutorService val)

Ustawia usługę wykonawcy, która ma być używana do wykonywania żądań.
T httpClient(IHttpClient val)

Ustawia klienta HTTP, który ma być używany przez aplikację kliencka dla wszystkich żądań HTTP.
T instanceDiscovery(boolean val)

W przeszłości biblioteka MSAL łączyła się z centralnym punktem końcowym znajdującym się w lokalizacji ""https://login.microsoftonline".com'' do uzyskania niektórych metadanych, zwłaszcza w przypadku korzystania z nieznanego urzędu.
T logPii(boolean val)

Ustaw wartośćlogiczną Pii — wartość logiczna, która określa, czy dane osobowe (dane osobowe) będą rejestrowane.
T oidcAuthority(String val)

Ustaw znany urząd odpowiadający ogólnemu dostawcy tożsamości OpenIdConnect.
T proxy(Proxy val)

Ustawia konfigurację serwera proxy, która ma być używana przez aplikację kliencą (MSAL4J domyślnie używa javax.net.ssl.HttpsURLConnection) dla całej komunikacji sieciowej.
T readTimeoutForDefaultHttpClient(Integer val)

Ustawia wartość limitu czasu odczytu używaną w połączeniach HTTPSURLConnection wykonanych przez DefaultHttpClientusługę i nie jest wymagana w przypadku używania niestandardowego klienta HTTP
T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)

Ustawia aspekt dostępu dopamięci podręcznejIToken, który ma być używany do cache_data trwałości.
T sslSocketFactory(SSLSocketFactory val)

Ustawia usługę SSLSocketFactory do użycia przez aplikację klienczą dla całej komunikacji sieciowej.
T validateAuthority(boolean val)

Ustaw wartość logiczną informującą aplikację o konieczności zweryfikowania urzędu względem listy znanych władz.

Metody dziedziczone z Builder

connectTimeoutForDefaultHttpClient correlationId executorService httpClient logPii proxy readTimeoutForDefaultHttpClient sslSocketFactory

Metody dziedziczone z 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

Szczegóły pola

isInstanceDiscoveryEnabled

protected boolean isInstanceDiscoveryEnabled

Szczegóły konstruktora

Builder

public Builder(String clientId)

Konstruktor do tworzenia wystąpienia konstruktora aplikacji klienckiej

Parametry:

clientId - Identyfikator klienta aplikacji (identyfikator aplikacji) zarejestrowany w portalu rejestracji aplikacji (portal.azure.com)

Szczegóły metody

aadInstanceDiscoveryResponse

public T aadInstanceDiscoveryResponse(String val)

Ustawia dane odpowiedzi odnajdywania wystąpień, które będą używane do określania punktu końcowego odnajdywania dzierżawy i aliasów urzędu.

Należy pamiętać, że sprawdzanie poprawności urzędu nie jest wykonywane nawet wtedy, gdy AbstractClientApplicationBase#validateAuthority jest ustawiona wartość true.

Aby uzyskać więcej informacji, zobacz https://aka.ms/msal4j-instance-discovery

Parametry:

val - Formatowana wartość odpowiedzi z punktu końcowego odnajdywania wystąpienia usługi AAD w formacie JSON

Zwraca:

wystąpienie konstruktora, na którym wywoływano metodę

applicationName

public T applicationName(String val)

Ustawia nazwę aplikacji na potrzeby telemetrii

Parametry:

val - nazwa aplikacji

Zwraca:

wystąpienie konstruktora, na którym wywoływano metodę

applicationVersion

public T applicationVersion(String val)

Ustawia wersję aplikacji na potrzeby telemetrii

Parametry:

val - wersja aplikacji

Zwraca:

wystąpienie konstruktora, na którym wywoływano metodę

authority

public T authority(String val)

Ustaw adres URL urzędu uwierzytelniania lub usługi tokenu zabezpieczającego (STS), z której biblioteka MSAL uzyska tokeny zabezpieczające. Domyślna wartość to AbstractClientApplicationBase#DEFAULT_AUTHORITY

Parametry:

val - wartość ciągu urzędu

Zwraca:

wystąpienie konstruktora, na którym wywoływano metodę

Zgłasza:

java.net.MalformedURLException - jeśli wartość jest nieprawidłowo sformułowanym adresem URL

autoDetectRegion

public T autoDetectRegion(boolean val)

Wskazuje, że biblioteka powinna podjąć próbę odnalezienia regionu Azure, w którym aplikacja jest uruchomiona podczas pobierania metadanych odnajdywania wystąpienia. Regiony można wykryć tylko podczas uruchamiania w środowisku Azure, takim jak maszyna wirtualna Azure lub inna usługa, lub jeśli środowisko ma zmienną środowiskową o nazwie REGION_NAME skonfigurowana. Mimo że w tym miejscu można włączyć funkcję autodetecji i określony region AbstractClientApplicationBase#azureRegion z tym samym czasem, region ustawiony za AbstractClientApplicationBase#azureRegion pomocą polecenia będzie mieć priorytet, jeśli wystąpi niezgodność. Zobacz tutaj, aby uzyskać więcej informacji na temat obsługiwanych scenariuszy: https://aka.ms/msal4j-azure-regions

Parametry:

val - wartość logiczna (wartość domyślna to false)

Zwraca:

wystąpienie konstruktora, na którym wywoływano metodę

azureRegion

public T azureRegion(String val)

Ustaw region, za pomocą którego biblioteka będzie formatować urzędy w żądaniach tokenów. Jeśli zostanie podany prawidłowy region Azure, biblioteka podejmie próbę wysłania żądań tokenu w regionalnym punkcie końcowym ESTS-R zamiast globalnego punktu końcowego ESTS. Regiony muszą być prawidłowe Azure regionów, a ich krótkie nazwy powinny być używane, takie jak "westus" dla regionu Azure Zachodnie stany USA, "centralus" dla regionu Azure Środkowe stany USA itp. Mimo że w tym miejscu można ustawić określony region i włączyć autodetection z AbstractClientApplicationBase#autoDetectRegion tym samym czasem określony region ustawiony w tym miejscu będzie mieć priorytet nad automatycznie wykrywanym regionem, jeśli występuje niezgodność. Zobacz tutaj, aby uzyskać więcej informacji na temat obsługiwanych scenariuszy: https://aka.ms/msal4j-azure-regions

Parametry:

val - Nazwa regionu ciągu

Zwraca:

wystąpienie konstruktora, na którym wywoływano metodę

b2cAuthority

public T b2cAuthority(String val)

Ustaw adres URL uwierzytelniania urzędu B2C, z którego biblioteka MSAL uzyska tokeny Prawidłowe urzędy B2C powinny wyglądać następująco: https://< something.b2clogin.com/< tenant>/<zasady> MSAL Java obsługuje również starszy format urzędu B2C, który wygląda następująco: https://< host>/tfp/tenant/<<policy>> Jednak Java MSAL ostatecznie przestanie obsługiwać starszy format. Zobacz tutaj, aby uzyskać informacje na temat sposobu migracji do nowego formatu: https://aka.ms/msal4j-b2c

Parametry:

val - wartość logiczna dla validateAuthority

Zwraca:

wystąpienie konstruktora, na którym wywoływano metodę

Zgłasza:

java.net.MalformedURLException

clientCapabilities

public T clientCapabilities(Set<String> capabilities)

Parametry:

capabilities

connectTimeoutForDefaultHttpClient

public T connectTimeoutForDefaultHttpClient(Integer val)

Ustawia wartość limitu czasu połączenia używaną w połączeniach HttpsURLConnection wykonanych przez DefaultHttpClientprogram i nie jest wymagana w przypadku używania niestandardowego klienta HTTP

Przesłonięcia:

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

Parametry:

val - wartość limitu czasu w milisekundach

Zwraca:

wystąpienie konstruktora, na którym wywoływano metodę

correlationId

public T correlationId(String val)

Ustaw opcjonalny identyfikator korelacji, który ma być używany przez interfejs API. Jeśli nie zostanie podany, interfejs API generuje losowy identyfikator UUID.

Przesłonięcia:

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

Parametry:

val - wartość ciągu identyfikatora korelacji

Zwraca:

wystąpienie konstruktora, na którym wywoływano metodę

executorService

public T executorService(ExecutorService val)

Ustawia funkcję ExecuteorService, która ma być używana do wykonywania żądań. Deweloper jest odpowiedzialny za utrzymanie cyklu życia funkcji ExecutorService.

Przesłonięcia:

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

Parametry:

val - wystąpienie funkcji ExecutorService

Zwraca:

wystąpienie konstruktora, na którym wywoływano metodę

httpClient

public T httpClient(IHttpClient val)

Ustawia klienta HTTP, który ma być używany przez aplikację kliencka dla wszystkich żądań HTTP. Umożliwia szczegółową konfigurację klienta HTTP.

Przesłonięcia:

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

Parametry:

val - Implementacja IHttpClient

Zwraca:

wystąpienie konstruktora, na którym wywoływano metodę

instanceDiscovery

public T instanceDiscovery(boolean val)

W przeszłości biblioteka MSAL łączyła się z centralnym punktem końcowym znajdującym się w lokalizacji ""https://login.microsoftonline.com" w celu uzyskania niektórych metadanych, zwłaszcza w przypadku korzystania z nieznanego urzędu. To zachowanie jest nazywane odnajdywaniem wystąpień. Ten parametr domyślnie ma wartość true, co umożliwia odnajdywanie wystąpień. Jeśli nie znasz wcześniej niektórych władz, ale nadal chcesz, aby biblioteka MSAL akceptowała wszelkie podane przez Ciebie uprawnienia, możesz użyć "False", aby bezwarunkowo wyłączyć odnajdywanie wystąpień.

Parametry:

val

logPii

public T logPii(boolean val)

Ustaw logPii — wartość logiczna, która określa, czy dane osobowe (dane osobowe) będą rejestrowane. Wartość domyślna to fałsz.

Przesłonięcia:

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

Parametry:

val - wartość logiczna dla logPii

Zwraca:

wystąpienie konstruktora, na którym wywoływano metodę

oidcAuthority

public T oidcAuthority(String val)

Ustaw znany urząd odpowiadający ogólnemu dostawcy tożsamości OpenIdConnect. Biblioteka MSAL dołączy ciąg ".well-known/openid-configuration" do urzędu w celu pobrania metadanych OIDC i określenia punktów końcowych.

Parametry:

val - wartość ciągu urzędu

Zwraca:

wystąpienie konstruktora, na którym wywoływano metodę

Zgłasza:

java.net.MalformedURLException

proxy

public T proxy(Proxy val)

Ustawia konfigurację serwera proxy, która ma być używana przez aplikację kliencą (MSAL4J domyślnie używa javax.net.ssl.HttpsURLConnection) dla całej komunikacji sieciowej. Jeśli nie zostanie przekazana żadna wartość serwera proxy, zostaną użyte właściwości zdefiniowane przez system. Jeśli klient HTTP jest ustawiony w aplikacji klienckiej (za pośrednictwem clientApplication.builder().httpClient()), należy wykonać konfigurację serwera proxy w obiekcie klienta HTTP przekazywanym, a nie za pośrednictwem tej metody.

Przesłonięcia:

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

Parametry:

val - wystąpienie serwera proxy

Zwraca:

wystąpienie konstruktora, na którym wywoływano metodę

readTimeoutForDefaultHttpClient

public T readTimeoutForDefaultHttpClient(Integer val)

Ustawia wartość limitu czasu odczytu używaną w połączeniach HttpsURLConnection wykonanych przez DefaultHttpClientprogram i nie jest wymagana w przypadku używania niestandardowego klienta HTTP

Przesłonięcia:

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

Parametry:

val - wartość limitu czasu w milisekundach

Zwraca:

wystąpienie konstruktora, na którym wywoływano metodę

setTokenCacheAccessAspect

public T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)

Ustawia funkcję ITokenCacheAccessAspect do użycia w celu cache_data trwałości.

Parametry:

val - wystąpienie ITokenCacheAccessAspect

Zwraca:

wystąpienie konstruktora, na którym wywoływano metodę

sslSocketFactory

public T sslSocketFactory(SSLSocketFactory val)

Ustawia protokół SSLSocketFactory do użycia przez aplikację klienczą dla całej komunikacji sieciowej. Jeśli klient HTTP jest ustawiony w aplikacji klienckiej (za pośrednictwem clientApplication.builder().httpClient()), należy wykonać dowolną konfigurację protokołu SSL na kliencie HTTP, a nie za pomocą tej metody.

Przesłonięcia:

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

Parametry:

val - wystąpienie klasy SSLSocketFactory

Zwraca:

wystąpienie konstruktora, na którym wywoływano metodę

validateAuthority

public T validateAuthority(boolean val)

Ustaw wartość logiczną informującą aplikację o konieczności zweryfikowania urzędu względem listy znanych władz. Urząd jest weryfikowany tylko wtedy, gdy: 1 — jest to urząd Azure Active Directory (nie B2C lub ADFS) 2 — metadane odnajdywania wystąpień nie są ustawiane za pomocą poleceniaAbstractClientApplicationBase#aadAadInstanceDiscoveryResponse

Wartość domyślna to true.

Parametry:

val - wartość logiczna dla validateAuthority

Zwraca:

wystąpienie konstruktora, na którym wywoływano metodę

Dotyczy