AbstractClientApplicationBase.Builder<T> Classe

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.B2clogin.com/tenant/policy Java MSAL também suporta um formato de autoridade B2C legado, que se apresenta como: https://< host>/tfp/<tenant>/<policy> No entanto, o MSAL Java eventualmente deixará de suportar o formato legado.><><

T clientCapabilities(Set<String> capabilities)
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

T correlationId(String val)

Defina o id de correlação opcional para ser usado pela API.

T executorService(ExecutorService val)

Define o ExecutorService para executar os pedidos.

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.microsoftonline.com" para adquirir alguns metadados, especialmente quando se usa uma autoridade desconhecida.

T logPii(boolean val)

Defina o logPii - valor booleano, que determina se o Pii (informação pessoalmente identificável) será iniciado em sessão.

T oidcAuthority(String val)

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

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 HttpsURLConnection feitas por DefaultHttpClient, e não é necessário se estiver a usar um cliente HTTP personalizado

T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)

Define o Aspecto de Acessoà CacheITokenpara ser usado para persistência cache_data.

T sslSocketFactory(SSLSocketFactory val)

Define o SSLSocketFactory para ser usado pela aplicação cliente para toda a comunicação em rede.

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

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 a instância do Builder da aplicação cliente

Parâmetros:

clientId - ID do cliente (ID da candidatura) da candidatura registado no portal de registo da candidatura (portal.azure.com)

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:

val - Valor de resposta formatado em JSON a partir do endpoint de descoberta de instâncias AAD

Devoluções:

instância do Construtor em que o método foi chamado

applicationName

public T applicationName(String val)

Define o nome da aplicação para fins de telemetria

Parâmetros:

val - Nome da aplicação

Devoluções:

instância do Construtor em que o método foi chamado

applicationVersion

public T applicationVersion(String val)

Configuração da aplicação para fins de telemetria

Parâmetros:

val - Versão da aplicação

Devoluções:

instância do Construtor em que o método foi chamado

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:

val - um valor de cadeia de autoridade

Devoluções:

instância do Construtor em que o método foi chamado

Lançamentos:

java.net.MalformedURLException - se val for um URL malformado

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:

val - Booleano (o padrão é falso)

Devoluções:

instância do Construtor em que o método foi chamado

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:

val - Nome da região da corda

Devoluções:

instância do Construtor em que o método foi chamado

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:

val - um valor booleano para validateAuthority

Devoluções:

instância do Construtor em que o método foi chamado

Lançamentos:

java.net.MalformedURLException

clientCapabilities

public T clientCapabilities(Set<String> capabilities)

Parâmetros:

capabilities

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:

val - Valor de timeout em milissegundos

Devoluções:

instância do Construtor em que o método foi chamado

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:

val - Um valor de cadeia de ID de correlação

Devoluções:

instância do Construtor em que o método foi chamado

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:

val - uma instância do ExecutorService

Devoluções:

instância do Construtor em que o método foi chamado

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:

val - Implementação de IHttpClient

Devoluções:

instância do Construtor em que o método foi chamado

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:

val

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:

val - um valor booleano para logPii

Devoluções:

instância do Construtor em que o método foi chamado

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:

val - um valor de cadeia de autoridade

Devoluções:

instância do Construtor em que o método foi chamado

Lançamentos:

java.net.MalformedURLException

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:

val - uma instância de Proxy

Devoluções:

instância do Construtor em que o método foi chamado

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:

val - Valor de timeout em milissegundos

Devoluções:

instância do Construtor em que o método foi chamado

setTokenCacheAccessAspect

public T setTokenCacheAccessAspect(ITokenCacheAccessAspect val)

Define o ITokenCacheAccessAspect para ser usado para persistência cache_data.

Parâmetros:

val - uma instância de ITokenCacheAccessAspect

Devoluções:

instância do Construtor em que o método foi chamado

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:

val - uma instância de SSLSocketFactory

Devoluções:

instância do Construtor em que o método foi chamado

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:

val - um valor booleano para validateAuthority

Devoluções:

instância do Construtor em que o método foi chamado

Aplica-se a