InteractiveRequestParameters.InteractiveRequestParametersBuilder Classe

  • java.lang.Object
    • com.microsoft.aad.msal4j.InteractiveRequestParameters.InteractiveRequestParametersBuilder

public static class InteractiveRequestParameters.InteractiveRequestParametersBuilder

Resumo do método

Modificador e tipo Método e descrição
InteractiveRequestParameters build()
InteractiveRequestParametersBuilder claims(ClaimsRequest claims)

Declarações a serem solicitadas por meio do parâmetro de solicitação de declarações OIDC, permitindo solicitações para declarações padrão e personalizadas

InteractiveRequestParametersBuilder claimsChallenge(String claimsChallenge)
InteractiveRequestParametersBuilder domainHint(String domainHint)

Fornece uma dica sobre o locatário ou domínio que o usuário deve usar para entrar.

InteractiveRequestParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

Adiciona cabeçalhos adicionais à solicitação de token

InteractiveRequestParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

Adiciona parâmetros de consulta adicionais à solicitação de token

InteractiveRequestParametersBuilder httpPollingTimeoutInSeconds(int httpPollingTimeoutInSeconds)

A quantidade de tempo em segundos que a biblioteca aguardará por um resultado de autenticação.

InteractiveRequestParametersBuilder instanceAware(boolean instanceAware)

Se definido como true, o resultado da autorização conterá a autoridade para a nuvem inicial do usuário e essa autoridade será usada para a solicitação de token em vez da autoridade definida no aplicativo.

InteractiveRequestParametersBuilder loginHint(String loginHint)

Pode ser usado para preencher previamente o campo nome de usuário/endereço de email da página de entrada do usuário, se você souber o nome de usuário/endereço de email com antecedência.

InteractiveRequestParametersBuilder prompt(Prompt prompt)

Indique o tipo de interação do usuário necessário.

InteractiveRequestParametersBuilder proofOfPossession(HttpMethod httpMethod, URI uri, String nonce)

Define os Parâmetros Poppara essa solicitação, permitindo que a solicitação recupere tokens de prova de posse em vez de tokens de portador Para obter mais informações, consulte PopParameters e https://aka.ms/msal4j-pop

InteractiveRequestParametersBuilder redirectUri(@NonNull URI redirectUri)

URI de redirecionamento no qual a MSAL escutará o código de autorização retornado pelo Azure AD.

InteractiveRequestParametersBuilder scopes(Set<String> scopes)

Escopos aos quais o aplicativo está solicitando acesso e o usuário consentirá.

InteractiveRequestParametersBuilder systemBrowserOptions(SystemBrowserOptions systemBrowserOptions)

Conjuntos SystemBrowserOptions a serem usados pelo aplicativo clientepúblico

InteractiveRequestParametersBuilder tenant(String tenant)

Substitui o valor do locatário na URL de autoridade para essa solicitação

java.lang.String toString()
InteractiveRequestParametersBuilder windowHandle(long windowHandle)

O identificador de janela pai usado para abrir elementos de interface do usuário com o pai correto para cenários de navegador e aplicativos de console Windows, esse valor não deve ser definido Para Windows aplicativos de console, a MSAL Java tentará descobrir o identificador de janela do console se esse parâmetro não estiver definido para cenários em que a MSAL Java é responsável por abrir elementos de interface do usuário (como ao usar MSALRuntime), esse parâmetro é necessário e uma exceção será gerada se não for definida

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 método

build

public InteractiveRequestParameters build()

claims

public InteractiveRequestParameters.InteractiveRequestParametersBuilder claims(ClaimsRequest claims)

Declarações a serem solicitadas por meio do parâmetro de solicitação de declarações OIDC, permitindo solicitações para declarações padrão e personalizadas

Parâmetros:

claims

Retornos:

this.

claimsChallenge

public InteractiveRequestParameters.InteractiveRequestParametersBuilder claimsChallenge(String claimsChallenge)

Parâmetros:

claimsChallenge

Retornos:

this.

domainHint

public InteractiveRequestParameters.InteractiveRequestParametersBuilder domainHint(String domainHint)

Fornece uma dica sobre o locatário ou domínio que o usuário deve usar para entrar. O valor da dica de domínio é um domínio registrado para o locatário.

Parâmetros:

domainHint

Retornos:

this.

extraHttpHeaders

public InteractiveRequestParameters.InteractiveRequestParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

Adiciona cabeçalhos adicionais à solicitação de token

Parâmetros:

extraHttpHeaders

Retornos:

this.

extraQueryParameters

public InteractiveRequestParameters.InteractiveRequestParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

Adiciona parâmetros de consulta adicionais à solicitação de token

Parâmetros:

extraQueryParameters

Retornos:

this.

httpPollingTimeoutInSeconds

public InteractiveRequestParameters.InteractiveRequestParametersBuilder httpPollingTimeoutInSeconds(int httpPollingTimeoutInSeconds)

A quantidade de tempo em segundos que a biblioteca aguardará por um resultado de autenticação. 120 segundos é o tempo limite padrão, a menos que seja substituído aqui com algum outro inteiro positivo se esse tempo limite for definido como 0 ou menos, ele será ignorado e a biblioteca usará um tempo limite de 1 segundo em vez disso

Parâmetros:

httpPollingTimeoutInSeconds

Retornos:

this.

instanceAware

public InteractiveRequestParameters.InteractiveRequestParametersBuilder instanceAware(boolean instanceAware)

Se definido como true, o resultado da autorização conterá a autoridade para a nuvem inicial do usuário e essa autoridade será usada para a solicitação de token em vez da autoridade definida no aplicativo.

Parâmetros:

instanceAware

Retornos:

this.

loginHint

public InteractiveRequestParameters.InteractiveRequestParametersBuilder loginHint(String loginHint)

Pode ser usado para preencher previamente o campo nome de usuário/endereço de email da página de entrada do usuário, se você souber o nome de usuário/endereço de email com antecedência. Geralmente, os aplicativos usam esse parâmetro durante a autenticação nova, já tendo extraído o nome de usuário de uma entrada anterior usando a declaração preferred_username.

Parâmetros:

loginHint

Retornos:

this.

prompt

public InteractiveRequestParameters.InteractiveRequestParametersBuilder prompt(Prompt prompt)

Indique o tipo de interação do usuário necessário.

Parâmetros:

prompt

Retornos:

this.

proofOfPossession

public InteractiveRequestParameters.InteractiveRequestParametersBuilder proofOfPossession(HttpMethod httpMethod, URI uri, String nonce)

Define os PopParameters para essa solicitação, permitindo que a solicitação recupere tokens de prova de posse em vez de tokens de portador para obter mais informações, consulte PopParameters e https://aka.ms/msal4j-pop

Parâmetros:

httpMethod - um método HTTP válido, como "GET" ou "POST"
uri - o URI na API protegida downstream que o aplicativo está tentando acessar, por exemplo, https://graph.microsoft.com/beta/me/profile
nonce - uma cadeia de caracteres obtida chamando o recurso (por exemplo, Microsoft Graph) não autenticado e analisando o cabeçalho WWW-Authenticate associado ao esquema de autenticação pop e extraindo o parâmetro nonce ou, em chamadas subsequentes, analisando o cabeçalho Autheticate-Info e extraindo o parâmetro nextnonce.

redirectUri

public InteractiveRequestParameters.InteractiveRequestParametersBuilder redirectUri(@NonNull URI redirectUri)

URI de redirecionamento no qual a MSAL escutará o código de autorização retornado pelo Azure AD. Deve ser um endereço de loopback com uma porta especificada (por exemplo, http://localhost:3671). Se nenhuma porta for especificada, a MSAL encontrará uma porta aberta. Para obter mais informações, consulte https://aka.ms/msal4j-interactive-request.

Parâmetros:

redirectUri

Retornos:

this.

scopes

public InteractiveRequestParameters.InteractiveRequestParametersBuilder scopes(Set<String> scopes)

Escopos aos quais o aplicativo está solicitando acesso e o usuário consentirá.

Parâmetros:

scopes

Retornos:

this.

systemBrowserOptions

public InteractiveRequestParameters.InteractiveRequestParametersBuilder systemBrowserOptions(SystemBrowserOptions systemBrowserOptions)

Conjuntos SystemBrowserOptions a serem usados pelo PublicClientApplication

Parâmetros:

systemBrowserOptions

Retornos:

this.

tenant

public InteractiveRequestParameters.InteractiveRequestParametersBuilder tenant(String tenant)

Substitui o valor do locatário na URL de autoridade para essa solicitação

Parâmetros:

tenant

Retornos:

this.

toString

public String toString()

Substituições:

InteractiveRequestParameters.InteractiveRequestParametersBuilder.toString()

windowHandle

public InteractiveRequestParameters.InteractiveRequestParametersBuilder windowHandle(long windowHandle)

O identificador de janela pai usado para abrir elementos de interface do usuário com o pai correto para cenários de navegador e aplicativos de console Windows, esse valor não deve ser definido Para Windows aplicativos de console, a MSAL Java tentará descobrir o identificador de janela do console se esse parâmetro não estiver definido para cenários em que a MSAL Java é responsável por abrir elementos de interface do usuário (como ao usar MSALRuntime), esse parâmetro é necessário e uma exceção será gerada se não for definida

Parâmetros:

windowHandle

Retornos:

this.

Aplica-se a