org.jgroups.protocols
Class JMS

java.lang.Object
  extended by org.jgroups.stack.Protocol
      extended by org.jgroups.protocols.JMS
All Implemented Interfaces:
javax.jms.MessageListener

public class JMS
extends Protocol
implements javax.jms.MessageListener

Implementation of the transport protocol using the Java Message Service (JMS). This implementation depends on the JMS server that will distribute messages published to the specific topic to all topic subscribers.

Protocol parameters are:

Note, when you are using the JMS protocol, try to avoid using protocols that open server socket connections, like FD_SOCK. I belive that FD is more appropriate failure detector for JMS case.

Author:
Roman Rokytskyy (rrokytskyy@acm.org)

Nested Class Summary
protected static class JMS.JMSAddress
          Simple Address representing the JMS node ID or JMS topic group.
 
Field Summary
static java.lang.String DEFAULT_CONNECTION_FACTORY
           
static java.lang.String DEST_PROPERTY
           
static java.lang.String GROUP_NAME_PROPERTY
           
static java.lang.String INIT_CONNECTION_FACTORY
           
static java.lang.String INIT_JNDI_CONTEXT
           
static java.lang.String INIT_PROVIDER_URL
           
static java.lang.String INIT_TOPIC_NAME
           
static java.lang.String SRC_PROPERTY
           
static java.lang.String TIME_TO_LIVE
           
 
Fields inherited from class org.jgroups.stack.Protocol
down_handler, down_prot, down_queue, down_thread, down_thread_prio, log, observer, props, stack, stats, trace, up_handler, up_prot, up_queue, up_thread, up_thread_prio, warn
 
Constructor Summary
JMS()
          Empty constructor.
 
Method Summary
 void down(Event evt)
          Called by the protocol above this.
protected  java.lang.String generateLocalAddress()
          Generate random local address.
 java.lang.String getName()
          Get the name of the protocol.
protected  void handleDownEvent(Event evt)
          Handle down event, if it is not a Event.MSG type.
 void onMessage(javax.jms.Message jmsMessage)
          Implementation of the javax.jms.MessageListener interface.
protected  void sendMessage(Message msg)
          Publish message in the JMS topic.
 boolean setProperties(java.util.Properties props)
          Set protocol properties.
 void start()
          Start the JMS protocol.
 void stop()
          Stops the work of the JMS protocol.
 java.lang.String toString()
          Get the string representation of the protocol.
 
Methods inherited from class org.jgroups.stack.Protocol
destroy, downThreadEnabled, dumpStats, enableStats, getDownProtocol, getDownQueue, getProperties, getUpProtocol, getUpQueue, handleSpecialDownEvent, init, isTrace, isWarn, passDown, passUp, printStats, providedDownServices, providedUpServices, receiveDownEvent, receiveUpEvent, requiredDownServices, requiredUpServices, resetStats, setDownProtocol, setObserver, setPropertiesInternal, setProtocolStack, setTrace, setUpProtocol, setWarn, startDownHandler, startUpHandler, statsEnabled, stopInternal, up, upThreadEnabled
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DEFAULT_CONNECTION_FACTORY

public static final java.lang.String DEFAULT_CONNECTION_FACTORY
See Also:
Constant Field Values

INIT_CONNECTION_FACTORY

public static final java.lang.String INIT_CONNECTION_FACTORY
See Also:
Constant Field Values

INIT_TOPIC_NAME

public static final java.lang.String INIT_TOPIC_NAME
See Also:
Constant Field Values

INIT_JNDI_CONTEXT

public static final java.lang.String INIT_JNDI_CONTEXT
See Also:
Constant Field Values

INIT_PROVIDER_URL

public static final java.lang.String INIT_PROVIDER_URL
See Also:
Constant Field Values

TIME_TO_LIVE

public static final java.lang.String TIME_TO_LIVE
See Also:
Constant Field Values

GROUP_NAME_PROPERTY

public static final java.lang.String GROUP_NAME_PROPERTY
See Also:
Constant Field Values

SRC_PROPERTY

public static final java.lang.String SRC_PROPERTY
See Also:
Constant Field Values

DEST_PROPERTY

public static final java.lang.String DEST_PROPERTY
See Also:
Constant Field Values
Constructor Detail

JMS

public JMS()
Empty constructor.

Method Detail

getName

public java.lang.String getName()
Get the name of the protocol.

Specified by:
getName in class Protocol
Returns:
always returns the "JMS" string.

toString

public java.lang.String toString()
Get the string representation of the protocol.

Overrides:
toString in class java.lang.Object
Returns:
string representation of the protocol (not very useful though).

setProperties

public boolean setProperties(java.util.Properties props)
Set protocol properties. Properties are:

Overrides:
setProperties in class Protocol

onMessage

public void onMessage(javax.jms.Message jmsMessage)
Implementation of the javax.jms.MessageListener interface. This method receives the JMS message, checks the destination group name. If the group name is the same as the group name of this channel, it checks the destination address. If destination address is either multicast or is the same as local address then message is unwrapped and passed up the protocol stack. Otherwise it is ignored.

Specified by:
onMessage in interface javax.jms.MessageListener
Parameters:
jmsMessage - instance of javax.jms.Message.

handleDownEvent

protected void handleDownEvent(Event evt)
Handle down event, if it is not a Event.MSG type.

Parameters:
evt - event to handle.

down

public void down(Event evt)
Called by the protocol above this. We check the event type, and if it is message, we publish it in the topic, otherwise we let the handleDownEvent(Event) take care of it.

Overrides:
down in class Protocol
Parameters:
evt - event to process.

sendMessage

protected void sendMessage(Message msg)
Publish message in the JMS topic. We set the message source and destination addresses if they were null.

Parameters:
msg - message to publish.

start

public void start()
           throws java.lang.Exception
Start the JMS protocol. This method instantiates the JNDI initial context and looks up the topic connection factory and topic itself. If this step is successful, it creates a connection to JMS server, opens a session and obtains publisher and subscriber instances.

Overrides:
start in class Protocol
Throws:
javax.jms.JMSException - if something goes wrong with JMS.
javax.naming.NamingException - if something goes wrong with JNDI.
java.lang.IllegalArgumentException - if the connection factory or topic cannot be found under specified names.
java.lang.Exception - Thrown if protocol cannot be started successfully. This will cause the ProtocolStack to fail, so Channel.connect(String) will throw an exception

stop

public void stop()
Stops the work of the JMS protocol. This method closes JMS session and connection and deregisters itself from the message notification.

Overrides:
stop in class Protocol

generateLocalAddress

protected java.lang.String generateLocalAddress()
                                         throws java.net.UnknownHostException
Generate random local address. This method takes host name and appends it with randomly generated integer.

Returns:
randomly generated local address.
Throws:
java.net.UnknownHostException


Copyright ? 1998-2005 Bela Ban. All Rights Reserved.