Release notes for Sirius Mods V8.0

These release notes list the enhancements and other changes contained in Sirius Mods version 8.0, which was released on April 16, 2012. The immediately preceding and following versions of the Sirius Mods are:

• Version 7.9, available in July, 2011 — Release notes
• Version 8.1, available in November, 2012 — Release notes

Changes to classes and methods

Collection classes

New exception class: ItemNotPresent

The ItemNotPresent exception class indicates that the name used for a NamedArraylist, FloatNamedArraylist, or UnicodeNamedArraylist Item method is not present in the collection.

Email class

New method: RemoveRecipient

The RemoveRecipient method removes a specified name from the "To:", "CC:", and "BCC:" lists of recipients of an Email object.

Intrinsic classes

The following subsections describe new and changed Intrinsic methods available in Sirius Mods 8.0.

New String method: CharacterToUnicode

CharacterToUnicode uses a (new in Mods 8.0) CharacterToUnicodeMap object to translate a given character to Unicode.

XmlDoc API

The following sections describe new and changed XmlDoc API methods available in Sirius Mods 8.0.

XmlDoc/XmlNode Serial function support for untranslatable Unicode

Serial with the EBCDIC option now produces the character encoding for an untranslatable Unicode character. Prior to version 8.0, an untranslatable Unicode character resulted in a request cancellation.

Also, the CharacterEncodeAll option can now be used with Serial.

New classes: CharacterToUnicodeMap, UdpSocket

• The CharacterToUnicodeMap class is similar to the CharacterMap class, except it maps single-byte code points to Unicode. This class lets a User Language programmer dynamically build a codepage mapping for any codepage they might encounter.
• The UdpSocket class lets User Language programs send and receive UDP (User Datagram Protocol) messages.

Generic Print, Audit, and Trace methods for user objects

Available only for non-System User Language objects, the Print, Audit, and Trace methods output a display of the current values of the Variable members of the method object.

These methods are intended as programmer debugging and auditing tools and are not intended to be a core part of applications.

Other feature changes

SSL security

SSL support for Janus FTP Server ports

SSL (Secure Sockets Layer) data transmission is now available for Janus FTP Server ports. Explicit FTPS connections only are supported. To enable this SSL/TLS support for an FTPSERVER port, you include the SSL parameter in the port's JANUS DEFINE specification just as for other Janus server ports. If you also include the SSLOPT parameter on the port definition, clients can choose whether to use SSL/TLS or not.

New and updated methods for SSL authentication support

• Longstring version of SSL entities

  Two new methods and three updated methods now obtain a longstring copy of the binary (ASN.1 encoded) contents of an SSL certificate (client or server):

  • The new System class ClientCertificate method
  • The new Socket class Certificate method
  • The updated HttpRequest class Get, Post, and Send methods This method extracts a PEM-encoded string (certificate, CRL) from a Stringlist:
  • The new Stringlist class PemToString method
• XmlDoc version of SSL entities
  • DerToXmlDoc converts almost any DER-encoded string to an XmlDoc.

  The following String functions also convert DER-encoded strings to an XmlDoc, but they do so with XML tags that more specifically suit the source entity (CRL, private key, certificate) than does the more generic DerToXmlDoc:

  • X509CrlToXmlDoc
  • RSAPrivateKeyToXmlDoc
  • X509CertificateToXmlDoc

New Exception classes

These exception classes are associated with some of the new methods described above:

• NotJanusConnection

  A NotJanusConnection exception indicates that the method call originated on a thread whose associated Janus port is not a Janus server thread.

• InvalidPemData

  An InvalidPemData exception indicates that data does not conform to the PEM (Privacy Enhanced Mail) protocol.

• InvalidBerData

  An InvalidBerData exception indicates that data does not conform to the BER (Basic Encoding Rules) protocol.

Model 204 commands and parameters

New commands: PUSHUTABLE and POPUTABLE

Sirius Mods Version 8.0 contains support for the new Model 204 PUSHUTABLE and POPUTABLE commands.

For example:

PROCEDURE P.VERYBIG PUSHUTABLE LSTBL 20000+ LQTBL 120% LVTBL 2000+ LFSCB 20000- b ... end

Note: The parameter settings in the PUSHUTABLE command above are relative values. LSTBL 20000+ indicates a value that is 20,000 bytes greater than the LSTBL setting currently in effect. LQTBL 120% indicates a value that is 20% greater than the current LQTBL setting. LFSCB 20000- indicates a value that is 20,000 less than the current LFSCB setting. These three indicators — a following plus sign (+), minus sign (-), or percent sign (%) — are the only relative setting indicators. They are available for all Model 204 numeric parameters.

Relative values for numeric parameters

Sirius Mods Version 8.0 adds support for specifying relative values for Model 204 parameters. The feature is demonstrated in the example above.

User Language enhancements

As described in "Other User Language Enhancements", the Janus SOAP User Language Interface provides a number of enhancements to User Language in addition to the object-oriented enhancements.

Features among this set that are new in version 8.0 of the Sirius Mods are shown in the sections below.

Relative values for parameter settings

See "Relative values for numeric parameters" for more information about this feature.

Additional methods displayable for debugging

A large number of StringTokenizer functions and properties which previously were not displayable for debugging have been modified so that their result can now be displayed using the Janus Debugger or the Sirius Debugger or using SirFact.

Deflate compression performance enhancement

Changes in the deflate compression algorithm reduce CPU consumption by about 20 percent when compared with Sirius Mods Version 7.9. The difference in content compression is negligible, generally less than one-half of one percent. CPU savings can be greater than 20 percent when using higher compression values in your Janus Web port definitions (COMPRESS) or in the Deflate or Gzip methods (Maxchain parameter).

Compatibility and fixes

Support for Model 204 V7R4

Sirius Mods version 8.0 is the earliest version of the Sirius Mods that supports V7R4 of Model 204.

Version 8.0 also supports Model 204 V7R1.

Backwards compatibility with Sirius Mods 7.9 and Sirius Mods 8.0

This section lists any differences in processing that result from execution with Sirius Mods version 8.0, as compared with the same inputs to Sirius Mods version 7.9 at current maintenance levels. In some cases zaps have been delivered to change the behavior to be the same as the version 8.0 behavior; these cases are explicitly listed.

In general, backwards incompatibility means that an operation which was previously performed without any indication of error, now operates, given the same inputs and conditions, in a different manner. We may not list as backwards incompatibilities those cases in which the previous behaviour, although not indicating an error, was "clearly and obviously" incorrect, and which are introduced as normal bug fixes (whether or not they had been fixed with previous maintenance).

Allowed WebSend (or AddXml or Xml) of non-empty XmlDoc with no element

If a non-EMPTY XmlDoc does not contain an element node, some serialization methods (that is, WebSend, Xml and AddXml) should cancel the request, since that is not a valid XML document. However, the serialization is allowed. For example:

%x:addPI('a', 'b') print %x:xml:AsciiToEbcdic

This now results in:

CANCELLING REQUEST: ...non-EMPTY XmlDoc with no Element node ...

With previous versions of the Sirius Mods, the result was:

<?a b?>

This fix was delivered as maintenance to version 7.9 of the Sirius Mods as ZAP7985.

StringTokenizer incompatibilities

As noted below in "StringTokenizer bug fixes", fixes to some StringTokenizer methods have resulted in compatibiliy issues. Also note that the documentation of the StringTokenizer class and StringTokenizer methods now assumes usage with Sirius Mods version 8.0 or later.

Fixes in Sirius Mods 8.0 but not in 7.9

This section lists fixes to functionality existing in the Sirius Mods version 7.9 but which, due to the absence of customer problems, have not, as of the date of the release, been fixed in that version.

Error position in XML parsing

The character position of an XML parse error has been changed if the input to the parse is a Stringlist. Previously, the line-end character inserted between Stringlist items were not counted. With this change, you can now do something like the following:

%p = %doc:LoadXml(%stringlis, 'ERRRET') If %p Then %junk = %stringlis:CreateLines PrintText Bigger snippet at {%p} than error messages: {%junk:Substring(%p - 100, 200)} End If

Stringtokenizer bug fixes

This section describes fixes to some StringTokenizer methods. The fixes were delivered in version 8.0 of the Sirius Mods as ZAP80G4.

The first of these fixes, "driving OutOfBounds handling", represents an incompatibility that existed prior to the introduction of this fix (that is, with version 7.9 of the Sirius Mods). Although it is perhaps an "edge case", it corrects behavior that is central to the StringTokenizer semantics. Therefore, the documentation of the StringTokenizer class and StringTokenizer methods now assumes you are using Sirius Mods version 8.0 or later.

Skip processing should drive OutOfBounds handling

Skip processing should drive OutOfBounds handling, either causing an exception or returning the Default value. For example:

%t:string = 'foo bar' %t:separators = ',' printText {~=%t:nextToken(skip=2, default='qqq')} %t:string = 'foo bar' printText {~=%t:nextToken(skip=2)}

Prior to this fix, the result of the above fragment was:

%t:nextToken(skip=2, default='qqq')= %t:nextToken(skip=2)=

Now, with the fix, the result is:

%t:nextToken(skip=2, default='qqq')=qqq %t:nextToken(skip=2)= *** 1 CANCELLING REQUEST: ... function NextToken: OutOfBounds exception: Past end of string ...

The new result is correct: the Default value is returned by the first NextToken, and the second NextToken throws an exception.

As another example:

%t:string = %t:skipTokens(1) print 'Should not be here'

Prior to this fix, the result of the above fragment was:

Should not be here

Now, with the fix, the result is:

*** 1 CANCELLING REQUEST: ... subroutine SkipTokens: OutOfBounds exception: Past end of string ...

The new result is correct: SkipTokens throws an exception here.

All of the above changes, strictly speaking, represent incompatibilities with the previous behavior of the StringTokenizer.

Self-delimited token followed by final separator is not the final token

If a self-delimited token is immediately followed by a trailing separator, there is still another remaining token (that being the null string). For example:

%t:string = '"asdf",' %t:quotes = '"' printText {~=%t:nextToken} {~=%t:nextToken}

Prior to this fix, the result of the above fragment was:

%t:nextToken=asdf %t:nextToken= *** 1 CANCELLING REQUEST: ... function NextToken: OutOfBounds exception: Past end of string ...

Now, with the fix, the result is:

%t:nextToken=asdf %t:nextToken=

The new result is correct: NextToken does not throw an exception here.