iaik.asn1

Class ASN1String

java.lang.Object

iaik.asn1.ASN1Object

iaik.asn1.ASN1String

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

BMPString, GeneralString, IA5String, NumericString, PrintableString, T61String, UNIString, UTF8String, VisibleString

public abstract class ASN1String
extends ASN1Object

Abstract super class for all ASN.1 String types.

This class extends ASN1Object for grouping all ASN.1 String type implementing classes.

Version:

File Revision 12

See Also:

BMPString, GeneralString, IA5String, NumericString, PrintableString, T61String, UNIString, UTF8String, VisibleString

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	value The value as byte material representing the String value encoding.

Fields inherited from class iaik.asn1.ASN1Object

asnType, constructed, encode_listener, indefinite_length, isStringType, stream_mode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ASN1String() Creates an empty ASN1String.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Returns a clone of this ASN1String.
protected void	decode(int length, java.io.InputStream is) Decodes a ASN1String value from the given InputStream.
protected void	encode(java.io.OutputStream os) DER encodes this ASN1String and writes the result to the given output stream.
boolean	equals(java.lang.Object obj) Compares two ASN.1 Strings.
byte[]	getByteValue() Gets the (raw, not decoded into a String) value as byte array.
int	hashCode() Returns a hash code for this object.
static void	setIgnoreConstructedEncodingForSimpleTypes(boolean ignore) Generally the Basic Encoding Rules (BER) allow ASN.1 String types to be primitive or constructed encoded.
void	setIndefiniteLength(boolean indefiniteLength) Does nothing (primitive String types are encoded with definite length in any case).
java.lang.String	toString() Returns a string that represents the contents of this ASN1String.

Methods inherited from class iaik.asn1.ASN1Object

addComponent, addEncodeListener, countComponents, encodeObject, getAsnType, getComponentAt, getValue, indefiniteLength, isA, isConstructed, isStringType, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

value

protected byte[] value

The value as byte material representing the String value encoding.

Constructor Detail

ASN1String

protected ASN1String()

Creates an empty ASN1String.

Method Detail

setIgnoreConstructedEncodingForSimpleTypes

public static void setIgnoreConstructedEncodingForSimpleTypes(boolean ignore)

Generally the Basic Encoding Rules (BER) allow ASN.1 String types to be primitive or constructed encoded. The Distinguished Encoding Rules (DER), however, only allow primitive encoding for ASN.1 String types. Except for the native structured types like SEQUENCE or SET, in practice constructed encoding may be used for OCTET_STRINGs only. Other ASN.1 types are usually primitive encoded. For that reason IAIK-JCE supports constructed encoding only for the structured types like SEQUENCE or SET and the OCTET_STRING type. When decoding any other type an exception is thrown if the constructed encoding method has been used. With this ignoreConstructedEncoding method you can advice IAIK-JCE to ignore constructed encoding -- if ever used -- for simple types. In this case IAIK-JCE tries to read the contents but the value obtained from the ASN1Object may not fully represent its actual value.

Parameters:

ignore - whether to ignore constructed encoding for simple types like IA5String, UTF8String, BIT_STRING (except for OCTET_STRING) (default: false, an exception is thrown when the constructed method has been used for encoding a simple type)

clone

public java.lang.Object clone()

Returns a clone of this ASN1String.

Overrides:

clone in class ASN1Object

Returns:

a clone of this ASN1String

setIndefiniteLength

public void setIndefiniteLength(boolean indefiniteLength)

Does nothing (primitive String types are encoded with definite length in any case).

Overrides:

setIndefiniteLength in class ASN1Object

Parameters:

indefiniteLength - ignored

encode

protected void encode(java.io.OutputStream os)
               throws java.io.IOException

DER encodes this ASN1String and writes the result to the given output stream.

This is a protected method and will not be used by an application for DER encoding a ASN1String object. An application will call one of the encode methods of the DerCoder class for performing the encoding, and the DerCoder internally will call this encode method.

Specified by:

encode in class ASN1Object

Parameters:

os - the output stream to which to write the data

Throws:

java.io.IOException - if an I/O error occurs while writing to the stream

decode

protected void decode(int length,
          java.io.InputStream is)
               throws java.io.IOException

Decodes a ASN1String value from the given InputStream. The given input stream carries DER encoded data, and the next length bytes to be read represent the value of an ASN.1 object of type ASN1String.

This is a protected method and will not be used by an application for decoding a DER encoded ASN1String. An application will call one of the decode methods of the DerCoder class for performing the decoding. The DerCoder then determines the number of bytes (length) occupied by the value of this ASN1String object and internally calls this decode method for actually reading the value. No check is performed if the received value actually is composed only of characters belonging to the ASN1String typical character set!

Specified by:

decode in class ASN1Object

Parameters:

length - the already decoded length, i.e. number of the bytes representing the value of the ASN1String to be decoded

is - the input stream from which the DER encoded data is read in

Throws:

java.io.IOException - if there is a problem with the InputStream

getByteValue

public byte[] getByteValue()

Gets the (raw, not decoded into a String) value as byte array. This method may be used to get the raw value without decoding it into a String, but without any BER/DER encoding.

Returns:

the raw value as byte array (not cloned)

toString

public java.lang.String toString()

Returns a string that represents the contents of this ASN1String.

Overrides:

toString in class ASN1Object

Returns:

the string representation

See Also:

ASN1Object.toString()

equals

public boolean equals(java.lang.Object obj)

Compares two ASN.1 Strings.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the other ASN.1 String

Returns:

true, if the two ASN1Strings are equal, false otherwise

hashCode

public int hashCode()

Returns a hash code for this object.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code