Package com.ibm.ima.plugin
A Java plug-in can be used to implement any combination of the following:
- Define one or more protocols to accept from a TCP, UDP, or WebSockets connection
- Send messages to the MessageSight server and set up subscriptions which receive messages from a MessageSight server.
- Authenticate a connection
- Run JavaSE code constrained by a security manager.
These functions can be combined together to easily define a messaging bridge or to map from vendor or industry specific protocols.
This package primarily contains interfaces. A Java plug-in to IBM MessageSight defines a class implementing ImaPluginListener which is instantiated by IBM MessageSight. The initialize() method is invoked passing in the ImaPlugin object. The IBM MessageSight server communicates with the plug-in by calling methods in ImaPluginListener and the plug-in invokes methods in the ImaPlugin object to communicate with IBM MessageSight. Additionally, to enable client connections, a Java plug-in to IBM MessageSight defines a class implementing ImaConnectionListener. The callback methods implemented for the ImaConnectionListener interface permit clients using the plug-in protocol to send messages to and receive messages from IBM MessageSight via the target protocol.
-
Interface Summary Interface Description ImaConnection A connection represents a logical communications channel.ImaConnectionListener The connection listener defines the callbacks associated with a connection.ImaEndpoint The ImaEndpoint object represents a read only object which contains the settings of the endpoint within IBM MessageSight.ImaMessage The ImaMessage interface defines a message within the plug-in and represents the message as known internally in the MessageSight server.ImaPlugin A plug-in interface defines a set of methods which can be invoked for this plug-in.ImaPluginConfigValidator A plug-in custom properties validator.ImaPluginListener The ImaPluginListener defines a set of callback methods which are called by MessageSight.ImaSubscription The ImaSubscription object is created using the newSubscription() method of ImaConnection.ImaTransaction The ImaSubscription object is created using the newSubscription() method of ImaConnection.ImaTransactionListener The transaction listener defines the callbacks associated with a transaction. -
Class Summary Class Description ImaPropertyID A property ID defines identifiers for header fields that are larger than one byte.ImaReturnCode Define a subset of the IBM MessgeSight server return codes which might be visible to the plug-in. -
Enum Summary Enum Description ImaDestinationType Define the destination type as topic or queueImaMessageType Define the type of the message body.ImaReliability Define the reliability or quality of service of the message.ImaSubscriptionType Define the type of a shared subscription -
Exception Summary Exception Description ImaPluginException The ImaPluginExecption is used to indicate an error when processing a synchronous request.