com.rsa.certj.cert.attributes

Class PlaceOfBirth

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

All Implemented Interfaces:

Cloneable, Serializable

public class PlaceOfBirth

extends X501Attribute

implements Cloneable, Serializable

This class holds, encodes, and decodes the PlaceOfBirth attribute, which is defined in PKCS #9. The placeOfBirth attribute specifies the place of birth of the subject with which the attribute is associated.

 placeOfBirth ATTRIBUTE ::= {
	WITH SYNTAX DirectoryString {pkcs-9-ub-placeOfBirth}
	EQUALITY MATCHING RULE caseExactMatch
	SINGLE VALUE TRUE
	ID pkcs-9-at-placeOfBirth
 }

PlaceOfBirth attributes must be single-valued.

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

PlaceOfBirth()

Constructs an empty PlaceOfBirth object.

PlaceOfBirth(String placeOfBirth, int stringType)

Constructs a PlaceOfBirth 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 PlaceOfBirth; returns false, otherwise.
String	getPlaceOfBirth() Gets the value of this attribute, the place of birth.
void	setPlaceOfBirth(String placeOfBirth, int stringType) Sets the value of this attribute, the PlaceOfBirth, to placeOfBirth.

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

PlaceOfBirth

public PlaceOfBirth()

Constructs an empty PlaceOfBirth object.

PlaceOfBirth

public PlaceOfBirth(String placeOfBirth,
                    int stringType)
             throws AttributeException

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

Parameters

	placeOfBirth		The place of birth of the subject.
	stringType		placeOfBirth 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 placeOfBirth is null.

Method Detail

setPlaceOfBirth

public void setPlaceOfBirth(String placeOfBirth,
                            int stringType)
                     throws AttributeException

Sets the value of this attribute, the PlaceOfBirth, to placeOfBirth.

Parameters

	placeOfBirth		The place of birth.
	stringType		The placeOfBirth 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 placeOfBirth is null.

getPlaceOfBirth

public String getPlaceOfBirth()

Gets the value of this attribute, the place of birth.

Returns

A String indicating the PlaceOfBirth 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 PlaceOfBirth 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 PlaceOfBirth; returns false, otherwise.

Overrides

equals in class Object

Parameters

obj

The instance of the PlaceOfBirth object.

Returns

A Boolean indicating whether these objects are equal.