com.objsys.asn1j.runtime

Interface Asn1TypeIF

All Known Implementing Classes:

Asn18BitCharString, Asn1AbstractTime, Asn1ArrayType, Asn1Base64BinaryString, Asn1BCDString, Asn1BigDecimal, Asn1BigInteger, Asn1BitString, Asn1BMPString, Asn1Boolean, Asn1CharString, Asn1Choice, Asn1ChoiceExt, Asn1Date, Asn1DateTime, Asn1Duration, Asn1Enumerated, Asn1GeneralizedTime, Asn1GeneralString, Asn1GraphicString, Asn1IA5String, Asn1Integer, Asn1Null, Asn1NumericString, Asn1ObjectDescriptor, Asn1ObjectIdentifier, Asn1OctetString, Asn1OID_IRI, Asn1OpenExt, Asn1OpenType, Asn1PrintableString, Asn1Real, Asn1Real10, Asn1RealBase2, Asn1RELATIVE_OID_IRI, Asn1RelativeOID, Asn1Seq, Asn1SeqOf, Asn1SeqOrSet, Asn1SeqSetOf, Asn1Set, Asn1SetOf, Asn1StringOID, Asn1StringRelativeOID, Asn1T61String, Asn1TBCDString, Asn1Time, Asn1TimeOfDay, Asn1Type, Asn1UniversalString, Asn1UTCTime, Asn1UTF8String, Asn1VarWidthCharString, Asn1VideotexString, Asn1VisibleString, Asn1X694OrderElement, Asn1XerOpenType, Asn1XmlAnyElem

public interface Asn1TypeIF

This is the base interface for all ASN.1 built-in types.

Method Summary

Modifier and Type	Method and Description
void	decode(Asn1BerDecodeBuffer buffer, boolean explicit, int implicitLength) This method declaration is the signature of the standard Basic Encoding Rules (BER) or Distinguished Encoding Rules (DER) decode method.
void	decode(Asn1MderDecodeBuffer buffer) This method decodes this object's data from an MDER encoding.
void	decode(Asn1PerDecodeBuffer buffer) This method declaration is the signature of the standard Packed Encoding Rules (PER) decode method.
void	decode(java.lang.Object reader, java.io.InputStream byteStream) This method declaration is the signature of the standard XML Encoding Rules (XER) decode method.
void	decode(java.lang.Object reader, java.lang.String xmlURI) This method declaration is the signature of the standard XML Encoding Rules (XER) decode method.
void	decodeXML(java.lang.String buffer, java.lang.String attrs) This method decodes the XML content of a simple type.
int	encode(Asn1BerEncodeBuffer buffer, boolean explicit) This method declaration is the signature of the standard Basic Encoding Rules (BER) or Distinguished Encoding Rules (DER) encode method.
void	encode(Asn1BerOutputStream out, boolean explicit) This method declaration is the signature of the streaming oriented BER encode method.
void	encode(Asn1MderOutputStream buffer) This method encodes this object's data to an MDER encoding.
void	encode(Asn1PerEncodeBuffer buffer) This method declaration is the signature of the standard Packed Encoding Rules (PER) encode method.
void	encode(Asn1PerOutputStream out) This method declaration is the signature of the streaming oriented PER encode method.
void	encode(Asn1XerEncoder buffer) This method declaration is the signature of the standard XML Encoding Rules (XER) encode method.
void	encode(Asn1XerEncoder buffer, java.lang.String elemName) This method declaration is the signature of the standard XML Encoding Rules (XER) encode method.
boolean	isOpenType() Returns open type mode for XML encoding/decoding.
void	print(java.io.PrintStream out, java.lang.String varName, int level) This method declaration is the signature of the standard print method used to print the contents of the object representing the ASN.1 type.
void	print(java.io.PrintWriter out, java.lang.String varName, int level) This method declaration is the signature of the standard print method used to print the contents of the object representing the ASN.1 type.
void	print(java.lang.StringBuilder out, java.lang.String varName, int level) This method declaration is the signature of the standard print to string method used to print the contents of the object representing the ASN.1 type.
void	setOpenType() Sets open type mode for XML encoding/decoding.

Method Detail

decode

void decode(Asn1BerDecodeBuffer buffer,
            boolean explicit,
            int implicitLength)
     throws Asn1Exception,
            java.io.IOException

This method declaration is the signature of the standard Basic Encoding Rules (BER) or Distinguished Encoding Rules (DER) decode method.

Parameters:

buffer - Decode message buffer object

explicit - Flag indicating explicit tag should be parsed from the encoded type.

implicitLength - Length of the contents field (only required if explicit is false).

Throws:

Asn1Exception

java.io.IOException

encode

int encode(Asn1BerEncodeBuffer buffer,
           boolean explicit)
    throws Asn1Exception

This method declaration is the signature of the standard Basic Encoding Rules (BER) or Distinguished Encoding Rules (DER) encode method.

Parameters:

buffer - Encode message buffer object

explicit - Flag indicating explicit tag should be added to the encoded type.

Returns:

Decoded integer value

Throws:

Asn1Exception

decode

void decode(Asn1PerDecodeBuffer buffer)
     throws Asn1Exception,
            java.io.IOException

This method declaration is the signature of the standard Packed Encoding Rules (PER) decode method.

Parameters:

buffer - PER Encode message buffer object

Throws:

Asn1Exception

java.io.IOException

encode

void encode(Asn1PerEncodeBuffer buffer)
     throws Asn1Exception,
            java.io.IOException

This method declaration is the signature of the standard Packed Encoding Rules (PER) encode method.

Parameters:

buffer - PER Encode message buffer object

Throws:

Asn1Exception

java.io.IOException

encode

void encode(Asn1XerEncoder buffer)
     throws Asn1Exception,
            java.io.IOException

This method declaration is the signature of the standard XML Encoding Rules (XER) encode method. This method invokes the generated method with element name set to null. This will cause the ASN.1 type name to be used as the top-level element name.

Parameters:

buffer - XER Encode message buffer object

Throws:

java.io.IOException - Any exception thrown by the underlying stream.

Asn1Exception - Thrown, if operation is failed.

encode

void encode(Asn1XerEncoder buffer,
            java.lang.String elemName)
     throws Asn1Exception,
            java.io.IOException

This method declaration is the signature of the standard XML Encoding Rules (XER) encode method.

Parameters:

buffer - XER Encode message buffer object

elemName - XML element name of item

Throws:

java.io.IOException - Any exception thrown by the underlying stream.

Asn1Exception - Thrown, if operation is failed.

decode

void decode(java.lang.Object reader,
            java.lang.String xmlURI)
     throws Asn1Exception,
            java.io.IOException

This method declaration is the signature of the standard XML Encoding Rules (XER) decode method.

Parameters:

reader - XML reader object

xmlURI - URI of a source

Throws:

java.io.IOException - An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.

Asn1Exception - Thrown, if operation is failed.

decode

void decode(java.lang.Object reader,
            java.io.InputStream byteStream)
     throws Asn1Exception,
            java.io.IOException

This method declaration is the signature of the standard XML Encoding Rules (XER) decode method.

Parameters:

reader - XML reader object

byteStream - Input byte stream object

Throws:

java.io.IOException - An IO exception from the parser, possibly from a byte stream or character stream supplied by the application.

Asn1Exception - Thrown, if operation is failed.

decodeXML

void decodeXML(java.lang.String buffer,
               java.lang.String attrs)
        throws Asn1Exception

This method decodes the XML content of a simple type.

Parameters:

buffer - String containing data to be decoded

attrs - Attributes string from element tag

Throws:

Asn1Exception

setOpenType

void setOpenType()

Sets open type mode for XML encoding/decoding.

isOpenType

boolean isOpenType()

Returns open type mode for XML encoding/decoding.

Returns:

true if open type mode is on.

decode

void decode(Asn1MderDecodeBuffer buffer)
     throws Asn1Exception,
            java.io.IOException

This method decodes this object's data from an MDER encoding. When MDER code has not been generated, classes implementing this interface may simply throw an exception.

Throws:

Asn1Exception

java.io.IOException

encode

void encode(Asn1MderOutputStream buffer)
     throws Asn1Exception,
            java.io.IOException

This method encodes this object's data to an MDER encoding. When MDER code has not been generated, classes implementing this interface may simply throw an exception.

Throws:

Asn1Exception

java.io.IOException

encode

void encode(Asn1BerOutputStream out,
            boolean explicit)
     throws Asn1Exception,
            java.io.IOException

This method declaration is the signature of the streaming oriented BER encode method.

Parameters:

out - BER Output Stream object

explicit - Flag indicating explicit tagging should be done

Throws:

java.io.IOException - Any exception thrown by the underlying OutputStream.

Asn1Exception - Thrown, if operation is failed.

encode

void encode(Asn1PerOutputStream out)
     throws Asn1Exception,
            java.io.IOException

This method declaration is the signature of the streaming oriented PER encode method.

Parameters:

out - BER Output Stream object

Throws:

java.io.IOException - Any exception thrown by the Asn1PerOutputStream.

Asn1Exception - Thrown, if operation is failed.

print

void print(java.io.PrintWriter out,
           java.lang.String varName,
           int level)

This method declaration is the signature of the standard print method used to print the contents of the object representing the ASN.1 type. This method is provided for backwards-compatibility with earlier versions of the runtime; users should instead use a PrintWriter to obtain better output performance.

Parameters:

out - Output print writer

varName - Name of the variable being printed

level - Indentation level

print

void print(java.io.PrintStream out,
           java.lang.String varName,
           int level)

This method declaration is the signature of the standard print method used to print the contents of the object representing the ASN.1 type. This method is provided for backwards-compatibility with earlier versions of the runtime; users should instead use a PrintWriter to obtain better output performance.

Parameters:

out - Output print stream

varName - Name of the variable being printed

level - Indentation level

print

void print(java.lang.StringBuilder out,
           java.lang.String varName,
           int level)

This method declaration is the signature of the standard print to string method used to print the contents of the object representing the ASN.1 type. N.b., StringBuilder is not synchronized, and calls to this method from a multiple threads must be synchronized by the caller.

Parameters:

out - Output string builder

varName - Name of the variable being printed

level - Indentation level