com.lightstreamer.jms

Class LSConnectionFactory

java.lang.Object

com.lightstreamer.jms.LSConnectionFactory

All Implemented Interfaces:

ConnectionFactory

Direct Known Subclasses:

LSQueueConnectionFactory, LSTopicConnectionFactory

public class LSConnectionFactory
extends java.lang.Object
implements ConnectionFactory

A ConnectionFactory interface implementation that can be used used to create a connection with a JMS broker through an embedded JMS Extender client connection.

Constructor Summary

Constructors

Constructor and Description
LSConnectionFactory() Creates an LSConnectionFactory object that can create new Connection objects.
LSConnectionFactory(java.lang.String serverAddress, java.lang.String jmsConnector) Creates an LSConnectionFactory object that can create new Connection objects.
LSConnectionFactory(java.lang.String serverAddress, java.lang.String adapterSet, java.lang.String jmsConnector) Creates an LSConnectionFactory object that can create new Connection objects.

Method Summary

Modifier and Type	Method and Description
Connection	createConnection() Creates a new Connection with an unspecified user identity.
Connection	createConnection(java.lang.String userName, java.lang.String password) Creates a new Connection using the specified user name and password.
JMSContext	createContext() Creates a new JMSContext with an unspecified user identity and Session.AUTO_ACKNOWLEDGE session mode.
JMSContext	createContext(int sessionMode) Creates a new JMSContext with an unspecified user identity and the specified session mode.
JMSContext	createContext(java.lang.String userName, java.lang.String password) Creates a new JMSContext with the specified user identity, and Session.AUTO_ACKNOWLEDGE session mode.
JMSContext	createContext(java.lang.String userName, java.lang.String password, int sessionMode) Creates a new JMSContext with the specified user identity and session mode.
java.lang.String	getAdapterSet() Returns the name of the adapter set to use when connecting to the JMS Extender.
LSConnectionListener	getConnectionListener() Returns the LSConnectionListener implementation to be called during connection setup, or null if it has not been set.
java.lang.String	getJmsConnector() Returns the name of the JMS connector to use.
java.lang.String	getServerAddress() Returns the URL of the JMS Extender to connect to.
void	setAdapterSet(java.lang.String adapterSet) Sets the name of the adapter set to use when connecting to the JMS Extender.
void	setConnectionListener(LSConnectionListener listener) Sets an LSConnectionListener implementation to be called during connection creation.
void	setJmsConnector(java.lang.String jmsConnector) Sets the name of the JMS connector to use.
void	setServerAddress(java.lang.String serverAddress) Sets the URL of the JMS Extender to connect to.

Methods inherited from class java.lang.Object

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

Constructor Detail

LSConnectionFactory

public LSConnectionFactory()

Creates an LSConnectionFactory object that can create new Connection objects.

Uses the default adapter set name JMS, but leaves empty both the JMS connector name and the server address (to be specified later).

LSConnectionFactory

public LSConnectionFactory(java.lang.String serverAddress,
                           java.lang.String jmsConnector)

Creates an LSConnectionFactory object that can create new Connection objects.

Uses the default adapter set name JMS and the specified JMS connector name and server address.

Parameters:

serverAddress - the URL of the JMS Extender to connect to

jmsConnector - the name of the JMS connector to use

LSConnectionFactory

public LSConnectionFactory(java.lang.String serverAddress,
                           java.lang.String adapterSet,
                           java.lang.String jmsConnector)

Creates an LSConnectionFactory object that can create new Connection objects.

Uses the specified adapter set name, JMS connector name and server address.

Parameters:

serverAddress - the URL of the JMS Extender to connect to

adapterSet - the name of the adapter set to use

jmsConnector - the name of the JMS connector to use

Method Detail

getServerAddress

public java.lang.String getServerAddress()

Returns the URL of the JMS Extender to connect to.

Returns:

the URL of JMS Extender

setServerAddress

public void setServerAddress(java.lang.String serverAddress)

Sets the URL of the JMS Extender to connect to.

Parameters:

serverAddress - the URL of the JMS Extender

getAdapterSet

public java.lang.String getAdapterSet()

Returns the name of the adapter set to use when connecting to the JMS Extender.

Returns:

the name of the adapter set

setAdapterSet

public void setAdapterSet(java.lang.String adapterSet)

Sets the name of the adapter set to use when connecting to the JMS Extender.

Parameters:

adapterSet - the name of the adapter set

getJmsConnector

public java.lang.String getJmsConnector()

Returns the name of the JMS connector to use.

Returns:

the name of the JMS connector

setJmsConnector

public void setJmsConnector(java.lang.String jmsConnector)

Sets the name of the JMS connector to use.

Parameters:

jmsConnector - the name of the JMS connector

setConnectionListener

public void setConnectionListener(LSConnectionListener listener)

Sets an LSConnectionListener implementation to be called during connection creation.

Parameters:

listener - the LSConnectionListener implementation

getConnectionListener

public LSConnectionListener getConnectionListener()

Returns the LSConnectionListener implementation to be called during connection setup, or null if it has not been set.

Returns:

the LSConnectionListener implementation or null

createConnection

public Connection createConnection()
                            throws JMSException

Creates a new Connection with an unspecified user identity.

The connection is created in stopped mode. No messages will be delivered until the Connection.start() method is explicitly called on the Connection object.

If a LSConnectionListener implementation has been set, its events will be called during connection creation.

Specified by:

createConnection in interface ConnectionFactory

Returns:

the created Connection

Throws:

JMSException - if the connection creation fails for some reason

createConnection

public Connection createConnection(java.lang.String userName,
                                   java.lang.String password)
                            throws JMSException

Creates a new Connection using the specified user name and password.

The connection is created in stopped mode. No messages will be delivered until the Connection.start() method is explicitly called on the Connection object.

If a LSConnectionListener implementation has been set, its events will be called during connection creation.

Specified by:

createConnection in interface ConnectionFactory

Parameters:

userName - the user's name

password - the user's password

Returns:

the created Connection

Throws:

JMSException - if the connection creation fails for some reason

createContext

public JMSContext createContext()

Creates a new JMSContext with an unspecified user identity and Session.AUTO_ACKNOWLEDGE session mode.

The context is created in stopped mode, but will start automatically as soon as the first consumer is created. If a LSConnectionListener implementation has been set, its events will be called during connection creation.

Specified by:

createContext in interface ConnectionFactory

Returns:

the created JMSContext

Throws:

JMSRuntimeException - if the context creation fails for some reason

createContext

public JMSContext createContext(int sessionMode)

Creates a new JMSContext with an unspecified user identity and the specified session mode.

The context is created in stopped mode, but will start automatically as soon as the first consumer is created. If a LSConnectionListener implementation has been set, its events will be called during connection creation.

Specified by:

createContext in interface ConnectionFactory

Parameters:

sessionMode - the session mode, one of:

• Session.AUTO_ACKNOWLEDGE
• Session.CLIENT_ACKNOWLEDGE
• Session.SESSION_TRANSACTED
• Session.DUPS_OK_ACKNOWLEDGE
• LSSession.PRE_ACKNOWLEDGE
• LSSession.INDIVIDUAL_ACKNOWLEDGE

Returns:

the created JMSContext

Throws:

JMSRuntimeException - if the context creation fails for some reason

createContext

public JMSContext createContext(java.lang.String userName,
                                java.lang.String password)

Creates a new JMSContext with the specified user identity, and Session.AUTO_ACKNOWLEDGE session mode.

The context is created in stopped mode, but will start automatically as soon as the first consumer is created. If a LSConnectionListener implementation has been set, its events will be called during connection creation.

Specified by:

createContext in interface ConnectionFactory

Parameters:

userName - the user's name

password - the user's password

Returns:

the created JMSContext

Throws:

JMSRuntimeException - if the context creation fails for some reason

createContext

public JMSContext createContext(java.lang.String userName,
                                java.lang.String password,
                                int sessionMode)

Creates a new JMSContext with the specified user identity and session mode.

The context is created in stopped mode, but will start automatically as soon as the first consumer is created. If a LSConnectionListener implementation has been set, its events will be called during connection creation.

Specified by:

createContext in interface ConnectionFactory

Parameters:

userName - the user's name

password - the user's password

sessionMode - the session mode, one of:

• Session.AUTO_ACKNOWLEDGE
• Session.CLIENT_ACKNOWLEDGE
• Session.SESSION_TRANSACTED
• Session.DUPS_OK_ACKNOWLEDGE
• LSSession.PRE_ACKNOWLEDGE
• LSSession.INDIVIDUAL_ACKNOWLEDGE

Returns:

the created JMSContext

Throws:

JMSRuntimeException - if the context creation fails for some reason