WebSphere Message Broker™ V8.0.0.0 .NET Plugin Node API
NBRecoverableException Class
NamespacesIBM.Broker.PluginNBRecoverableException
SUMMARY
NBRecoverableException represents errors which, although not terminal in nature, mean that the processing of the current message flow has to be ended.
Declaration Syntax
C#Visual BasicVisual C++F#
[SerializableAttribute]
public class NBRecoverableException : NBException, 
	ISerializable
<SerializableAttribute> _
Public Class NBRecoverableException _
	Inherits NBException _
	Implements ISerializable
[SerializableAttribute]
public ref class NBRecoverableException : public NBException, 
	ISerializable
[<SerializableAttribute>]
type NBRecoverableException =  
    class
        inherit NBException
        interface ISerializable
    end
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
NBRecoverableException(String, String, Int64, NBSeverity, Exception, array<Object>[]()[][])
Constructs a new exception object with the given message, the object's catalog, exception number, severity, the inner exception and the object's inserts.

NBRecoverableException(String, String, Int64, NBSeverity, array<Object>[]()[][])
Constructs a new exception object with the given message, the object's catalog, exception number, severity and the object's inserts.

NBRecoverableException(String, String, Int64, Exception, array<Object>[]()[][])
Constructs a new exception object with the given message, the object's catalog, exception number, inner exception and inserts.

NBRecoverableException(String, String, Int64, array<Object>[]()[][])
Constructs a new exception object with the given message, the object's catalog, exception number and inserts.

NBRecoverableException(String, String, Int64)
Constructs a new exception object with the given message, the object's catalog and exception number.

NBRecoverableException(String, Int64, NBSeverity, Exception, array<Object>[]()[][])
Recording the exception's message, exception number, the severity, the inner exception and the object's inserts.

NBRecoverableException(String, Int64, NBSeverity, array<Object>[]()[][])
Constructs a new exception object with the given message, exception number, the severity and the object's inserts.

NBRecoverableException(String, Int64, Exception, array<Object>[]()[][])
Constructs a new exception object with the given message, exception number, the inner exception and inserts.

NBRecoverableException(String, Int64, array<Object>[]()[][])
Constructs a new exception object with the given message, exception number and inserts.

NBRecoverableException(String, Exception, array<Object>[]()[][])
Constructs a new exception object with the given message, inner exception and inserts and the defaulted message number 7498.

NBRecoverableException(String, array<Object>[]()[][])
Constructs a new exception object with the given message and inserts and the defaulted message number 7498.

NBRecoverableException(String, Int64, NBSeverity, Exception)
Constructs a new exception object with the given message, exception number, severity and the inner exception.

NBRecoverableException(String, Int64, NBSeverity)
Constructs a new exception object with the given message, exception number and severity.

NBRecoverableException(String, Int64, Exception)
Constructs a new exception object with the given message, exception number and the inner exception.

NBRecoverableException(String, Int64)
Constructs a new exception object with the given message and exception number.

NBRecoverableException(String, Exception)
Constructs a new exception object with the given message and inner exception and the defaulted message number 7499.

NBRecoverableException(String)
Constructs a new exception object with the given message and the defaulted message number 7499.

NBRecoverableException()()()()
Constructs a new exception object with the defaulted message number 7499.

AddNestedException(NBException)
Adds a nested exception to the current exception.
(Inherited from NBException.)
Catalog
Gets or sets The catalog that contains the exception message number.
(Inherited from NBException.)
Data
Gets a collection of key/value pairs that provide additional user-defined information about the exception.
(Inherited from NBException.)
Dispose()()()() (Inherited from NBException.)
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
File
Gets or sets the file that generated the exception.
(Inherited from NBException.)
FormattedMessage(Boolean)
Formats the exception as a string using the catalog provided in the exception itself.
(Inherited from NBException.)
GetBaseException()()()()
When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.
(Inherited from Exception.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetNestedExceptions()()()()
Gets all the nested exceptions that belong to the current exception.
(Inherited from NBException.)
GetObjectData(SerializationInfo, StreamingContext)
Initializes a new instance of the Exception class with serialized data.
(Inherited from NBException.)
GetType()()()()
Gets the runtime type of the current instance.
(Inherited from Exception.)
HelpLink
Gets or sets a link to the help file associated with this exception.
(Inherited from Exception.)
InnerException
Gets the Exception instance that caused the current exception.
(Inherited from Exception.)
Label
Gets or sets the label of the component or class that originated the exception.
(Inherited from NBException.)
Line
Gets or sets the line in the file where the exception was generated.
(Inherited from NBException.)
Message
Gets a message that describes the current exception.
(Inherited from Exception.)
MessageAsFirstInsert
Gets or sets a flag to request that the exception, when logged, contains the Message as the first insert.
(Inherited from NBException.)
Method
Gets or sets the name of the method which throws the exception.
(Inherited from NBException.)
Name
Gets or sets the name of the component or class that originated the exception.
(Inherited from NBException.)
Number
Gets or sets the Error number.
(Inherited from NBException.)
Severity
Gets or sets the severity of the exception.
(Inherited from NBException.)
Source
Gets or sets the message source of the message in the exception.
(Inherited from NBException.)
StackTrace
Gets a string representation of the immediate frames on the call stack.
(Inherited from NBException.)
StackTraceAsLastInsert
Gets or sets a flag to request that the exception, when logged, contains the StackTrace as its last insert.
(Inherited from NBException.)
TargetSite
Gets the method that throws the current exception.
(Inherited from Exception.)
ThrowThis()()()()
Instructs this object to throw itself.
(Overrides NBException.ThrowThis()()()().)
ToString()()()()
Creates and returns a string representation of the current exception.
(Inherited from Exception.)
Remarks
Examples of recoverable exceptions are invalid data in the content of a message, or a failure to write a message to an output node.

Many methods in the Plugin API will throw NBRecoverableException's. This type of exception is safe to catch in user code and can be handled by user code without having to rethrow the exception back to the broker. Therefore, NBRecoverableException would be the usual type to place in a catch block around Plugin API calls.

Inheritance Hierarchy

Assembly: IBM.Broker.Plugin (Module: IBM.Broker.Plugin) Version: 8.0.0.0