com.entrust.toolkit.credentials

Enum CapiIdentity.Format

java.lang.Object

java.lang.Enum<CapiIdentity.Format>

com.entrust.toolkit.credentials.CapiIdentity.Format

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CapiIdentity.Format>

Enclosing class:

CapiIdentity

public static enum CapiIdentity.Format
extends java.lang.Enum<CapiIdentity.Format>

An MSCAPI-based digital identity format.

The MSCAPI-based digital identity format is a function of key container naming scheme that is employed by the MSCAPI key container(s) that the identity contains. The digital identity format determines how/if the digital identity is managed.

Since:

8.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
ENTRUST_LEGACY Represents a legacy Entrust MSCAPI-based digital identity; digital identity management is not supported on identities of this format.
ENTRUST_V1 Represents a V1-key-pair Entrust MSCAPI-based digital identity; digital identity management is supported on identities of this format.
ENTRUST_V2 Represents a V2-key-pair Entrust MSCAPI-based digital identity; digital identity management is supported on identities of this format.
NON_ENTRUST Represents an MSCAPI-based digital identity that is not of Entrust format; digital identity management is not supported on identities of this format.

Method Summary

Methods

Modifier and Type	Method and Description
static CapiIdentity.Format	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CapiIdentity.Format[]	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

NON_ENTRUST

public static final CapiIdentity.Format NON_ENTRUST

Represents an MSCAPI-based digital identity that is not of Entrust format; digital identity management is not supported on identities of this format.

Note: This does not mean that the keys/certificates in a digital identity of this format were issued by a non-Entrust certification authority. It simply means that the digital identity format is non-Entrust (not recognized by Entrust software).

ENTRUST_LEGACY

public static final CapiIdentity.Format ENTRUST_LEGACY

Represents a legacy Entrust MSCAPI-based digital identity; digital identity management is not supported on identities of this format.

ENTRUST_V1

public static final CapiIdentity.Format ENTRUST_V1

Represents a V1-key-pair Entrust MSCAPI-based digital identity; digital identity management is supported on identities of this format.

ENTRUST_V2

public static final CapiIdentity.Format ENTRUST_V2

Represents a V2-key-pair Entrust MSCAPI-based digital identity; digital identity management is supported on identities of this format.

Method Detail

values

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

Returns:

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

valueOf

public static CapiIdentity.Format 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