org.nhindirect.policy.x509

Enum TBSFieldName

java.lang.Object

java.lang.Enum<TBSFieldName>

org.nhindirect.policy.x509.TBSFieldName

All Implemented Interfaces:

Serializable, Comparable<TBSFieldName>

public enum TBSFieldName
extends Enum<TBSFieldName>

Enumeration of to be signed fields in an X509 certificate as defined by RFC5280.

Since:

1.0

Author:

Greg Meyer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TBSFieldName.AttributeReferenceClass

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXTENSIONS Certificate extension fields
ISSUER Distinguished name of certificate signer
ISSUER_UNIQUE_ID Certificate issuer unique id
SERIAL_NUMBER Certificate serial number
SIGNATURE Certificate signature algorithm
SUBJECT Distinguished name of the entity associated with the public key
SUBJECT_PUBLIC_KEY_INFO Certificate public key and algorithm
SUBJECT_UNIQUE_ID Certificate subject unique id
VALIDITY Certificate valid to and valid from dates
VERSION Certificate version

Method Summary

Modifier and Type	Method and Description
static TBSFieldName	fromToken(String token) Gets the field name associated with a specific token string.
String	getDisplay() Gets a human readable display name of the field.
Collection<String>	getFieldTokens() Some fields may contain complex structure and multiple value may be extracted from the field or may required additional qualifiers to identify a specific value.
Class<? extends TBSField<?>>	getReferenceClass(String tokenName) Gets the class implementing the field name.
String	getRfcName() Gets the name of the field as defined by RFC5280.
String	toString()
static TBSFieldName	valueOf(String name) Returns the enum constant of this type with the specified name.
static TBSFieldName[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

VERSION

public static final TBSFieldName VERSION

Certificate version

SERIAL_NUMBER

public static final TBSFieldName SERIAL_NUMBER

Certificate serial number

SIGNATURE

public static final TBSFieldName SIGNATURE

Certificate signature algorithm

ISSUER

public static final TBSFieldName ISSUER

Distinguished name of certificate signer

VALIDITY

public static final TBSFieldName VALIDITY

Certificate valid to and valid from dates

SUBJECT

public static final TBSFieldName SUBJECT

Distinguished name of the entity associated with the public key

ISSUER_UNIQUE_ID

public static final TBSFieldName ISSUER_UNIQUE_ID

Certificate issuer unique id

SUBJECT_UNIQUE_ID

public static final TBSFieldName SUBJECT_UNIQUE_ID

Certificate subject unique id

EXTENSIONS

public static final TBSFieldName EXTENSIONS

Certificate extension fields

SUBJECT_PUBLIC_KEY_INFO

public static final TBSFieldName SUBJECT_PUBLIC_KEY_INFO

Certificate public key and algorithm

Method Detail

values

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

Returns:

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

valueOf

public static TBSFieldName 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

getRfcName

public String getRfcName()

Gets the name of the field as defined by RFC5280.

Returns:

The name of the field as defined by RFC5280.

getDisplay

public String getDisplay()

Gets a human readable display name of the field.

Returns:

A human readable display name of the field.

getFieldTokens

public Collection<String> getFieldTokens()

Some fields may contain complex structure and multiple value may be extracted from the field or may required additional qualifiers to identify a specific value. This method get a list of attribute token names or qualifiers that can be access from the field. If the field does not support sub attributes or qualifiers, then this method returns a single entry with the field name.

Returns:

Gets a list of attribute token names or qualifiers that can be access from the field.

getReferenceClass

public Class<? extends TBSField<?>> getReferenceClass(String tokenName)

Gets the class implementing the field name.

Returns:

The class implementing the field name.

fromToken

public static TBSFieldName fromToken(String token)

Gets the field name associated with a specific token string.

Parameters:

token - The token used to look up the TBSFieldName.

Returns:

The TBSFieldName associated with the token. If the token does not represent a known field, then null is returned,.

toString

public String toString()

Overrides:

toString in class Enum<TBSFieldName>