Algorithm (application-core-library 0.4.0 API)

java.lang.Object
- java.lang.Enum<Algorithm>
- - net.messagevortex.asn1.encryption.Algorithm

All Implemented Interfaces:

Serializable, Comparable<Algorithm>
```
public enum Algorithm
extends Enum<Algorithm>
implements Serializable
```
Represents all supported crypto algorithms.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AES128`
`AES192`
`AES256`
`CAMELLIA128`
`CAMELLIA192`
`CAMELLIA256`
`EC`
`RIPEMD160`
`RSA`
`SHA256`
`SHA384`
`SHA512`
`TWOFISH128`
`TWOFISH192`
`TWOFISH256`

Field Summary

Fields
Modifier and Type Field and Description

static long serialVersionUID

Fields
Modifier and Type	Field and Description
`static long`	`serialVersionUID`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAlgorithmFamily()` The algorithm family.
`static Algorithm[]`	`getAlgorithms(AlgorithmType at)` Return a list of algorithms of the specified type.
`AlgorithmType`	`getAlgorithmType()` Get the type of algorithm.
`int`	`getBlockSize()` Get the default key size for this algorithm.
`int`	`getBlockSize(SecurityLevel sl)` Get the block size for this algorithm and security level.
`static Algorithm`	`getById(int id)` Look up an algorithm by id.
`static Algorithm`	`getByString(String s)` Look up an algorithm by its identification string.
`static Algorithm`	`getDefault(AlgorithmType at)` Look up the default algorithm to be used on the system.
`int`	`getId()` Look up the current id.
`int`	`getKeySize()` Get the default key size for this algorithm.
`int`	`getKeySize(SecurityLevel sl)` Get the key size for this algorithm and security level.
`Map<SecurityLevel,AlgorithmParameter>`	`getParameters()` Get a map of security levels and default parameters for this algorithm.
`AlgorithmParameter`	`getParameters(SecurityLevel sl)` Get default parameters for the security level specified.
`String`	`getProvider()` Get the provider string for this algorithm.
`String`	`toString()` Get the identification string.
`static Algorithm`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Algorithm[]`	`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
  - AES128
```
public static final Algorithm AES128
```
  - AES192
```
public static final Algorithm AES192
```
  - AES256
```
public static final Algorithm AES256
```
  - CAMELLIA128
```
public static final Algorithm CAMELLIA128
```
  - CAMELLIA192
```
public static final Algorithm CAMELLIA192
```
  - CAMELLIA256
```
public static final Algorithm CAMELLIA256
```
  - EC
```
public static final Algorithm EC
```
  - RIPEMD160
```
public static final Algorithm RIPEMD160
```
  - RSA
```
public static final Algorithm RSA
```
  - SHA256
```
public static final Algorithm SHA256
```
  - SHA384
```
public static final Algorithm SHA384
```
  - SHA512
```
public static final Algorithm SHA512
```
  - TWOFISH128
```
public static final Algorithm TWOFISH128
```
  - TWOFISH192
```
public static final Algorithm TWOFISH192
```
  - TWOFISH256
```
public static final Algorithm TWOFISH256
```
- Field Detail
  - serialVersionUID
```
public static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
- Method Detail
  - values
```
public static Algorithm[] 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 (Algorithm c : Algorithm.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Algorithm 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
  - getAlgorithms
```
public static Algorithm[] getAlgorithms(AlgorithmType at)
```
    Return a list of algorithms of the specified type.
    
    Parameters:
    
    at - the algorithm type to generate a list for
    
    Returns:
    
    the list of algorithms
  - getById
```
public static Algorithm getById(int id)
```
    Look up an algorithm by id.
    
    Parameters:
    
    id - the idto be looked up
    
    Returns:
    
    the algorithm or null if not known
  - getByString
```
public static Algorithm getByString(String s)
```
    Look up an algorithm by its identification string.
    
    The string search is case insensitive.
    
    Parameters:
    
    s - the identification string to be looked up
    
    Returns:
    
    the algorithm or null if not found
  - getDefault
```
public static Algorithm getDefault(AlgorithmType at)
```
    Look up the default algorithm to be used on the system.
    
    Parameters:
    
    at - the type of algorithm to be looked for
    
    Returns:
    
    the default type
  - getId
```
public int getId()
```
    Look up the current id.
    
    Returns:
    
    the current id
  - getAlgorithmFamily
```
public String getAlgorithmFamily()
```
    The algorithm family.
    
    This is either the identification string without the key size or identical to the identification string
    
    Returns:
    
    the identification string without key size (if any)
  - toString
```
public String toString()
```
    Get the identification string.
    
    Overrides:
    
    toString in class Enum<Algorithm>
    
    Returns:
    
    the identification string
  - getAlgorithmType
```
public AlgorithmType getAlgorithmType()
```
    Get the type of algorithm.
    
    Returns:
    
    the type of algorithm
  - getProvider
```
public String getProvider()
```
    Get the provider string for this algorithm.
    
    Returns:
    
    the provider string for this algorithm
  - getKeySize
```
public int getKeySize()
```
    Get the default key size for this algorithm.
    
    Returns:
    
    the default key size in bits
  - getKeySize
```
public int getKeySize(SecurityLevel sl)
```
    Get the key size for this algorithm and security level.
    
    Parameters:
    
    sl - the security level
    
    Returns:
    
    the key size in bits for the security level specified
  - getBlockSize
```
public int getBlockSize()
```
    Get the default key size for this algorithm.
    
    Returns:
    
    the default key size in bits
  - getBlockSize
```
public int getBlockSize(SecurityLevel sl)
```
    Get the block size for this algorithm and security level.
    
    Parameters:
    
    sl - the security level
    
    Returns:
    
    the key size in bits for the security level specified or -1 if not set
  - getParameters
```
public AlgorithmParameter getParameters(SecurityLevel sl)
```
    Get default parameters for the security level specified.
    
    Parameters:
    
    sl - the security level
    
    Returns:
    
    the default set of parameters for the security level specified
  - getParameters
```
public Map<SecurityLevel,AlgorithmParameter> getParameters()
```
    Get a map of security levels and default parameters for this algorithm.
    
    Returns:
    
    The map containing the default parameters

Enum Algorithm

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

AES128

AES192

AES256

CAMELLIA128

CAMELLIA192

CAMELLIA256

EC

RIPEMD160

RSA

SHA256

SHA384

SHA512

TWOFISH128

TWOFISH192

TWOFISH256

Field Detail

serialVersionUID

Method Detail

values

valueOf

getAlgorithms

getById

getByString

getDefault

getId

getAlgorithmFamily

toString

getAlgorithmType

getProvider

getKeySize

getKeySize

getBlockSize

getBlockSize

getParameters

getParameters