AbstractClientApplicationBase.Builder<T> Classe

Parâmetros de tipo

T

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

Resumo do campo

Modificador e tipo Campo e descrição
protected boolean isInstanceDiscoveryEnabled

Resumo do Construtor

Construtor Description
Builder(String clientId)

Construtor para criar uma instância do Construtor do aplicativo cliente

Resumo do método

Modificador e tipo Método e descrição
T aadInstanceDiscoveryResponse(String val)

Define dados de resposta de descoberta de instância que serão usados para determinar o ponto de extremidade de descoberta de locatário e os aliases de autoridade.

T applicationName(String val)

Define o nome do aplicativo para fins de telemetria

T applicationVersion(String val)

Define a versão do aplicativo para fins de telemetria

T authority(String val)

Defina a URL da autoridade de autenticação ou do STS (serviço de token de segurança) do qual a MSAL adquirirá tokens de segurança.

T autoDetectRegion(boolean val)

Indica que a biblioteca deve tentar descobrir a região Azure em que o aplicativo está sendo executado ao buscar os metadados de descoberta da instância.

T azureRegion(String val)

Defina a região que a biblioteca usará para formatar autoridades em solicitações de token.

T b2cAuthority(String val)

Defina a URL da autoridade B2C de autenticação da qual a MSAL adquirirá tokens que as autoridades B2C válidas devem ter a aparência: https://< alfação.b2clogin.com/<tenant>/<policy> MSAL Java também dá suporte a um formato de autoridade B2C herdado, que se parece com: https://< host>/tfp/tenant>/<<policy> No entanto, Java MSAL acabarão por parar de dar suporte ao formato herdado.

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

Define o valor de tempo limite de conexão usado em conexões de URLConnection httpsfeitas por DefaultHttpClient, e não é necessário se estiver usando um cliente HTTP personalizado

T correlationId(String val)

Defina a ID de correlação opcional a ser usada pela API.

T executorService(ExecutorService val)

Define o Serviço executora ser usado para executar as solicitações.

T httpClient(IHttpClient val)

Define o cliente HTTP a ser usado pelo aplicativo cliente para todas as solicitações HTTP.

T instanceDiscovery(boolean val)

Historicamente, a MSAL se conectaria a um ponto de extremidade central localizado em ''https://login.microsoftonline.com'' para adquirir alguns metadados, especialmente ao usar uma autoridade desconhecida.

T logPii(boolean val)

Defina o pii de log– valor booliano, que determina se o Pii (informações de identificação pessoal) será conectado.

T oidcAuthority(String val)

Defina uma autoridade conhecida correspondente a um Provedor de Identidade OpenIdConnect genérico.

T proxy(Proxy val)

Define a configuração de proxy a ser usada pelo aplicativo cliente (MSAL4J por padrão usa javax.net.ssl.HttpsURLConnection) para toda a comunicação de rede.

T readTimeoutForDefaultHttpClient(Integer val)

Define o valor de tempo limite de leitura usado em conexões de URLConnection httpsfeitas por DefaultHttpClient, e não é necessário se estiver usando um cliente HTTP personalizado

T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)

Define o Aspecto de Acessoao CacheITokena ser usado para cache_data persistência.

T sslSocketFactory(SSLSocketFactory val)

Define o SSLSocketFactory a ser usado pelo aplicativo cliente para toda a comunicação de rede.

T validateAuthority(boolean val)

Defina um valor booliano informando ao aplicativo se a autoridade precisa ser verificada em uma lista de autoridades conhecidas.

Métodos herdados de Builder

Métodos herdados 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

Detalhes do campo

isInstanceDiscoveryEnabled

protected boolean isInstanceDiscoveryEnabled

Detalhes do construtor

Builder

public Builder(String clientId)

Construtor para criar uma instância do Construtor do aplicativo cliente

Parâmetros:

clientId - ID do cliente (ID do aplicativo) do aplicativo, conforme registrado no portal de registro do aplicativo (portal.azure.com)

Detalhes do método

aadInstanceDiscoveryResponse

public T aadInstanceDiscoveryResponse(String val)

Define dados de resposta de descoberta de instância que serão usados para determinar o ponto de extremidade de descoberta de locatário e os aliases de autoridade.

Observe que a validação de autoridade não é feita mesmo se AbstractClientApplicationBase#validateAuthority for definida como true.

Para obter mais informações, veja https://aka.ms/msal4j-instance-discovery

Parâmetros:

val - Valor formatado JSON da resposta do ponto de extremidade de descoberta de instância do AAD

Retornos:

instância do Construtor no qual o método foi chamado

applicationName

public T applicationName(String val)

Define o nome do aplicativo para fins de telemetria

Parâmetros:

val - nome do aplicativo

Retornos:

instância do Construtor no qual o método foi chamado

applicationVersion

public T applicationVersion(String val)

Define a versão do aplicativo para fins de telemetria

Parâmetros:

val - versão do aplicativo

Retornos:

instância do Construtor no qual o método foi chamado

authority

public T authority(String val)

Defina a URL da autoridade de autenticação ou do STS (serviço de token de segurança) do qual a MSAL adquirirá tokens de segurança. O valor padrão é AbstractClientApplicationBase#DEFAULT_AUTHORITY

Parâmetros:

val - um valor de cadeia de caracteres de autoridade

Retornos:

instância do Construtor no qual o método foi chamado

Gera:

java.net.MalformedURLException - se val for URL malformada

autoDetectRegion

public T autoDetectRegion(boolean val)

Indica que a biblioteca deve tentar descobrir a região Azure em que o aplicativo está sendo executado ao buscar os metadados de descoberta da instância. As regiões só podem ser detectadas ao serem executadas em um ambiente Azure, como uma VM Azure ou outro serviço, ou se o ambiente tiver uma variável de ambiente chamada REGION_NAME configurada. Embora você possa habilitar a autodeteção aqui e uma região específica ao AbstractClientApplicationBase#azureRegion mesmo tempo, a região definida com AbstractClientApplicationBase#azureRegion terá prioridade se houver uma incompatibilidade. Veja aqui mais informações sobre cenários com suporte: https://aka.ms/msal4j-azure-regions

Parâmetros:

val - booliano (o padrão é false)

Retornos:

instância do Construtor no qual o método foi chamado

azureRegion

public T azureRegion(String val)

Defina a região que a biblioteca usará para formatar autoridades em solicitações de token. Se for dada uma região de Azure válida, a biblioteca tentará fazer solicitações de token em um ponto de extremidade de ESTS-R regional em vez do ponto de extremidade ESTS global. As regiões devem ser válidas Azure regiões e seus nomes curtos devem ser usados, como 'westus' para a região Azure Oeste dos EUA, 'centralus' para a região central dos EUA Azure etc. Embora você possa definir uma região específica aqui e habilitar a detecção automática ao AbstractClientApplicationBase#autoDetectRegion mesmo tempo, a região específica definida aqui terá prioridade sobre a região detectada automaticamente se houver uma incompatibilidade. Veja aqui mais informações sobre cenários com suporte: https://aka.ms/msal4j-azure-regions

Parâmetros:

val - Nome da região da cadeia de caracteres

Retornos:

instância do Construtor no qual o método foi chamado

b2cAuthority

public T b2cAuthority(String val)

Defina a URL da autoridade de autenticação B2C da qual a MSAL adquirirá tokens que as autoridades B2C válidas devem ter a aparência: https://< something.b2clogin.com/< tenant>/<policy> msal Java também dá suporte a um formato de autoridade B2C herdado, que se parece com: https://< host>/tfp/tenant>/<<policy> No entanto, Java MSAL acabará por parar de dar suporte ao formato herdado. Confira aqui informações sobre como migrar para o novo formato: https://aka.ms/msal4j-b2c

Parâmetros:

val - um valor booliano para validateAuthority

Retornos:

instância do Construtor no qual o método foi chamado

Gera:

java.net.MalformedURLException

clientCapabilities

public T clientCapabilities(Set<String> capabilities)

Parâmetros:

capabilities

connectTimeoutForDefaultHttpClient

public T connectTimeoutForDefaultHttpClient(Integer val)

Define o valor de tempo limite de conexão usado em conexões HttpsURLConnection feitas por DefaultHttpClient, e não é necessário se estiver usando um cliente HTTP personalizado

Substituições:

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

Parâmetros:

val - valor de tempo limite em milissegundos

Retornos:

instância do Construtor no qual o método foi chamado

correlationId

public T correlationId(String val)

Defina a ID de correlação opcional a ser usada pela API. Se não for fornecido, a API gerará uma UUID aleatória.

Substituições:

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

Parâmetros:

val - um valor de cadeia de caracteres da ID de correlação

Retornos:

instância do Construtor no qual o método foi chamado

executorService

public T executorService(ExecutorService val)

Define ExecutorService a ser usado para executar as solicitações. O desenvolvedor é responsável por manter o ciclo de vida do ExecutorService.

Substituições:

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

Parâmetros:

val - uma instância do ExecutorService

Retornos:

instância do Construtor no qual o método foi chamado

httpClient

public T httpClient(IHttpClient val)

Define o cliente HTTP a ser usado pelo aplicativo cliente para todas as solicitações HTTP. Permite a configuração refinada do cliente HTTP.

Substituições:

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

Parâmetros:

val - Implementação de IHttpClient

Retornos:

instância do Construtor no qual o método foi chamado

instanceDiscovery

public T instanceDiscovery(boolean val)

Historicamente, a MSAL se conectaria a um ponto de extremidade central localizado em ''https://login.microsoftonline.com'' para adquirir alguns metadados, especialmente ao usar uma autoridade desconhecida. Esse comportamento é conhecido como Descoberta de Instância. Esse parâmetro usa como padrão true, o que habilita a Descoberta de Instância. Se você não conhece algumas autoridades de antemão, ainda quer que a MSAL aceite qualquer autoridade que você fornecerá, você pode usar um ''False'' para desabilitar incondicionalmente a Descoberta de Instância.

Parâmetros:

val

logPii

public T logPii(boolean val)

Defina logPii – valor booliano, que determina se o Pii (informações de identificação pessoal) será conectado. O valor padrão é falso.

Substituições:

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

Parâmetros:

val - um valor booliano para logPii

Retornos:

instância do Construtor no qual o método foi chamado

oidcAuthority

public T oidcAuthority(String val)

Defina uma autoridade conhecida correspondente a um Provedor de Identidade OpenIdConnect genérico. A MSAL acrescentará ".well-known/openid-configuration" à autoridade para recuperar os metadados do OIDC e determinar os pontos de extremidade.

Parâmetros:

val - um valor de cadeia de caracteres de autoridade

Retornos:

instância do Construtor no qual o método foi chamado

Gera:

java.net.MalformedURLException

proxy

public T proxy(Proxy val)

Define a configuração de proxy a ser usada pelo aplicativo cliente (MSAL4J por padrão usa javax.net.ssl.HttpsURLConnection) para toda a comunicação de rede. Se nenhum valor de proxy for passado, as propriedades definidas pelo sistema serão usadas. Se o cliente HTTP estiver definido no aplicativo cliente (via ClientApplication.builder().httpClient()), a configuração de proxy deverá ser feita no objeto cliente HTTP que está sendo passado e não por esse método.

Substituições:

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

Parâmetros:

val - uma instância do Proxy

Retornos:

instância do Construtor no qual o método foi chamado

readTimeoutForDefaultHttpClient

public T readTimeoutForDefaultHttpClient(Integer val)

Define o valor de tempo limite de leitura usado em conexões HttpsURLConnection feitas por DefaultHttpClient, e não é necessário se estiver usando um cliente HTTP personalizado

Substituições:

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

Parâmetros:

val - valor de tempo limite em milissegundos

Retornos:

instância do Construtor no qual o método foi chamado

setTokenCacheAccessAspect

public T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)

Define ITokenCacheAccessAspect a ser usado para cache_data persistência.

Parâmetros:

val - uma instância de ITokenCacheAccessAspect

Retornos:

instância do Construtor no qual o método foi chamado

sslSocketFactory

public T sslSocketFactory(SSLSocketFactory val)

Define SSLSocketFactory a ser usado pelo aplicativo cliente para toda a comunicação de rede. Se o cliente HTTP estiver definido no aplicativo cliente (via ClientApplication.builder().httpClient()), qualquer configuração de SSL deverá ser feita no cliente HTTP e não por meio desse método.

Substituições:

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

Parâmetros:

val - uma instância de SSLSocketFactory

Retornos:

instância do Construtor no qual o método foi chamado

validateAuthority

public T validateAuthority(boolean val)

Defina um valor booliano informando ao aplicativo se a autoridade precisa ser verificada em uma lista de autoridades conhecidas. A autoridade só é validada quando: 1 – É uma autoridade de Azure Active Directory (não B2C ou ADFS) 2 – metadados de descoberta de instância não são definidos por meio deAbstractClientApplicationBase#aadAadInstanceDiscoveryResponse

O valor padrão é true.

Parâmetros:

val - um valor booliano para validateAuthority

Retornos:

instância do Construtor no qual o método foi chamado

Aplica-se a