CkAsn Java Reference Documentation

CkAsn

For creating, loading, parsing, converting, and saving ASN.1

Object Creation

CkAsn obj = new CkAsn();

Properties

boolean get_BoolValue();
void put_BoolValue(boolean newVal);

Introduced in version 9.5.0.49

The ASN.1 item's boolean value if it is a boolean item.

boolean get_Constructed();

Introduced in version 9.5.0.49

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).

void get_ContentStr(CkString str);
String contentStr();
void put_ContentStr(String newVal);

Introduced in version 9.5.0.49

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).

void get_DebugLogFilePath(CkString str);
String debugLogFilePath();
void put_DebugLogFilePath(String newVal);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

int get_IntValue();
void put_IntValue(int newVal);

Introduced in version 9.5.0.49

The ASN.1 item's integer value if it is a small integer item.

void get_LastErrorHtml(CkString str);
String lastErrorHtml();

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

void get_LastErrorText(CkString str);
String lastErrorText();

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

void get_LastErrorXml(CkString str);
String lastErrorXml();

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

boolean get_LastMethodSuccess();
void put_LastMethodSuccess(boolean newVal);

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

int get_NumSubItems();

Introduced in version 9.5.0.49

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.

void get_Tag(CkString str);
String tag();

Introduced in version 9.5.0.49

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
bmpString

int get_TagValue();

Introduced in version 9.5.0.49

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)

boolean get_VerboseLogging();
void put_VerboseLogging(boolean newVal);

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.

void get_Version(CkString str);
String version();

Version of the component/library, such as "9.5.0.63"

Methods

boolean AppendBigInt(String encodedBytes, String encoding);

Introduced in version 9.5.0.49

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).

Returns true for success, false for failure.

(Android™) Using the ASN.1 API to Create a Certificate Request (CSR)

(Java) Using the ASN.1 API to Create a Certificate Request (CSR)

boolean AppendBits(String encodedBytes, String encoding);

Introduced in version 9.5.0.49

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).

Returns true for success, false for failure.

boolean AppendBool(boolean value);

Introduced in version 9.5.0.49

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.

Returns true for success, false for failure.

boolean AppendContextConstructed(int tag);

Introduced in version 9.5.0.50

Appends an ASN.1 context-specific constructed item to the caller's sub-items.

Returns true for success, false for failure.

(Android™) Using the ASN.1 API to Create a Certificate Request (CSR)

(Java) Using the ASN.1 API to Create a Certificate Request (CSR)

boolean AppendContextPrimitive(int tag, String encodedBytes, String encoding);

Introduced in version 9.5.0.50

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).

Returns true for success, false for failure.

boolean AppendInt(int value);

Introduced in version 9.5.0.49

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.

Returns true for success, false for failure.

boolean AppendNull();

Introduced in version 9.5.0.49

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.

Returns true for success, false for failure.

boolean AppendOctets(String encodedBytes, String encoding);

Introduced in version 9.5.0.49

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).

Returns true for success, false for failure.

boolean AppendOid(String oid);

Introduced in version 9.5.0.49

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".

Returns true for success, false for failure.

boolean AppendSequence();

Introduced in version 9.5.0.49

Appends an ASN.1 sequence item to the caller's sub-items.

Returns true for success, false for failure.

(Android™) Using the ASN.1 API to Create a Certificate Request (CSR)

(Java) Using the ASN.1 API to Create a Certificate Request (CSR)

boolean AppendSequence2();

Introduced in version 9.5.0.50

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.

Returns true for success, false for failure.

CkAsn AppendSequenceR();

Introduced in version 9.5.0.50

Appends an ASN.1 sequence item to the caller's sub-items, and returns the newly appended sequence item.

Returns nil on failure

boolean AppendSet();

Introduced in version 9.5.0.49

Appends an ASN.1 set item to the caller's sub-items.

Returns true for success, false for failure.

(Android™) Using the ASN.1 API to Create a Certificate Request (CSR)

(Java) Using the ASN.1 API to Create a Certificate Request (CSR)

boolean AppendSet2();

Introduced in version 9.5.0.50

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.

Returns true for success, false for failure.

CkAsn AppendSetR();

Introduced in version 9.5.0.50

Appends an ASN.1 set item to the caller's sub-items, and returns the newly appended set item.

Returns nil on failure

boolean AppendString(String strType, String value);

Introduced in version 9.5.0.49

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.

Returns true for success, false for failure.

boolean AppendTime(String timeFormat, String dateTimeStr);

Introduced in version 9.5.0.49

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".

Returns true for success, false for failure.

boolean AsnToXml(CkString outStr);
String asnToXml();

Introduced in version 9.5.0.49

Converts ASN.1 to XML and returns the XML string.

Returns true for success, false for failure.

(Android™) Convert ASN.1 to/from Binary DER, XML, and Base64

(Java) Convert ASN.1 to/from Binary DER, XML, and Base64

(Android™) Load PEM ASN.1 and Convert to XML

(Java) Load PEM ASN.1 and Convert to XML

boolean DeleteSubItem(int index);

Introduced in version 9.5.0.49

Discards the Nth sub-item. (The 1st sub-item is at index 0.)

Returns true for success, false for failure.

boolean GetBinaryDer(CkByteData outData);

Introduced in version 9.5.0.49

Returns the ASN.1 in binary DER form.

Returns true for success, false for failure.

boolean GetEncodedContent(String encoding, CkString outStr);
String getEncodedContent(String encoding);

Introduced in version 9.5.0.49

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).

Returns true for success, false for failure.

boolean GetEncodedDer(String encoding, CkString outStr);
String getEncodedDer(String encoding);

Introduced in version 9.5.0.49

Returns the binary DER in encoded string form. The encoding indicates the encoding and can be "base64", "hex", "uu", "quoted-printable", "base32", or "modbase64".

Returns true for success, false for failure.

(Android™) Convert ASN.1 to/from Binary DER, XML, and Base64

(Java) Convert ASN.1 to/from Binary DER, XML, and Base64

(Android™) Using the ASN.1 API to Create a Certificate Request (CSR)

(Java) Using the ASN.1 API to Create a Certificate Request (CSR)

CkAsn GetLastSubItem();

Introduced in version 9.5.0.49

Returns the last ASN.1 sub-item. This method can be called immediately after any Append* method to access the appended item.

Returns nil on failure

CkAsn GetSubItem(int index);

Introduced in version 9.5.0.49

Returns the Nth ASN.1 sub-item. The 1st sub-item is at index 0.

Returns nil on failure

(Android™) Using the ASN.1 API to Create a Certificate Request (CSR)

(Java) Using the ASN.1 API to Create a Certificate Request (CSR)

boolean LoadAsnXml(String xmlStr);

Introduced in version 9.5.0.49

Loads ASN.1 from the XML representation (such as that created by the AsnToXml method).

Returns true for success, false for failure.

(Android™) Convert ASN.1 to/from Binary DER, XML, and Base64

(Java) Convert ASN.1 to/from Binary DER, XML, and Base64

boolean LoadBinary(CkByteData derBytes);

Introduced in version 9.5.0.49

Loads ASN.1 from binary DER.

Returns true for success, false for failure.

boolean LoadBinaryFile(String path);

Introduced in version 9.5.0.49

Loads ASN.1 from a binary DER file.

Returns true for success, false for failure.

(Android™) Convert ASN.1 to/from Binary DER, XML, and Base64

(Java) Convert ASN.1 to/from Binary DER, XML, and Base64

boolean LoadEncoded(String asnContent, String encoding);

Introduced in version 9.5.0.49

Loads ASN.1 from an encoded string. The encoding can be "base64", "hex", "uu", "quoted-printable", "base32", or "modbase64".

Returns true for success, false for failure.

(Android™) Convert ASN.1 to/from Binary DER, XML, and Base64

(Java) Convert ASN.1 to/from Binary DER, XML, and Base64

boolean SaveLastError(String path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

boolean SetEncodedContent(String encodedBytes, String encoding);

Introduced in version 9.5.0.49

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).

Returns true for success, false for failure.

boolean WriteBinaryDer(String path);

Introduced in version 9.5.0.49

Writes the ASN.1 in binary DER form to a file.

Returns true for success, false for failure.

(Android™) Convert ASN.1 to/from Binary DER, XML, and Base64

(Java) Convert ASN.1 to/from Binary DER, XML, and Base64

(Android™) Using the ASN.1 API to Create a Certificate Request (CSR)

(Java) Using the ASN.1 API to Create a Certificate Request (CSR)