AbstractClientApplicationBase.Builder<T> Classe
- java.
lang. Object - com.
microsoft. aad. msal4j. AbstractApplicationBase. Builder<T> - com.
microsoft. aad. msal4j. AbstractClientApplicationBase. Builder<T>
- com.
- com.
Parâmetros de Tipo Genérico
- 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 | Descrição |
|---|---|
| Builder(String clientId) |
Construtor para criar a instância do Builder da aplicação cliente |
Resumo do Método
| Modificador e Tipo | Método e Descrição |
|---|---|
| T |
aadInstanceDiscoveryResponse(String val)
Define dados de resposta à descoberta de instâncias que serão usados para determinar os nomes de endpoint de descoberta de inquilin e de autoridade. |
| T |
applicationName(String val)
Define o nome da aplicação para fins de telemetria |
| T |
applicationVersion(String val)
Configuração da aplicação para fins de telemetria |
| T |
authority(String val)
Defina o URL da autoridade de autenticação ou do serviço de token de segurança (STS) do qual a MSAL irá adquirir tokens de segurança. |
| T |
autoDetectRegion(boolean val)
Indica que a biblioteca deve tentar descobrir a região do Azure onde a aplicação está a correr ao buscar os metadados de descoberta da instância. |
| T |
azureRegion(String val)
Defina a região que a biblioteca irá usar para formatar as autoridades nos pedidos de token. |
| T |
b2cAuthority(String val)
Defina o URL da autoridade B2C de autenticação da qual a MSAL irá adquirir tokens As autoridades B2C válidas devem parecer-se: https://< algo. |
| T | clientCapabilities(Set<String> capabilities) |
| T |
connectTimeoutForDefaultHttpClient(Integer val)
Define o valor de timeout de ligação usado nas ligações Https |
| T |
correlationId(String val)
Defina o id de correlação opcional para ser usado pela API. |
| T |
executorService(ExecutorService val)
Define o Executor |
| T |
httpClient(IHttpClient val)
Define o cliente HTTP para ser usado pela aplicação cliente para todos os pedidos HTTP. |
| T |
instanceDiscovery(boolean val)
Historicamente, o MSAL ligava-se a um endpoint central localizado em ''https://login. |
| T |
logPii(boolean val)
Defina o log |
| T |
oidcAuthority(String val)
Defina uma autoridade conhecida correspondente a um Fornecedor de Identidade Open |
| T |
proxy(Proxy val)
Define a configuração Proxy para ser usada pela aplicação cliente (MSAL4J por defeito usa javax.net.ssl.HttpsURLConnection) para toda a comunicação de rede. |
| T |
readTimeoutForDefaultHttpClient(Integer val)
Define o valor de timeout de leitura usado nas ligações Https |
| T |
setTokenCacheAccessAspect(ITokenCacheAccessAspect val)
Define o Aspecto de Acesso |
| T |
sslSocketFactory(SSLSocketFactory val)
Define o SSLSocket |
| T |
validateAuthority(boolean val)
Defina um valor booleano a informar a candidatura se a autoridade precisa de ser verificada com uma lista de autoridades conhecidas. |
Métodos herdados de Builder
Métodos herdados de java.lang.Object
Detalhes do Campo
isInstanceDiscoveryEnabled
protected boolean isInstanceDiscoveryEnabled
Detalhes do Construtor
Builder
public Builder(String clientId)
Construtor para criar a instância do Builder da aplicação cliente
Parâmetros:
Detalhes de Método
aadInstanceDiscoveryResponse
public T aadInstanceDiscoveryResponse(String val)
Define dados de resposta à descoberta de instâncias que serão usados para determinar os nomes de endpoint de descoberta de inquilin e de autoridade.
Note que a validação da autoridade não é feita mesmo que AbstractClientApplicationBase#validateAuthority seja definida como verdadeira.
Para mais informações, consulte https://aka.ms/msal4j-instance-discovery
Parâmetros:
Devoluções:
applicationName
public T applicationName(String val)
Define o nome da aplicação para fins de telemetria
Parâmetros:
Devoluções:
applicationVersion
public T applicationVersion(String val)
Configuração da aplicação para fins de telemetria
Parâmetros:
Devoluções:
authority
public T authority(String val)
Defina o URL da autoridade de autenticação ou do serviço de token de segurança (STS) do qual a MSAL irá adquirir tokens de segurança. O valor predefinido é AbstractClientApplicationBase#DEFAULT_AUTHORITY
Parâmetros:
Devoluções:
Lançamentos:
autoDetectRegion
public T autoDetectRegion(boolean val)
Indica que a biblioteca deve tentar descobrir a região do Azure onde a aplicação está a correr ao buscar os metadados de descoberta da instância. As regiões só podem ser detetadas quando a correr num 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 possas ativar tanto a autodeteção aqui como 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 para mais informações sobre cenários suportados: https://aka.ms/msal4j-azure-regions
Parâmetros:
Devoluções:
azureRegion
public T azureRegion(String val)
Defina a região que a biblioteca irá usar para formatar as autoridades nos pedidos de token. Se for dada uma região Azure válida, a biblioteca tentará fazer pedidos de token num endpoint regional ESTS-R em vez do endpoint global ESTS. As regiões devem ser regiões válidas do Azure e os seus nomes curtos devem ser usados, como 'westus' para a região do Azure do Oeste dos EUA, 'centralus' para a região do Azure Central dos EUA, etc. Embora possas definir uma região específica aqui e ativar a autodeteção, mas AbstractClientApplicationBase#autoDetectRegion ao mesmo tempo a região específica definida aqui terá prioridade sobre a região autodetetada se houver uma incompatibilidade. Veja aqui para mais informações sobre cenários suportados: https://aka.ms/msal4j-azure-regions
Parâmetros:
Devoluções:
b2cAuthority
public T b2cAuthority(String val)
Definir URL da autoridade B2C de autenticação da qual a MSAL irá adquirir tokens As autoridades B2C válidas devem parecer-se: https://< something.b2clogin.com/< inquilino>/<política> A MSAL Java também suporta um formato legado de autoridade B2C, que se apresenta como: https://< host>/tfp/<tenant>/<policy> No entanto, a MSAL Java eventualmente deixará de suportar o formato legado. Veja aqui informações sobre como migrar para o novo formato: https://aka.ms/msal4j-b2c
Parâmetros:
Devoluções:
Lançamentos:
clientCapabilities
public T clientCapabilities(Set<String> capabilities)
Parâmetros:
connectTimeoutForDefaultHttpClient
public T connectTimeoutForDefaultHttpClient(Integer val)
Define o valor de timeout de ligação usado nas ligações HttpsURLConnection feitas por DefaultHttpClient, e não é necessário se estiver a usar um cliente HTTP personalizado
Substituições:
AbstractClientApplicationBase.Builder<T>.connectTimeoutForDefaultHttpClient(Integer val)Parâmetros:
Devoluções:
correlationId
public T correlationId(String val)
Defina o id de correlação opcional para ser usado pela API. Se não for fornecida, a API gera um UUID aleatório.
Substituições:
AbstractClientApplicationBase.Builder<T>.correlationId(String val)Parâmetros:
Devoluções:
executorService
public T executorService(ExecutorService val)
Define o ExecutorService para executar os pedidos. O programador é responsável por manter o ciclo de vida do ExecutorService.
Substituições:
AbstractClientApplicationBase.Builder<T>.executorService(ExecutorService val)Parâmetros:
Devoluções:
httpClient
public T httpClient(IHttpClient val)
Define o cliente HTTP para ser usado pela aplicação cliente para todos os pedidos HTTP. Permite uma configuração detalhada do cliente HTTP.
Substituições:
AbstractClientApplicationBase.Builder<T>.httpClient(IHttpClient val)Parâmetros:
Devoluções:
instanceDiscovery
public T instanceDiscovery(boolean val)
Historicamente, a MSAL ligava-se a um ponto final central localizado em ''https://login.microsoftonline.com'' para adquirir alguns metadados, especialmente quando utilizava uma autoridade desconhecida. Este comportamento é conhecido como Descoberta de Instâncias. Este parâmetro é predefinido para verdadeiro, o que permite a Descoberta de Instâncias. Se não conhece algumas autoridades antecipadamente, mas ainda assim quiser que a MSAL aceite qualquer autoridade que vá fornecer, pode usar um ''Falso'' para desativar incondicionalmente a Descoberta de Instâncias.
Parâmetros:
logPii
public T logPii(boolean val)
Defina logPii - valor booleano, que determina se Pii (informação pessoalmente identificável) será iniciada. O valor predefinido é false.
Substituições:
AbstractClientApplicationBase.Builder<T>.logPii(boolean val)Parâmetros:
Devoluções:
oidcAuthority
public T oidcAuthority(String val)
Defina uma autoridade conhecida correspondente a um Fornecedor de Identidade OpenIdConnect genérico. O MSAL irá acrescentar ".well-known/openid-configuration" à autoridade para recuperar os metadados do OIDC e determinar os endpoints.
Parâmetros:
Devoluções:
Lançamentos:
proxy
public T proxy(Proxy val)
Define a configuração Proxy para ser usada pela aplicação cliente (MSAL4J por defeito usa javax.net.ssl.HttpsURLConnection) para toda a comunicação de rede. Se não for passado nenhum valor de proxy, são usadas propriedades definidas pelo sistema. Se o cliente HTTP estiver definido na aplicação cliente (via ClientApplication.builder().httpClient()), a configuração do proxy deve ser feita no objeto cliente HTTP que está a ser passado, e não através deste método.
Substituições:
AbstractClientApplicationBase.Builder<T>.proxy(Proxy val)Parâmetros:
Devoluções:
readTimeoutForDefaultHttpClient
public T readTimeoutForDefaultHttpClient(Integer val)
Define o valor de tempo de leitura usado nas ligações HttpsURLConnection feitas por DefaultHttpClient, e não é necessário se estiver a usar um cliente HTTP personalizado
Substituições:
AbstractClientApplicationBase.Builder<T>.readTimeoutForDefaultHttpClient(Integer val)Parâmetros:
Devoluções:
setTokenCacheAccessAspect
public T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)
Define o ITokenCacheAccessAspect para ser usado para persistência cache_data.
Parâmetros:
Devoluções:
sslSocketFactory
public T sslSocketFactory(SSLSocketFactory val)
Define o SSLSocketFactory para ser usado pela aplicação cliente para toda a comunicação em rede. Se o cliente HTTP estiver definido na aplicação cliente (via ClientApplication.builder().httpClient()), qualquer configuração de SSL deve ser feita no cliente HTTP e não através deste método.
Substituições:
AbstractClientApplicationBase.Builder<T>.sslSocketFactory(SSLSocketFactory val)Parâmetros:
Devoluções:
validateAuthority
public T validateAuthority(boolean val)
Defina um valor booleano a informar a candidatura se a autoridade precisa de ser verificada com uma lista de autoridades conhecidas. A autoridade só é validada quando: 1 - É uma autoridade do Azure Active Directory (não B2C ou ADFS) 2 - Metadados de descoberta de instância não são definidos viaAbstractClientApplicationBase#aadAadInstanceDiscoveryResponse
O valor predefinido é true.
Parâmetros:
Devoluções: