com.rsa.certj.cert.attributes

Class Pseudonym

java.lang.Object
  |
  +--com.rsa.certj.cert.attributes.X501Attribute
        |
        +--com.rsa.certj.cert.attributes.Pseudonym

All Implemented Interfaces:

Cloneable, Serializable

public class Pseudonym

extends X501Attribute

implements Cloneable, Serializable

This class holds, encodes, and decodes the Pseudonym attribute, which is defined in PKCS #9. The Pseudonym attribute type contains a pseudonym of a subject. The exact interpretation of pseudonyms is intended to be specified by certificate issuers. No particular interpretation is required.

 pseudonym ATTRIBUTE ::= {
	WITH SYNTAX DirectoryString {pkcs-9-ub-pseudonym}
	EQUALITY MATCHING RULE caseExactMatch
	ID id-at-pseudonym
 }

Copyright © RSA Security Inc., 2002. All rights reserved.

See Also

Serialized Form

Fields inherited from class com.rsa.certj.cert.attributes.X501Attribute

CHALLENGE_PASSWORD, CONTENT_TYPE, COUNTRY_OF_CITIZENSHIP, COUNTRY_OF_RESIDENCE, CRS_DUAL_STATUS, CRS_FAILURE_INFO, CRS_MESSAGE_TYPE, CRS_PKI_STATUS, CRS_RECIPIENT_NONCE, CRS_SENDER_NONCE, CRS_TRANSACTION_ID, CRS_VERSION, DATE_OF_BIRTH, FRIENDLY_NAME, GENDER, LOCAL_KEY_ID, MESSAGE_DIGEST, NON_STANDARD, PLACE_OF_BIRTH, POSTAL_ADDRESS, PSEUDONYM, SIGNING_TIME, SMART_CSP, X509_V3_EXTENSION

Constructor Summary

Pseudonym()

Constructs an empty Pseudonym object.

Pseudonym(String pseudonym, int stringType)

Constructs a Pseudonym object and initializes it with the value given.

Method Summary

Object	clone() Overrides the default clone method to get a deeper clone.
boolean	equals(Object obj) Returns true if this object and obj contain the same Pseudonym; returns false, otherwise.
String	getPseudonym() Gets the value of this attribute, the pseudonym.
void	setPseudonym(String pseudonym, int stringType) Sets the value of this attribute, Pseudonym, to pseudonym.

Methods inherited from class com.rsa.certj.cert.attributes.X501Attribute

clearSensitiveData, compareOID, derEncodeAttributeLen, getAttributeType, getAttributeTypeString, getDEREncoding, getDERLen, getInstance, getNextBEROffset, getOID, isAttributeType

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Pseudonym

public Pseudonym()

Constructs an empty Pseudonym object.

Pseudonym

public Pseudonym(String pseudonym,
                 int stringType)
          throws AttributeException

Constructs a Pseudonym object and initializes it with the value given.

Parameters

	pseudonym		A pseudonym of a subject.
	stringType		The pseudonym is BER-encoded, as this is an ASN.1 string type. This argument must be one of the following fields: ASN1.PRINT_STRING, ASN1.UNIVERSAL_STRING, ASN1.UTF8_STRING, ASN1.BMP_STRING, ASN1.IA5_STRING, or ASN1.TELETEX_STRING.

Throws

AttributeException - If the specified stringType is invalid, or if pseudonym is null.

Method Detail

setPseudonym

public void setPseudonym(String pseudonym,
                         int stringType)
                  throws AttributeException

Sets the value of this attribute, Pseudonym, to pseudonym.

Parameters

	pseudonym		The pseudonym to store.
	stringType		The pseudonym is BER-encoded, as this is an ASN.1 string type. This argument must be one of the following fields: ASN1.PRINT_STRING, ASN1.UNIVERSAL_STRING, ASN1.UTF8_STRING, ASN1.BMP_STRING, ASN1.IA5_STRING, or ASN1.TELETEX_STRING.

Throws

AttributeException - If the encoding is invalid for this attribute, or if pseudonym is null.

getPseudonym

public String getPseudonym()

Gets the value of this attribute, the pseudonym.

Returns

A String indicating the pseudonym value.

clone

public Object clone()
             throws CloneNotSupportedException

Overrides the default clone method to get a deeper clone.

Overrides

clone in class X501Attribute

Returns

A new Pseudonym object, a copy of this object.

Throws

CloneNotSupportedException - If the cloning operation is not successful.

equals

public boolean equals(Object obj)

Returns true if this object and obj contain the same Pseudonym; returns false, otherwise.

Overrides

equals in class Object

Parameters

obj

The instance of the Pseudonym object.

Returns

A Boolean indicating whether these objects are equal.