com.amazonaws.cloudhsm.jce.jni.exception

Enum KeyUsageExceptionCause

java.lang.Object

java.lang.Enum<KeyUsageExceptionCause>

com.amazonaws.cloudhsm.jce.jni.exception.KeyUsageExceptionCause

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<KeyUsageExceptionCause>

public enum KeyUsageExceptionCause
extends java.lang.Enum<KeyUsageExceptionCause>

Used with KeyUsageException to specify the cause of the exception.

Enum Constant Summary

Enum Constants

Enum Constant and Description
KEY_AVAILABILITY_CHECK_FAILED The provided key does not meet the availability requirements.
KEY_FUNCTION_NOT_PERMITTED An attempt has been made to use a key for a cryptographic purpose that the key's attributes are not set to allow it to do.
KEY_NOT_FOUND Key pointed to by this object was not found on the HSM.
KEY_SIZE_RANGE The supplied key size is outside the range of supported key sizes for the key type.
KEY_TYPE_INCONSISTENT The specified key has an invalid type for the specified mechanism.
KEY_UNEXTRACTABLE The attributes of the key do not allow it to be extracted.
UNSUPPORTED_KEY_TYPE The provided key type is not supported.

Method Summary

Modifier and Type	Method and Description
static KeyUsageExceptionCause	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static KeyUsageExceptionCause[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

KEY_AVAILABILITY_CHECK_FAILED

public static final KeyUsageExceptionCause KEY_AVAILABILITY_CHECK_FAILED

The provided key does not meet the availability requirements.

Resolution: The application should wait until the key is available on the set number of HSMs or update the key availability requirement configuration option.

KEY_FUNCTION_NOT_PERMITTED

public static final KeyUsageExceptionCause KEY_FUNCTION_NOT_PERMITTED

An attempt has been made to use a key for a cryptographic purpose that the key's attributes are not set to allow it to do.

Resolution: The application should use a key with attributes that allow this cryptographic operation.

KEY_SIZE_RANGE

public static final KeyUsageExceptionCause KEY_SIZE_RANGE

The supplied key size is outside the range of supported key sizes for the key type.

Resolution: The application should use a supported key size for the given operation.

KEY_TYPE_INCONSISTENT

public static final KeyUsageExceptionCause KEY_TYPE_INCONSISTENT

The specified key has an invalid type for the specified mechanism.

Resolution: The application should use a valid key type for this mechanism

UNSUPPORTED_KEY_TYPE

public static final KeyUsageExceptionCause UNSUPPORTED_KEY_TYPE

The provided key type is not supported.

Resolution: The application should use a supported key type for this operation.

KEY_NOT_FOUND

public static final KeyUsageExceptionCause KEY_NOT_FOUND

Key pointed to by this object was not found on the HSM.

Resolution: The application should only use active keys.

KEY_UNEXTRACTABLE

public static final KeyUsageExceptionCause KEY_UNEXTRACTABLE

The attributes of the key do not allow it to be extracted.

Resolution: The application may only extract keys which have the KeyAttribute.EXTRACTABLE attribute.

Method Detail

values

public static KeyUsageExceptionCause[] 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 (KeyUsageExceptionCause c : KeyUsageExceptionCause.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static KeyUsageExceptionCause valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null