com.ibm.ima.samples.plugin.jsonmsg

Class JMConnection

Object

com.ibm.ima.samples.plugin.jsonmsg.JMConnection

public class JMConnection
extends Object

The JMConnection class is the connection listener for the json_msg plug-in. This object represents the connection from the plug-in point of view.

The basic job of this listener is to convert data between the external JSON representation and the MessageSight plug-in methods. The json_msg sample protocol is conceptually very similar to the natively supported messaging protocols. So this example demonstrates the mechanisms for a protocol plug-in but it does relatively simple conversions from one representation to another.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COPYRIGHT

Method Summary

Modifier and Type	Method and Description
void	onClose(int rc, String reason) Handle the close of a connection.
void	onComplete(Object obj, int rc, String message) Handle a completion event.
void	onConnected(int rc, String reason) Handle the completion of a connection and send a connection message to the client.
int	onData(byte[] data, int offset, int length) Handle data from the client.
void	onGetMessage(Object correlate, int rc, ImaMessage msg) Handle a message from the server.
void	onHttpData(String op, String path, String query, String content_type, byte[] data) This plug-in does not support HTTP interactions.
boolean	onLivenessCheck() Handle a request to check if the connection is alive.
void	onMessage(ImaSubscription sub, ImaMessage msg) Handle a message from the server.
String	toString() Give a simple string representation of this connection listener object.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COPYRIGHT

public static final String COPYRIGHT

See Also:

Constant Field Values

Method Detail

onClose

public void onClose(int rc,
                    String reason)

Handle the close of a connection. If we get a close, try sending a close action. If the physical connection is already closed this will fail silently.

See Also:

com.ibm.ima.plugin.ImaConnectionListener#onClose(int, java.lang.String)

onLivenessCheck

public boolean onLivenessCheck()

Handle a request to check if the connection is alive. Send a ping to the client to check if the connection is still alive.

See Also:

com.ibm.ima.plugin.ImaConnectionListener#onLivenessCheck()

onData

public int onData(byte[] data,
                  int offset,
                  int length)

Handle data from the client. When we receive data from the client, convert it to a string and use the JSON parser to find a JSON object as a message within it. If we find one call the method associated with the action.

See Also:

com.ibm.ima.plugin.ImaConnectionListener#onData(byte[])

onConnected

public void onConnected(int rc,
                        String reason)

Handle the completion of a connection and send a connection message to the client. A non-zero return code indicates that the connection is closed, and that is handled by calling close.

See Also:

com.ibm.ima.plugin.ImaConnectionListener#onConnected(int, java.lang.String)

onMessage

public void onMessage(ImaSubscription sub,
                      ImaMessage msg)

Handle a message from the server. Convert the message from the internal format to the JSON format and send the message on to the client.

See Also:

com.ibm.ima.plugin.ImaConnectionListener#onMessage(com.ibm.ima.plugin.ImaSubscription, com.ibm.ima.plugin.ImaMessage)

onGetMessage

public void onGetMessage(Object correlate,
                         int rc,
                         ImaMessage msg)

Handle a message from the server. Convert the message from the internal format to the JSON format and send the message on to the client.

See Also:

com.ibm.ima.plugin.ImaConnectionListener#onMessage(com.ibm.ima.plugin.ImaSubscription, com.ibm.ima.plugin.ImaMessage)

onComplete

public void onComplete(Object obj,
                       int rc,
                       String message)

Handle a completion event. The completion can come in on a message or subscription.

See Also:

com.ibm.ima.plugin.ImaConnectionListener#onComplete(java.lang.Object, int, java.lang.String)

toString

public String toString()

Give a simple string representation of this connection listener object.

Overrides:

toString in class Object

See Also:

Object.toString()

onHttpData

public void onHttpData(String op,
                       String path,
                       String query,
                       String content_type,
                       byte[] data)

This plug-in does not support HTTP interactions.

See Also:

com.ibm.ima.plugin.ImaConnectionListener#onHttpData(java.lang.String, java.lang.String, java.lang.String, java.lang.String, byte[])