com.ibm.tivoli.nm.collectors.impl.alcatel5620sam.jms.provider

Class Alcatel5620SamJmsProvider

java.lang.Object

java.util.Observable

com.ibm.tivoli.nm.collectors.impl.alcatel5620sam.jms.provider.Alcatel5620SamJmsProvider

public class Alcatel5620SamJmsProvider
extends java.util.Observable

Provides Jave Message Service functionality

Author:

Yeo Eng Seng

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	acceptedClientId This is the accepted client id for the topic.
protected boolean	isListening This identifies if the consumer is listening to the topic.

Constructor Summary

Constructors

Constructor and Description
Alcatel5620SamJmsProvider(java.util.Properties jndiProps, boolean blnSecure, java.lang.String strKeyPass, java.lang.String strKeyStore, java.lang.String strUsername, java.lang.String strPassword, java.lang.String strTopic, boolean blnDurable, java.lang.String strClientId, java.lang.String strFilter) Constructor

Method Summary

Modifier and Type	Method and Description
void	close() This method is called when the consumer wants to close the connection.
static boolean	isConnected()
static boolean	isStopped()
void	onException(JMSException aInException) This method is called when an exception occurs on the JMS connection.
void	onMessage(Message aInMessage) This method is called by message service for each event received.
static void	setConnected(boolean isConnected)
void	setExceptionListener(ExceptionListener aInListener) This method sets the exception listener on the connection.
void	setMessageListener(MessageListener aInListener) This method sets the message listener for the connection.
static void	setStopped(boolean isStopped)
boolean	startJmsSession(java.lang.String host) Starts the JMS session
void	startListening() This method is called when the consumer wants to start receiving messages.
void	stopListening() This method is called when the consumer wants to stop receiving messages.

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Field Detail

acceptedClientId

protected java.lang.String acceptedClientId

This is the accepted client id for the topic. This attribute contains the client id that was successfully registered with the server.

isListening

protected boolean isListening

This identifies if the consumer is listening to the topic.

Constructor Detail

Alcatel5620SamJmsProvider

public Alcatel5620SamJmsProvider(java.util.Properties jndiProps,
                                 boolean blnSecure,
                                 java.lang.String strKeyPass,
                                 java.lang.String strKeyStore,
                                 java.lang.String strUsername,
                                 java.lang.String strPassword,
                                 java.lang.String strTopic,
                                 boolean blnDurable,
                                 java.lang.String strClientId,
                                 java.lang.String strFilter)

Constructor

Parameters:

jmsConn - Alcatel5620SamJmsConnection instance

jmsSession - Alcatel5620SamJmsSession instance

jndiProps - JNDI properties

blnSecure - Flag to enable a secure session using SSL

strKeyPass - Keypass value for the secure session

strKeyStore - Keystore value for the secure session

strHost - IP address or hostname of the EMS

strUsername - Username

strPassword - Password

strTopic - The Topic name to listen for JMS messages

blnDurable - Flag to enable durable subscription

blnUnsubscribe - Flag to unsubscribe durable subscription

strClientId - JMS client identifier to be set for durable subscriptions

Method Detail

isConnected

public static boolean isConnected()

setConnected

public static void setConnected(boolean isConnected)

isStopped

public static boolean isStopped()

setStopped

public static void setStopped(boolean isStopped)

startJmsSession

public boolean startJmsSession(java.lang.String host)

Starts the JMS session

Throws:

Alcatel5620SamJmsException

startListening

public void startListening()
                    throws JMSException

This method is called when the consumer wants to start receiving messages.

Throws:

JMSException - If an exception happens on the connection.

setMessageListener

public void setMessageListener(MessageListener aInListener)

This method sets the message listener for the connection.

Parameters:

aInListener - The message listener to receive messages.

setExceptionListener

public void setExceptionListener(ExceptionListener aInListener)
                          throws JMSException

This method sets the exception listener on the connection.

Parameters:

aInListener - The connection listener to set.

Throws:

JMSException - If an exception happens on the connection.

onMessage

public void onMessage(Message aInMessage)

This method is called by message service for each event received.

Parameters:

aInMessage - The event received

onException

public void onException(JMSException aInException)

This method is called when an exception occurs on the JMS connection.

Parameters:

aInException - The exception that occurred.

close

public void close()

This method is called when the consumer wants to close the connection.

stopListening

public void stopListening()
                   throws JMSException

This method is called when the consumer wants to stop receiving messages.

Throws:

JMSException - If an exception happens on the connection.