As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
Esta seção lista os SDK objetos, as operações e as configurações da versão mais recente disponível do AWS WAF celularSDK. Para obter informações detalhadas sobre como o provedor de token e as operações funcionam para as várias combinações de configurações, consulte Como o SDK móvel do AWS WAF funciona.
WAFToken
-
Guarda uma AWS WAF ficha.
getValue()
-
Recupera a representação
String
deWAFToken
.
WAFTokenProvider
-
Gerencia tokens em seu aplicativo móvel. Implemente isso usando um objeto
WAFConfiguration
.getToken()
-
Se a atualização em segundo plano estiver ativada, isso retornará o token em cache. Se a atualização em segundo plano estiver desativada, isso fará uma chamada síncrona e bloqueadora AWS WAF para recuperar um novo token.
loadTokenIntoProvider(WAFToken)
-
Carrega o token especificado no
WAFTokenProvider
, substituindo qualquer token que o provedor estava gerenciando. O provedor do token assume a propriedade do novo token e se encarrega de atualizá-lo daqui para frente. Essa operação também atualiza o token no armazenamento de cookies, sesetTokenCookie
estiver habilitada noWAFConfiguration
. onTokenReady(WAFTokenResultCallback)
-
Instrui o provedor de token a atualizar o token e invocar o retorno de chamada fornecido quando um token ativo estiver pronto. O provedor do token invocará seu retorno de chamada em um thread em segundo plano quando o token estiver armazenado em cache e pronto. Chame isso quando seu aplicativo for carregado pela primeira vez e também quando ele voltar ao estado ativo. Para obter mais informações sobre como retornar a um estado ativo, consulte Recuperação de um token após a inatividade do aplicativo.
Para aplicativos Android ou iOS, você pode definir
WAFTokenResultCallback
para a operação que deseja que o provedor de token invoque quando um token solicitado estiver pronto. Sua implementação doWAFTokenResultCallback
deve seguir os parâmetrosWAFToken
,SdkError
. Para aplicativos iOS, você pode criar alternadamente uma função embutida. storeTokenInCookieStorage(WAFToken)
-
Instrui o
WAFTokenProvider
a armazenar o AWS WAF token especificado no gerenciador SDK de cookies do. Por padrão, o token só é adicionado ao armazenamento de cookies quando é adquirido pela primeira vez e quando é atualizado. Se o aplicativo limpar o armazenamento de cookies compartilhado por qualquer motivo, SDK ele não adicionará automaticamente o AWS WAF token de volta até a próxima atualização.
WAFConfiguration
-
Mantém a configuração para a implementação do
WAFTokenProvider
. Ao implementar isso, você fornece a integração ACL da webURL, o nome de domínio a ser usado no token e todas as configurações não padrão que você deseja que o provedor de token use.A lista a seguir especifica as configurações que você pode gerenciar no objeto
WAFConfiguration
.applicationIntegrationUrl
-
A integração do aplicativoURL. Obtenha isso no AWS WAF console ou por meio da
getWebACL
API chamada.Obrigatório: sim
Tipo: específico do aplicativoURL. Para iOS, consulte iOS URL
. Para Android, consulte java.net. URL backgroundRefreshEnabled
Indica se você deseja que o provedor de token atualize o token em segundo plano. Se você definir isso, o provedor de token atualizará seus tokens em segundo plano de acordo com as configurações que regem as atividades de atualização automática de tokens.
Obrigatório: não
Tipo:
Boolean
Valor padrão:
TRUE
domainName
-
O domínio a ser usado no token, que é usado na aquisição e armazenamento de cookies. Por exemplo, o
example.com
ou oaws.amazon.com
. Geralmente, esse é o domínio do host do seu recurso associado à WebACL, para o qual você enviará solicitações da Web. Para o grupo de regras ACFP gerenciadasAWSManagedRulesACFPRuleSet
, geralmente será um único domínio que corresponde ao domínio no caminho de criação da conta que você forneceu na configuração do grupo de regras. Para o grupo de regras ATP gerenciadasAWSManagedRulesATPRuleSet
, geralmente será um único domínio que corresponde ao domínio no caminho de login que você forneceu na configuração do grupo de regras.Não são permitidos sufixos públicos. Por exemplo, você não pode usar
gov.au
ouco.uk
como domínio do token.O domínio deve ser aceito, com base no domínio do host protegido e na lista de domínios ACL de tokens da web. AWS WAF Para obter mais informações, consulte Configuração da lista de domínios de tokens da ACL da Web no AWS WAF.
Obrigatório: sim
Tipo:
String
maxErrorTokenRefreshDelayMsec
-
O tempo máximo em milissegundos a se esperar antes de repetir uma atualização de token após uma tentativa malsucedida. Esse valor é usado depois que a recuperação do token falhou e foi repetida
maxRetryCount
vezes.Obrigatório: não
Tipo:
Integer
Valor padrão:
5000
(5 segundos)Valor mínimo permitido:
1
(1 milissegundo)Valor máximo permitido:
30000
(30 segundos) maxRetryCount
-
O número máximo de novas tentativas a serem executadas com recuo exponencial quando um token é solicitado.
Obrigatório: não
Tipo:
Integer
Valor padrão: se a atualização em segundo plano estiver ativada,
5
. Caso contrário,3
.Valor mínimo permitido:
0
Valor máximo permitido:
10
setTokenCookie
Indica se você deseja que SDK o gerenciador de cookies adicione um cookie simbólico às solicitações e em outras áreas.
Com um
TRUE
valor:O gerenciador de cookies adiciona um cookie de token a todas as solicitações cujo caminho está abaixo do caminho especificado em
tokenCookiePath
.A
WAFTokenProvider
operaçãoloadTokenIntoProvider()
atualiza o token no armazenamento de cookies, além de carregá-lo no provedor do token.
Obrigatório: não
Tipo:
Boolean
Valor padrão:
TRUE
tokenCookiePath
-
Usado quando
setTokenCookie
éTRUE
. Indica o caminho de nível superior em que você deseja que SDK o gerenciador de cookies adicione um cookie de token. O gerente adiciona um cookie de token a todas as solicitações que você envia para esse caminho e para todos os caminhos secundários.Por exemplo, se você definir isso como
/web/login
, o gerenciador incluirá o cookie de token para tudo o que é enviado para/web/login
e para qualquer um de seus caminhos secundários, como/web/login/help
. Ele não inclui o token para solicitações enviadas para outros caminhos, como/
,/web
ou/web/order
.Obrigatório: não
Tipo:
String
Valor padrão:
/
tokenRefreshDelaySec
-
Usado para atualização em segundo plano. O tempo máximo em segundos entre as atualizações do token em segundo plano.
Obrigatório: não
Tipo:
Integer
Valor padrão:
88
Valor mínimo permitido:
88
Valor máximo permitido:
300
(5 minutos)