OtpErrorConstants (kernel-otpmanager-service 1.0.5 API)

java.lang.Object
- java.lang.Enum<OtpErrorConstants>
- - io.mosip.kernel.otpmanager.constant.OtpErrorConstants

All Implemented Interfaces:

Serializable, Comparable<OtpErrorConstants>
```
public enum OtpErrorConstants
extends Enum<OtpErrorConstants>
```
This ENUM provides all the constant identified for OTP errors.

Version:

1.0.0

Author:

Sagar Mahapatra, Ritesh Sinha

Enum Constant Summary

Enum Constants
Enum Constant and Description
`HTTP_MESSAGE_NOT_READABLE`
`INTERNAL_SERVER_ERROR`
`OTP_GEN_ALGO_FAILURE`
`OTP_GEN_CRYPTO_FAILURE`
`OTP_GEN_ILLEGAL_KEY_INPUT`
`OTP_GEN_IO_FAILURE`
`OTP_VAL_ILLEGAL_KEY_INPUT`
`OTP_VAL_ILLEGAL_OTP_INPUT`
`OTP_VAL_INVALID_KEY_INPUT`
`OTP_VAL_INVALID_OTP_INPUT`
`OTP_VAL_KEY_NOT_FOUND`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getErrorCode()`
`String`	`getErrorMessage()`
`static OtpErrorConstants`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static OtpErrorConstants[]`	`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, toString, valueOf

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

- Enum Constant Detail
  - OTP_GEN_ILLEGAL_KEY_INPUT
```
public static final OtpErrorConstants OTP_GEN_ILLEGAL_KEY_INPUT
```
  - OTP_VAL_INVALID_KEY_INPUT
```
public static final OtpErrorConstants OTP_VAL_INVALID_KEY_INPUT
```
  - OTP_VAL_ILLEGAL_KEY_INPUT
```
public static final OtpErrorConstants OTP_VAL_ILLEGAL_KEY_INPUT
```
  - OTP_VAL_INVALID_OTP_INPUT
```
public static final OtpErrorConstants OTP_VAL_INVALID_OTP_INPUT
```
  - OTP_VAL_ILLEGAL_OTP_INPUT
```
public static final OtpErrorConstants OTP_VAL_ILLEGAL_OTP_INPUT
```
  - OTP_VAL_KEY_NOT_FOUND
```
public static final OtpErrorConstants OTP_VAL_KEY_NOT_FOUND
```
  - INTERNAL_SERVER_ERROR
```
public static final OtpErrorConstants INTERNAL_SERVER_ERROR
```
  - HTTP_MESSAGE_NOT_READABLE
```
public static final OtpErrorConstants HTTP_MESSAGE_NOT_READABLE
```
  - OTP_GEN_CRYPTO_FAILURE
```
public static final OtpErrorConstants OTP_GEN_CRYPTO_FAILURE
```
  - OTP_GEN_ALGO_FAILURE
```
public static final OtpErrorConstants OTP_GEN_ALGO_FAILURE
```
  - OTP_GEN_IO_FAILURE
```
public static final OtpErrorConstants OTP_GEN_IO_FAILURE
```
- Method Detail
  - values
```
public static OtpErrorConstants[] 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 (OtpErrorConstants c : OtpErrorConstants.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static OtpErrorConstants 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
  - getErrorCode
```
public String getErrorCode()
```
    Returns:
    
    The error code.
  - getErrorMessage
```
public String getErrorMessage()
```
    Returns:
    
    The error message.

Enum OtpErrorConstants

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

OTP_GEN_ILLEGAL_KEY_INPUT

OTP_VAL_INVALID_KEY_INPUT

OTP_VAL_ILLEGAL_KEY_INPUT

OTP_VAL_INVALID_OTP_INPUT

OTP_VAL_ILLEGAL_OTP_INPUT

OTP_VAL_KEY_NOT_FOUND

INTERNAL_SERVER_ERROR

HTTP_MESSAGE_NOT_READABLE

OTP_GEN_CRYPTO_FAILURE

OTP_GEN_ALGO_FAILURE

OTP_GEN_IO_FAILURE

Method Detail

values

valueOf

getErrorCode

getErrorMessage