FsDelegationToken (Apache HBase 1.2.12 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.hadoop.hbase.security.token.FsDelegationToken

```
@InterfaceAudience.Private
@InterfaceStability.Evolving
public class FsDelegationToken
extends Object
```
Helper class to obtain a filesystem delegation token. Mainly used by Map-Reduce jobs that requires to read/write data to a remote file-system (e.g. BulkLoad, ExportSnapshot).

Field Summary

Fields
Modifier and Type	Field and Description
`private org.apache.hadoop.fs.FileSystem`	`fs`
`private boolean`	`hasForwardedToken`
`private static org.apache.commons.logging.Log`	`LOG`
`private String`	`renewer`
`private UserProvider`	`userProvider`
`private org.apache.hadoop.security.token.Token<?>`	`userToken`

Constructor Summary

Constructors
Constructor and Description

FsDelegationToken(UserProvider userProvider, String renewer)

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`acquireDelegationToken(org.apache.hadoop.fs.FileSystem fs)` Acquire the delegation token for the specified filesytem.
`org.apache.hadoop.fs.FileSystem`	`getFileSystem()`
`String`	`getRenewer()`
`UserProvider`	`getUserProvider()`
`org.apache.hadoop.security.token.Token<?>`	`getUserToken()`
`void`	`releaseDelegationToken()` Releases a previously acquired delegation token.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

private static final org.apache.commons.logging.Log LOG

userProvider

private final UserProvider userProvider

renewer
```
private final String renewer
```

hasForwardedToken
```
private boolean hasForwardedToken
```

userToken

private org.apache.hadoop.security.token.Token<?> userToken

fs

private org.apache.hadoop.fs.FileSystem fs

Constructor Detail

FsDelegationToken

public FsDelegationToken(UserProvider userProvider,
                 String renewer)

Method Detail
- acquireDelegationToken
```
public void acquireDelegationToken(org.apache.hadoop.fs.FileSystem fs)
                            throws IOException
```
  Acquire the delegation token for the specified filesytem. Before requesting a new delegation token, tries to find one already available.
  
  Parameters:
  fs - the filesystem that requires the delegation token
  
  Throws:
  
  IOException - on fs.getDelegationToken() failure
- releaseDelegationToken
```
public void releaseDelegationToken()
```
  Releases a previously acquired delegation token.
- getUserProvider
```
public UserProvider getUserProvider()
```
- getRenewer
```
public String getRenewer()
```
  Returns:
  the account name that is allowed to renew the token.
- getUserToken
```
public org.apache.hadoop.security.token.Token<?> getUserToken()
```
  Returns:
  the delegation token acquired, or null in case it was not acquired
- getFileSystem
```
public org.apache.hadoop.fs.FileSystem getFileSystem()
```

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2007–2019 The Apache Software Foundation. All rights reserved.