Package org.apache.hadoop.security.token.delegation.web

Class DelegationTokenAuthenticator

java.lang.Object

org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticator

All Implemented Interfaces:

org.apache.hadoop.security.authentication.client.Authenticator

Direct Known Subclasses:

KerberosDelegationTokenAuthenticator, MaprDelegationTokenAuthenticator, PseudoDelegationTokenAuthenticator

@Public
@Evolving
public abstract class DelegationTokenAuthenticator
extends java.lang.Object
implements org.apache.hadoop.security.authentication.client.Authenticator

Authenticator wrapper that enhances an Authenticator with Delegation Token support.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DelegationTokenAuthenticator.DelegationTokenOperation	DelegationToken operations.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DELEGATION_PARAM
static java.lang.String	DELEGATION_TOKEN_HEADER
static java.lang.String	DELEGATION_TOKEN_JSON
static java.lang.String	DELEGATION_TOKEN_URL_STRING_JSON
static java.lang.String	OP_PARAM
static java.lang.String	RENEW_DELEGATION_TOKEN_JSON
static java.lang.String	RENEWER_PARAM
static java.lang.String	SERVICE_PARAM
static java.lang.String	TOKEN_PARAM

Constructor Summary

Constructors

Constructor	Description
DelegationTokenAuthenticator(org.apache.hadoop.security.authentication.client.Authenticator authenticator)

Method Summary

Modifier and Type	Method	Description
void	authenticate(java.net.URL url, org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token)
void	cancelDelegationToken(java.net.URL url, org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token, Token<AbstractDelegationTokenIdentifier> dToken)	Cancels a delegation token from the server end-point.
void	cancelDelegationToken(java.net.URL url, org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token, Token<AbstractDelegationTokenIdentifier> dToken, java.lang.String doAsUser)	Cancels a delegation token from the server end-point.
Token<AbstractDelegationTokenIdentifier>	getDelegationToken(java.net.URL url, org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token, java.lang.String renewer)	Requests a delegation token using the configured Authenticator for authentication.
Token<AbstractDelegationTokenIdentifier>	getDelegationToken(java.net.URL url, org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token, java.lang.String renewer, java.lang.String doAsUser)	Requests a delegation token using the configured Authenticator for authentication.
long	renewDelegationToken(java.net.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	renewDelegationToken(java.net.URL url, org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token, Token<AbstractDelegationTokenIdentifier> dToken, java.lang.String doAsUser)	Renews a delegation token from the server end-point using the configured Authenticator for authentication.
void	setConnectionConfigurator(org.apache.hadoop.security.authentication.client.ConnectionConfigurator configurator)

Methods inherited from class java.lang.Object

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

Field Detail

OP_PARAM

public static final java.lang.String OP_PARAM

See Also:

Constant Field Values

DELEGATION_TOKEN_HEADER

public static final java.lang.String DELEGATION_TOKEN_HEADER

See Also:

Constant Field Values

DELEGATION_PARAM

public static final java.lang.String DELEGATION_PARAM

See Also:

Constant Field Values

TOKEN_PARAM

public static final java.lang.String TOKEN_PARAM

See Also:

Constant Field Values

RENEWER_PARAM

public static final java.lang.String RENEWER_PARAM

See Also:

Constant Field Values

SERVICE_PARAM

public static final java.lang.String SERVICE_PARAM

See Also:

Constant Field Values

DELEGATION_TOKEN_JSON

public static final java.lang.String DELEGATION_TOKEN_JSON

See Also:

Constant Field Values

DELEGATION_TOKEN_URL_STRING_JSON

public static final java.lang.String DELEGATION_TOKEN_URL_STRING_JSON

See Also:

Constant Field Values

RENEW_DELEGATION_TOKEN_JSON

public static final java.lang.String RENEW_DELEGATION_TOKEN_JSON

See Also:

Constant Field Values

Constructor Detail

DelegationTokenAuthenticator

public DelegationTokenAuthenticator(org.apache.hadoop.security.authentication.client.Authenticator authenticator)

Method Detail

setConnectionConfigurator

public void setConnectionConfigurator(org.apache.hadoop.security.authentication.client.ConnectionConfigurator configurator)

Specified by:

setConnectionConfigurator in interface org.apache.hadoop.security.authentication.client.Authenticator

authenticate

public void authenticate(java.net.URL url,
                         org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token)
                  throws java.io.IOException,
                         org.apache.hadoop.security.authentication.client.AuthenticationException

Specified by:

authenticate in interface org.apache.hadoop.security.authentication.client.Authenticator

Throws:

java.io.IOException

org.apache.hadoop.security.authentication.client.AuthenticationException

getDelegationToken

public Token<AbstractDelegationTokenIdentifier> getDelegationToken(java.net.URL url,
                                                                   org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token,
                                                                   java.lang.String renewer)
                                                            throws java.io.IOException,
                                                                   org.apache.hadoop.security.authentication.client.AuthenticationException

Requests a delegation token using the configured Authenticator for authentication.

Parameters:

url - the URL to get the delegation token from. Only HTTP/S URLs are supported.

token - the authentication token being used for the user where the Delegation token will be stored.

renewer - the renewer user.

Returns:

abstract delegation token identifier.

Throws:

java.io.IOException - if an IO error occurred.

org.apache.hadoop.security.authentication.client.AuthenticationException - if an authentication exception occurred.

getDelegationToken

public Token<AbstractDelegationTokenIdentifier> getDelegationToken(java.net.URL url,
                                                                   org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token,
                                                                   java.lang.String renewer,
                                                                   java.lang.String doAsUser)
                                                            throws java.io.IOException,
                                                                   org.apache.hadoop.security.authentication.client.AuthenticationException

Requests a delegation token using the configured Authenticator for authentication.

Parameters:

url - the URL to get the delegation token from. Only HTTP/S URLs are supported.

token - the authentication token being used for the user where the Delegation token will be stored.

renewer - the renewer user.

doAsUser - the user to do as, which will be the token owner.

Returns:

abstract delegation token identifier.

Throws:

java.io.IOException - if an IO error occurred.

org.apache.hadoop.security.authentication.client.AuthenticationException - if an authentication exception occurred.

renewDelegationToken

public long renewDelegationToken(java.net.URL url,
                                 org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token,
                                 Token<AbstractDelegationTokenIdentifier> dToken)
                          throws java.io.IOException,
                                 org.apache.hadoop.security.authentication.client.AuthenticationException

Renews a delegation token from the server end-point using the configured Authenticator for authentication.

Parameters:

url - the URL to renew the delegation token from. Only HTTP/S URLs are supported.

token - the authentication token with the Delegation Token to renew.

dToken - abstract delegation token identifier.

Returns:

delegation token long value.

Throws:

java.io.IOException - if an IO error occurred.

org.apache.hadoop.security.authentication.client.AuthenticationException - if an authentication exception occurred.

renewDelegationToken

public long renewDelegationToken(java.net.URL url,
                                 org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token,
                                 Token<AbstractDelegationTokenIdentifier> dToken,
                                 java.lang.String doAsUser)
                          throws java.io.IOException,
                                 org.apache.hadoop.security.authentication.client.AuthenticationException

Renews a delegation token from the server end-point using the configured Authenticator for authentication.

Parameters:

url - the URL to renew the delegation token from. Only HTTP/S URLs are supported.

token - the authentication token with the Delegation Token to renew.

doAsUser - the user to do as, which will be the token owner.

dToken - abstract delegation token identifier.

Returns:

delegation token long value.

Throws:

java.io.IOException - if an IO error occurred.

org.apache.hadoop.security.authentication.client.AuthenticationException - if an authentication exception occurred.

cancelDelegationToken

public void cancelDelegationToken(java.net.URL url,
                                  org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token,
                                  Token<AbstractDelegationTokenIdentifier> dToken)
                           throws java.io.IOException

Cancels a delegation token from the server end-point. It does not require being authenticated by the configured Authenticator.

Parameters:

url - the URL to cancel the delegation token from. Only HTTP/S URLs are supported.

token - the authentication token with the Delegation Token to cancel.

dToken - abstract delegation token identifier.

Throws:

java.io.IOException - if an IO error occurred.

cancelDelegationToken

public void cancelDelegationToken(java.net.URL url,
                                  org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token,
                                  Token<AbstractDelegationTokenIdentifier> dToken,
                                  java.lang.String doAsUser)
                           throws java.io.IOException

Cancels a delegation token from the server end-point. It does not require being authenticated by the configured Authenticator.

Parameters:

url - the URL to cancel the delegation token from. Only HTTP/S URLs are supported.

token - the authentication token with the Delegation Token to cancel.

dToken - abstract delegation token identifier.

doAsUser - the user to do as, which will be the token owner.

Throws:

java.io.IOException - if an IO error occurred.