[This is preliminary documentation and is subject to change.]
The base class for all exception classes defined by the Adk.
Declaration Syntax| C# | Visual Basic | Visual C++ |
[SerializableAttribute] public class AdkException : Exception
<SerializableAttribute> _ Public Class AdkException _ Inherits Exception
[SerializableAttribute] public ref class AdkException : public Exception
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | AdkExceptionAdkExceptionNew(String, IZone) | Constructs an exception with a detailed message that occurs in the
context of a zone
|
| AdkExceptionAdkExceptionNew(String, IZone, Exception) |
Constructs an exception with zone information and the exception that caused this exception to be raised
|
| add(Exception) | Adds a child exception |
 | Children | Gets the child exceptions, if any |
| hasChildren()() | Determines if this exception has nested child exceptions |
| hasSIFError(SifErrorCategoryCode) | Determines if this exception contains at least one nested SifException
with the specified error category.
|
| hasSIFError(SifErrorCategoryCode, Int32) | Determines if this exception contains at least one nested SifException
with the specified error category and code.
|
| hasSIFExceptions()() | Determines if this exception contains any SifException children.
SifException encapsulates SIF errors returned to the agent in SIF_Ack
messages.
|
| Log(ILog) | Write this exception and all of its nested exceptions to the logging framework. For
any exception that is not associated with a zone, the supplied default
Category will be used. Otherwise the Category of the zone is used.
|
| Log(ILog, Int32) |
Write this exception and all of its nested exception to the logging framework
|
| Retry | Determines if the Adk should attempt to retry the operation associated
with this exception.
|
| SIFExceptions | Gets all child SIFExceptions, if any |
| ToString()() | Returns a string representation of this exception and all child
exceptions formatted for printing to System.out. Each exception is
on its own line.
(Overrides Exception.ToString()().) |
| ToString(Int32, Boolean) | Returns a string representation of this exception and all child
exceptions formatted for printing to System.out. Each exception is
on its own line.
|
| Zone | Gets the zone associated with this exception. |
| ZoneId | Gets the ID of the zone associated with this exception. |
Remarks
AdkExceptions have the following characteristics:
- An exception may contain one or more child exceptions. All Adk methods that operate on multiple zones or topics take a fail-late approach where the method continues processing even when an error occurs. Only after all zones and topics have been enumerated is a final exception thrown. It may contain multiple child exceptions collected during the processing
- The caller can obtain a reference to the Zone in which the exception occurred.
Author: Eric Peterson
Version: Adk 1.0
