com.rsa.certj.cert.extensions

Class PDSParameter

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

All Implemented Interfaces:

Cloneable, Serializable

public class PDSParameter

extends Object

implements Cloneable, Serializable

This class is used in the GeneralName object.

This ASN.1 definition is as follows:

 PDSParameter ::= SET {
    printable-string PrintableString 
                         (SIZE (1. .ub-pds-parameter-length)) OPTIONAL,
    teletex-string TeletexString 
                         (SIZE (1. .ub-pds-parameter-length)) OPTIONAL }

 ub-pds-parameter-length INTEGER ::= 30

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

See Also

Serialized Form

Constructor Summary

PDSParameter()

Constructs an empty PDSParameter object.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PDSParameter

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

Creates a PDSParameter object and initializes it with the given values.

Parameters

	valueBER		A byte array that contains the BER encoding of PDSParameter.
	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.

PDSParameter

public PDSParameter()

Constructs an empty PDSParameter object.

Method Detail

setPrintableString

public void setPrintableString(String value)

Sets the printable string value.

Parameters

value

A String that specifies the printable string, up to 30 characters in length.

setTeletexString

public void setTeletexString(String value)

Sets the teletex string value.

Parameters

value

A String that specifies the teletex string, up to 30 characters in length.

getPrintableString

public String getPrintableString()

Gets the printable string value.

Returns

A String that specifies the printable string value.

getTeletexString

public String getTeletexString()

Gets the teletex string value.

Returns

A String that specifies the teletex string value.

toString

public String toString()

Returns a String that describes this PDSParameter object.

Overrides

toString in class Object

Returns

A String that describes this PDSParameter object.

getNextBEROffset

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

Given valueBER, the BER encoding of a PDSParameter object, beginning at offset, finds the index to the next element in the encoding. In other words, gets the next offset after the PDSParameter object.

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

Parameters

	valueBER		The BER encoding of a PDSParameter object.
	offset		The offset into valueBER 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 PDSParameter 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 PDSParameter 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 PDSParameter; returns false otherwise.

Overrides

equals in class Object

Parameters

obj

An instance of PDSParameter object.

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

Throws

CloneNotSupportedException - If the cloning operation is not successful.