@InterfaceAudience.Public @InterfaceStability.Evolving public abstract class DelegationTokenAuthenticator extends Object implements org.apache.hadoop.security.authentication.client.Authenticator
Authenticator
wrapper that enhances an Authenticator
with
Delegation Token support.Modifier and Type | Field and Description |
---|---|
static String |
DELEGATION_PARAM |
static String |
DELEGATION_TOKEN_HEADER |
static String |
DELEGATION_TOKEN_JSON |
static String |
DELEGATION_TOKEN_URL_STRING_JSON |
static String |
OP_PARAM |
static String |
RENEW_DELEGATION_TOKEN_JSON |
static String |
RENEWER_PARAM |
static String |
TOKEN_PARAM |
Constructor and Description |
---|
DelegationTokenAuthenticator(org.apache.hadoop.security.authentication.client.Authenticator authenticator) |
Modifier and Type | Method and Description |
---|---|
void |
authenticate(URL url,
org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token)
Authenticates against a URL and returns a
AuthenticatedURL.Token to be
used by subsequent requests. |
void |
cancelDelegationToken(URL url,
org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token,
org.apache.hadoop.security.token.Token<org.apache.hadoop.security.token.delegation.AbstractDelegationTokenIdentifier> dToken)
Cancels a delegation token from the server end-point.
|
void |
cancelDelegationToken(URL url,
org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token,
org.apache.hadoop.security.token.Token<org.apache.hadoop.security.token.delegation.AbstractDelegationTokenIdentifier> dToken,
String doAsUser)
Cancels a delegation token from the server end-point.
|
org.apache.hadoop.security.token.Token<org.apache.hadoop.security.token.delegation.AbstractDelegationTokenIdentifier> |
getDelegationToken(URL url,
org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token,
String renewer)
Requests a delegation token using the configured
Authenticator
for authentication. |
org.apache.hadoop.security.token.Token<org.apache.hadoop.security.token.delegation.AbstractDelegationTokenIdentifier> |
getDelegationToken(URL url,
org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token,
String renewer,
String doAsUser)
Requests a delegation token using the configured
Authenticator
for authentication. |
long |
renewDelegationToken(URL url,
org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token,
org.apache.hadoop.security.token.Token<org.apache.hadoop.security.token.delegation.AbstractDelegationTokenIdentifier> dToken)
Renews a delegation token from the server end-point using the
configured
Authenticator for authentication. |
long |
renewDelegationToken(URL url,
org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token,
org.apache.hadoop.security.token.Token<org.apache.hadoop.security.token.delegation.AbstractDelegationTokenIdentifier> dToken,
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)
Sets a
ConnectionConfigurator instance to use for
configuring connections. |
public static final String OP_PARAM
public static final String DELEGATION_TOKEN_HEADER
public static final String DELEGATION_PARAM
public static final String TOKEN_PARAM
public static final String RENEWER_PARAM
public static final String DELEGATION_TOKEN_JSON
public static final String DELEGATION_TOKEN_URL_STRING_JSON
public static final String RENEW_DELEGATION_TOKEN_JSON
public DelegationTokenAuthenticator(org.apache.hadoop.security.authentication.client.Authenticator authenticator)
public void setConnectionConfigurator(org.apache.hadoop.security.authentication.client.ConnectionConfigurator configurator)
org.apache.hadoop.security.authentication.client.Authenticator
ConnectionConfigurator
instance to use for
configuring connections.setConnectionConfigurator
in interface org.apache.hadoop.security.authentication.client.Authenticator
configurator
- the ConnectionConfigurator
instance.public void authenticate(URL url, org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token) throws IOException, org.apache.hadoop.security.authentication.client.AuthenticationException
org.apache.hadoop.security.authentication.client.Authenticator
AuthenticatedURL.Token
to be
used by subsequent requests.authenticate
in interface org.apache.hadoop.security.authentication.client.Authenticator
url
- the URl to authenticate against.token
- the authentication token being used for the user.IOException
- if an IO error occurred.org.apache.hadoop.security.authentication.client.AuthenticationException
- if an authentication error occurred.public org.apache.hadoop.security.token.Token<org.apache.hadoop.security.token.delegation.AbstractDelegationTokenIdentifier> getDelegationToken(URL url, org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token, String renewer) throws IOException, org.apache.hadoop.security.authentication.client.AuthenticationException
Authenticator
for authentication.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.IOException
- if an IO error occurred.org.apache.hadoop.security.authentication.client.AuthenticationException
- if an authentication exception occurred.public org.apache.hadoop.security.token.Token<org.apache.hadoop.security.token.delegation.AbstractDelegationTokenIdentifier> getDelegationToken(URL url, org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token, String renewer, String doAsUser) throws IOException, org.apache.hadoop.security.authentication.client.AuthenticationException
Authenticator
for authentication.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.IOException
- if an IO error occurred.org.apache.hadoop.security.authentication.client.AuthenticationException
- if an authentication exception occurred.public long renewDelegationToken(URL url, org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token, org.apache.hadoop.security.token.Token<org.apache.hadoop.security.token.delegation.AbstractDelegationTokenIdentifier> dToken) throws IOException, org.apache.hadoop.security.authentication.client.AuthenticationException
Authenticator
for authentication.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.IOException
- if an IO error occurred.org.apache.hadoop.security.authentication.client.AuthenticationException
- if an authentication exception occurred.public long renewDelegationToken(URL url, org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token, org.apache.hadoop.security.token.Token<org.apache.hadoop.security.token.delegation.AbstractDelegationTokenIdentifier> dToken, String doAsUser) throws IOException, org.apache.hadoop.security.authentication.client.AuthenticationException
Authenticator
for authentication.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.IOException
- if an IO error occurred.org.apache.hadoop.security.authentication.client.AuthenticationException
- if an authentication exception occurred.public void cancelDelegationToken(URL url, org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token, org.apache.hadoop.security.token.Token<org.apache.hadoop.security.token.delegation.AbstractDelegationTokenIdentifier> dToken) throws IOException
Authenticator
.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.IOException
- if an IO error occurred.public void cancelDelegationToken(URL url, org.apache.hadoop.security.authentication.client.AuthenticatedURL.Token token, org.apache.hadoop.security.token.Token<org.apache.hadoop.security.token.delegation.AbstractDelegationTokenIdentifier> dToken, String doAsUser) throws IOException
Authenticator
.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.doAsUser
- the user to do as, which will be the token owner.IOException
- if an IO error occurred.Copyright © 2017 Apache Software Foundation. All rights reserved.