AbstractClientApplicationBase.Builder<T> Sınıf

Paket:
com.microsoft.aad.msal4j
Maven Yapıtı:
com.microsoft.azure:msal4j:1.19.1

Tür Parametreleri

T

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

Alan Özeti

Değiştirici ve Tür Alan ve Açıklaması
protected boolean isInstanceDiscoveryEnabled

Oluşturucu Özeti

Oluşturucu Description
Builder(String clientId)

İstemci uygulamasının Oluşturucusu örneğini oluşturmak için oluşturucu

Yöntem Özeti

Değiştirici ve Tür Yöntem ve Açıklaması
T aadInstanceDiscoveryResponse(String val)

Kiracı bulma uç noktasını ve yetkili diğer adlarını belirlemek için kullanılacak örnek bulma yanıt verilerini ayarlar.
T applicationName(String val)

Telemetri amacıyla uygulama adını ayarlar
T applicationVersion(String val)

Telemetri amacıyla uygulama sürümünü ayarlar
T authority(String val)

MSAL'nin güvenlik belirteçlerini edineceği kimlik doğrulama yetkilisinin veya güvenlik belirteci hizmetinin (STS) URL'sini ayarlayın.
T autoDetectRegion(boolean val)

Örnek bulma meta verileri getirilirken kitaplığın uygulamanın çalıştığı Azure bölgeyi bulmaya çalışması gerektiğini gösterir.
T azureRegion(String val)

Kitaplığın belirteç isteklerindeki yetkilileri biçimlendirmek için kullanacağı bölgeyi ayarlayın.
T b2cAuthority(String val)

MSAL'nin belirteçleri edineceği kimlik doğrulama B2C yetkilisinin URL'sini ayarlayın Geçerli B2C yetkilileri şöyle görünmelidir: https://< something.b2clogin.com/<tenant>/<policy> MSAL Java, şu şekilde görünen eski bir B2C yetkili biçimini de destekler: https://< host>/tfp/<tenant>/<policy> Ancak MSAL Java sonunda eski biçimi desteklemeyi durduracaktır.
T clientCapabilities(Set<String> capabilities)
T connectTimeoutForDefaultHttpClient(Integer val)

tarafından DefaultHttpClientyapılan HttpsURLConnection bağlantılarında kullanılan bağlantı zaman aşımı değerini ayarlar ve özel bir HTTP istemcisi kullanılıyorsa gerekli değildir
T correlationId(String val)

API tarafından kullanılacak isteğe bağlı bağıntı kimliğini ayarlayın.
T executorService(ExecutorService val)

İstekleri yürütmek için kullanılacak YürütücüHizmeti'ni ayarlar.
T httpClient(IHttpClient val)

TÜM HTTP istekleri için istemci uygulaması tarafından kullanılacak HTTP istemcisini ayarlar.
T instanceDiscovery(boolean val)

MSAL, geçmişte 'https://login.'microsoftonline'da bulunan merkezi bir uç noktaya bağlanacaktı.özellikle de tanıdık olmayan bir yetkili kullanırken bazı meta verileri almak için com'' yazın.
T logPii(boolean val)

Pii günlüğünüayarla - Pii'nin (kişisel bilgiler) oturum açıp açmayacağını belirleyen boole değeri.
T oidcAuthority(String val)

Genel bir OpenIdConnect Kimlik Sağlayıcısına karşılık gelen bilinen bir yetkili ayarlayın.
T proxy(Proxy val)

Tüm ağ iletişimi için istemci uygulaması tarafından kullanılacak Ara Sunucu yapılandırmasını (varsayılan olarak MSAL4J kullanır javax.net.ssl.HttpsURLConnection) ayarlar.
T readTimeoutForDefaultHttpClient(Integer val)

tarafından DefaultHttpClientyapılan HttpsURLConnection bağlantılarında kullanılan okuma zaman aşımı değerini ayarlar ve özel bir HTTP istemcisi kullanılıyorsa gerekli değildir
T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)

cache_data kalıcılığı için kullanılacak ITokenÖnbelleğiErişimYönünü ayarlar.
T sslSocketFactory(SSLSocketFactory val)

SSLSocketFactory'yi tüm ağ iletişimi için istemci uygulaması tarafından kullanılacak şekilde ayarlar.
T validateAuthority(boolean val)

Yetkilinin bilinen yetkili listesinde doğrulanması gerekip gerekmediğini uygulamaya söyleyen bir boole değeri ayarlayın.

Yöntemlerin devralındığı yer: Builder

connectTimeoutForDefaultHttpClient correlationId executorService httpClient logPii proxy readTimeoutForDefaultHttpClient sslSocketFactory

Yöntemlerin devralındığı yer: 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

Alan Ayrıntıları

isInstanceDiscoveryEnabled

protected boolean isInstanceDiscoveryEnabled

Oluşturucu Ayrıntıları

Builder

public Builder(String clientId)

İstemci uygulamasının Oluşturucusu örneğini oluşturmak için oluşturucu

Parametreler:

clientId - Uygulama kayıt portalında (portal.azure.com) kayıtlı olarak uygulamanın İstemci Kimliği (Uygulama Kimliği)

Yöntem Ayrıntıları

aadInstanceDiscoveryResponse

public T aadInstanceDiscoveryResponse(String val)

Kiracı bulma uç noktasını ve yetkili diğer adlarını belirlemek için kullanılacak örnek bulma yanıt verilerini ayarlar.

Doğru olarak ayarlansa AbstractClientApplicationBase#validateAuthority bile yetkili doğrulamasının yapılmadığını unutmayın.

Daha fazla bilgi için bkz. https://aka.ms/msal4j-instance-discovery.

Parametreler:

val - AAD örneği bulma uç noktasından JSON biçimli yanıt değeri

Döndürülenler:

yönteminin çağrıldığı Builder örneği

applicationName

public T applicationName(String val)

Telemetri amacıyla uygulama adını ayarlar

Parametreler:

val - uygulama adı

Döndürülenler:

yönteminin çağrıldığı Builder örneği

applicationVersion

public T applicationVersion(String val)

Telemetri amacıyla uygulama sürümünü ayarlar

Parametreler:

val - uygulama sürümü

Döndürülenler:

yönteminin çağrıldığı Builder örneği

authority

public T authority(String val)

MSAL'nin güvenlik belirteçlerini edineceği kimlik doğrulama yetkilisinin veya güvenlik belirteci hizmetinin (STS) URL'sini ayarlayın. Varsayılan değer: AbstractClientApplicationBase#DEFAULT_AUTHORITY

Parametreler:

val - yetki dizesi değeri

Döndürülenler:

yönteminin çağrıldığı Builder örneği

Atar:

java.net.MalformedURLException - val hatalı biçimlendirilmiş URL ise

autoDetectRegion

public T autoDetectRegion(boolean val)

Örnek bulma meta verileri getirilirken kitaplığın uygulamanın çalıştığı Azure bölgeyi bulmaya çalışması gerektiğini gösterir. Bölgeler yalnızca Azure VM veya başka bir hizmet gibi Azure bir ortamda çalıştırılırken veya ortamın REGION_NAME adlı ortam değişkeni yapılandırılmışsa algılanabilir. Hem burada hem de belirli bir bölgeyle AbstractClientApplicationBase#azureRegion aynı anda hem otomatik denetimi etkinleştirebilirsiniz, ancak uyuşmazlık varsa ile AbstractClientApplicationBase#azureRegion ayarlanan bölge öncelik alır. Desteklenen senaryolar hakkında daha fazla bilgi için buraya bakın: https://aka.ms/msal4j-azure-regions

Parametreler:

val - boole (varsayılan değer false)

Döndürülenler:

yönteminin çağrıldığı Builder örneği

azureRegion

public T azureRegion(String val)

Kitaplığın belirteç isteklerindeki yetkilileri biçimlendirmek için kullanacağı bölgeyi ayarlayın. Geçerli bir Azure bölgesi verilirse, kitaplık genel ESTS uç noktası yerine bölgesel bir ESTS-R uç noktasında belirteç isteklerinde bulunmaya çalışır. Bölgeler geçerli Azure bölgeler olmalı ve kısa adları kullanılmalıdır; örneğin Batı ABD Azure bölgesi için 'westus', Orta ABD Azure bölgesi için 'centralus' vb. Burada belirli bir bölge ayarlayabilir ve aynı zamanda ile AbstractClientApplicationBase#autoDetectRegion otomatik algılamayı etkinleştirebilirsiniz, ancak uyuşmazlık varsa, burada ayarlanan bölge otomatik olarak algılanan bölgeye göre öncelik alır. Desteklenen senaryolar hakkında daha fazla bilgi için buraya bakın: https://aka.ms/msal4j-azure-regions

Parametreler:

val - Dize bölgesi adı

Döndürülenler:

yönteminin çağrıldığı Builder örneği

b2cAuthority

public T b2cAuthority(String val)

MSAL'nin belirteçleri edineceği kimlik doğrulama B2C yetkilisinin URL'sini ayarlama Geçerli B2C yetkilileri şöyle görünmelidir: https://< something.b2clogin.com/< tenant>/<policy> MSAL Java şu şekilde görünen eski bir B2C yetkili biçimini de destekler: https://< host>/tfp/tenant>/<<policy> Ancak MSAL Java sonunda eski biçimi desteklemeyi durduracaktır. Yeni biçime geçiş hakkında bilgi için buraya bakın: https://aka.ms/msal4j-b2c

Parametreler:

val - validateAuthority için boole değeri

Döndürülenler:

yönteminin çağrıldığı Builder örneği

Atar:

java.net.MalformedURLException

clientCapabilities

public T clientCapabilities(Set<String> capabilities)

Parametreler:

capabilities

connectTimeoutForDefaultHttpClient

public T connectTimeoutForDefaultHttpClient(Integer val)

tarafından DefaultHttpClientyapılan HttpsURLConnection bağlantılarında kullanılan bağlantı zaman aşımı değerini ayarlar ve özel bir HTTP istemcisi kullanılıyorsa gerekli değildir

Geçersiz Kılmalar:

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

Parametreler:

val - milisaniye cinsinden zaman aşımı değeri

Döndürülenler:

yönteminin çağrıldığı Builder örneği

correlationId

public T correlationId(String val)

API tarafından kullanılacak isteğe bağlı bağıntı kimliğini ayarlayın. Sağlanmazsa API rastgele bir UUID oluşturur.

Geçersiz Kılmalar:

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

Parametreler:

val - bağıntı kimliğinin dize değeri

Döndürülenler:

yönteminin çağrıldığı Builder örneği

executorService

public T executorService(ExecutorService val)

executeorService'i istekleri yürütmek için kullanılacak şekilde ayarlar. Geliştirici, ExecutorService yaşam döngüsünü korumakla sorumludur.

Geçersiz Kılmalar:

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

Parametreler:

val - ExecutorService örneği

Döndürülenler:

yönteminin çağrıldığı Builder örneği

httpClient

public T httpClient(IHttpClient val)

TÜM HTTP istekleri için istemci uygulaması tarafından kullanılacak HTTP istemcisini ayarlar. HTTP istemcisinin ayrıntılı yapılandırmasına izin verir.

Geçersiz Kılmalar:

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

Parametreler:

val - Uygulamasının IHttpClient

Döndürülenler:

yönteminin çağrıldığı Builder örneği

instanceDiscovery

public T instanceDiscovery(boolean val)

Geçmişte MSAL, özellikle de tanıdık olmayan bir yetkili kullanırken bazı meta verileri almak için ''https://login.microsoftonline.com'' konumunda bulunan merkezi bir uç noktaya bağlanırdı. Bu davranış Örnek Bulma olarak bilinir. Bu parametre varsayılan olarak true olarak ayarlanır ve bu da Örnek Bulma'yı etkinleştirir. Bazı yetkilileri önceden tanımıyorsanız ancak yine de MSAL'nin sağlayacağınız herhangi bir yetkiyi kabul etmelerini istiyorsanız, Koşulsuz olarak Örnek Bulma'yı devre dışı bırakmak için ''False'' kullanabilirsiniz.

Parametreler:

val

logPii

public T logPii(boolean val)

Pii'nin (kişisel bilgiler) oturum açıp açmayacağını belirleyen logPii - boole değerini ayarlayın. Varsayılan değer yanlıştır.

Geçersiz Kılmalar:

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

Parametreler:

val - logPii için boole değeri

Döndürülenler:

yönteminin çağrıldığı Builder örneği

oidcAuthority

public T oidcAuthority(String val)

Genel bir OpenIdConnect Kimlik Sağlayıcısına karşılık gelen bilinen bir yetkili ayarlayın. MSAL, OIDC meta verilerini almak ve uç noktaları belirlemek için yetkiliye ".well-known/openid-configuration" ekler.

Parametreler:

val - yetki dizesi değeri

Döndürülenler:

yönteminin çağrıldığı Builder örneği

Atar:

java.net.MalformedURLException

proxy

public T proxy(Proxy val)

Tüm ağ iletişimi için istemci uygulaması tarafından kullanılacak Ara Sunucu yapılandırmasını (varsayılan olarak MSAL4J kullanır javax.net.ssl.HttpsURLConnection) ayarlar. Hiçbir proxy değeri geçirilmezse sistem tanımlı özellikler kullanılır. İstemci uygulamasında HTTP istemcisi ayarlandıysa (ClientApplication.builder().httpClient() aracılığıyla), proxy yapılandırması bu yöntemle değil, geçirilen HTTP istemci nesnesinde yapılmalıdır.

Geçersiz Kılmalar:

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

Parametreler:

val - Proxy örneği

Döndürülenler:

yönteminin çağrıldığı Builder örneği

readTimeoutForDefaultHttpClient

public T readTimeoutForDefaultHttpClient(Integer val)

tarafından DefaultHttpClientyapılan HttpsURLConnection bağlantılarında kullanılan okuma zaman aşımı değerini ayarlar ve özel bir HTTP istemcisi kullanılıyorsa gerekli değildir

Geçersiz Kılmalar:

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

Parametreler:

val - milisaniye cinsinden zaman aşımı değeri

Döndürülenler:

yönteminin çağrıldığı Builder örneği

setTokenCacheAccessAspect

public T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)

ITokenCacheAccessAspect öğesini cache_data kalıcılık için kullanılacak şekilde ayarlar.

Parametreler:

val - ITokenCacheAccessAspect örneği

Döndürülenler:

yönteminin çağrıldığı Builder örneği

sslSocketFactory

public T sslSocketFactory(SSLSocketFactory val)

SSLSocketFactory'yi tüm ağ iletişimi için istemci uygulaması tarafından kullanılacak şekilde ayarlar. İstemci uygulamasında HTTP istemcisi ayarlandıysa (ClientApplication.builder().httpClient() aracılığıyla), BU yöntemle değil, HTTP istemcisinde ssl yapılandırması yapılmalıdır.

Geçersiz Kılmalar:

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

Parametreler:

val - SSLSocketFactory örneği

Döndürülenler:

yönteminin çağrıldığı Builder örneği

validateAuthority

public T validateAuthority(boolean val)

Yetkilinin bilinen yetkili listesinde doğrulanması gerekip gerekmediğini uygulamaya söyleyen bir boole değeri ayarlayın. Yetkili yalnızca şu durumlarda doğrulanır: 1 - Bu bir Azure Active Directory yetkilisidir (B2C veya ADFS değil) 2 - Örnek bulma meta verileriAbstractClientApplicationBase#aadAadInstanceDiscoveryResponse

Varsayılan değer doğru'dur.

Parametreler:

val - validateAuthority için boole değeri

Döndürülenler:

yönteminin çağrıldığı Builder örneği

Şunlara uygulanır