cern::cmw::mom::pubsub::impl::JMSConnection Interface Reference

Inheritance diagram for cern::cmw::mom::pubsub::impl::JMSConnection:

[legend]

List of all members.

Public Member Functions
String	getConnectId ()
boolean	isConnected ()
void	setExceptionListener (ExceptionListener listener) throws ConnectionException
String	getUsername ()
void	close ()
void	connect (boolean retry) throws ConnectionException
void	disconnect ()
void	start () throws ConnectionException
void	stop () throws ConnectionException

---

Detailed Description

Interface class. Defines an interface to manage a generic JMS connection.

Version:

1.0 23 Jan 2001

Author:

Controls Middleware Project

---

Member Function Documentation

void cern::cmw::mom::pubsub::impl::JMSConnection::close

(

)

Close the connection.

Implemented in cern::cmw::mom::pubsub::impl::ACSJMSTopicConnectionImpl, and cern::cmw::mom::pubsub::impl::DefaultJMSTopicConnectionImpl.

Referenced by cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::close(), and cern::cmw::mom::pubsub::impl::DefaultPublisherImpl::close().

void cern::cmw::mom::pubsub::impl::JMSConnection::connect

(

boolean

retry

)

throws ConnectionException

Estabilish a connection to a JMS broker.

Parameters:

retry

true if connection retry mechanism is requested.

Exceptions:

ConnectionException

Implemented in cern::cmw::mom::pubsub::impl::ACSJMSTopicConnectionImpl, and cern::cmw::mom::pubsub::impl::DefaultJMSTopicConnectionImpl.

Referenced by cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::initialize(), and cern::cmw::mom::pubsub::impl::DefaultPublisherImpl::initialize().

void cern::cmw::mom::pubsub::impl::JMSConnection::disconnect

(

)

Disconnect from the JMS broker.

Implemented in cern::cmw::mom::pubsub::impl::ACSJMSTopicConnectionImpl, and cern::cmw::mom::pubsub::impl::DefaultJMSTopicConnectionImpl.

String cern::cmw::mom::pubsub::impl::JMSConnection::getConnectId

(

)

Get the unique connection identifier associated with the connection.

Returns:

String The connection identifier.

Implemented in cern::cmw::mom::pubsub::impl::ACSJMSTopicConnectionImpl, and cern::cmw::mom::pubsub::impl::DefaultJMSTopicConnectionImpl.

Referenced by cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::setConnectionIdentifier().

String cern::cmw::mom::pubsub::impl::JMSConnection::getUsername

(

)

Get the username, if any, associated with the connection.

Returns:

String The username.

Implemented in cern::cmw::mom::pubsub::impl::ACSJMSTopicConnectionImpl, and cern::cmw::mom::pubsub::impl::DefaultJMSTopicConnectionImpl.

Referenced by cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::createTopic(), and cern::cmw::mom::pubsub::impl::DefaultPublisherImpl::createTopic().

boolean cern::cmw::mom::pubsub::impl::JMSConnection::isConnected

(

)

Check if the connection is estabilished.

Returns:

boolean true if the connection is active.

Implemented in cern::cmw::mom::pubsub::impl::ACSJMSTopicConnectionImpl, and cern::cmw::mom::pubsub::impl::DefaultJMSTopicConnectionImpl.

Referenced by cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::publishKeepAliveNotifications().

void cern::cmw::mom::pubsub::impl::JMSConnection::setExceptionListener

(

ExceptionListener

listener

)

throws ConnectionException

Set the listener for JMSException.

Parameters:

listener

the ExceptionListener instance implementing the onException() method

Exceptions:

ConnectionException

JMS was unable to set the ExceptionListener for the connection.

Implemented in cern::cmw::mom::pubsub::impl::ACSJMSTopicConnectionImpl, and cern::cmw::mom::pubsub::impl::DefaultJMSTopicConnectionImpl.

Referenced by cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::initialize(), and cern::cmw::mom::pubsub::impl::DefaultPublisherImpl::initialize().

void cern::cmw::mom::pubsub::impl::JMSConnection::start

(

)

throws ConnectionException

Start the connection.

Exceptions:

ConnectionException

Implemented in cern::cmw::mom::pubsub::impl::ACSJMSTopicConnectionImpl, and cern::cmw::mom::pubsub::impl::DefaultJMSTopicConnectionImpl.

Referenced by cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::initialize(), and cern::cmw::mom::pubsub::impl::DefaultPublisherImpl::initialize().

void cern::cmw::mom::pubsub::impl::JMSConnection::stop

(

)

throws ConnectionException

Stop the connection.

Exceptions:

ConnectionException

Implemented in cern::cmw::mom::pubsub::impl::ACSJMSTopicConnectionImpl, and cern::cmw::mom::pubsub::impl::DefaultJMSTopicConnectionImpl.

Referenced by cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::close(), and cern::cmw::mom::pubsub::impl::DefaultPublisherImpl::close().

---

The documentation for this interface was generated from the following file:

• JMSConnection.java