org.apache.hadoop.yarn.server.timeline.security

Class TimelineDelegationTokenSecretManagerService

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.yarn.server.timeline.security.TimelineDelegationTokenSecretManagerService

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.hadoop.service.Service

@InterfaceAudience.Private
@InterfaceStability.Unstable
public class TimelineDelegationTokenSecretManagerService
extends org.apache.hadoop.service.AbstractService

The service wrapper of TimelineDelegationTokenSecretManagerService.TimelineDelegationTokenSecretManager

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimelineDelegationTokenSecretManagerService.TimelineDelegationTokenSecretManager Create a timeline secret manager

Nested classes/interfaces inherited from interface org.apache.hadoop.service.Service

org.apache.hadoop.service.Service.STATE

Constructor Summary

Constructors

Constructor and Description
TimelineDelegationTokenSecretManagerService()

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelToken(org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier> token, String canceler) Cancels a delegation token.
org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier>	createToken(org.apache.hadoop.security.UserGroupInformation ugi, String renewer) Creates a delegation token.
long	renewToken(org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier> token, String renewer) Renews a delegation token.
protected void	serviceInit(org.apache.hadoop.conf.Configuration conf)
protected void	serviceStop()
org.apache.hadoop.security.UserGroupInformation	verifyToken(org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier> token) Verifies a delegation token.

Methods inherited from class org.apache.hadoop.service.AbstractService

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, serviceStart, setConfig, start, stop, toString, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TimelineDelegationTokenSecretManagerService

public TimelineDelegationTokenSecretManagerService()

Method Detail

serviceInit

protected void serviceInit(org.apache.hadoop.conf.Configuration conf)
                    throws Exception

Overrides:

serviceInit in class org.apache.hadoop.service.AbstractService

Throws:

Exception

serviceStop

protected void serviceStop()
                    throws Exception

Overrides:

serviceStop in class org.apache.hadoop.service.AbstractService

Throws:

Exception

createToken

public org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier> createToken(org.apache.hadoop.security.UserGroupInformation ugi,
                                                                                                                           String renewer)
                                                                                                                             throws IOException

Creates a delegation token.

Parameters:

ugi - UGI creating the token.

renewer - token renewer.

Returns:

new delegation token.

Throws:

IOException - thrown if the token could not be created.

renewToken

public long renewToken(org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier> token,
              String renewer)
                throws IOException

Renews a delegation token.

Parameters:

token - delegation token to renew.

renewer - token renewer.

Throws:

IOException - thrown if the token could not be renewed.

cancelToken

public void cancelToken(org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier> token,
               String canceler)
                 throws IOException

Cancels a delegation token.

Parameters:

token - delegation token to cancel.

canceler - token canceler.

Throws:

IOException - thrown if the token could not be canceled.

verifyToken

public org.apache.hadoop.security.UserGroupInformation verifyToken(org.apache.hadoop.security.token.Token<org.apache.hadoop.yarn.security.client.TimelineDelegationTokenIdentifier> token)
                                                            throws IOException

Verifies a delegation token.

Parameters:

token - delegation token to verify.

Returns:

the UGI for the token.

Throws:

IOException - thrown if the token could not be verified.