org.ow2.joram.jakarta.jms.admin

Class ClusterConnectionFactory

java.lang.Object

org.ow2.joram.jakarta.jms.admin.AdministeredObject

org.ow2.joram.jakarta.jms.admin.ClusterConnectionFactory

All Implemented Interfaces:

jakarta.jms.ConnectionFactory, Serializable, Referenceable

public class ClusterConnectionFactory
extends AdministeredObject
implements jakarta.jms.ConnectionFactory

A base class for clustered connection factories.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Hashtable<String,ConnectionFactory>	cluster
private static org.objectweb.util.monolog.api.Logger	logger
private static long	serialVersionUID define serialVersionUID for interoperability

Fields inherited from class org.ow2.joram.jakarta.jms.admin.AdministeredObject

rand

Constructor Summary

Constructors

Constructor and Description
ClusterConnectionFactory() Constructs an empty clustered connection factory.

Method Summary

Modifier and Type	Method and Description
void	addConnectionFactory(ConnectionFactory cf) Adds a connection factory to the cluster.
void	addConnectionFactory(String location, ConnectionFactory cf) Adds a connection factory to the cluster with the specified location key.
jakarta.jms.Connection	createConnection() Creates a connection with the default user identity.
jakarta.jms.Connection	createConnection(String name, String password) Creates a connection with the specified user identity.
jakarta.jms.JMSContext	createContext()
jakarta.jms.JMSContext	createContext(int sessionMode)
jakarta.jms.JMSContext	createContext(String userName, String password)
jakarta.jms.JMSContext	createContext(String userName, String password, int sessionMode)
void	fromReference(Reference ref) Restores the administered object from a naming reference.
Hashtable<String,ConnectionFactory>	getCluster()
protected ConnectionFactory	getConnectionFactory() Chooses a connection factory from the cluster definition.
void	toReference(Reference ref) Sets the naming reference of an administered object.
String	toString() Returns a String image of the object.

Methods inherited from class org.ow2.joram.jakarta.jms.admin.AdministeredObject

getReference

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

define serialVersionUID for interoperability

See Also:

Constant Field Values

logger

private static final org.objectweb.util.monolog.api.Logger logger

cluster

protected Hashtable<String,ConnectionFactory> cluster

Constructor Detail

ClusterConnectionFactory

public ClusterConnectionFactory()

Constructs an empty clustered connection factory.

Method Detail

addConnectionFactory

public void addConnectionFactory(ConnectionFactory cf)

Adds a connection factory to the cluster. The object will be added with a key equals to the location property. By default, the location value is set to the hostname of corresponding server. Be careful, the object should be rebind after modification.

Parameters:

cf - the ConnectionFactory

addConnectionFactory

public void addConnectionFactory(String location,
                                 ConnectionFactory cf)

Adds a connection factory to the cluster with the specified location key. Be careful, the object should be rebind after modification.

Parameters:

location - the location key

cf - the ConnectionFactory

getConnectionFactory

protected ConnectionFactory getConnectionFactory()

Chooses a connection factory from the cluster definition.

createConnection

public final jakarta.jms.Connection createConnection()
                                              throws jakarta.jms.JMSException

Creates a connection with the default user identity. It chooses a ConnectionFactory depending of the location property, then creates the related Connection. API method, see jakarta.jms.ConnectionFactory.

Specified by:

createConnection in interface jakarta.jms.ConnectionFactory

Throws:

jakarta.jms.JMSSecurityException - If the default identification is incorrect.

IllegalStateException - If the server is not listening.

jakarta.jms.JMSException

createConnection

public final jakarta.jms.Connection createConnection(String name,
                                                     String password)
                                              throws jakarta.jms.JMSException

Creates a connection with the specified user identity. It chooses a ConnectionFactory depending of the location property, then creates the related Connection. API method, see jakarta.jms.ConnectionFactory.

Specified by:

createConnection in interface jakarta.jms.ConnectionFactory

Parameters:

name - the caller's user name

password - the caller's password

Throws:

jakarta.jms.JMSSecurityException - If the user identification is incorrect.

IllegalStateException - If the server is not listening.

jakarta.jms.JMSException

toString

public String toString()

Returns a String image of the object.

Overrides:

toString in class Object

getCluster

public Hashtable<String,ConnectionFactory> getCluster()

Returns:

the cluster hashtable.

toReference

public void toReference(Reference ref)
                 throws NamingException

Sets the naming reference of an administered object.

Specified by:

toReference in class AdministeredObject

Throws:

NamingException

fromReference

public void fromReference(Reference ref)
                   throws NamingException

Restores the administered object from a naming reference.

Specified by:

fromReference in class AdministeredObject

Throws:

NamingException

createContext

public jakarta.jms.JMSContext createContext()

Specified by:

createContext in interface jakarta.jms.ConnectionFactory

createContext

public jakarta.jms.JMSContext createContext(String userName,
                                            String password)

Specified by:

createContext in interface jakarta.jms.ConnectionFactory

createContext

public jakarta.jms.JMSContext createContext(String userName,
                                            String password,
                                            int sessionMode)

Specified by:

createContext in interface jakarta.jms.ConnectionFactory

createContext

public jakarta.jms.JMSContext createContext(int sessionMode)

Specified by:

createContext in interface jakarta.jms.ConnectionFactory