com.ibm.ima.samples.plugin.restmsg

Class RestMsgPlugin

Object

com.ibm.ima.samples.plugin.restmsg.RestMsgPlugin

public class RestMsgPlugin
extends Object

The RestMsgPlugin class acts as the plug-in object associated with restmsg protocol. It the implements the required ImaPluginListener interface.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COPYRIGHT

Constructor Summary

Constructors

Constructor and Description
RestMsgPlugin() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	initialize(ImaPlugin plugin) Initialize the plug-in
boolean	onAuthenticate(ImaConnection connect) Authenticate a connection.
void	onConfigUpdate(String name, Object subname, Object value) Handle the update of a configuration item.
ImaConnectionListener	onConnection(ImaConnection connect, String protocol) When the connection is accepted for this protocol, create a new connection listener for communication between restmsg clients and IBM MessageSight.
int	onProtocolCheck(ImaConnection connect, byte[] data) Check that this connection is for this protocol.
void	startMessaging(boolean active) This callback informs us that messaging is now active in the server.
void	terminate(int reason) This callback informs us that the MessgeSight server is terminating.

Methods inherited from class Object

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

Field Detail

COPYRIGHT

public static final String COPYRIGHT

See Also:

Constant Field Values

Constructor Detail

RestMsgPlugin

public RestMsgPlugin()

Default constructor.

This is invoked by IBM MessageSight when a plug-in is loaded based on the Class property of the plugin.json definition file.

Method Detail

initialize

public void initialize(ImaPlugin plugin)

Initialize the plug-in

See Also:

com.ibm.ima.plugin.ImaPluginListener#initialize(com.ibm.ima.plugin.ImaPlugin)

onAuthenticate

public boolean onAuthenticate(ImaConnection connect)

Authenticate a connection. This method is intended for use by self-authenticating protocols but is not currently invoked by the MessageSight server. For protocols that are not self-authenticating, always return true.

See Also:

com.ibm.ima.plugin.ImaPluginListener#onAuthenticate(com.ibm.ima.plugin.ImaConnection)

onProtocolCheck

public int onProtocolCheck(ImaConnection connect,
                           byte[] data)

Check that this connection is for this protocol. We do not support base TCP connections.

See Also:

com.ibm.ima.plugin.ImaPluginListener#onConnection(com.ibm.ima.plugin.ImaConnection, byte[])

onConnection

public ImaConnectionListener onConnection(ImaConnection connect,
                                          String protocol)

When the connection is accepted for this protocol, create a new connection listener for communication between restmsg clients and IBM MessageSight.

See Also:

com.ibm.ima.plugin.ImaPluginListener#onConnection(com.ibm.ima.plugin.ImaConnection, java.lang.String)

onConfigUpdate

public void onConfigUpdate(String name,
                           Object subname,
                           Object value)

Handle the update of a configuration item.

See Also:

com.ibm.ima.plugin.ImaPluginListener#onConfigUpdate(String, Object, Object)

startMessaging

public void startMessaging(boolean active)

This callback informs us that messaging is now active in the server. Since we are basing our work on incoming connections, we do not care about this as we will not get a onConnection() callback unless messaging is started. This would be used by a plug-in such as a bridge which wanted to do some subscriptions at the start of messaging.

See Also:

com.ibm.ima.plugin.ImaPluginListener#startMessaging(boolean)

terminate

public void terminate(int reason)

This callback informs us that the MessgeSight server is terminating. This is about to terminate the plug-in process as well, so we do not need to do anything at this point. This callback could be used by close any external resources.

See Also:

com.ibm.ima.plugin.ImaPluginListener#terminate(int)