AbstractClientApplicationBase.Builder<T> Kelas

Paket:
com.microsoft.aad.msal4j
Maven Artifact:
com.microsoft.azure:msal4j:1.19.1

Jenis parameter

T

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

Ringkasan Bidang

Pemodifikasi dan Jenis Bidang dan Deskripsi
protected boolean isInstanceDiscoveryEnabled

Ringkasan Konstruktor

Konstruktor Deskripsi
Builder(String clientId)

Konstruktor untuk membuat instans Builder aplikasi klien

Ringkasan Metode

Pemodifikasi dan Jenis Metode dan Deskripsi
T aadInstanceDiscoveryResponse(String val)

Mengatur data respons penemuan instans yang akan digunakan untuk menentukan titik akhir penemuan penyewa dan alias otoritas.
T applicationName(String val)

Mengatur nama aplikasi untuk tujuan telemetri
T applicationVersion(String val)

Mengatur versi aplikasi untuk tujuan telemetri
T authority(String val)

Atur URL otoritas autentikasi atau layanan token keamanan (STS) tempat MSAL akan memperoleh token keamanan.
T autoDetectRegion(boolean val)

Menunjukkan bahwa pustaka harus mencoba menemukan wilayah Azure tempat aplikasi berjalan saat mengambil metadata penemuan instans.
T azureRegion(String val)

Atur wilayah yang akan digunakan pustaka untuk memformat otoritas dalam permintaan token.
T b2cAuthority(String val)

Atur URL otoritas B2C yang mengautentikasi dari mana MSAL akan memperoleh token otoritas Valid B2C akan terlihat seperti: https://< sambut.b2clogin.com/<tenant>/<policy> MSAL Java juga mendukung format otoritas B2C warisan, yang terlihat seperti: https://< host>/tfp/<tenant>/<policy> Namun, Java MSAL pada akhirnya akan berhenti mendukung format warisan.
T clientCapabilities(Set<String> capabilities)
T connectTimeoutForDefaultHttpClient(Integer val)

Mengatur nilai batas waktu koneksi yang digunakan dalam koneksi HTTPSURLConnection yang dibuat oleh DefaultHttpClient, dan tidak diperlukan jika menggunakan klien HTTP kustom
T correlationId(String val)

Atur id korelasi opsional yang akan digunakan oleh API.
T executorService(ExecutorService val)

Mengatur Layanan Pelaksanayang akan digunakan untuk menjalankan permintaan.
T httpClient(IHttpClient val)

Mengatur klien HTTP yang akan digunakan oleh aplikasi klien untuk semua permintaan HTTP.
T instanceDiscovery(boolean val)

Secara historis, MSAL akan terhubung ke titik akhir pusat yang terletak di ''https://login.microsoftonline.com'' untuk memperoleh beberapa metadata, terutama saat menggunakan otoritas yang tidak dikenal.
T logPii(boolean val)

Atur logPii - nilai boolean, yang menentukan apakah Pii (informasi identitas pribadi) akan masuk.
T oidcAuthority(String val)

Atur otoritas yang diketahui yang sesuai dengan Penyedia Identitas OpenIdConnect generik.
T proxy(Proxy val)

Mengatur konfigurasi Proksi yang akan digunakan oleh aplikasi klien (MSAL4J secara default menggunakan javax.net.ssl.HttpsURLConnection) untuk semua komunikasi jaringan.
T readTimeoutForDefaultHttpClient(Integer val)

Mengatur nilai batas waktu baca yang digunakan dalam koneksi HTTPSURLConnection yang dibuat oleh DefaultHttpClient, dan tidak diperlukan jika menggunakan klien HTTP kustom
T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)

Mengatur Aspek AksesCacheITokenyang akan digunakan untuk persistensi cache_data.
T sslSocketFactory(SSLSocketFactory val)

Mengatur SSLSocketFactory yang akan digunakan oleh aplikasi klien untuk semua komunikasi jaringan.
T validateAuthority(boolean val)

Tetapkan nilai boolean yang memberi tahu aplikasi jika otoritas perlu diverifikasi terhadap daftar otoritas yang diketahui.

Metode diperoleh dari Builder

connectTimeoutForDefaultHttpClient correlationId executorService httpClient logPii proxy readTimeoutForDefaultHttpClient sslSocketFactory

Metode diperoleh dari 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

Detail Bidang

isInstanceDiscoveryEnabled

protected boolean isInstanceDiscoveryEnabled

Detail Konstruktor

Builder

public Builder(String clientId)

Konstruktor untuk membuat instans Builder aplikasi klien

Parameter:

clientId - ID Klien (ID Aplikasi) aplikasi seperti yang terdaftar di portal pendaftaran aplikasi (portal.azure.com)

Detail Metode

aadInstanceDiscoveryResponse

public T aadInstanceDiscoveryResponse(String val)

Mengatur data respons penemuan instans yang akan digunakan untuk menentukan titik akhir penemuan penyewa dan alias otoritas.

Perhatikan bahwa validasi otoritas tidak dilakukan meskipun AbstractClientApplicationBase#validateAuthority diatur ke true.

Untuk informasi selengkapnya, lihat https://aka.ms/msal4j-instance-discovery

Parameter:

val - Nilai respons yang diformat JSON dari titik akhir penemuan instans AAD

Mengembalikan:

instans Builder di metode mana yang dipanggil

applicationName

public T applicationName(String val)

Mengatur nama aplikasi untuk tujuan telemetri

Parameter:

val - nama aplikasi

Mengembalikan:

instans Builder di metode mana yang dipanggil

applicationVersion

public T applicationVersion(String val)

Mengatur versi aplikasi untuk tujuan telemetri

Parameter:

val - versi aplikasi

Mengembalikan:

instans Builder di metode mana yang dipanggil

authority

public T authority(String val)

Atur URL otoritas autentikasi atau layanan token keamanan (STS) tempat MSAL akan memperoleh token keamanan. Nilai defaultnya adalah AbstractClientApplicationBase#DEFAULT_AUTHORITY

Parameter:

val - nilai string otoritas

Mengembalikan:

instans Builder di metode mana yang dipanggil

Melemparkan:

java.net.MalformedURLException - jika val adalah URL cacat

autoDetectRegion

public T autoDetectRegion(boolean val)

Menunjukkan bahwa pustaka harus mencoba menemukan wilayah Azure tempat aplikasi berjalan saat mengambil metadata penemuan instans. Wilayah hanya dapat dideteksi saat berjalan di lingkungan Azure, seperti VM Azure atau layanan lain, atau jika lingkungan memiliki variabel lingkungan bernama REGION_NAME dikonfigurasi. Meskipun Anda dapat mengaktifkan pendeteksian otomatis di sini dan wilayah tertentu dengan AbstractClientApplicationBase#azureRegion pada saat yang sama, wilayah yang ditetapkan akan AbstractClientApplicationBase#azureRegion diprioritaskan jika ada ketidakcocokan. Lihat di sini untuk informasi selengkapnya tentang skenario yang didukung: https://aka.ms/msal4j-azure-regions

Parameter:

val - boolean (defaultnya adalah false)

Mengembalikan:

instans Builder di metode mana yang dipanggil

azureRegion

public T azureRegion(String val)

Atur wilayah yang akan digunakan pustaka untuk memformat otoritas dalam permintaan token. Jika diberikan wilayah Azure yang valid, pustaka akan mencoba membuat permintaan token di titik akhir ESTS-R regional daripada titik akhir ESTS global. Wilayah harus valid Azure wilayah dan nama pendeknya harus digunakan, seperti 'westus' untuk wilayah Azure AS Barat, 'centralus' untuk wilayah Azure AS Tengah, dll. Meskipun Anda dapat mengatur wilayah tertentu di sini dan mengaktifkan pendeteksian otomatis dengan AbstractClientApplicationBase#autoDetectRegion pada saat yang sama wilayah tertentu yang ditetapkan di sini akan mengambil prioritas atas wilayah yang terdeteksi otomatis jika ada ketidakcocokan. Lihat di sini untuk informasi selengkapnya tentang skenario yang didukung: https://aka.ms/msal4j-azure-regions

Parameter:

val - Nama wilayah string

Mengembalikan:

instans Builder di metode mana yang dipanggil

b2cAuthority

public T b2cAuthority(String val)

Atur URL otoritas B2C yang mengautentikasi dari mana MSAL akan memperoleh token Otoritas B2C valid akan terlihat seperti: https://< something.b2clogin.com/< tenant>/<policy> MSAL Java juga mendukung format otoritas B2C warisan, yang terlihat seperti: https://< host>/tfp/tenant>/<<policy> Namun, Java MSAL pada akhirnya akan berhenti mendukung format warisan. Lihat di sini untuk informasi tentang cara bermigrasi ke format baru: https://aka.ms/msal4j-b2c

Parameter:

val - nilai boolean untuk validateAuthority

Mengembalikan:

instans Builder di metode mana yang dipanggil

Melemparkan:

java.net.MalformedURLException

clientCapabilities

public T clientCapabilities(Set<String> capabilities)

Parameter:

capabilities

connectTimeoutForDefaultHttpClient

public T connectTimeoutForDefaultHttpClient(Integer val)

Mengatur nilai batas waktu koneksi yang digunakan dalam koneksi HttpsURLConnection yang dibuat oleh DefaultHttpClient, dan tidak diperlukan jika menggunakan klien HTTP kustom

Timpa:

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

Parameter:

val - nilai batas waktu dalam milidetik

Mengembalikan:

instans Builder di metode mana yang dipanggil

correlationId

public T correlationId(String val)

Atur id korelasi opsional yang akan digunakan oleh API. Jika tidak disediakan, API menghasilkan UUID acak.

Timpa:

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

Parameter:

val - nilai string id korelasi

Mengembalikan:

instans Builder di metode mana yang dipanggil

executorService

public T executorService(ExecutorService val)

Mengatur ExecutorService yang akan digunakan untuk menjalankan permintaan. Pengembang bertanggung jawab untuk mempertahankan siklus hidup ExecutorService.

Timpa:

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

Parameter:

val - instans ExecutorService

Mengembalikan:

instans Builder di metode mana yang dipanggil

httpClient

public T httpClient(IHttpClient val)

Mengatur klien HTTP yang akan digunakan oleh aplikasi klien untuk semua permintaan HTTP. Memungkinkan konfigurasi klien HTTP yang halus.

Timpa:

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

Parameter:

val - Implementasi IHttpClient

Mengembalikan:

instans Builder di metode mana yang dipanggil

instanceDiscovery

public T instanceDiscovery(boolean val)

Secara historis, MSAL akan terhubung ke titik akhir pusat yang terletak di '''https://login.microsoftonline.com' untuk memperoleh beberapa metadata, terutama saat menggunakan otoritas yang tidak dikenal. Perilaku ini dikenal sebagai Penemuan Instans. Parameter ini default ke true, yang memungkinkan Penemuan Instans. Jika Anda tidak tahu beberapa otoritas sebelumnya, namun masih ingin MSAL menerima otoritas apa pun yang akan Anda berikan, Anda dapat menggunakan ''False'' untuk menonaktifkan Penemuan Instans tanpa syarat.

Parameter:

val

logPii

public T logPii(boolean val)

Atur logPii - nilai boolean, yang menentukan apakah Pii (informasi identitas pribadi) akan masuk. Nilai defaultnya adalah false.

Timpa:

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

Parameter:

val - nilai boolean untuk logPii

Mengembalikan:

instans Builder di metode mana yang dipanggil

oidcAuthority

public T oidcAuthority(String val)

Atur otoritas yang diketahui yang sesuai dengan Penyedia Identitas OpenIdConnect generik. MSAL akan menambahkan ".well-known/openid-configuration" ke otoritas untuk mengambil metadata OIDC dan menentukan titik akhir.

Parameter:

val - nilai string otoritas

Mengembalikan:

instans Builder di metode mana yang dipanggil

Melemparkan:

java.net.MalformedURLException

proxy

public T proxy(Proxy val)

Mengatur konfigurasi Proksi yang akan digunakan oleh aplikasi klien (MSAL4J secara default menggunakan javax.net.ssl.HttpsURLConnection) untuk semua komunikasi jaringan. Jika tidak ada nilai proksi yang diteruskan, properti yang ditentukan sistem akan digunakan. Jika klien HTTP diatur pada aplikasi klien (melalui ClientApplication.builder().httpClient()), konfigurasi proksi harus dilakukan pada objek klien HTTP yang diteruskan, dan bukan melalui metode ini.

Timpa:

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

Parameter:

val - instans Proksi

Mengembalikan:

instans Builder di metode mana yang dipanggil

readTimeoutForDefaultHttpClient

public T readTimeoutForDefaultHttpClient(Integer val)

Mengatur nilai batas waktu baca yang digunakan dalam koneksi HttpsURLConnection yang dibuat oleh DefaultHttpClient, dan tidak diperlukan jika menggunakan klien HTTP kustom

Timpa:

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

Parameter:

val - nilai batas waktu dalam milidetik

Mengembalikan:

instans Builder di metode mana yang dipanggil

setTokenCacheAccessAspect

public T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)

Mengatur ITokenCacheAccessAspect yang akan digunakan untuk persistensi cache_data.

Parameter:

val - instans ITokenCacheAccessAspect

Mengembalikan:

instans Builder di metode mana yang dipanggil

sslSocketFactory

public T sslSocketFactory(SSLSocketFactory val)

Mengatur SSLSocketFactory yang akan digunakan oleh aplikasi klien untuk semua komunikasi jaringan. Jika klien HTTP diatur pada aplikasi klien (melalui ClientApplication.builder().httpClient()), konfigurasi SSL apa pun harus dilakukan pada klien HTTP dan bukan melalui metode ini.

Timpa:

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

Parameter:

val - instans SSLSocketFactory

Mengembalikan:

instans Builder di metode mana yang dipanggil

validateAuthority

public T validateAuthority(boolean val)

Tetapkan nilai boolean yang memberi tahu aplikasi jika otoritas perlu diverifikasi terhadap daftar otoritas yang diketahui. Otoritas hanya divalidasi ketika: 1 - Ini adalah otoritas Azure Active Directory (bukan B2C atau ADFS) 2 - Metadata penemuan instans tidak diatur melaluiAbstractClientApplicationBase#aadAadInstanceDiscoveryResponse

Nilai defaultnya adalah true.

Parameter:

val - nilai boolean untuk validateAuthority

Mengembalikan:

instans Builder di metode mana yang dipanggil

Berlaku untuk