Hash (Apache Shiro 1.7.0 API)

All Superinterfaces:

ByteSource

All Known Implementing Classes:

AbstractHash, Md2Hash, Md5Hash, Sha1Hash, Sha256Hash, Sha384Hash, Sha512Hash, SimpleHash
```
public interface Hash
extends ByteSource
```
A Cryptographic Hash represents a one-way conversion algorithm that transforms an input source to an underlying byte array. Hex and Base64-encoding output of the hashed bytes are automatically supported by the inherited toHex() and toBase64() methods.
The bytes returned by the parent interface's getBytes() are the hashed value of the original input source, also known as the 'checksum' or 'digest'.

Since:

0.9

See Also:

Md2Hash, Md5Hash, Sha1Hash, Sha256Hash, Sha384Hash, Sha512Hash

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.shiro.util.ByteSource
  ByteSource.Util

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getAlgorithmName()`	Returns the name of the algorithm used to hash the input source, for example, `SHA-256`, `MD5`, etc.
`int`	`getIterations()`	Returns the number of hash iterations used to compute the hash.
`ByteSource`	`getSalt()`	Returns a salt used to compute the hash or `null` if no salt was used.

Methods inherited from interface org.apache.shiro.util.ByteSource
getBytes, isEmpty, toBase64, toHex

- Method Detail
  - getAlgorithmName
```
String getAlgorithmName()
```
    Returns the name of the algorithm used to hash the input source, for example, SHA-256, MD5, etc.
    The name is expected to be a MessageDigest algorithm name.
    
    Returns:
    
    the the name of the algorithm used to hash the input source, for example, SHA-256, MD5, etc.
    
    Since:
    
    1.1
  - getSalt
```
ByteSource getSalt()
```
    Returns a salt used to compute the hash or null if no salt was used.
    
    Returns:
    
    a salt used to compute the hash or null if no salt was used.
    
    Since:
    
    1.2
  - getIterations
```
int getIterations()
```
    Returns the number of hash iterations used to compute the hash.
    
    Returns:
    
    the number of hash iterations used to compute the hash.
    
    Since:
    
    1.2