InvalidBerData class: Difference between revisions
mNo edit summary |
mNo edit summary |
||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
The <var>InvalidBerData</var> exception class validates whether the data being processed by the called method conforms to the BER (Basic Encoding Rules) protocol. BER data is base64-encoded binary data; BER rules are a superset of DER (Distinguished Encoding Rules) rules. | The <var>InvalidBerData</var> exception class validates whether the data being processed by the called method conforms to the BER (Basic Encoding Rules) protocol. BER data is base64-encoded binary data; BER rules are a superset of DER (Distinguished Encoding Rules) rules. | ||
The <var>InvalidBerData</var> class has properties that indicate the position and description of the non-conforming data. | The <var>InvalidBerData</var> class has properties that indicate the position and description of the non-conforming data. There are currently no standardized error codes. | ||
An <var>InvalidBerData</var> exception can be thrown by any of the [[SSL security changes in V8.0#XmlDoc version of SSL entities|DER-to-XmlDoc]] methods. | An <var>InvalidBerData</var> exception can be thrown by any of the [[SSL security changes in V8.0#XmlDoc version of SSL entities|DER-to-XmlDoc]] methods. | ||
To produce an <var>InvalidBerData</var> exception for yourself, you typically use a <var class="product">User Language</var> <var>[[Exceptions#Throwing exceptions|Throw]]</var> statement calling the <var>InvalidBerData</var> <var>[[New_(InvalidBerData_constructor)|New]]</var> constructor: | To produce an <var>InvalidBerData</var> exception for yourself, you typically use a <var class="product">User Language</var> <var>[[Exceptions#Throwing exceptions|Throw]]</var> statement calling the <var>InvalidBerData</var> <var>[[New_(InvalidBerData_constructor)|New]]</var> constructor: | ||
<p class="code"> throw %(InvalidBerData):new(position=13, description=' | <p class="code"> throw %(InvalidBerData):new(position=13, description='did not get expected tag') | ||
</p> | </p> | ||
Line 60: | Line 56: | ||
<td>This [[Methods#Named parameters|name required]] parameter: <var>Position</var>, specifies the numeric value (<var class="term">number</var>) for the position to be assigned to the <var>InvalidBerData</var> exception object's <var>Position</var> property when a data error is encountered. </td></tr> | <td>This [[Methods#Named parameters|name required]] parameter: <var>Position</var>, specifies the numeric value (<var class="term">number</var>) for the position to be assigned to the <var>InvalidBerData</var> exception object's <var>Position</var> property when a data error is encountered. </td></tr> | ||
<tr><th><var>Description</var></th> | <tr><th><var>Description</var></th> | ||
<td>This name required parameter: <var>Description</var>, | <td>This name required parameter: <var>Description</var>, is the string, containing a brief description of the exception, that is assigned to the <var>InvalidBerData</var> exception object's <var>Description</var> property when a data error is encountered. </td></tr> | ||
</table> | </table> | ||
<h3>Usage notes</h3> | <h3>Usage notes</h3> | ||
<ul> | <ul> | ||
<li>As described in [[Object variables#Using New or other Constructors|"Using New or other Constructors"]], <var>New</var> can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is <var>Null</var>:<p class="code">%invalidBer = new | <li>As described in [[Object variables#Using New or other Constructors|"Using New or other Constructors"]], <var>New</var> can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is <var>Null</var>:<p class="code">%invalidBer = new(position=1, description='did not get expected tag') | ||
%invalidBer = %(InvalidBerData):new | %invalidBer = %(InvalidBerData):new(position=1, description='did not get expected tag') | ||
%invalidBer = %invalidBer:new | %invalidBer = %invalidBer:new(position=1, description='did not get expected tag') | ||
</p> | </p> | ||
</ul> | </ul> |
Revision as of 16:27, 24 April 2012
The InvalidBerData exception class validates whether the data being processed by the called method conforms to the BER (Basic Encoding Rules) protocol. BER data is base64-encoded binary data; BER rules are a superset of DER (Distinguished Encoding Rules) rules.
The InvalidBerData class has properties that indicate the position and description of the non-conforming data. There are currently no standardized error codes.
An InvalidBerData exception can be thrown by any of the DER-to-XmlDoc methods.
To produce an InvalidBerData exception for yourself, you typically use a User Language Throw statement calling the InvalidBerData New constructor:
throw %(InvalidBerData):new(position=13, description='did not get expected tag')
The methods of the InvalidBerData exception class are described below.
This class is available as of Sirius Mods Version 8.0.
The InvalidBerData methods
The following are the available InvalidBerData class methods.
Method | Description |
---|---|
Description | Description of error |
New | Create a new InvalidBerData object |
Position | Position where error encountered |
The methods in the class are described in the subsections that follow. In addition:
- "Notation conventions for methods" has information about the conventions followed.
- "InvalidBerData methods syntax" is a single page that contains the syntax diagrams of the methods in the class.
Description property
Description of error (InvalidBerData class)
[Introduced in Sirius Mods 8.0]
This ReadOnly property returns a description of the data error.
Syntax
%string = invalidBerData:Description
Syntax terms
%number | This numeric value is the line in the data being validated where a non-PEM-conforming character was found. |
---|---|
invalidBerData | A reference to an instance of an InvalidBerData object. |
New constructor
Create a new InvalidBerData object (InvalidBerData class)
[Introduced in Sirius Mods 8.0]
This method generates an instance of an InvalidBerData exception. The New method format is as follows:
Syntax
%invalidBerData = [%(InvalidBerData):]New( Position= number, - Description= string)
Syntax terms
%invalidBerData | A reference to an instance of a InvalidBerData object. |
---|---|
%(InvalidBerData) | The class name in parentheses denotes a Constructor. See "Usage notes", below, for more information about invoking a InvalidBerData Constructor. |
Position | This name required parameter: Position, specifies the numeric value (number) for the position to be assigned to the InvalidBerData exception object's Position property when a data error is encountered. |
Description | This name required parameter: Description, is the string, containing a brief description of the exception, that is assigned to the InvalidBerData exception object's Description property when a data error is encountered. |
Usage notes
- As described in "Using New or other Constructors", New can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is Null:
%invalidBer = new(position=1, description='did not get expected tag') %invalidBer = %(InvalidBerData):new(position=1, description='did not get expected tag') %invalidBer = %invalidBer:new(position=1, description='did not get expected tag')
Position property
Position where error encountered (InvalidBerData class)
[Introduced in Sirius Mods 8.0]
This ReadOnly property returns the position in the (expected) base64-encoded string where a non-BER-conforming character was found.
Syntax
%number = invalidBerData:Position
Syntax terms
%number | This numeric value is the position in the base64 string (in the line identified by the value of Line) where a non-BER-conforming character was found. |
---|---|
invalidBerData | A reference to an instance of an InvalidBerData object. |