Asn Chilkat2 Java Reference Documentation
Asn
Current Version: 11.7.0
Markdown version of this page for AI tools (v 11.7.0) · all AI docs
Chilkat.Asn
Load ASN.1 from binary DER bytes, encoded text such as Base64 or hex,
files, or existing
Read the item tag, tag value, constructed/primitive state, sub-item
count, string content, boolean value, or integer value.
Append constructed
Add booleans, integers, big integers, bit strings, octet strings, OIDs,
strings, times, null values, and encoded byte content.
Add context-specific primitive or constructed items when working with
ASN.1 formats that use tagged application-specific structures.
Convert ASN.1 to XML for inspection or editing, load ASN.1 back from XML,
and output the result as binary or encoded DER.
Load, inspect, build, edit, and encode ASN.1 structures in DER or XML form.
Chilkat.Asn represents an ASN.1 item and its optional child
items. It can load ASN.1 from binary DER, encoded DER strings, files, or
BinData; expose tags, tag values, primitive content, boolean
and integer values, and child counts; build constructed structures such as
SEQUENCE and SET; append common primitive types
such as booleans, integers, big integers, bit strings, octets, OIDs, strings,
times, null values, and context-specific items; convert ASN.1 to XML; reload
from that XML form; and write the final structure back to DER.
Load DER data
BinData objects.
Inspect ASN.1 items
Build sequences and sets
SEQUENCE and SET items,
then add child ASN.1 values beneath them.
Append primitive values
Context-specific tags
DER and XML conversion
LoadBinary, LoadEncoded,
LoadBd, or LoadBinaryFile, inspect the tree with
Tag, Constructed, NumSubItems, and
GetSubItem, then extract primitive content or convert to XML
with AsnToXml. To create ASN.1, start with a constructed item,
append child values, and write the final DER with GetBinaryDer,
GetEncodedDer, WriteBd, or
WriteBinaryDer.
Object Creation
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Asn;
try (Asn asn = new Asn()) {
// ... use asn ...
} catch (ChilkatException e) {
System.out.println(e.getMessage()); // "Asn.someMethod failed: <reason>"
System.out.println(e.getLastErrorText()); // the full log of the failed call
}Creates the underlying native Chilkat object. The native library (chilkat2java) is loaded the first time any Chilkat2 object is created; see the README in the download for where it is looked for (-Dchilkat2.library.path, a classpath resource, or java.library.path).
Releases the native object (Asn is AutoCloseable, so try-with-resources calls it). Calling it again does nothing; any other method or property accessor called afterwards throws IllegalStateException. An object that is never closed is freed by a background cleaner once it becomes unreachable, but the garbage collector does not see native memory, so closing is the normal path. Objects returned by methods are owned by the caller too.
Returns true once close() has been called.
Errors
A method that fails throws ChilkatException, an unchecked exception carrying getClassName(), getMethodName(), getReason() (one line, also in the message) and getLastErrorText() (the full log, captured at the moment of the failure). The object remains usable. Methods that look something up and find nothing return null instead of throwing (each such method says so), and methods that answer a question (hasMember, isUnlocked, ...) return a plain boolean. Property accessors do not throw for Chilkat reasons.
A null string or object argument throws NullPointerException naming the parameter (except where a method documents that null is accepted), and a string containing U+0000 throws IllegalArgumentException.
Use an object from one thread at a time; it may be handed from one thread to another. The one cross-thread operation is setting setAbortCurrent(true) on an object that is busy in another thread (on the classes that have AbortCurrent). Unlocking: call new Global().unlockBundle("...") once at startup.
Properties
BoolValue
boolean getBoolValue()
void setBoolValue(boolean value)
The ASN.1 item's boolean value if it is a boolean item.
topConstructed
boolean getConstructed()
true if this ASN.1 item is a constructed item. Sequence and Set items are constructed and can contain sub-items. All other tags (boolean, integer, octets, utf8String, etc.) are primitive (non-constructed).
ContentStr
String getContentStr()
void setContentStr(String value)
The ASN.1 item's content if it is an ASN.1 string type (such as Utf8String, BmpString, PrintableString, VisibleString, T61String, IA5String, NumericString, or UniversalString).
topDebugLogFilePath
String getDebugLogFilePath()
void setDebugLogFilePath(String value)
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
IntValue
int getIntValue()
void setIntValue(int value)
The ASN.1 item's integer value if it is a small integer item.
topLastErrorHtml
String getLastErrorHtml()
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
String getLastErrorText()
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
String getLastErrorXml()
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
boolean getLastMethodSuccess()
void setLastMethodSuccess(boolean value)
Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
NumSubItems
int getNumSubItems()
The number of sub-items contained within this ASN.1 item. Only constructed items, such as Sequence and Set will contain sub-iitems. Primitive items such as OIDs, octet strings, integers, etc. will never contain sub-items.
topTag
String getTag()
The ASN.1 item's tag as a descriptive string. Possible values are:
boolean integer bitString octets null oid utf8String relativeOid sequence set numericString printableString t61String ia5String utcTime bmpStringtop
TagValue
int getTagValue()
The ASN.1 item's tag as a integer value. The integer values for possible tags are as follows:
boolean (1) integer (2) bitString (3) octets (4) null (5) oid (6) utf8String (12) relativeOid (13) sequence (16) set (17) numericString (18) printableString (19) t61String (20) ia5String (22) utcTime (23) bmpString (30)top
VerboseLogging
boolean getVerboseLogging()
void setVerboseLogging(boolean value)
If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
String getVersion()
Methods
AppendBigInt
Appends an ASN.1 integer, but one that is a big (huge) integer that is too large to be represented by an integer variable. The bytes composing the integer are passed in encoded string format (such as base64, hex, etc.). The byte order must be big-endian. The encoding may be any of the following encodings: Base64, Hex, Base58, modBase64, Base32, UU, QP (for quoted-printable), URL (for url-encoding), Q, B, url_oath, url_rfc1738, url_rfc2396, and url_rfc3986. The encoding name is case insensitive (for example, both Base64 and base64 are treated the same).
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
AppendBits
Appends an ASN.1 bit string to the caller's sub-items. The bytes containing the bits are passed in encoded string format (such as base64, hex, etc.). The byte order must be big-endian (MSB first). The encoding may be any of the following encodings: Base64, Hex, Base58, modBase64, Base32, UU, QP (for quoted-printable), URL (for url-encoding), Q, B, url_oath, url_rfc1738, url_rfc2396, and url_rfc3986. The encoding name is case insensitive (for example, both Base64 and base64 are treated the same).
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
AppendBool
Appends an ASN.1 boolean item to the caller's sub-items. Items may only be appended to constructed data types such as Sequence and Set.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
AppendContextConstructed
Appends an ASN.1 context-specific constructed item to the caller's sub-items.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
AppendContextPrimitive
Appends an ASN.1 context-specific primitive item to the caller's sub-items. The bytes are passed in encoded string format (such as base64, hex, etc.). The encoding may be any of the following encodings: Base64, Hex, Base58, modBase64, Base32, UU, QP (for quoted-printable), URL (for url-encoding), Q, B, url_oath, url_rfc1738, url_rfc2396, and url_rfc3986. The encoding name is case insensitive (for example, both Base64 and base64 are treated the same).
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
AppendInt
Appends an ASN.1 integer item to the caller's sub-items. Items may only be appended to constructed data types such as Sequence and Set.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
AppendNull
Appends an ASN.1 null item to the caller's sub-items. Items may only be appended to constructed data types such as Sequence and Set.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
AppendOctets
Appends an ASN.1 octet string to the caller's sub-items. The bytes are passed in encoded string format (such as base64, hex, etc.). The encoding may be any of the following encodings: Base64, Hex, Base58, modBase64, Base32, UU, QP (for quoted-printable), URL (for url-encoding), Q, B, url_oath, url_rfc1738, url_rfc2396, and url_rfc3986. The encoding name is case insensitive (for example, both Base64 and base64 are treated the same).
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
AppendOid
Appends an ASN.1 OID (object identifier) to the caller's sub-items. The OID is passed in string form, such as 1.2.840.113549.1.9.1.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
AppendSequence
Appends an ASN.1 sequence item to the caller's sub-items.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
AppendSequence2
Appends an ASN.1 sequence item to the caller's sub-items, and updates the internal reference to point to the newly appended sequence item.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
AppendSequenceR
Appends an ASN.1 sequence item to the caller's sub-items, and returns the newly appended sequence item.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable. The returned object is new and owned by the caller: close it when done (try (...)), or let it be garbage-collected.
AppendSet
Appends an ASN.1 set item to the caller's sub-items.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
AppendSet2
Appends an ASN.1 set item to the caller's sub-items, and updates the internal reference to point to the newly appended set item.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
AppendSetR
Appends an ASN.1 set item to the caller's sub-items, and returns the newly appended set item.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable. The returned object is new and owned by the caller: close it when done (try (...)), or let it be garbage-collected.
AppendString
Appends a string item to the caller's sub-items. The strType specifies the type of string to be added. It may be utf8, ia5, t61, printable, visible, numeric, universal, or bmp. The value must conform to the ASN.1 restrictions imposed for a given string type. The utf8, bmp, and universal types have no restrictions on what characters are allowed. In general, unless a specific type of string is required, choose the utf8 type.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
AppendTime
Appends a UTCTime item to the caller's sub-items. The timeFormat specifies the format of the dateTimeStr. It should be set to utc. (In the future, this method will be expanded to append GeneralizedTime items by using generalized for timeFormat.) To append the current date/time, set dateTimeStr equal to the empty string or the keyword now. Otherwise, the dateTimeStr should be in the UTC time format YYMMDDhhmm[ss]Z or YYMMDDhhmm[ss](+|-)hhmm.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
AsnToXml
Converts ASN.1 to XML and returns the XML string.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
DeleteSubItem
Discards the Nth sub-item. (The 1st sub-item is at index 0.)
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
GetEncodedContent
Returns the content of the ASN.1 item in encoded string form. The encoding may be any of the following encodings: Base64, Hex, Base58, modBase64, Base32, UU, QP (for quoted-printable), URL (for url-encoding), Q, B, url_oath, url_rfc1738, url_rfc2396, and url_rfc3986. The encoding name is case insensitive (for example, both Base64 and base64 are treated the same).
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
GetEncodedDer
Returns the binary DER in encoded string form. The encoding indicates the encoding and can be base64, hex, uu, quoted-printable, base32, or modbase64.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
GetLastSubItem
Returns the last ASN.1 sub-item. This method can be called immediately after any Append* method to access the appended item.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable. The returned object is new and owned by the caller: close it when done (try (...)), or let it be garbage-collected.
GetSubItem
Returns the Nth ASN.1 sub-item. The 1st sub-item is at index 0.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable. The returned object is new and owned by the caller: close it when done (try (...)), or let it be garbage-collected.
LoadAsnXml
Loads ASN.1 from the XML representation (such as that created by the AsnToXml method).
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
LoadBd
Loads ASN.1 from the binary DER contained in bd.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
LoadBinaryFile
Loads ASN.1 from a binary DER file.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
LoadEncoded
Loads ASN.1 from an encoded string. The encoding can be base64, hex, uu, quoted-printable, base32, or modbase64.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
SetEncodedContent
Sets the content of this primitive ASN.1 item. The encoding may be any of the following encodings: Base64, Hex, Base58, modBase64, Base32, UU, QP (for quoted-printable), URL (for url-encoding), Q, B, url_oath, url_rfc1738, url_rfc2396, and url_rfc3986. The encoding name is case insensitive (for example, both Base64 and base64 are treated the same).
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
WriteBd
Appends the ASN.1 in binary DER format to bd.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.
WriteBinaryDer
Writes the ASN.1 in binary DER form to a file.
Throws ChilkatException on failure; e.getLastErrorText() (or the object's getLastErrorText()) explains why, and the object remains usable.