com.rsa.certj.cert.extensions

Class TeletexDomainDefinedAttributes

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

All Implemented Interfaces:

Cloneable, Serializable

public class TeletexDomainDefinedAttributes

extends Object

implements Cloneable, Serializable

This class is used in the GeneralName class.

The ASN.1 definition is as follows:

 TeletexDomainDefinedAttributes ::= SEQUENCE SIZE
                               (1..ub-domain-defined-attributes) OF
                               TeletexDomainDefinedAttribute

 TeletexDomainDefinedAttribute ::= SEQUENCE {
  type TeletexString (SIZE
                       (1..ub-domain-defined-attribute-type-length)),
  value TeletexString (SIZE
                       (1..ub-domain-defined-attribute-value-length))}

 ub-domain-defined-attribute-type-length INTEGER ::= 8
 ub-domain-defined-attribute-value-length INTEGER ::= 128

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

See Also

Serialized Form

Constructor Summary

TeletexDomainDefinedAttributes()

Constructs an empty TeletexDomainDefinedAttributes object.

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

Constructs a TeletexDomainDefinedAttributes object and initializes it with the given values.

Method Summary

void	addAttribute(String type, String value) Adds an attribute specified by type and value.
Object	clone() Overrides the default clone method to get a deeper clone.
boolean	equals(Object obj) Return true if this object and obj contain the same TeletexDomainDefinedAttributes; returns false otherwise.
String[]	getAttribute(int Index) Gets the attribute value at the specified index.
int	getAttributeCount() Gets the number of attributes in this object.
int	getDEREncoding(byte[] encoding, int offset, int special) Places the DER encoding of the TeletexDomainDefinedAttributes 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 TeletexDomainDefinedAttributes object.
static int	getNextBEROffset(byte[] nameBER, int offset) Given nameBER, the BER encoding of a TeletexDomainDefinedAttributes object, beginning at offset, finds the index to the next element in the encoding.
String	toString() Returns a String that describes this TeletexDomainDefinedAttributes object.

Methods inherited from class java.lang.Object

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

Constructor Detail

TeletexDomainDefinedAttributes

public TeletexDomainDefinedAttributes()

Constructs an empty TeletexDomainDefinedAttributes object.

TeletexDomainDefinedAttributes

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

Constructs a TeletexDomainDefinedAttributes object and initializes it with the given values.

Parameters

	valueBER		A byte array that contains the BER encoding of this object.
	offset		The offset into the valueBER array.
	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 null or invalid.

Method Detail

addAttribute

public void addAttribute(String type,
                         String value)
                  throws NameException

Adds an attribute specified by type and value.

Parameters

	type		A String that specifies the attribute type, up to a maximum length of 8 characters.
	value		A String that specifies the attribute value, up to a maximum length of 128 characters.

Throws

NameException - If the parameters are null or exceed the maximum length.

getAttribute

public String[] getAttribute(int Index)
                      throws NameException

Gets the attribute value at the specified index.

Parameters

index

The index to the attribute with a value between 0 and 3.

Returns

The type and value of the attribute.

Throws

NameException - If specified index is invalid.

getAttributeCount

public int getAttributeCount()

Gets the number of attributes in this object.

Returns

The number of attributes in this object.

toString

public String toString()

Returns a String that describes this TeletexDomainDefinedAttributes object.

Overrides

toString in class Object

Returns

A String that describes this TeletexDomainDefinedAttributes object.

getNextBEROffset

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

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

Parameters

	nameBER		The BER encoding of a TeletexDomainDefinedAttributes 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 TeletexDomainDefinedAttributes 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 TeletexDomainDefinedAttributes 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)

Return true if this object and obj contain the same TeletexDomainDefinedAttributes; returns false otherwise.

Overrides

equals in class Object

Parameters

obj

An instance of the TeletexDomainDefinedAttributes 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 TeletexDomainDefinedAttribute object, a copy of this object.

Throws

CloneNotSupportedException - If the cloning operation is not successful.