com.rsa.certj.cert.extensions

Class UnformattedPostalAddress

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

All Implemented Interfaces:

Cloneable, Serializable

public class UnformattedPostalAddress

extends Object

implements Cloneable, Serializable

This class is used in the GeneralName class.

The ASN.1 definition is as follows

 UnformattedPostalAddress ::= SET {
   printable-address SEQUENCE SIZE (1..ub-pds-physical-address-lines) OF
           PrintableString (SIZE (1..ub-pds-parameter-length)) OPTIONAL,
   teletex-string TeletexString
         (SIZE (1..ub-unformatted-address-length)) OPTIONAL }
 

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

See Also

Serialized Form

Constructor Summary

UnformattedPostalAddress()

Constructs an empty UnformattedPostalAddress object.

UnformattedPostalAddress(byte[] valueBER, int offset, int special)

Constructs an UnformattedPostalAddress 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 UnformattedPostalAddress, returns false otherwise.
int	getDEREncoding(byte[] encoding, int offset, int special) Places the DER encoding of the UnformattedPostalAddress 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 UnformattedPostalAddress object.
static int	getNextBEROffset(byte[] nameBER, int offset) Given nameBER, the BER encoding an UnformattedPostalAddress object, beginning at offset, finds the index to the next element in the encoding.
String[]	getPrintableAddress() Gets the value of the printable-address field in an object.
String	getTeletexString() Gets the value of the teletex-string field in an UnformattedPostalAddress object.
void	setPrintableAddress(String address) Sets the value of the printable-address field in an UnformattedPostalAddress object.
void	setTeletexString(String teletex) Sets the value of the teletex-string field in an UnformattedPostalAddress object.
String	toString() Returns a String that describes this UnformattedPostalAddress object.

Methods inherited from class java.lang.Object

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

Constructor Detail

UnformattedPostalAddress

public UnformattedPostalAddress(byte[] valueBER,
                                int offset,
                                int special)
                         throws NameException

Constructs an UnformattedPostalAddress object, and initializes it with the given values.

Parameters

	valueBER		A byte array that contains the BER encoding of an UnformattedPostalAddress object.
	offset		The offset into valueBER 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.

UnformattedPostalAddress

public UnformattedPostalAddress()

Constructs an empty UnformattedPostalAddress object.

Method Detail

setPrintableAddress

public void setPrintableAddress(String address)
                         throws NameException

Sets the value of the printable-address field in an UnformattedPostalAddress object. The object can contain up to six printable addresses.

Parameters

address

A String that contains the printable-address value, up to a maximum length of 30 characters. Address cannot be null.

Throws

NameException - If specified values are too long or null, or if there are already six printable addresses associated with the object.

setTeletexString

public void setTeletexString(String teletex)
                      throws NameException

Sets the value of the teletex-string field in an UnformattedPostalAddress object.

Parameters

address

A String that contains the teletex-string value, up to a maximum length of 180 characters. Address cannot be null.

Throws

NameException - If specified values are too long or null.

getPrintableAddress

public String[] getPrintableAddress()

Gets the value of the printable-address field in an object.

Returns

A String array that contains the printable-address value.

getTeletexString

public String getTeletexString()

Gets the value of the teletex-string field in an UnformattedPostalAddress object.

Returns

A String that contains the teletex-string value.

toString

public String toString()

Returns a String that describes this UnformattedPostalAddress object.

Overrides

toString in class Object

Returns

A String that describes this UnformattedPostalAddress object.

getNextBEROffset

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

Given nameBER, the BER encoding an UnformattedPostalAddress 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 UnformattedPostalAddress object is 1819 bytes, then this method will return 1939, the index immediately following the UnformattedPostalAddress object. That is, nameBER[120] is the first byte in the encoding of the UnformattedPostalAddress object, nameBER[1938] is the last byte in the encoding of the UnformattedPostalAddress object, and the next element begins at index 1939.

Parameters

	nameBER		The BER encoding of a UnformattedPostalAddress 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)
              throws NameException

Returns the number of bytes that will be used by the DER encoding of this UnformattedPostalAddress 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 UnformattedPostalAddress 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 UnformattedPostalAddress, returns false otherwise.

Overrides

equals in class Object

Parameters

obj

An instance of the UnformattedPostalAddress class.

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 UnformattedPostalAddress object, a copy of this object.

Throws

CloneNotSupportedException - If the cloning operation is not successful.