Package com.oracle.bmc.keymanagement.model

Enum KeySummary.ProtectionMode

java.lang.Object

java.lang.Enum<KeySummary.ProtectionMode>

com.oracle.bmc.keymanagement.model.KeySummary.ProtectionMode

All Implemented Interfaces:

BmcEnum, Serializable, Comparable<KeySummary.ProtectionMode>

Enclosing class:

KeySummary

public static enum KeySummary.ProtectionMode
extends Enum<KeySummary.ProtectionMode>
implements BmcEnum

The key’s protection mode indicates how the key persists and where cryptographic operations that use the key are performed.

A protection mode of HSM means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside the HSM. A protection mode of SOFTWARE means that the key persists on the server, protected by the vault’s RSA wrapping key which persists on the HSM. All cryptographic operations that use a key with a protection mode of SOFTWARE are performed on the server. By default, a key’s protection mode is set to HSM. You can’t change a key’s protection mode after the key is created or imported. A protection mode of EXTERNAL mean that the key persists on the customer’s external key manager which is hosted externally outside of oracle. Oracle only hold a reference to that key. All cryptographic operations that use a key with a protection mode of EXTERNAL are performed by external key manager.

Enum Constant Summary

Enum Constants

Enum Constant	Description
External
Hsm
Software
UnknownEnumValue	This value is used if a service returns a value for this enum that is not recognized by this version of the SDK.

Method Summary

Modifier and Type	Method	Description
static KeySummary.ProtectionMode	create(String key)
String	getValue()
static KeySummary.ProtectionMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static KeySummary.ProtectionMode[]	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

Hsm

public static final KeySummary.ProtectionMode Hsm

Software

public static final KeySummary.ProtectionMode Software

External

public static final KeySummary.ProtectionMode External

UnknownEnumValue

public static final KeySummary.ProtectionMode UnknownEnumValue

This value is used if a service returns a value for this enum that is not recognized by this version of the SDK.

Method Detail

values

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

Returns:

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

valueOf

public static KeySummary.ProtectionMode 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

getValue

public String getValue()

Specified by:

getValue in interface BmcEnum

create

public static KeySummary.ProtectionMode create(String key)