SecretKeyCredentialHandler (Apache Tomcat 8.0.15 API Documentation)

java.lang.Object
- org.apache.catalina.realm.DigestCredentialHandlerBase
- - org.apache.catalina.realm.SecretKeyCredentialHandler

All Implemented Interfaces:: CredentialHandler

public class SecretKeyCredentialHandler
extends DigestCredentialHandlerBase

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_ALGORITHM

static int DEFAULT_ITERATIONS

static int DEFAULT_KEY_LENGTH
- Fields inherited from class org.apache.catalina.realm.DigestCredentialHandlerBase
  DEFAULT_SALT_LENGTH, sm

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_ALGORITHM`
`static int`	`DEFAULT_ITERATIONS`
`static int`	`DEFAULT_KEY_LENGTH`

Constructor Summary

Constructors
Constructor and Description

SecretKeyCredentialHandler()

Constructors
Constructor and Description
`SecretKeyCredentialHandler()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getAlgorithm()` Get the algorithm used to convert input credentials to stored credentials.
`protected int`	`getDefaultIterations()` Get the default number of iterations used by the `CredentialHandler`.
`int`	`getKeyLength()`
`protected Log`	`getLog()` Obtain the logger for the CredentialHandler instance.
`boolean`	`matches(String inputCredentials, String storedCredentials)` Checks to see if the input credentials match the stored credentials
`protected String`	`mutate(String inputCredentials, byte[] salt, int iterations)` Generates the equivalent stored credentials for the given input credentials, salt and iterations.
`void`	`setAlgorithm(String algorithm)` Set the algorithm used to convert input credentials to stored credentials.
`void`	`setKeyLength(int keyLength)`

Methods inherited from class org.apache.catalina.realm.DigestCredentialHandlerBase
getDefaultSaltLength, getIterations, getLogInvalidStoredCredentials, getSaltLength, matchesSaltIterationsEncoded, mutate, setIterations, setLogInvalidStoredCredentials, setSaltLength

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

- Field Detail
  - DEFAULT_ALGORITHM
```
public static final String DEFAULT_ALGORITHM
```
    See Also:
    Constant Field Values
  - DEFAULT_KEY_LENGTH
```
public static final int DEFAULT_KEY_LENGTH
```
    See Also:
    Constant Field Values
  - DEFAULT_ITERATIONS
```
public static final int DEFAULT_ITERATIONS
```
    See Also:
    Constant Field Values
- Constructor Detail
  - SecretKeyCredentialHandler
```
public SecretKeyCredentialHandler()
                           throws NoSuchAlgorithmException
```
    Throws:
    
    NoSuchAlgorithmException
- Method Detail
  - getAlgorithm
```
public String getAlgorithm()
```
    Description copied from class: DigestCredentialHandlerBase
    
    Get the algorithm used to convert input credentials to stored credentials.
    
    Specified by:
    
    getAlgorithm in class DigestCredentialHandlerBase
  - setAlgorithm
```
public void setAlgorithm(String algorithm)
                  throws NoSuchAlgorithmException
```
    Description copied from class: DigestCredentialHandlerBase
    
    Set the algorithm used to convert input credentials to stored credentials.
    
    Specified by:
    
    setAlgorithm in class DigestCredentialHandlerBase
    
    Throws:
    
    NoSuchAlgorithmException
  - getKeyLength
```
public int getKeyLength()
```
  - setKeyLength
```
public void setKeyLength(int keyLength)
```
  - matches
```
public boolean matches(String inputCredentials,
              String storedCredentials)
```
    Description copied from interface: CredentialHandler
    
    Checks to see if the input credentials match the stored credentials
    
    Parameters:
    inputCredentials - User provided credentials
    storedCredentials - Credentials stored in the Realm
    
    Returns:
    true if the inputCredentials match the storedCredentials, otherwise false
  - mutate
```
protected String mutate(String inputCredentials,
            byte[] salt,
            int iterations)
```
    Description copied from class: DigestCredentialHandlerBase
    
    Generates the equivalent stored credentials for the given input credentials, salt and iterations.
    
    Specified by:
    
    mutate in class DigestCredentialHandlerBase
    
    Parameters:
    inputCredentials - User provided credentials
    salt - Salt, if any
    iterations - Number of iterations of the algorithm associated with this CredentialHandler applied to the inputCredentials to generate the equivalent stored credentials
    
    Returns:
    The equivalent stored credentials for the given input credentials
  - getDefaultIterations
```
protected int getDefaultIterations()
```
    Description copied from class: DigestCredentialHandlerBase
    
    Get the default number of iterations used by the CredentialHandler.
    
    Specified by:
    
    getDefaultIterations in class DigestCredentialHandlerBase
  - getLog
```
protected Log getLog()
```
    Description copied from class: DigestCredentialHandlerBase
    
    Obtain the logger for the CredentialHandler instance.
    
    Specified by:
    
    getLog in class DigestCredentialHandlerBase

Class SecretKeyCredentialHandler

Field Summary

Fields inherited from class org.apache.catalina.realm.DigestCredentialHandlerBase

Constructor Summary

Method Summary

Methods inherited from class org.apache.catalina.realm.DigestCredentialHandlerBase

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ALGORITHM

DEFAULT_KEY_LENGTH

DEFAULT_ITERATIONS

Constructor Detail

SecretKeyCredentialHandler

Method Detail

getAlgorithm

setAlgorithm

getKeyLength

setKeyLength

matches

mutate

getDefaultIterations

getLog