WebSphere Message Broker™ V8.0.0.0 .NET Plugin Node API
NBCollectionMessage Class
NamespacesIBM.Broker.PluginNBCollectionMessage
SUMMARY
NBCollectionMessage represents a message collection that can be passed between the nodes in a message flow. A message collection is a specialisation of an NBMessage.
Declaration Syntax
C#Visual BasicVisual C++F#
public class NBCollectionMessage : NBMessage
Public Class NBCollectionMessage _
	Inherits NBMessage
public ref class NBCollectionMessage : public NBMessage
type NBCollectionMessage =  
    class
        inherit NBMessage
    end
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
NBCollectionMessage()()()()
Default constructor for NBCollectionMessage.

CreateFolder(String)
Creates a folder element as the last child of the Collection element of the message collection.

CreateNameValue(String, Object)
Creates a name-value element as the last child of the Collection element of the message collection.

Dispose()()()()
Deletes the resources associated with the message.
(Inherited from NBMessage.)
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
FinalizeMessage()()()()
Performs finalizing processing on the message.
(Inherited from NBMessage.)
GetBuffer()()()()
Gets a copy of the data buffer associated with (and owned by) the message object.
(Inherited from NBMessage.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
ReadOnly
Returns true if the message is read only.
(Inherited from NBMessage.)
RootElement
Returns the RootNBElement of the message.
(Inherited from NBMessage.)
ToString()()()()
Returns a String that represents the current Object.
(Inherited from Object.)
Remarks
The last child of the root of the message is an element called "Collection" and has a Collection parser associated with it. The children of the Collection element are either name-value types that do not have an associated parser or are the root elements of Message Broker message structures and will have an appropriate parser associated with them. In the case of structures created using this NBCollectionMessage class, the message roots are referred to as folders. The folders can be given any name you require and will be associated with a CollectionFolder parser. Typically, any name-value elements will preceed any folder element children of the Collection element. The following diagram illustrates the structure of a message collection.

              +------+
              | Root | (A)
              +--+---+
                 |
           +-----+------+
           | Collection | (A)
          +-----+------+
                 |
 +----------+----+-------+--------------+
 |          |            |              |
+--+--+    +--+--+    +----+----+    +----+----+
| nv1 |    | nv2 |    | folder1 |    | folder2 |
+-----+    +-----+    +----+----+    +----+----+
(B)        (B)       (C) |          (C) 
             +-----------+----------+                   
             |                      |    
       +-----+------+           +--------+
       | Properties |   - - -   | XMLNSC |
       +-----+------+    (D)    +---+----+
             |                      |
                                 +--+--+
                                 | msg |
                                 +--+--+
                                    |

The elements in the diagram marked (A), (B) and (C) are created by methods of the NBCollectionMessage class. Other elements, such as the children of the folder elements and their children in Properties and message body related children are created via their parent elements using the Create methods on the NBElement class. See CreateLastChild as an example. There may be other header elements at (D) in the diagram.

The elements marked (A) in the above diagram are created by the NBCollectionMessage constructor.

The elements marked (B) are created using the CreateNameValue() method of the NBCollectionMessage class.

The elements marked (C) are created using the CreateFolder() method of the NBCollectionMessage class.

See Also: "Working with Messages. Appendix A: Message Parsers - element definitions" in the infocenter.

Inheritance Hierarchy
Object
NBMessage
 NBCollectionMessage

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