DtFetcher (Apache Hadoop Common 3.5.0 API)
Description: declaration: package: org.apache.hadoop.security.token, interface: DtFetcher

Package org.apache.hadoop.security.token

# Interface DtFetcher

public interface DtFetcher
DtFetcher is an interface which permits the abstraction and separation of delegation token fetch implementaions across different packages and compilation units. Resolution of fetcher impl will be done at runtime.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `Token<?>`
  `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.
  `Text`
  `getServiceName()`
  Return a key used to identify the object/service implementation.
  `boolean`
  `isTokenRequired()`
  Used to allow the service API to indicate whether a token is required.

- ## Method Details

  - ### getServiceName

    Text getServiceName()
    Return a key used to identify the object/service implementation.
    Returns:
      ServiceName.

  - ### isTokenRequired

    boolean isTokenRequired()
    Used to allow the service API to indicate whether a token is required.
    Returns:
      isTokenRequired.

  - ### addDelegationTokens

    Token<?> addDelegationTokens(Configuration conf, Credentials creds, String renewer, String url) throws Exception
    Add any number of delegation tokens to Credentials object and return a token instance that is appropriate for aliasing, or null if none.
    Parameters:
      `conf` - configuration.
      `creds` - credentials.
      `renewer` - renewer.
      `url` - url.
    Returns:
      DelegationTokens.
    Throws:
      `Exception` - Exception.