Package com.ibm.broker.plugin

This package provides the classes for creating a user-defined node.

See: Description

Interface Summary

Interface	Description
MbInputNodeInterface	MbInputNodeInterface provides the mechanism for creating a user-defined input node.
MbJdbcType4ConnFactoryInterface
MbNodeInterface	MbNodeInterface provides the mechanism for creating a user plugin (non-input) node.

Class Summary

Class	Description
MbBLOB	This class contains constants for the BLOB parser.
MbBroker	MbBroker provides access to various broker related information such as broker name, queue manager name.
MbDate	MbDate is a representation of the broker's ESQL date type.
MbDeployedJarProvider
MbDFDL	This class contains constants for the DFDL parser.
MbElement	MbElement represents the syntax elements in the logical (hierarchical) view of the message.
MbExecutionGroup	MbExecutionGroup provides access to execution group properties.
MbGlobalMap	MbGlobalMap represents an instance of a map within the embedded global cache, or in an external WebSphere eXtreme Scale grid.
MbGlobalMapSessionPolicy	MbGlobalMapSessionPolicy is a container for properties to be set on a given MbGlobalMap object.
MbInputNode	MbInputNode provides utility methods allowing a user-defined input node to interact with the broker.
MbInputTerminal	MbInputTerminal represents a terminal on which a message is passed into the user-defined node.
MbJSON	This class contains constants for the JSON parser.
MbMessage	MbMessage represents the message passed between the nodes in a message flow.
MbMessageAssembly	MbMessageAssembly is the top level structure used to pass messages between nodes.
MbMessageCollection	MbMessageCollection represents a message collection that can be passed between the nodes in a message flow.
MbMessageFlow	MbMessageFlow provides access to message flow properties.
MbMQMD	This class contains constants for the MQMD parser.
MbMRM	This class contains constants for the MRM parser.
MbNode	MbNode provides utility methods allowing a plugin node to interact with the broker.
MbOutputTerminal	MbOutputTerminal represents a terminal to which a message is propagated out of the user-defined node.
MbRFH2C	This class contains constants for the compact RFH2 parser.
MbRoute	MbRoute represents a Label node to which a message can be propagated.
MbService	MbService contains static methods for writing information to the system log.
MbSQLStatement	MbSQLStatement provides support for accessing an external ODBC Database.
MbTable	MbTable is a complex data type which contains one or more rows of simple data types.
MbTerminal	MbTerminal provides base class functionality for input and output terminals.
MbTime	MbTime is a representation of the broker's ESQL time type.
MbTimestamp	MbTimestamp is a representation of the broker's ESQL timestamp type.
MbUtilities	MbUtilities contains static broker utility methods.
MbXML	This class contains constants for the generic XML parser.
MbXMLNS	This class contains constants for the generic namespace-aware XML parser.
MbXMLNSC	This class contains constants for the compact XML parser.
MbXPath	XPath is a query language for addressing parts of an XML document.

Enum Summary

Enum	Description
MbNode.JDBC_TransactionType	Transaction type.

Exception Summary

Exception	Description
MbBrokerException	An MbBrokerException is thrown when an internal error occurs in the broker.
MbConfigurationException	An MbConfigurationException is generated when a configuration request fails.
MbConversionException	An MbConversionException is generated by the broker character conversion functions if invalid data is found when attempting to convert to another datatype.
MbDatabaseException	An MbDatabaseException is generated when a database management system reports an error during broker operation.
MbException	This is the base class of the exception hierarchy from which all exceptions are derived.
MbFatalException	An MbFatalException is generated when a condition occurs that prevents the broker process from continuing execution safely, or where it is broker policy to terminate the process.
MbJavaException	This class provides a wrapper of any non-broker Java exceptions ( subclasses of Throwable ) thrown from within a Java plug-in.
MbParserException	An MbParserException is generated by message parsers for errors which prevent the parsing of the message content or creating a bit-stream.
MbReadOnlyMessageException	An MbReadOnlyMessageException is thrown whenever a user tries to write to a read-only message.
MbRecoverableException	An MbRecoverableException is generated for errors which, although not terminal in nature, mean that the processing of the current message flow has to be ended.
MbSecurityException
MbTerminalCreationException	An MbTerminalCreationException is thrown whenever a user tries to create terminals anywhere other than in the node constructor (for example, in the evaluate method).
MbUserException	These are generated when a Throw node throws a user-defined exception.

Package com.ibm.broker.plugin Description

This package provides the classes for creating a user-defined node.

A node is a basic building block designed to do some particular processing in response to each message in a message flow. The skeleton code required to create a user-defined node is shown on the MbNodeInterface page.

An input node is a special type of node and requires extra consideration for threading issues and transactional control. Input nodes are described on the MbInputNodeInterface page.

This package is also used by the Java Compute Node to access broker services, such as navigating and building message trees.