StandardAttributeType (Cryptacular Library 1.2.7 API)

java.lang.Object
- java.lang.Enum<StandardAttributeType>
- - org.cryptacular.x509.dn.StandardAttributeType

All Implemented Interfaces:

Serializable, Comparable<StandardAttributeType>, AttributeType
```
public enum StandardAttributeType
extends Enum<StandardAttributeType>
implements AttributeType
```
Describes the registered values of AttributeType that may appear in a RelativeDistinguishedName (RDN) as defined in section 2 of RFC 2253.
Enumeration values include attributes likely to appear in an X.509 RDN, which were obtained from the following sources:
- RFC 4519 Lightweight Directory Access Protocol (LDAP): Schema for User Applications
- RFC 4524 COSINE LDAP/X.500 Schema
- PKCS #9 v2.0: Selected Object Classes and Attribute Types
Version:

$Revision: 2745 $

Author:

Middleware Services

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CommonName` CN - RFC 4519 section 2.3.
`CountryName` C - RFC 4519 section 2.2.
`Description` DESCRIPTION - RFC 4519 section 2.5.
`DnQualifier` DNQUALIFIER - RFC 4519 section 2.8.
`DomainComponent` DC - RFC 4519 section 2.4.
`EmailAddress` Email address - PKCS#9 v2.0 section B.3.5.
`GenerationQualifier` GenerationQualifier - RFC 4519 section 2.11.
`GivenName` GIVENNAME - RFC 4519 section 2.12.
`Initials` INITIALS - RFC 4519 section 2.14.
`LocalityName` L - RFC 4519 section 2.16.
`Mail` MAIL - RFC 4524 section 2.16.
`Name` NAME - RFC 4519 section 2.18.
`OrganizationalUnitName` OU - RFC 4519 section 2.20.
`OrganizationName` O - RFC 4519 section 2.19.
`PostalAddress` POSTALADDRESS - RFC 4519 section 2.23.
`PostalCode` POSTALCODE - RFC 4519 section 2.24.
`PostOfficeBox` POSTOFFICEBOX - RFC 4519 section 2.25.
`SerialNumber` SERIALNUMBER - RFC 4519 section 2.31.
`StateOrProvinceName` ST - RFC 4519 section 2.33.
`StreetAddress` STREET - RFC 4519 section 2.34.
`Surname` SN - RFC 4519 section 2.32.
`TelephoneNumber` TELEPHONENUMBER - RFC 4519 section 2.35.
`Title` TITLE - RFC 4519 section 2.38.
`UniqueIdentifier` UNIQUEIDENTIFIER - RFC 4524 section 2.24.
`UserId` UID - RFC 4519 section 2.39.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AttributeType`	`fromName(String name)` Gets the attribute type whose name is the given string.
`static StandardAttributeType`	`fromOid(String oid)` Gets the attribute type whose OID is the given string.
`String`	`getName()`
`String`	`getOid()`
`String`	`toString()`
`static StandardAttributeType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static StandardAttributeType[]`	`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, valueOf

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

- Enum Constant Detail
  - CommonName
```
public static final StandardAttributeType CommonName
```
    CN - RFC 4519 section 2.3.
  - CountryName
```
public static final StandardAttributeType CountryName
```
    C - RFC 4519 section 2.2.
  - Description
```
public static final StandardAttributeType Description
```
    DESCRIPTION - RFC 4519 section 2.5.
  - DnQualifier
```
public static final StandardAttributeType DnQualifier
```
    DNQUALIFIER - RFC 4519 section 2.8.
  - DomainComponent
```
public static final StandardAttributeType DomainComponent
```
    DC - RFC 4519 section 2.4.
  - EmailAddress
```
public static final StandardAttributeType EmailAddress
```
    Email address - PKCS#9 v2.0 section B.3.5.
  - GenerationQualifier
```
public static final StandardAttributeType GenerationQualifier
```
    GenerationQualifier - RFC 4519 section 2.11.
  - GivenName
```
public static final StandardAttributeType GivenName
```
    GIVENNAME - RFC 4519 section 2.12.
  - Initials
```
public static final StandardAttributeType Initials
```
    INITIALS - RFC 4519 section 2.14.
  - LocalityName
```
public static final StandardAttributeType LocalityName
```
    L - RFC 4519 section 2.16.
  - Mail
```
public static final StandardAttributeType Mail
```
    MAIL - RFC 4524 section 2.16.
  - Name
```
public static final StandardAttributeType Name
```
    NAME - RFC 4519 section 2.18.
  - OrganizationName
```
public static final StandardAttributeType OrganizationName
```
    O - RFC 4519 section 2.19.
  - OrganizationalUnitName
```
public static final StandardAttributeType OrganizationalUnitName
```
    OU - RFC 4519 section 2.20.
  - PostalAddress
```
public static final StandardAttributeType PostalAddress
```
    POSTALADDRESS - RFC 4519 section 2.23.
  - PostalCode
```
public static final StandardAttributeType PostalCode
```
    POSTALCODE - RFC 4519 section 2.24.
  - PostOfficeBox
```
public static final StandardAttributeType PostOfficeBox
```
    POSTOFFICEBOX - RFC 4519 section 2.25.
  - SerialNumber
```
public static final StandardAttributeType SerialNumber
```
    SERIALNUMBER - RFC 4519 section 2.31.
  - StateOrProvinceName
```
public static final StandardAttributeType StateOrProvinceName
```
    ST - RFC 4519 section 2.33.
  - StreetAddress
```
public static final StandardAttributeType StreetAddress
```
    STREET - RFC 4519 section 2.34.
  - Surname
```
public static final StandardAttributeType Surname
```
    SN - RFC 4519 section 2.32.
  - TelephoneNumber
```
public static final StandardAttributeType TelephoneNumber
```
    TELEPHONENUMBER - RFC 4519 section 2.35.
  - Title
```
public static final StandardAttributeType Title
```
    TITLE - RFC 4519 section 2.38.
  - UniqueIdentifier
```
public static final StandardAttributeType UniqueIdentifier
```
    UNIQUEIDENTIFIER - RFC 4524 section 2.24.
  - UserId
```
public static final StandardAttributeType UserId
```
    UID - RFC 4519 section 2.39.
- Method Detail
  - values
```
public static StandardAttributeType[] 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 (StandardAttributeType c : StandardAttributeType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static StandardAttributeType 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
  - getOid
```
public String getOid()
```
    Specified by:
    
    getOid in interface AttributeType
    
    Returns:
    
    OID of attribute type.
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface AttributeType
    
    Returns:
    
    Registered short name of attribute type.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<StandardAttributeType>
    
    Returns:
    
    Attribute name.
  - fromOid
```
public static StandardAttributeType fromOid(String oid)
```
    Gets the attribute type whose OID is the given string.
    
    Parameters:
    
    oid - OID of attribute type to get.
    
    Returns:
    
    Attribute type whose OID matches given value or none if there is no standard attribute type matching the given OID.
  - fromName
```
public static AttributeType fromName(String name)
```
    Gets the attribute type whose name is the given string.
    
    Parameters:
    
    name - Name of attribute to get, where the name is the all-caps RFC/standard name that would be returned by getName() for the desired attribute.
    
    Returns:
    
    Attribute type whose getName() property matches the given value or null if there is no standard attribute with the given name.

Enum StandardAttributeType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

CommonName

CountryName

Description

DnQualifier

DomainComponent

EmailAddress

GenerationQualifier

GivenName

Initials

LocalityName

Mail

Name

OrganizationName

OrganizationalUnitName

PostalAddress

PostalCode

PostOfficeBox

SerialNumber

StateOrProvinceName

StreetAddress

Surname

TelephoneNumber

Title

UniqueIdentifier

UserId

Method Detail

values

valueOf

getOid

getName

toString

fromOid

fromName