AbstractClientApplicationBase.Builder<T> Класс

Пакет:
com.microsoft.aad.msal4j
Артефакт Maven:
com.microsoft.azure:msal4j:1.19.1

Параметры типа

T

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

Сводка по полю

Модификатор и тип Поле и описание
protected boolean isInstanceDiscoveryEnabled

Сводка по конструктору

Конструктор Описание
Builder(String clientId)

Конструктор для создания экземпляра построителя клиентского приложения

Сводка по методу

Модификатор и тип Метод и описание
T aadInstanceDiscoveryResponse(String val)

Задает данные ответа на обнаружение экземпляров, которые будут использоваться для определения конечной точки обнаружения клиентов и псевдонимов центра.
T applicationName(String val)

Задает имя приложения для целей телеметрии
T applicationVersion(String val)

Задает версию приложения для целей телеметрии
T authority(String val)

Задайте URL-адрес службы проверки подлинности или службы маркеров безопасности (STS), из которой MSAL получит маркеры безопасности.
T autoDetectRegion(boolean val)

Указывает, что библиотека должна попытаться обнаружить регион Azure, в котором приложение выполняется при получении метаданных обнаружения экземпляров.
T azureRegion(String val)

Задайте регион, который библиотека будет использовать для форматирования центров в запросах маркеров.
T b2cAuthority(String val)

Задайте URL-адрес проверки подлинности центра B2C, из которого MSAL получит маркеры Допустимые центры B2C, должны выглядеть следующим образом: https://< something.b2clogin.com/tenant>/<<policy> MSAL Java также поддерживает устаревший формат центра B2C, который выглядит следующим образом: https://< host>/tfp/tenant>/<<policy>, однако MSAL Java в конечном итоге перестанет поддерживать устаревший формат.
T clientCapabilities(Set<String> capabilities)
T connectTimeoutForDefaultHttpClient(Integer val)

Задает значение времени ожидания подключения, используемое в подключениях HTTPsURLConnection, сделанных DefaultHttpClientи не требуется, если используется пользовательский HTTP-клиент.
T correlationId(String val)

Задайте необязательный идентификатор корреляции, используемый API.
T executorService(ExecutorService val)

Задает службу исполнителядля выполнения запросов.
T httpClient(IHttpClient val)

Задает HTTP-клиент, используемый клиентским приложением для всех HTTP-запросов.
T instanceDiscovery(boolean val)

Исторически MSAL подключается к центральной конечной точке, расположенной в microsoftonlinehttps://login..com'' для получения некоторых метаданных, особенно при использовании незнакомого центра.
T logPii(boolean val)

Установите logPii — логическое значение, определяющее, будет ли входить pii (личная идентифицируемая информация).
T oidcAuthority(String val)

Задайте известный центр, соответствующий универсальному поставщику удостоверений OpenIdConnect.
T proxy(Proxy val)

Задает конфигурацию прокси-сервера для использования клиентским приложением (MSAL4J по умолчанию) javax.net.ssl.HttpsURLConnectionдля всех сетевых подключений.
T readTimeoutForDefaultHttpClient(Integer val)

Задает значение времени ожидания чтения, используемое в подключениях HTTPsURLConnection, сделанных DefaultHttpClientи не требуется, если используется пользовательский HTTP-клиент.
T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)

Задает аспект доступа ккэшуIToken, используемый для cache_data сохраняемости.
T sslSocketFactory(SSLSocketFactory val)

Задает фабрику SSLSocket, которая будет использоваться клиентским приложением для всех сетевых подключений.
T validateAuthority(boolean val)

Задайте логическое значение, указывающее приложению, если центру необходимо проверить список известных органов.

Методы, унаследованные от Builder

connectTimeoutForDefaultHttpClient correlationId executorService httpClient logPii proxy readTimeoutForDefaultHttpClient sslSocketFactory

Методы, унаследованные от 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

Сведения о полях

isInstanceDiscoveryEnabled

protected boolean isInstanceDiscoveryEnabled

Сведения о конструкторе

Builder

public Builder(String clientId)

Конструктор для создания экземпляра построителя клиентского приложения

Параметры:

clientId - Идентификатор клиента (идентификатор приложения) приложения, зарегистрированного на портале регистрации приложений (portal.azure.com)

Сведения о методе

aadInstanceDiscoveryResponse

public T aadInstanceDiscoveryResponse(String val)

Задает данные ответа на обнаружение экземпляров, которые будут использоваться для определения конечной точки обнаружения клиентов и псевдонимов центра.

Обратите внимание, что проверка центра не выполняется, даже если AbstractClientApplicationBase#validateAuthority задано значение true.

Дополнительные сведения см. по ссылке https://aka.ms/msal4j-instance-discovery.

Параметры:

val - Форматируемое значение JSON ответа из конечной точки обнаружения экземпляра AAD

Возвращаемое значение:

экземпляр построителя, для которого был вызван метод

applicationName

public T applicationName(String val)

Задает имя приложения для целей телеметрии

Параметры:

val - Имя приложения

Возвращаемое значение:

экземпляр построителя, для которого был вызван метод

applicationVersion

public T applicationVersion(String val)

Задает версию приложения для целей телеметрии

Параметры:

val - версия приложения

Возвращаемое значение:

экземпляр построителя, для которого был вызван метод

authority

public T authority(String val)

Задайте URL-адрес службы проверки подлинности или службы маркеров безопасности (STS), из которой MSAL получит маркеры безопасности. Значение по умолчанию — AbstractClientApplicationBase#DEFAULT_AUTHORITY.

Параметры:

val - строковое значение центра

Возвращаемое значение:

экземпляр построителя, для которого был вызван метод

Активизирует исключение:

java.net.MalformedURLException - Значение

autoDetectRegion

public T autoDetectRegion(boolean val)

Указывает, что библиотека должна попытаться обнаружить регион Azure, в котором приложение выполняется при получении метаданных обнаружения экземпляров. Регионы можно обнаружить только при запуске в среде Azure, например Azure виртуальной машине или другой службе, или если среда имеет переменную среды с именем REGION_NAME настроена. Хотя вы можете включить автоопределение здесь и определенный регион одновременно AbstractClientApplicationBase#azureRegion , набор регионов с AbstractClientApplicationBase#azureRegion приоритетом будет иметь приоритет, если имеется несоответствие. Дополнительные сведения о поддерживаемых сценариях см. здесь: https://aka.ms/msal4j-azure-regions

Параметры:

val - логическое значение (по умолчанию — false)

Возвращаемое значение:

экземпляр построителя, для которого был вызван метод

azureRegion

public T azureRegion(String val)

Задайте регион, который библиотека будет использовать для форматирования центров в запросах маркеров. Если задан допустимый регион Azure, библиотека попытается выполнить запросы маркеров в региональной ESTS-R конечной точке, а не глобальной конечной точке ESTS. Регионы должны быть допустимыми Azure регионами и их короткими именами, такими как "westus" для региона "Западная часть США" Azure регион, "центральная часть" для центрального региона США Azure и т. д. Несмотря на то что здесь можно задать определенный регион и включить автоопределение одновременно AbstractClientApplicationBase#autoDetectRegion с заданным здесь регионом будет иметь приоритет над автоопределенным регионом, если имеется несоответствие. Дополнительные сведения о поддерживаемых сценариях см. здесь: https://aka.ms/msal4j-azure-regions

Параметры:

val - Имя области строки

Возвращаемое значение:

экземпляр построителя, для которого был вызван метод

b2cAuthority

public T b2cAuthority(String val)

Задайте URL-адрес проверки подлинности центра B2C, из которого MSAL получит маркеры Допустимых центров B2C, должен выглядеть следующим образом: https:// something.b2clogin.com/ tenant/policy MSAL Java также поддерживает устаревший формат центра B2C, который выглядит следующим образом: https://<< host>/tfp/tenant>/<<policy> Однако MSAL Java в конечном итоге перестанет поддерживать устаревший формат.><>< Дополнительные сведения о миграции в новый формат см. здесь: https://aka.ms/msal4j-b2c

Параметры:

val - логическое значение для validateAuthority

Возвращаемое значение:

экземпляр построителя, для которого был вызван метод

Активизирует исключение:

java.net.MalformedURLException

clientCapabilities

public T clientCapabilities(Set<String> capabilities)

Параметры:

capabilities

connectTimeoutForDefaultHttpClient

public T connectTimeoutForDefaultHttpClient(Integer val)

Задает значение времени ожидания подключения, используемое в подключениях HttpsURLConnection, сделанных DefaultHttpClientи не требуется, если используется пользовательский HTTP-клиент.

Переопределения:

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

Параметры:

val - Значение времени ожидания в миллисекундах

Возвращаемое значение:

экземпляр построителя, для которого был вызван метод

correlationId

public T correlationId(String val)

Задайте необязательный идентификатор корреляции, используемый API. В противном случае API создает случайный идентификатор UUID.

Переопределения:

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

Параметры:

val - строковое значение идентификатора корреляции

Возвращаемое значение:

экземпляр построителя, для которого был вызван метод

executorService

public T executorService(ExecutorService val)

Задает метод ExecuteorService, используемый для выполнения запросов. Разработчик отвечает за обслуживание жизненного цикла службы исполнителя.

Переопределения:

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

Параметры:

val - экземпляр ExecutorService

Возвращаемое значение:

экземпляр построителя, для которого был вызван метод

httpClient

public T httpClient(IHttpClient val)

Задает HTTP-клиент, используемый клиентским приложением для всех HTTP-запросов. Позволяет точно настроить HTTP-клиент.

Переопределения:

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

Параметры:

val - Реализация IHttpClient

Возвращаемое значение:

экземпляр построителя, для которого был вызван метод

instanceDiscovery

public T instanceDiscovery(boolean val)

Исторически MSAL подключается к центральной конечной точке, расположенной в ''https://login.microsoftonline.com' для получения некоторых метаданных, особенно при использовании незнакомого центра. Это поведение называется обнаружением экземпляров. Этот параметр по умолчанию имеет значение true, которое включает обнаружение экземпляров. Если вы не знаете некоторые органы заранее, но по-прежнему хотите, чтобы MSAL приняла какие-либо полномочия, которые вы предоставите, вы можете использовать "False", чтобы безусловно отключить обнаружение экземпляров.

Параметры:

val

logPii

public T logPii(boolean val)

Задайте logPii — логическое значение, определяющее, будет ли входить pii (личная информация). По умолчанию используется значение false.

Переопределения:

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

Параметры:

val - логическое значение для logPii

Возвращаемое значение:

экземпляр построителя, для которого был вызван метод

oidcAuthority

public T oidcAuthority(String val)

Задайте известный центр, соответствующий универсальному поставщику удостоверений OpenIdConnect. MSAL добавит .well-known/openid-configuration к центру для получения метаданных OIDC и определения конечных точек.

Параметры:

val - строковое значение центра

Возвращаемое значение:

экземпляр построителя, для которого был вызван метод

Активизирует исключение:

java.net.MalformedURLException

proxy

public T proxy(Proxy val)

Задает конфигурацию прокси-сервера для использования клиентским приложением (MSAL4J по умолчанию) javax.net.ssl.HttpsURLConnectionдля всех сетевых подключений. Если значение прокси-сервера не передается, используются системные свойства. Если http-клиент установлен в клиентском приложении (через ClientApplication.builder().httpClient()), то конфигурацию прокси-сервера следует выполнить в объекте HTTP-клиента, который передается, а не через этот метод.

Переопределения:

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

Параметры:

val - экземпляр прокси-сервера

Возвращаемое значение:

экземпляр построителя, для которого был вызван метод

readTimeoutForDefaultHttpClient

public T readTimeoutForDefaultHttpClient(Integer val)

Задает значение времени ожидания чтения, используемое в подключениях HttpsURLConnection, сделанных DefaultHttpClientи не требуется, если используется пользовательский HTTP-клиент.

Переопределения:

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

Параметры:

val - Значение времени ожидания в миллисекундах

Возвращаемое значение:

экземпляр построителя, для которого был вызван метод

setTokenCacheAccessAspect

public T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)

Задает значение ITokenCacheAccessAspect для cache_data сохраняемости.

Параметры:

val - экземпляр ITokenCacheAccessAspect

Возвращаемое значение:

экземпляр построителя, для которого был вызван метод

sslSocketFactory

public T sslSocketFactory(SSLSocketFactory val)

Задает протокол SSLSocketFactory для использования клиентским приложением для всех сетевых подключений. Если http-клиент установлен в клиентском приложении (с помощью ClientApplication.builder().httpClient()), любая конфигурация SSL должна выполняться на HTTP-клиенте, а не с помощью этого метода.

Переопределения:

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

Параметры:

val - экземпляр SSLSocketFactory

Возвращаемое значение:

экземпляр построителя, для которого был вызван метод

validateAuthority

public T validateAuthority(boolean val)

Задайте логическое значение, указывающее приложению, если центру необходимо проверить список известных органов. Центр проверяется только в том случае, если: 1 — это центр Azure Active Directory (а не B2C или ADFS) 2. Метаданные обнаружения экземпляров не задаются черезAbstractClientApplicationBase#aadAadInstanceDiscoveryResponse

Значение по умолчанию — true.

Параметры:

val - логическое значение для validateAuthority

Возвращаемое значение:

экземпляр построителя, для которого был вызван метод

Применяется к