HashService (nifi-security-utils 1.13.2 API)

java.lang.Object
- org.apache.nifi.security.util.crypto.HashService

```
public class HashService
extends Object
```
This class provides a generic service for cryptographic hashing.
See also: * HashAlgorithm

Field Summary

Fields
Modifier and Type Field and Description

private static int BUFFER_SIZE

private static org.slf4j.Logger logger

private static String UTF_16_DESCRIPTION

Fields
Modifier and Type	Field and Description
`private static int`	`BUFFER_SIZE`
`private static org.slf4j.Logger`	`logger`
`private static String`	`UTF_16_DESCRIPTION`

Constructor Summary

Constructors
Constructor and Description

HashService()

Constructors
Constructor and Description
`HashService()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`private static byte[]`	`blake2Hash(HashAlgorithm algorithm, byte[] value)`
`private static byte[]`	`blake2HashStreaming(HashAlgorithm algorithm, InputStream value)`
`static AllowableValue[]`	`buildCharacterSetAllowableValues()` Returns an array of `AllowableValue` elements for each `Charset`.
`static AllowableValue[]`	`buildHashAlgorithmAllowableValues()` Returns an array of `AllowableValue` elements for each `HashAlgorithm`.
`static List<Charset>`	`getSupportedCharsets()` Returns a `List` of supported `Charset`s on this platform.
`static String`	`hashValue(HashAlgorithm algorithm, String value)` Returns the hex-encoded hash of the specified value.
`static String`	`hashValue(HashAlgorithm algorithm, String value, Charset charset)` Returns the hex-encoded hash of the specified value.
`static byte[]`	`hashValueRaw(HashAlgorithm algorithm, byte[] value)` Returns the raw `byte[]` hash of the specified value.
`static byte[]`	`hashValueRaw(HashAlgorithm algorithm, String value)` Returns the raw `byte[]` hash of the specified value.
`static byte[]`	`hashValueRaw(HashAlgorithm algorithm, String value, Charset charset)` Returns the raw `byte[]` hash of the specified value.
`static String`	`hashValueStreaming(HashAlgorithm algorithm, InputStream value)` Returns the hash of the specified value.
`private static byte[]`	`traditionalHash(HashAlgorithm algorithm, byte[] value)`
`private static byte[]`	`traditionalHashStreaming(HashAlgorithm algorithm, InputStream value)`

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

- Field Detail
  - logger
```
private static final org.slf4j.Logger logger
```
  - BUFFER_SIZE
```
private static final int BUFFER_SIZE
```
    See Also:
    
    Constant Field Values
  - UTF_16_DESCRIPTION
```
private static final String UTF_16_DESCRIPTION
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HashService
```
public HashService()
```
- Method Detail
  - buildHashAlgorithmAllowableValues
```
public static AllowableValue[] buildHashAlgorithmAllowableValues()
```
    Returns an array of AllowableValue elements for each HashAlgorithm. The complete description is built from the digest length, safety warnings, etc. See HashAlgorithm.buildAllowableValueDescription().
    
    Returns:
    
    an ordered AllowableValue[] containing the values
  - buildCharacterSetAllowableValues
```
public static AllowableValue[] buildCharacterSetAllowableValues()
```
    Returns an array of AllowableValue elements for each Charset. Only the charsets in StandardCharsets are returned to be consistent across JVM instances.
    
    Returns:
    
    an ordered AllowableValue[] containing the values
  - getSupportedCharsets
```
public static List<Charset> getSupportedCharsets()
```
    Returns a List of supported Charsets on this platform. This is not a complete list, as only the charsets in StandardCharsets are returned to be consistent across JVM instances.
    
    Returns:
    
    the list of charsets
  - hashValueStreaming
```
public static String hashValueStreaming(HashAlgorithm algorithm,
                                        InputStream value)
                                 throws IOException
```
    Returns the hash of the specified value. This method uses an InputStream to perform the operation in a streaming manner for large inputs.
    
    Parameters:
    
    algorithm - the hash algorithm to use
    
    value - the value to hash (cannot be null but can be an empty stream)
    
    Returns:
    
    the hash value in hex
    
    Throws:
    
    IOException
  - hashValue
```
public static String hashValue(HashAlgorithm algorithm,
                               String value,
                               Charset charset)
```
    Returns the hex-encoded hash of the specified value.
    
    Parameters:
    
    algorithm - the hash algorithm to use
    
    value - the value to hash (cannot be null but can be an empty String)
    
    charset - the charset to use
    
    Returns:
    
    the hash value in hex
  - hashValue
```
public static String hashValue(HashAlgorithm algorithm,
                               String value)
```
    Returns the hex-encoded hash of the specified value. The default charset (StandardCharsets.UTF_8) is used.
    
    Parameters:
    
    algorithm - the hash algorithm to use
    
    value - the value to hash (cannot be null but can be an empty String)
    
    Returns:
    
    the hash value in hex
  - hashValueRaw
```
public static byte[] hashValueRaw(HashAlgorithm algorithm,
                                  String value,
                                  Charset charset)
```
    Returns the raw byte[] hash of the specified value.
    
    Parameters:
    
    algorithm - the hash algorithm to use
    
    value - the value to hash (cannot be null but can be an empty String)
    
    charset - the charset to use
    
    Returns:
    
    the hash value in bytes
  - hashValueRaw
```
public static byte[] hashValueRaw(HashAlgorithm algorithm,
                                  String value)
```
    Returns the raw byte[] hash of the specified value. The default charset (StandardCharsets.UTF_8) is used.
    
    Parameters:
    
    algorithm - the hash algorithm to use
    
    value - the value to hash (cannot be null but can be an empty String)
    
    Returns:
    
    the hash value in bytes
  - hashValueRaw
```
public static byte[] hashValueRaw(HashAlgorithm algorithm,
                                  byte[] value)
```
    Returns the raw byte[] hash of the specified value.
    
    Parameters:
    
    algorithm - the hash algorithm to use
    
    value - the value to hash
    
    Returns:
    
    the hash value in bytes
  - traditionalHash
```
private static byte[] traditionalHash(HashAlgorithm algorithm,
                                      byte[] value)
```
  - traditionalHashStreaming
```
private static byte[] traditionalHashStreaming(HashAlgorithm algorithm,
                                               InputStream value)
                                        throws IOException
```
    Throws:
    
    IOException
  - blake2Hash
```
private static byte[] blake2Hash(HashAlgorithm algorithm,
                                 byte[] value)
```
  - blake2HashStreaming
```
private static byte[] blake2HashStreaming(HashAlgorithm algorithm,
                                          InputStream value)
                                   throws IOException
```
    Throws:
    
    IOException

Class HashService

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

BUFFER_SIZE

UTF_16_DESCRIPTION

Constructor Detail

HashService

Method Detail

buildHashAlgorithmAllowableValues

buildCharacterSetAllowableValues

getSupportedCharsets

hashValueStreaming

hashValue

hashValue

hashValueRaw

hashValueRaw

hashValueRaw

traditionalHash

traditionalHashStreaming

blake2Hash

blake2HashStreaming