## Uses of Class
org.apache.hadoop.security.token.Token

- Packages that use Token
  Package | Description
  --- | ---
  org.apache.hadoop.crypto.key | Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
  org.apache.hadoop.crypto.key.kms |
  org.apache.hadoop.fs | An abstract file system API.
  org.apache.hadoop.fs.viewfs | ViewFileSystem and ViewFileSystemOverloadScheme classes.
  org.apache.hadoop.security |
  org.apache.hadoop.security.token |
  org.apache.hadoop.security.token.delegation |
  org.apache.hadoop.security.token.delegation.web |

- - ### Uses of Token in org.apache.hadoop.crypto.key

    Methods in org.apache.hadoop.crypto.key that return Token
    Modifier and Type | Method and Description
    --- | ---
    `Token<?>` | KeyProviderDelegationTokenExtension.`getDelegationToken(String renewer)`

    Methods in org.apache.hadoop.crypto.key with parameters of type Token
    Modifier and Type | Method and Description
    --- | ---
    `Void` | KeyProviderDelegationTokenExtension.DelegationTokenExtension.`cancelDelegationToken(Token<?> token)` Cancels the given token.
    `long` | KeyProviderDelegationTokenExtension.DelegationTokenExtension.`renewDelegationToken(Token<?> token)` Renews the given token.

  - ### Uses of Token in org.apache.hadoop.crypto.key.kms

    Methods in org.apache.hadoop.crypto.key.kms that return Token
    Modifier and Type | Method and Description
    --- | ---
    `Token<?>` | LoadBalancingKMSClientProvider.`getDelegationToken(String renewer)`
    `Token<? extends TokenIdentifier>` | LoadBalancingKMSClientProvider.`selectDelegationToken(Credentials creds)`

    Methods in org.apache.hadoop.crypto.key.kms with parameters of type Token
    Modifier and Type | Method and Description
    --- | ---
    `void` | KMSClientProvider.KMSTokenRenewer.`cancel(Token<?> token, Configuration conf)`
    `Void` | LoadBalancingKMSClientProvider.`cancelDelegationToken(Token<?> token)`
    `boolean` | KMSClientProvider.KMSTokenRenewer.`isManaged(Token<?> token)`
    `long` | KMSClientProvider.KMSTokenRenewer.`renew(Token<?> token, Configuration conf)`
    `long` | LoadBalancingKMSClientProvider.`renewDelegationToken(Token<?> token)`

  - ### Uses of Token in org.apache.hadoop.fs

    Methods in org.apache.hadoop.fs that return Token
    Modifier and Type | Method and Description
    --- | ---
    `Token<?>` | DelegationTokenRenewer.Renewable.`getRenewToken()`

    Methods in org.apache.hadoop.fs with parameters of type Token
    Modifier and Type | Method and Description
    --- | ---
    `<T extends TokenIdentifier> void` | DelegationTokenRenewer.Renewable.`setDelegationToken(Token<T> token)` Set delegation token.

  - ### Uses of Token in org.apache.hadoop.fs.viewfs

    Methods in org.apache.hadoop.fs.viewfs with annotations of type with type parameters of type that implement declared as with annotations of type with type parameters of type with annotations of type with annotations of type with type parameters of type that return that return types with arguments of type with parameters of type with type arguments of type that throw with annotations of type with annotations of type with parameters of type with type arguments of type that throw Token
    Modifier and Type | Method and Description
    --- | ---
    `List<Token<?>>` | ViewFs.`getDelegationTokens(String renewer)`

  - ### Uses of Token in org.apache.hadoop.security

    Methods in org.apache.hadoop.security that return Token
    Modifier and Type | Method and Description
    --- | ---
    `Token<? extends TokenIdentifier>` | Credentials.`getToken(Text alias)` Returns the Token object for the alias.

    Methods in org.apache.hadoop.security that return types with arguments of type Token
    Modifier and Type | Method and Description
    --- | ---
    `Collection<Token<? extends TokenIdentifier>>` | Credentials.`getAllTokens()` Return all the tokens in the in-memory map.
    `Map<Text,Token<? extends TokenIdentifier>>` | Credentials.`getTokenMap()` Returns an unmodifiable version of the full map of aliases to Tokens.
    `Collection<Token<? extends TokenIdentifier>>` | UserGroupInformation.`getTokens()` Obtain the collection of tokens associated with this user.

    Methods in org.apache.hadoop.security with parameters of type Token
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | UserGroupInformation.`addToken(Text alias, Token<? extends TokenIdentifier> token)` Add a named token to this UGI
    `void` | Credentials.`addToken(Text alias, Token<? extends TokenIdentifier> t)` Add a token in the storage (in memory).
    `boolean` | UserGroupInformation.`addToken(Token<? extends TokenIdentifier> token)` Add a token to this UGI
    `static InetSocketAddress` | SecurityUtil.`getTokenServiceAddr(Token<?> token)` Decode the given token's service field into an InetAddress
    `static void` | SecurityUtil.`setTokenService(Token<?> token, InetSocketAddress addr)` Set the given token's service to the format expected by the RPC client

  - ### Uses of Token in org.apache.hadoop.security.token

    Methods in org.apache.hadoop.security.token that return Token
    Modifier and Type | Method and Description
    --- | ---
    `Token<?>` | DtFetcher.`addDelegationTokens(Configuration conf, Credentials creds, String renewer, String url)` Add any number of delegation tokens to Credentials object and return a token instance that is appropriate for aliasing, or null if none.
    `Token<T>` | Token.`copyToken()`
    `Token<T>` | Token.`privateClone(Text newService)` Create a private clone of a public token.
    `Token<T>` | TokenSelector.`selectToken(Text service, Collection<Token<? extends TokenIdentifier>> tokens)`

    Methods in org.apache.hadoop.security.token with parameters of type Token
    Modifier and Type | Method and Description
    --- | ---
    `abstract void` | TokenRenewer.`cancel(Token<?> token, Configuration conf)` Cancel the given token
    `void` | Token.TrivialRenewer.`cancel(Token<?> token, Configuration conf)`
    `abstract boolean` | TokenRenewer.`isManaged(Token<?> token)` Is the given token managed? Only managed tokens may be renewed or cancelled.
    `boolean` | Token.TrivialRenewer.`isManaged(Token<?> token)`
    `abstract long` | TokenRenewer.`renew(Token<?> token, Configuration conf)` Renew the given token.
    `long` | Token.TrivialRenewer.`renew(Token<?> token, Configuration conf)`

    Method parameters in org.apache.hadoop.security.token with type arguments of type Token
    Modifier and Type | Method and Description
    --- | ---
    `Token<T>` | TokenSelector.`selectToken(Text service, Collection<Token<? extends TokenIdentifier>> tokens)`

    Constructors in org.apache.hadoop.security.token with parameters of type Token
    Constructor and Description
    `Token(Token<T> other)` Clone a token.

  - ### Uses of Token in org.apache.hadoop.security.token.delegation

    Methods in org.apache.hadoop.security.token.delegation with annotations of type with type parameters of type that implement declared as with annotations of type with type parameters of type with annotations of type with annotations of type with type parameters of type that return that return types with arguments of type with parameters of type with type arguments of type that throw with annotations of type with annotations of type with parameters of type with type arguments of type that throw Token
    Modifier and Type | Method and Description
    --- | ---
    `TokenIdent` | AbstractDelegationTokenSecretManager.`cancelToken(Token<TokenIdent> token, String canceller)` Cancel a token by removing it from cache.
    `TokenIdent` | AbstractDelegationTokenSecretManager.`decodeTokenIdentifier(Token<TokenIdent> token)` Decode the token identifier.
    `long` | AbstractDelegationTokenSecretManager.`renewToken(Token<TokenIdent> token, String renewer)` Renew a delegation token.

  - ### Uses of Token in org.apache.hadoop.security.token.delegation.web

    Methods in org.apache.hadoop.security.token.delegation.web that return Token
    Modifier and Type | Method and Description
    --- | ---
    `Token<AbstractDelegationTokenIdentifier>` | DelegationTokenAuthenticatedURL.Token.`getDelegationToken()`
    `Token<AbstractDelegationTokenIdentifier>` | DelegationTokenAuthenticator.`getDelegationToken(URL url, org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token, String renewer)` Requests a delegation token using the configured `Authenticator` for authentication.
    `Token<AbstractDelegationTokenIdentifier>` | DelegationTokenAuthenticator.`getDelegationToken(URL url, org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token, String renewer, String doAsUser)` Requests a delegation token using the configured `Authenticator` for authentication.
    `Token<AbstractDelegationTokenIdentifier>` | DelegationTokenAuthenticatedURL.`getDelegationToken(URL url, DelegationTokenAuthenticatedURL.Token token, String renewer)` Requests a delegation token using the configured `Authenticator` for authentication.
    `Token<AbstractDelegationTokenIdentifier>` | DelegationTokenAuthenticatedURL.`getDelegationToken(URL url, DelegationTokenAuthenticatedURL.Token token, String renewer, String doAsUser)` Requests a delegation token using the configured `Authenticator` for authentication.

    Methods in org.apache.hadoop.security.token.delegation.web with parameters of type Token
    Modifier and Type | Method and Description
    --- | ---
    `void` | DelegationTokenAuthenticator.`cancelDelegationToken(URL url, org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token, Token<AbstractDelegationTokenIdentifier> dToken)` Cancels a delegation token from the server end-point.
    `void` | DelegationTokenAuthenticator.`cancelDelegationToken(URL url, org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token, Token<AbstractDelegationTokenIdentifier> dToken, String doAsUser)` Cancels a delegation token from the server end-point.
    `long` | DelegationTokenAuthenticator.`renewDelegationToken(URL url, org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token, Token<AbstractDelegationTokenIdentifier> dToken)` Renews a delegation token from the server end-point using the configured `Authenticator` for authentication.
    `long` | DelegationTokenAuthenticator.`renewDelegationToken(URL url, org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token, Token<AbstractDelegationTokenIdentifier> dToken, String doAsUser)` Renews a delegation token from the server end-point using the configured `Authenticator` for authentication.
    `void` | DelegationTokenAuthenticatedURL.Token.`setDelegationToken(Token<AbstractDelegationTokenIdentifier> delegationToken)`

Copyright © 2008–2022 Apache Software Foundation. All rights reserved.