cern.cmw.mom.pubsub.impl

Interface JMSConnection

All Known Subinterfaces:

JMSTopicConnection

All Known Implementing Classes:

ACSJMSTopicConnectionImpl, DefaultJMSTopicConnectionImpl

public interface JMSConnection

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

Author:

Controls Middleware Project

Method Summary

Modifier and Type	Method and Description
void	close() Close the connection.
void	connect(boolean retry) Estabilish a connection to a JMS broker.
void	disconnect() Disconnect from the JMS broker.
java.lang.String	getConnectId() Get the unique connection identifier associated with the connection.
java.lang.String	getUsername() Get the username, if any, associated with the connection.
boolean	isConnected() Check if the connection is estabilished.
void	setExceptionListener(ExceptionListener listener) Set the listener for JMSException.
void	start() Start the connection.
void	stop() Stop the connection.

Method Detail

getConnectId

java.lang.String getConnectId()

Get the unique connection identifier associated with the connection.

Returns:

String The connection identifier.

isConnected

boolean isConnected()

Check if the connection is estabilished.

Returns:

boolean true if the connection is active.

setExceptionListener

void setExceptionListener(ExceptionListener listener)
                   throws ConnectionException

Set the listener for JMSException.

Parameters:

listener - the ExceptionListener instance implementing the onException() method

Throws:

ConnectionException - JMS was unable to set the ExceptionListener for the connection.

getUsername

java.lang.String getUsername()

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

Returns:

String The username.

close

void close()

Close the connection.

connect

void connect(boolean retry)
      throws ConnectionException

Estabilish a connection to a JMS broker.

Parameters:

retry - true if connection retry mechanism is requested.

Throws:

ConnectionException

disconnect

void disconnect()

Disconnect from the JMS broker.

start

void start()
    throws ConnectionException

Start the connection.

Throws:

ConnectionException

stop

void stop()
   throws ConnectionException

Stop the connection.

Throws:

ConnectionException