com.rsa.certj.cert.extensions

Class TeletexPersonalName

java.lang.Object
  |
  +--com.rsa.certj.cert.extensions.TeletexPersonalName

All Implemented Interfaces:

Cloneable, Serializable

public class TeletexPersonalName

extends Object

implements Cloneable, Serializable

This class is used in the GeneralName class.

The ASN.1 definition is as follows:

 TeletexPersonalName ::= SET {
   surname    [0] TeletexString (SIZE (1. .ub-surname-length)),
   given-name [1] TeletexString (SIZE (1. .ub-given-name-length)) OPTIONAL,
   initials   [2] TeletexString (SIZE (1. .ub-initials-length)) OPTIONAL,
   generation-qualifier [3] TeletexString 
                      (SIZE (1. .ub-generation-qualifier-length)) OPTIONAL }

 ub-surname-length INTEGER ::= 40
 ub-given-name-length INTEGER ::= 16
 ub-initials-length INTEGER ::= 5
 ub-generation-qualifier-length INTEGER ::= 3

Copyright © RSA Security Inc., 1999-2001. All rights reserved.

See Also

Serialized Form

Constructor Summary

TeletexPersonalName()

Constructs an empty TeletexPersonalName object.

TeletexPersonalName(byte[] nameBER, int offset, int special)

Constructs a TeletexPersonalName object, and initializes it with the given values.

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 TeletexPersonalName; returns false otherwise.
int	getDEREncoding(byte[] encoding, int offset, int special) Places the DER encoding of the TeletexPersonalName object into encoding, beginning at offset.
int	getDERLen(int special) Returns the number of bytes that will be used by the DER encoding of this TeletexPersonalName object.
String	getGenerationQualifier() Gets the value of the generation-qualifier field in this object.
String	getGivenName() Gets the value of the given-name field in this object.
String	getInitials() Gets the value of the initials field in this object.
static int	getNextBEROffset(byte[] nameBER, int offset) Given nameBER, the BER encoding of an TeletexPersonalName object, beginning at offset, finds the index to the next element in the encoding.
String	getSurname() Gets the value of the surname field in this object.
void	setGenerationQualifier(String name) Sets the value of the generation-qualifier field in this object.
void	setGivenName(String name) Sets the value of the given-name field in this object.
void	setInitials(String name) Sets the value of the initials field in this object.
void	setSurname(String name) Sets the value of the surname field in this object.
String	toString() Returns a String that describes this TeletexPersonalName object.

Methods inherited from class java.lang.Object

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

Constructor Detail

TeletexPersonalName

public TeletexPersonalName(byte[] nameBER,
                           int offset,
                           int special)
                    throws NameException

Constructs a TeletexPersonalName object, and initializes it with the given values.

Parameters

	nameBER		A byte array that contains the BER encoding of a TeletexPersonalName name.
	offset		The offset into nameBER where the encoding begins.
	special		The special circumstances of the BER encoding, if there are any. The following ASN.1 constants are possible values for special: APP_IMPLICIT, APP_EXPLICIT, PRIVATE_IMPLICIT, PRIVATE_EXPLICIT, OPTIONAL, DEFAULT, CONTEXT_IMPLICIT, or CONTEXT_EXPLICIT.

Throws

NameException - If the encoding is invalid.

TeletexPersonalName

public TeletexPersonalName()

Constructs an empty TeletexPersonalName object.

Method Detail

setSurname

public void setSurname(String name)

Sets the value of the surname field in this object.

Parameters

name

A String that specifies the surname value, up to a maximum length of 40 characters.

setGivenName

public void setGivenName(String name)

Sets the value of the given-name field in this object.

Parameters

name

A String that specifies the given name, up to a maximum length of 16 characters.

setInitials

public void setInitials(String name)

Sets the value of the initials field in this object.

Parameters

name

A String that specifies the initials value, up to a maximum length of 5 characters.

setGenerationQualifier

public void setGenerationQualifier(String name)

Sets the value of the generation-qualifier field in this object.

Parameters

name

A String that specifies the generation-qualifier value, up to a maximum length of 3 characters.

getSurname

public String getSurname()

Gets the value of the surname field in this object.

Returns

A String that specifies the surname value.

getGivenName

public String getGivenName()

Gets the value of the given-name field in this object.

Returns

A String that specifies the given name value.

getInitials

public String getInitials()

Gets the value of the initials field in this object.

Returns

A String that specifies the initials value.

getGenerationQualifier

public String getGenerationQualifier()

Gets the value of the generation-qualifier field in this object.

Returns

A String that specifies the generation qualifier value.

toString

public String toString()

Returns a String that describes this TeletexPersonalName object.

Overrides

toString in class Object

Returns

A String that describes this TeletexPersonalName object.

getNextBEROffset

public static int getNextBEROffset(byte[] nameBER,
                                   int offset)
                            throws NameException

Given nameBER, the BER encoding of an TeletexPersonalName object, beginning at offset, finds the index to the next element in the encoding. In other words, gets the next offset after the name.

For example, if the offset is 120 and the length of the BER encoding of the TeletexPersonalName object is 1819 bytes, then this method will return 1939, the index immediately following the TeletexPersonalName object. That is, nameBER[120] is the first byte in the encoding of the TeletexPersonalName object, nameBER[1938] is the last byte in the encoding of the TeletexPersonalName object, and the next element begins at index 1939.

Parameters

	nameBER		The BER encoding of a TeletexPersonalName object.
	offset		The offset into nameBER where the encoding begins.

Returns

The index to the next element in the BER encoding.

Throws

NameException - If the method cannot read the BER encoding.

getDERLen

public int getDERLen(int special)

Returns the number of bytes that will be used by the DER encoding of this TeletexPersonalName object. If this object is not set with values, this method returns zero.

Parameters

special

The special DER circumstances of the encoding, if there are any. The following ASN.1 constants are possible values for special: APP_IMPLICIT, APP_EXPLICIT, PRIVATE_IMPLICIT, PRIVATE_EXPLICIT, OPTIONAL, DEFAULT, CONTEXT_IMPLICIT, or CONTEXT_EXPLICIT.

Returns

The number of bytes that will be used in the DER encoding of this object.

getDEREncoding

public int getDEREncoding(byte[] encoding,
                          int offset,
                          int special)
                   throws NameException

Places the DER encoding of the TeletexPersonalName object into encoding, beginning at offset. To determine the length of the encoding, call getDERLen. If this object is not yet set with values, then this method places nothing into the array and returns zero. To indicate that the DER encoding should follow any special instructions, use the special argument.

For example, to indicate the following:

      extension   [1] IMPLICIT Extension
 

Pass in the following:

      special = (ASN1.CONTEXT_IMPLICIT | 1);
 

If there are no special circumstances, pass in the following:

      special = 0
 

The following ASN.1 constants are possible values for special: APP_IMPLICIT, APP_EXPLICIT, PRIVATE_IMPLICIT, PRIVATE_EXPLICIT, OPTIONAL, DEFAULT, CONTEXT_IMPLICIT, or CONTEXT_EXPLICIT.

Parameters

	encoding		The byte array into which the result will be placed.
	offset		The offset into encoding where writing begins.
	special		The special circumstances of the DER encoding, if there are any. The following ASN.1 constants are possible values for special: APP_IMPLICIT, APP_EXPLICIT, PRIVATE_IMPLICIT, PRIVATE_EXPLICIT, OPTIONAL, DEFAULT, CONTEXT_IMPLICIT, or CONTEXT_EXPLICIT.

Returns

The number of bytes actually placed into encoding.

Throws

NameException - If the method cannot create the DER encoding.

equals

public boolean equals(Object obj)

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

Overrides

equals in class Object

Parameters

obj

An instance of the TeletexPersonalName instance.

Returns

A boolean that indicates whether these objects are equal.

clone

public Object clone()
             throws CloneNotSupportedException

Overrides the default clone method to get a deeper clone.

Returns

A new TeletexPersonalName object, a copy of this object.

Throws

CloneNotSupportedException - If the cloning operation is not successful.