SignatureAlgorithm (Cryptographic Support Classes 1.0.0 API)

java.lang.Object
- java.lang.Enum<SignatureAlgorithm>
- - org.dihedron.crypto.constants.SignatureAlgorithm

All Implemented Interfaces:

Serializable, Comparable<SignatureAlgorithm>
```
@License
public enum SignatureAlgorithm
extends Enum<SignatureAlgorithm>
```
Author:

Andrea Funto'

Enum Constant Summary

Enum Constants
Enum Constant and Description
`MD5_WITH_RSA` The MD5 with RSA digital signature algorithm.
`SHA1_WITH_RSA` The SHA1 with RSA digital signature algorithm.
`SHA224_WITH_RSA` The SHA224 with RSA digital signature algorithm.
`SHA256_WITH_RSA` The SHA256 with RSA digital signature algorithm (default).
`SHA384_WITH_RSA` The SHA384 with RSA digital signature algorithm.
`SHA512_WITH_RSA` The SHA512 with RSA digital signature algorithm.

Method Summary

Methods
Modifier and Type	Method and Description
`static SignatureAlgorithm`	`fromAlgorithmAsn1Ids(String digestAlgorithm, String encryptionAlgorithm)` Factory method, returns the enumeration value corresponding to the two given algorithm descriptions.
`static SignatureAlgorithm`	`fromAlgorithmDescriptions(String digestAlgorithm, String encryptionAlgorithm)` Factory method, returns the enumeration value corresponding to the two given algorithm descriptions.
`static SignatureAlgorithm`	`fromBouncyCastleCode(String bcCode)` Attempts to translate the BouncyCastle code of a signature algorithm (in the "SHA1withRSA" format into an enumeration value.
`static SignatureAlgorithm`	`fromBouncyCastleCodes(String digestAlgorithm, String encryptionAlgorithm)` Factory method, returns the enumeration value corresponding to the two given algorithm descriptions.
`DigestAlgorithm`	`getDigestAlgorithm()` Returns the algorithm used to hash the data.
`EncryptionAlgorithm`	`getEncryptionAlgorithm()` Returns the algorithm used to encrypt the hashed data.
`String`	`toBouncyCastleCode()` Provides a string representation of the signature algorithm in the format used by BouncyCastle to identify it, e.g.
`String`	`toString()` Returns the algorithm string representation, such as "SHA256withRSA".
`static SignatureAlgorithm`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SignatureAlgorithm[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - MD5_WITH_RSA
```
public static final SignatureAlgorithm MD5_WITH_RSA
```
    The MD5 with RSA digital signature algorithm.
  - SHA1_WITH_RSA
```
public static final SignatureAlgorithm SHA1_WITH_RSA
```
    The SHA1 with RSA digital signature algorithm.
  - SHA224_WITH_RSA
```
public static final SignatureAlgorithm SHA224_WITH_RSA
```
    The SHA224 with RSA digital signature algorithm.
  - SHA256_WITH_RSA
```
public static final SignatureAlgorithm SHA256_WITH_RSA
```
    The SHA256 with RSA digital signature algorithm (default).
  - SHA384_WITH_RSA
```
public static final SignatureAlgorithm SHA384_WITH_RSA
```
    The SHA384 with RSA digital signature algorithm.
  - SHA512_WITH_RSA
```
public static final SignatureAlgorithm SHA512_WITH_RSA
```
    The SHA512 with RSA digital signature algorithm.
- Method Detail
  - values
```
public static SignatureAlgorithm[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (SignatureAlgorithm c : SignatureAlgorithm.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SignatureAlgorithm valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    name - the name of the enum constant to be returned.
    
    Returns:
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - fromBouncyCastleCode
```
public static SignatureAlgorithm fromBouncyCastleCode(String bcCode)
```
    Attempts to translate the BouncyCastle code of a signature algorithm (in the "SHA1withRSA" format into an enumeration value.
    
    Parameters:
    bcCode - the BouncyCastle code for the signature algorithm.
    
    Returns:
    the corresponding enumeration value, or null if none found.
  - fromAlgorithmDescriptions
```
public static SignatureAlgorithm fromAlgorithmDescriptions(String digestAlgorithm,
                                           String encryptionAlgorithm)
```
    Factory method, returns the enumeration value corresponding to the two given algorithm descriptions.
    
    Parameters:
    digestAlgorithm - the description of the algorithm used to calculate the data checksum (hash), e.g. "sha-1".
    encryptionAlgorithm - the description of the algorithm used to encrypt the hash in the signature, e.g. "rsa".
  - fromAlgorithmAsn1Ids
```
public static SignatureAlgorithm fromAlgorithmAsn1Ids(String digestAlgorithm,
                                      String encryptionAlgorithm)
```
    Factory method, returns the enumeration value corresponding to the two given algorithm descriptions.
    
    Parameters:
    digestAlgorithm - the ASN.1 code of the algorithm used to calculate the data checksum (hash), e.g. "sha-1".
    encryptionAlgorithm - the ASN.1 code of the algorithm used to encrypt the hash in the signature, e.g. "rsa".
  - fromBouncyCastleCodes
```
public static SignatureAlgorithm fromBouncyCastleCodes(String digestAlgorithm,
                                       String encryptionAlgorithm)
```
    Factory method, returns the enumeration value corresponding to the two given algorithm descriptions.
    
    Parameters:
    digestAlgorithm - the BouncyCastle code of the algorithm used to calculate the data checksum (hash), e.g. "SHA256".
    encryptionAlgorithm - the BouncyCastle code of the algorithm used to encrypt the hash in the signature, e.g. "RSA".
  - getDigestAlgorithm
```
public DigestAlgorithm getDigestAlgorithm()
```
    Returns the algorithm used to hash the data.
    
    Returns:
    the algorithm used to hash the data.
  - getEncryptionAlgorithm
```
public EncryptionAlgorithm getEncryptionAlgorithm()
```
    Returns the algorithm used to encrypt the hashed data.
    
    Returns:
    the algorithm used to encrypt the hashed data.
  - toBouncyCastleCode
```
public String toBouncyCastleCode()
```
    Provides a string representation of the signature algorithm in the format used by BouncyCastle to identify it, e.g. "SHA256withRSA".
    
    Returns:
    the digest and encryption algorithm combination as BoucnyCastle expects it, e.g. "SHA1withRSA".
  - toString
```
public String toString()
```
    Returns the algorithm string representation, such as "SHA256withRSA".
    
    Overrides:
    
    toString in class Enum<SignatureAlgorithm>
    
    Returns:
    the algorithm string representation, such as "SHA256withRSA".

Enum SignatureAlgorithm

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

MD5_WITH_RSA

SHA1_WITH_RSA

SHA224_WITH_RSA

SHA256_WITH_RSA

SHA384_WITH_RSA

SHA512_WITH_RSA

Method Detail

values

valueOf

fromBouncyCastleCode

fromAlgorithmDescriptions

fromAlgorithmAsn1Ids

fromBouncyCastleCodes

getDigestAlgorithm

getEncryptionAlgorithm

toBouncyCastleCode

toString