MbOutputTerminal (IBM Integration Bus Java Plugin Node API)

Skip navigation links

IBM Integration Bus^TM
Java^TM Plugin Node API

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- com.ibm.broker.plugin.MbTerminal
- - com.ibm.broker.plugin.MbOutputTerminal

```
public class MbOutputTerminal
extends MbTerminal
```
MbOutputTerminal represents a terminal to which a message is propagated out of the user-defined node. A node should have one or more output terminals.
If a node creates a terminal named 'failure', then the framework will automatically use this to propagate a failed message. Likewise, if an input node creates a terminal named 'catch', then the framework will automatically use this to propagate a failed message caused by a downstream exception.
Output terminals are created in the constructor of the user node class by calling the createOutputTerminal method.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`propagate(MbMessageAssembly assembly)` Propagates an MbMessageAssembly to the terminal.
`void`	`propagate(MbMessageAssembly assembly, boolean clear)` Propagates an MbMessageAssembly to the terminal.
`java.lang.String`	`toString()` Returns a String representation of the MbOutputTerminal.

Methods inherited from class com.ibm.broker.plugin.MbTerminal
equals, getName, isAttached, isDynamic

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - propagate
```
public void propagate(MbMessageAssembly assembly)
               throws MbException
```
    Propagates an MbMessageAssembly to the terminal.
    
    Parameters:
    
    assembly - The MbMessageAssembly being propagated.
    
    Throws:
    
    MbException
  - propagate
```
public void propagate(MbMessageAssembly assembly,
                      boolean clear)
               throws MbException
```
    Propagates an MbMessageAssembly to the terminal.
    
    Parameters:
    
    assembly - The MbMessageAssembly being propagated.
    
    clear - Indicates if the message assembly is to be cleared after propagation. This will clear all of the output messages, their root elements and clear the resources associated with the assembly. Setting this value to true is the equivalent of using ESQL PROPAGATE with DELETE default.
    
    Throws:
    
    MbException
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of the MbOutputTerminal.
    
    Overrides:
    
    toString in class MbTerminal
    
    Returns:
    
    The String representation of the MbOutputTerminal.