AccessTokenProvider (util-hadoop 3.0.0-RC01 API)

All Superinterfaces:

org.apache.hadoop.conf.Configurable

All Known Implementing Classes:

TestingAccessTokenProvider
```
public interface AccessTokenProvider
extends org.apache.hadoop.conf.Configurable
```
A provider to provide access token, and upon access token expiration, the utility to refresh.

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static class`	`AccessTokenProvider.AccessToken`	An access token and its expiration time.
`static class`	`AccessTokenProvider.AccessTokenType`	Supported access token types.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`AccessTokenProvider.AccessToken`	`getAccessToken()`
`default AccessTokenProvider.AccessToken`	`getAccessToken(List<AccessBoundary> accessBoundaries)`
`default AccessTokenProvider.AccessTokenType`	`getAccessTokenType()`
`void`	`refresh()`	Force this provider to refresh its access token.

Methods inherited from interface org.apache.hadoop.conf.Configurable
getConf, setConf

- Method Detail
  - getAccessTokenType
```
default AccessTokenProvider.AccessTokenType getAccessTokenType()
```
    Returns:
    
    an access token type.
  - getAccessToken
```
AccessTokenProvider.AccessToken getAccessToken()
```
    Returns:
    
    an access token.
  - getAccessToken
```
default AccessTokenProvider.AccessToken getAccessToken(List<AccessBoundary> accessBoundaries)
```
    Parameters:
    
    accessBoundaries - access boundaries used to generate a downscoped access token.
    
    Returns:
    
    an access token.
  - refresh
```
void refresh()
      throws IOException
```
    Force this provider to refresh its access token.
    
    Throws:
    
    IOException - when refresh fails.