DelegationTokenMultiSchemeAuthHandler (Solr 4.10.3-cdh5.9.1 API)

java.lang.Object
- org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticationHandler
- - org.apache.solr.servlet.authentication.DelegationTokenMultiSchemeAuthHandler

All Implemented Interfaces:

org.apache.hadoop.security.authentication.server.AuthenticationHandler
```
public class DelegationTokenMultiSchemeAuthHandler
extends org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticationHandler
```
An AuthenticationHandler that supports multiple HTTP authentication schemes along with Delegation Token functionality.
In addition to the wrapped AuthenticationHandler configuration properties, this handler supports the following properties prefixed with the type of the wrapped AuthenticationHandler:
- delegation-token.token-kind: the token kind for generated tokens (no default, required property).
- delegation-token.update-interval.sec: secret manager master key update interval in seconds (default 1 day).
- delegation-token.max-lifetime.sec: maximum life of a delegation token in seconds (default 7 days).
- delegation-token.renewal-interval.sec: renewal interval for delegation tokens in seconds (default 1 day).
- delegation-token.removal-scan-interval.sec: delegation tokens removal scan interval in seconds (default 1 hour).
multi-scheme-auth-handler.delegation.http.schemes: A comma separated list of HTTP authentication mechanisms (e.g. Negotiate, Basic) etc. to be allowed for delegation token management operations.

Field Summary

Fields
Modifier and Type Field and Description

static String DELEGATION_TOKEN_SCHEMES_PROPERTY
- Fields inherited from class org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticationHandler
  DELEGATION_TOKEN_UGI_ATTRIBUTE, PREFIX, TOKEN_KIND, TYPE_POSTFIX
- Fields inherited from interface org.apache.hadoop.security.authentication.server.AuthenticationHandler
  WWW_AUTHENTICATE

Fields
Modifier and Type	Field and Description
`static String`	`DELEGATION_TOKEN_SCHEMES_PROPERTY`

Constructor Summary

Constructors
Constructor and Description

DelegationTokenMultiSchemeAuthHandler()

Constructors
Constructor and Description
`DelegationTokenMultiSchemeAuthHandler()`

Method Summary

Methods
Modifier and Type	Method and Description
`org.apache.hadoop.security.authentication.server.AuthenticationToken`	`authenticate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` This method is overridden to restrict HTTP authentication schemes available for delegation token management functionality.
`static String`	`getParameter(javax.servlet.http.HttpServletRequest request, String name)` Extract a query string parameter without triggering http parameters processing by the servlet container.
`void`	`init(Properties config)`
`static String`	`toUpperCase(String str)` Converts all of the characters in this String to upper case with Locale.ENGLISH.

Methods inherited from class org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticationHandler
destroy, getType, initTokenManager, managementOperation, setExternalDelegationTokenSecretManager

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

- Field Detail
  - DELEGATION_TOKEN_SCHEMES_PROPERTY
```
public static final String DELEGATION_TOKEN_SCHEMES_PROPERTY
```
    See Also:
    Constant Field Values
- Constructor Detail
  - DelegationTokenMultiSchemeAuthHandler
```
public DelegationTokenMultiSchemeAuthHandler()
```
- Method Detail
  - init
```
public void init(Properties config)
          throws javax.servlet.ServletException
```
    Specified by:
    
    init in interface org.apache.hadoop.security.authentication.server.AuthenticationHandler
    
    Overrides:
    
    init in class org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticationHandler
    
    Throws:
    
    javax.servlet.ServletException
  - authenticate
```
public org.apache.hadoop.security.authentication.server.AuthenticationToken authenticate(javax.servlet.http.HttpServletRequest request,
                                                                                javax.servlet.http.HttpServletResponse response)
                                                                                  throws IOException,
                                                                                         org.apache.hadoop.security.authentication.client.AuthenticationException
```
    This method is overridden to restrict HTTP authentication schemes available for delegation token management functionality. The authentication schemes to be used for delegation token management are configured using DELEGATION_TOKEN_SCHEMES_PROPERTY The basic logic here is to check if the current request is for delegation token management. If yes then check if the request contains an "Authorization" header. If it is missing, then return the HTTP 401 response with WWW-Authenticate header for each scheme configured for delegation token management. It is also possible for a client to preemptively send Authorization header for a scheme not configured for delegation token management. We detect this case and return the HTTP 401 response with WWW-Authenticate header for each scheme configured for delegation token management. If a client has sent a request with "Authorization" header for a scheme configured for delegation token management, then it is forwarded to underlying MultiSchemeAuthenticationHandler for actual authentication. Finally all other requests (excluding delegation token management) are forwarded to underlying MultiSchemeAuthenticationHandler for actual authentication.
    
    Specified by:
    
    authenticate in interface org.apache.hadoop.security.authentication.server.AuthenticationHandler
    
    Overrides:
    
    authenticate in class org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticationHandler
    
    Throws:
    
    IOException
    
    org.apache.hadoop.security.authentication.client.AuthenticationException
  - getParameter
```
public static String getParameter(javax.servlet.http.HttpServletRequest request,
                  String name)
                           throws IOException
```
    Extract a query string parameter without triggering http parameters processing by the servlet container.
    
    Parameters:
    request - the request
    name - the parameter to get the value.
    
    Returns:
    the parameter value, or NULL if the parameter is not defined.
    
    Throws:
    
    IOException - thrown if there was an error parsing the query string.
  - toUpperCase
```
public static String toUpperCase(String str)
```
    Converts all of the characters in this String to upper case with Locale.ENGLISH.
    
    Parameters:
    str - string to be converted
    
    Returns:
    the str, converted to uppercase.

Class DelegationTokenMultiSchemeAuthHandler

Field Summary

Fields inherited from class org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticationHandler

Fields inherited from interface org.apache.hadoop.security.authentication.server.AuthenticationHandler

Constructor Summary

Method Summary

Methods inherited from class org.apache.hadoop.security.token.delegation.web.DelegationTokenAuthenticationHandler

Methods inherited from class java.lang.Object

Field Detail

DELEGATION_TOKEN_SCHEMES_PROPERTY

Constructor Detail

DelegationTokenMultiSchemeAuthHandler

Method Detail

init

authenticate

getParameter

toUpperCase