AbstractClientApplicationBase.Builder<T> Clase

Parámetros de tipo

T

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

Resumen del campo

Modificador y tipo Campo y descripción
protected boolean isInstanceDiscoveryEnabled

Resumen del constructor

Constructor Description
Builder(String clientId)

Constructor para crear una instancia del Generador de aplicaciones cliente

Resumen del método

Modificador y tipo Método y descripción
T aadInstanceDiscoveryResponse(String val)

Establece los datos de respuesta de detección de instancias que se usarán para determinar los alias de entidad y punto de conexión de detección de inquilinos.

T applicationName(String val)

Establece el nombre de la aplicación con fines de telemetría

T applicationVersion(String val)

Establece la versión de la aplicación con fines de telemetría

T authority(String val)

Establezca la dirección URL de la entidad de autenticación o del servicio de token de seguridad (STS) desde la que MSAL adquirirá tokens de seguridad.

T autoDetectRegion(boolean val)

Indica que la biblioteca debe intentar detectar la región de Azure en la que se ejecuta la aplicación al capturar los metadatos de detección de instancias.

T azureRegion(String val)

Establezca la región que usará la biblioteca para dar formato a las autoridades en las solicitudes de token.

T b2cAuthority(String val)

Establezca la dirección URL de la entidad de autenticación B2C desde la que MSAL adquirirá tokens entidades válidas de B2C: https://< something.b2clogin.com/<tenant>/<policy> MSAL Java también admite un formato de entidad de B2C heredado, que tiene el siguiente aspecto: https://< host>/tfp/<tenant>/<policy> Sin embargo, MSAL Java finalmente dejará de admitir el formato heredado.

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

Establece el valor de tiempo de espera de conexión usado en las conexiones HTTPSURLConnection realizadas por DefaultHttpClienty no es necesario si se usa un cliente HTTP personalizado.

T correlationId(String val)

Establezca el identificador de correlación opcional que usará la API.

T executorService(ExecutorService val)

Establece el servicio Executorque se va a usar para ejecutar las solicitudes.

T httpClient(IHttpClient val)

Establece el cliente HTTP que usará la aplicación cliente para todas las solicitudes HTTP.

T instanceDiscovery(boolean val)

Históricamente, MSAL se conectaría a un punto de conexión central ubicado en ""https://login.microsoftonline".com'' para adquirir algunos metadatos, especialmente cuando se usa una autoridad desconocida.

T logPii(boolean val)

Establezca logPii: valor booleano, que determina si Pii (información de identificación personal) se registrará.

T oidcAuthority(String val)

Establezca una entidad conocida correspondiente a un proveedor genérico de identidades openIdConnect.

T proxy(Proxy val)

Establece la configuración de proxy que usará la aplicación cliente (MSAL4J de forma predeterminada usa javax.net.ssl.HttpsURLConnection) para toda la comunicación de red.

T readTimeoutForDefaultHttpClient(Integer val)

Establece el valor de tiempo de espera de lectura usado en las conexiones HTTPSURLConnection realizadas por DefaultHttpClienty no es necesario si se usa un cliente HTTP personalizado.

T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)

Establece el aspecto de acceso acachéde ITokenque se usará para cache_data persistencia.

T sslSocketFactory(SSLSocketFactory val)

Establece SSLSocketFactory que usará la aplicación cliente para toda la comunicación de red.

T validateAuthority(boolean val)

Establezca un valor booleano que indique a la aplicación si la autoridad debe comprobarse en una lista de autoridades conocidas.

Métodos heredados de Builder

Métodos heredados de 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

Detalles del campo

isInstanceDiscoveryEnabled

protected boolean isInstanceDiscoveryEnabled

Detalles del constructor

Builder

public Builder(String clientId)

Constructor para crear una instancia del Generador de aplicaciones cliente

Parámetros:

clientId - Id. de cliente (id. de aplicación) de la aplicación como registrado en el portal de registro de aplicaciones (portal.azure.com)

Detalles del método

aadInstanceDiscoveryResponse

public T aadInstanceDiscoveryResponse(String val)

Establece los datos de respuesta de detección de instancias que se usarán para determinar los alias de entidad y punto de conexión de detección de inquilinos.

Tenga en cuenta que la validación de la autoridad no se realiza aunque AbstractClientApplicationBase#validateAuthority esté establecida en true.

Para obtener más información, consulte: https://aka.ms/msal4j-instance-discovery

Parámetros:

val - Valor con formato JSON de respuesta del punto de conexión de detección de instancias de AAD

Devoluciones:

instancia del Generador en el que se llamó al método

applicationName

public T applicationName(String val)

Establece el nombre de la aplicación con fines de telemetría

Parámetros:

val - Nombre de aplicación

Devoluciones:

instancia del Generador en el que se llamó al método

applicationVersion

public T applicationVersion(String val)

Establece la versión de la aplicación con fines de telemetría

Parámetros:

val - versión de la aplicación

Devoluciones:

instancia del Generador en el que se llamó al método

authority

public T authority(String val)

Establezca la dirección URL de la entidad de autenticación o del servicio de token de seguridad (STS) desde la que MSAL adquirirá tokens de seguridad. El valor predeterminado es AbstractClientApplicationBase#DEFAULT_AUTHORITY

Parámetros:

val - un valor de cadena de autoridad

Devoluciones:

instancia del Generador en el que se llamó al método

Produce:

java.net.MalformedURLException - si val tiene una dirección URL con formato incorrecto

autoDetectRegion

public T autoDetectRegion(boolean val)

Indica que la biblioteca debe intentar detectar la región de Azure en la que se ejecuta la aplicación al capturar los metadatos de detección de instancias. Las regiones solo se pueden detectar al ejecutarse en un entorno de Azure, como una máquina virtual de Azure u otro servicio, o si el entorno tiene una variable de entorno denominada REGION_NAME configurada. Aunque puede habilitar la detección automática aquí y una región específica con AbstractClientApplicationBase#azureRegion al mismo tiempo, la región establecida con AbstractClientApplicationBase#azureRegion tendrá prioridad si hay un error de coincidencia. Consulte aquí para obtener más información sobre los escenarios admitidos: https://aka.ms/msal4j-azure-regions

Parámetros:

val - booleano (el valor predeterminado es false)

Devoluciones:

instancia del Generador en el que se llamó al método

azureRegion

public T azureRegion(String val)

Establezca la región que usará la biblioteca para dar formato a las autoridades en las solicitudes de token. Si se da una región de Azure válida, la biblioteca intentará realizar solicitudes de token en un punto de conexión de ESTS-R regional en lugar del punto de conexión ESTS global. Las regiones deben ser válidas Azure regiones y se deben usar sus nombres cortos, como "westus" para la región oeste de EE. UU. Azure, "centralus" para la región centro de EE. UU. Azure, etc. Aunque puede establecer una región específica aquí y habilitar la detección automática con AbstractClientApplicationBase#autoDetectRegion al mismo tiempo que la región específica establecida aquí tendrá prioridad sobre la región detectada automáticamente si hay un error de coincidencia. Consulte aquí para obtener más información sobre los escenarios admitidos: https://aka.ms/msal4j-azure-regions

Parámetros:

val - Nombre de la región de cadena

Devoluciones:

instancia del Generador en el que se llamó al método

b2cAuthority

public T b2cAuthority(String val)

Establezca la dirección URL de la entidad de autenticación B2C desde la que MSAL adquirirá tokens entidades válidas de B2C: https://< something.b2clogin.com/< tenant>/<policy> MSAL Java también admite un formato de autoridad B2C heredado, que tiene el siguiente aspecto: https://< host>/tfp/tenant>/<<policy> Sin embargo, MSAL Java finalmente dejará de admitir el formato heredado. Consulte aquí para obtener información sobre cómo migrar al nuevo formato: https://aka.ms/msal4j-b2c

Parámetros:

val - un valor booleano para validateAuthority

Devoluciones:

instancia del Generador en el que se llamó al método

Produce:

java.net.MalformedURLException

clientCapabilities

public T clientCapabilities(Set<String> capabilities)

Parámetros:

capabilities

connectTimeoutForDefaultHttpClient

public T connectTimeoutForDefaultHttpClient(Integer val)

Establece el valor de tiempo de espera de conexión usado en las conexiones HttpsURLConnection realizadas por DefaultHttpClienty no es necesario si se usa un cliente HTTP personalizado.

Invalidaciones:

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

Parámetros:

val - valor de tiempo de espera en milisegundos

Devoluciones:

instancia del Generador en el que se llamó al método

correlationId

public T correlationId(String val)

Establezca el identificador de correlación opcional que usará la API. Si no se proporciona, la API genera un UUID aleatorio.

Invalidaciones:

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

Parámetros:

val - un valor de cadena del identificador de correlación

Devoluciones:

instancia del Generador en el que se llamó al método

executorService

public T executorService(ExecutorService val)

Establece ExecutorService que se usará para ejecutar las solicitudes. El desarrollador es responsable de mantener el ciclo de vida de ExecutorService.

Invalidaciones:

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

Parámetros:

val - una instancia de ExecutorService

Devoluciones:

instancia del Generador en el que se llamó al método

httpClient

public T httpClient(IHttpClient val)

Establece el cliente HTTP que usará la aplicación cliente para todas las solicitudes HTTP. Permite una configuración específica del cliente HTTP.

Invalidaciones:

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

Parámetros:

val - Implementación de IHttpClient

Devoluciones:

instancia del Generador en el que se llamó al método

instanceDiscovery

public T instanceDiscovery(boolean val)

Históricamente, MSAL se conectaría a un punto de conexión central ubicado en ""https://login.microsoftonline.com" para adquirir algunos metadatos, especialmente cuando se usa una entidad desconocida. Este comportamiento se conoce como Detección de instancias. Este parámetro tiene como valor predeterminado true, lo que habilita la detección de instancias. Si no conoce a algunas autoridades de antemano, todavía quiere que MSAL acepte cualquier autoridad que proporcione, puede usar "False" para deshabilitar incondicionalmente la detección de instancias.

Parámetros:

val

logPii

public T logPii(boolean val)

Establezca logPii: valor booleano, que determina si Pii (información de identificación personal) se registrará. El valor predeterminado es falso.

Invalidaciones:

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

Parámetros:

val - un valor booleano para logPii

Devoluciones:

instancia del Generador en el que se llamó al método

oidcAuthority

public T oidcAuthority(String val)

Establezca una entidad conocida correspondiente a un proveedor de identidades de OpenIdConnect genérico. MSAL anexará ".well-known/openid-configuration" a la autoridad para recuperar los metadatos de OIDC y determinar los puntos de conexión.

Parámetros:

val - un valor de cadena de autoridad

Devoluciones:

instancia del Generador en el que se llamó al método

Produce:

java.net.MalformedURLException

proxy

public T proxy(Proxy val)

Establece la configuración de proxy que usará la aplicación cliente (MSAL4J de forma predeterminada usa javax.net.ssl.HttpsURLConnection) para toda la comunicación de red. Si no se pasa ningún valor de proxy, se usan las propiedades definidas por el sistema. Si el cliente HTTP se establece en la aplicación cliente (a través de ClientApplication.builder().httpClient()), la configuración del proxy debe realizarse en el objeto de cliente HTTP que se pasa y no a través de este método.

Invalidaciones:

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

Parámetros:

val - una instancia de Proxy

Devoluciones:

instancia del Generador en el que se llamó al método

readTimeoutForDefaultHttpClient

public T readTimeoutForDefaultHttpClient(Integer val)

Establece el valor de tiempo de espera de lectura usado en las conexiones HttpsURLConnection realizadas por DefaultHttpClienty no es necesario si se usa un cliente HTTP personalizado.

Invalidaciones:

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

Parámetros:

val - valor de tiempo de espera en milisegundos

Devoluciones:

instancia del Generador en el que se llamó al método

setTokenCacheAccessAspect

public T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)

Establece ITokenCacheAccessAspect que se usará para cache_data persistencia.

Parámetros:

val - una instancia de ITokenCacheAccessAspect

Devoluciones:

instancia del Generador en el que se llamó al método

sslSocketFactory

public T sslSocketFactory(SSLSocketFactory val)

Establece SSLSocketFactory que usará la aplicación cliente para toda la comunicación de red. Si el cliente HTTP se establece en la aplicación cliente (a través de ClientApplication.builder().httpClient()), se debe realizar cualquier configuración de SSL en el cliente HTTP y no a través de este método.

Invalidaciones:

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

Parámetros:

val - una instancia de SSLSocketFactory

Devoluciones:

instancia del Generador en el que se llamó al método

validateAuthority

public T validateAuthority(boolean val)

Establezca un valor booleano que indique a la aplicación si la autoridad debe comprobarse en una lista de autoridades conocidas. La autoridad solo se valida cuando: 1: es una entidad de Azure Active Directory (no B2C o ADFS) 2: los metadatos de detección de instancias no se establecen a través deAbstractClientApplicationBase#aadAadInstanceDiscoveryResponse

El valor predeterminado es true.

Parámetros:

val - un valor booleano para validateAuthority

Devoluciones:

instancia del Generador en el que se llamó al método

Se aplica a