Package org.objectweb.joram.client.jms.admin

Class AbstractConnectionFactory

java.lang.Object

org.objectweb.joram.client.jms.admin.AdministeredObject

org.objectweb.joram.client.jms.admin.AbstractConnectionFactory

All Implemented Interfaces:

Serializable, Referenceable

Direct Known Subclasses:

ConnectionFactory, QueueConnectionFactory, TopicConnectionFactory, XAConnectionFactory, XAQueueConnectionFactory, XATopicConnectionFactory

public abstract class AbstractConnectionFactory
extends AdministeredObject

Implements the javax.jms.ConnectionFactory interface.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private String	cnxJMXBeanBaseName
(package private) static String	dfltLogin	Default login name for connection, default value is "anonymous".
(package private) static String	dfltPassword	Default login password for connection, default value is "anonymous".
(package private) static String	dfltRootLogin	Default administrator login name for connection, default value is "root".
(package private) static String	dfltRootPassword	Default administrator login password for connection, default value is "root".
(package private) static String	dfltServerHost	Default server's hostname for connection, default value is "localhost".
(package private) static int	dfltServerPort	Default server's port for connection, default value is 16010.
protected org.objectweb.joram.shared.security.Identity	identity	Authentication identity.
protected String	identityClassName
private boolean	isSetIdentityClassName
private static org.objectweb.util.monolog.api.Logger	logger
protected FactoryParameters	params	Object containing the factory's parameters.
protected String	reliableClass	Reliable class name, for example use by ssl.
private static long	serialVersionUID	define serialVersionUID for interoperability, fix with 5.15.0 value

Fields inherited from class org.objectweb.joram.client.jms.admin.AdministeredObject

rand

Constructor Summary

Constructors

Constructor	Description
AbstractConnectionFactory()	Constructs an empty ConnectionFactory.
AbstractConnectionFactory(String url)	Constructs a ConnectionFactory dedicated to a given server.
AbstractConnectionFactory(String host, int port)	Constructs a ConnectionFactory dedicated to a given server.

Method Summary

Modifier and Type	Method	Description
Connection	createConnection()	API method, creates a connection with the default user identity.
Connection	createConnection(String name, String password)	API method, creates a connection with the specified user identity.
JMSContext	createContext()	JMS2.0 API method.
JMSContext	createContext(int mode)	JMS2.0 API method.
JMSContext	createContext(String userName, String password)	JMS2.0 API method.
JMSContext	createContext(String userName, String password, int mode)	JMS2.0 API method.
QueueConnection	createQueueConnection()	API method, creates a queue connection with the default user identity.
QueueConnection	createQueueConnection(String name, String password)	API method, creates a queue connection with the specified user identity.
protected abstract RequestChannel	createRequestChannel(FactoryParameters params, org.objectweb.joram.shared.security.Identity identity, String reliableClass)	Creates the RequestChannel object specific to the protocol used.
TopicConnection	createTopicConnection()	API method, creates a topic connection with the default user identity.
TopicConnection	createTopicConnection(String name, String password)	API method, creates a topic connection with the specified user identity.
XAConnection	createXAConnection()	API method, creates an XA connection with the default user identity.
XAConnection	createXAConnection(String name, String password)	API method, creates an XA connection with the specified user identity.
XAJMSContext	createXAContext()	JMS2.0 API method.
XAJMSContext	createXAContext(String userName, String password)	JMS2.0 API method.
XAQueueConnection	createXAQueueConnection()	API method, creates an XA queue connection with the default user identity.
XAQueueConnection	createXAQueueConnection(String name, String password)	API method, creates an XA queue connection with the specified user identity.
XATopicConnection	createXATopicConnection()	API method, creates an XA topic connection with the default user identity.
XATopicConnection	createXATopicConnection(String name, String password)	API method, creates an XA topic connection with the specified user identity.
void	fromReference(Reference ref)	Restores the administered object from a naming reference.
void	fromReference(Reference ref, String prefix)	Restores the administered object from a clustered naming reference.
static String	getDefaultLogin()	Returns default login name for connection.
static String	getDefaultPassword()	Returns the default login password for connection.
static String	getDefaultRootLogin()	Returns default administrator login name for connection.
static String	getDefaultRootPassword()	Returns the default administrator login password for connection.
static String	getDefaultServerHost()	Returns default server's hostname for connection.
static int	getDefaultServerPort()	Returns default server's port for connection.
FactoryParameters	getParameters()	Returns the factory's configuration parameters.
protected void	initIdentity(String user, String passwd)	initialize the user identity.
void	setCnxJMXBeanBaseName(String base)
void	setIdentityClassName(String identityClassName)	set indentity class name
void	setReliableClass(String reliableClass)
void	toReference(Reference ref)	Sets the naming reference of an administered object.
void	toReference(Reference ref, String prefix)	Sets the clustered naming reference of a connection factory.

Methods inherited from class org.objectweb.joram.client.jms.admin.AdministeredObject

getReference

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

define serialVersionUID for interoperability, fix with 5.15.0 value

See Also:

Constant Field Values

logger

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

params

protected FactoryParameters params

Object containing the factory's parameters.

reliableClass

protected String reliableClass

Reliable class name, for example use by ssl.

identity

protected org.objectweb.joram.shared.security.Identity identity

Authentication identity.

identityClassName

protected String identityClassName

isSetIdentityClassName

private boolean isSetIdentityClassName

dfltServerHost

static final String dfltServerHost

Default server's hostname for connection, default value is "localhost". This value can be adjusted through the JoramDfltServerHost property.

See Also:

Constant Field Values

dfltServerPort

static final int dfltServerPort

Default server's port for connection, default value is 16010. This value can be adjusted through the JoramDfltServerPort property.

See Also:

Constant Field Values

dfltRootLogin

static final String dfltRootLogin

Default administrator login name for connection, default value is "root". This value can be adjusted through the JoramDfltRootLogin property.

See Also:

Constant Field Values

dfltRootPassword

static final String dfltRootPassword

Default administrator login password for connection, default value is "root". This value can be adjusted through the JoramDfltRootPassword property.

See Also:

Constant Field Values

dfltLogin

static final String dfltLogin

Default login name for connection, default value is "anonymous". This value can be adjusted through the JoramDfltLogin property.

See Also:

Constant Field Values

dfltPassword

static final String dfltPassword

Default login password for connection, default value is "anonymous". This value can be adjusted through the JoramDfltPassword property.

See Also:

Constant Field Values

cnxJMXBeanBaseName

private String cnxJMXBeanBaseName

Constructor Detail

AbstractConnectionFactory

public AbstractConnectionFactory(String host,
                                 int port)

Constructs a ConnectionFactory dedicated to a given server.

Parameters:

host - Name or IP address of the server's host.

port - Server's listening port.

AbstractConnectionFactory

public AbstractConnectionFactory(String url)

Constructs a ConnectionFactory dedicated to a given server.

Parameters:

url - joram ha url.

AbstractConnectionFactory

public AbstractConnectionFactory()

Constructs an empty ConnectionFactory. Needed by ObjectFactory.

Method Detail

setIdentityClassName

public void setIdentityClassName(String identityClassName)

set indentity class name

Parameters:

identityClassName - default Identity.SIMPLE_IDENTITY_CLASS (user/passwd).

initIdentity

protected void initIdentity(String user,
                            String passwd)
                     throws JMSException

initialize the user identity.

Parameters:

user - user name

passwd - user password

Throws:

JMSException

setReliableClass

public void setReliableClass(String reliableClass)

getDefaultServerHost

public static String getDefaultServerHost()

Returns default server's hostname for connection. Default value "localhost" can be adjusted by setting the JoramDfltServerHost property.

getDefaultServerPort

public static int getDefaultServerPort()

Returns default server's port for connection. Default value 16010 can be adjusted by setting the JoramDfltServerPort property.

getDefaultRootLogin

public static String getDefaultRootLogin()

Returns default administrator login name for connection. Default value "root" can be adjusted by setting the JoramDfltRootLogin property.

getDefaultRootPassword

public static String getDefaultRootPassword()

Returns the default administrator login password for connection. Default value "root" can be adjusted by setting the JoramDfltRootPassword property.

getDefaultLogin

public static String getDefaultLogin()

Returns default login name for connection. Default value "anonymous" can be adjusted by setting the JoramDfltLogin property.

getDefaultPassword

public static String getDefaultPassword()

Returns the default login password for connection. Default value "anonymous" can be adjusted by setting the JoramDfltPassword property.

getParameters

public FactoryParameters getParameters()

Returns the factory's configuration parameters.

setCnxJMXBeanBaseName

public void setCnxJMXBeanBaseName(String base)

createRequestChannel

protected abstract RequestChannel createRequestChannel(FactoryParameters params,
                                                       org.objectweb.joram.shared.security.Identity identity,
                                                       String reliableClass)
                                                throws JMSException

Creates the RequestChannel object specific to the protocol used.

Parameters:

params - Connection configuration parameters.

identity - Client's identity.

reliableClass - The protocol specific class.

Returns:

The RequestChannel object specific to the protocol used.

Throws:

JMSException - A problem occurs during the connection.

createConnection

public Connection createConnection()
                            throws JMSException

API method, creates a connection with the default user identity. The connection is created in stopped mode.

Returns:

a newly created connection.

Throws:

JMSSecurityException - If the default identification is incorrect.

IllegalStateException - If the server is not listening.

JMSException

See Also:

ConnectionFactory.createConnection()

createConnection

public Connection createConnection(String name,
                                   String password)
                            throws JMSException

API method, creates a connection with the specified user identity. The connection is created in stopped mode.

Parameters:

name - the caller's user name.

password - the caller's password.

Returns:

a newly created connection.

Throws:

JMSSecurityException - If the user identification is incorrect.

IllegalStateException - If the server is not listening.

JMSException

See Also:

ConnectionFactory.createConnection(String, String)

createQueueConnection

public QueueConnection createQueueConnection()
                                      throws JMSException

API method, creates a queue connection with the default user identity. The connection is created in stopped mode.

Returns:

a newly created queue connection.

Throws:

JMSSecurityException - If the default identification is incorrect.

IllegalStateException - If the server is not listening.

JMSException

See Also:

QueueConnectionFactory.createQueueConnection()

createQueueConnection

public QueueConnection createQueueConnection(String name,
                                             String password)
                                      throws JMSException

API method, creates a queue connection with the specified user identity. The connection is created in stopped mode.

Parameters:

name - the caller's user name.

password - the caller's password.

Returns:

a newly created queue connection.

Throws:

JMSSecurityException - If the user identification is incorrect.

IllegalStateException - If the server is not listening.

JMSException

See Also:

QueueConnectionFactory.createQueueConnection(String, String)

createTopicConnection

public TopicConnection createTopicConnection()
                                      throws JMSException

API method, creates a topic connection with the default user identity. The connection is created in stopped mode.

Returns:

a newly created topic connection.

Throws:

JMSSecurityException - If the default identification is incorrect.

IllegalStateException - If the server is not listening.

JMSException

See Also:

TopicConnectionFactory.createTopicConnection()

createTopicConnection

public TopicConnection createTopicConnection(String name,
                                             String password)
                                      throws JMSException

API method, creates a topic connection with the specified user identity. The connection is created in stopped mode.

Parameters:

name - the caller's user name.

password - the caller's password.

Returns:

a newly created topic connection.

Throws:

JMSSecurityException - If the user identification is incorrect.

IllegalStateException - If the server is not listening.

JMSException

See Also:

TopicConnectionFactory.createTopicConnection(String, String)

createXAConnection

public XAConnection createXAConnection()
                                throws JMSException

API method, creates an XA connection with the default user identity. The connection is created in stopped mode.

Returns:

a newly created XA connection..

Throws:

JMSSecurityException - If the default identification is incorrect.

IllegalStateException - If the server is not listening.

JMSException

See Also:

XAConnectionFactory.createXAConnection()

createXAConnection

public XAConnection createXAConnection(String name,
                                       String password)
                                throws JMSException

API method, creates an XA connection with the specified user identity. The connection is created in stopped mode.

Parameters:

name - the caller's user name.

password - the caller's password.

Returns:

a newly created XA connection.

Throws:

JMSSecurityException - If the user identification is incorrect.

IllegalStateException - If the server is not listening.

JMSException

See Also:

XAConnectionFactory.createXAConnection(String, String)

createXAQueueConnection

public XAQueueConnection createXAQueueConnection()
                                          throws JMSException

API method, creates an XA queue connection with the default user identity. The connection is created in stopped mode.

Returns:

a newly created XA queue connection..

Throws:

JMSSecurityException - If the default identification is incorrect.

IllegalStateException - If the server is not listening.

JMSException

See Also:

XAQueueConnectionFactory.createXAQueueConnection()

createXAQueueConnection

public XAQueueConnection createXAQueueConnection(String name,
                                                 String password)
                                          throws JMSException

API method, creates an XA queue connection with the specified user identity. The connection is created in stopped mode.

Parameters:

name - the caller's user name.

password - the caller's password.

Returns:

a newly created XA queue connection.

Throws:

JMSSecurityException - If the user identification is incorrect.

IllegalStateException - If the server is not listening.

JMSException

See Also:

XAQueueConnectionFactory.createXAQueueConnection(String, String)

createXATopicConnection

public XATopicConnection createXATopicConnection()
                                          throws JMSException

API method, creates an XA topic connection with the default user identity. The connection is created in stopped mode.

Returns:

a newly created XA topic connection..

Throws:

JMSSecurityException - If the default identification is incorrect.

IllegalStateException - If the server is not listening.

JMSException

See Also:

XATopicConnectionFactory.createXATopicConnection()

createXATopicConnection

public XATopicConnection createXATopicConnection(String name,
                                                 String password)
                                          throws JMSException

API method, creates an XA topic connection with the specified user identity. The connection is created in stopped mode.

Parameters:

name - the caller's user name.

password - the caller's password.

Returns:

a newly created XA topic connection.

Throws:

JMSSecurityException - If the user identification is incorrect.

IllegalStateException - If the server is not listening.

JMSException

See Also:

XATopicConnectionFactory.createXATopicConnection(String, String)

toReference

public final void toReference(Reference ref)
                       throws NamingException

Sets the naming reference of an administered object.

Specified by:

toReference in class AdministeredObject

Throws:

NamingException

toReference

public void toReference(Reference ref,
                        String prefix)

Sets the clustered naming reference of a connection factory.

fromReference

public final void fromReference(Reference ref)
                         throws NamingException

Restores the administered object from a naming reference.

Specified by:

fromReference in class AdministeredObject

Throws:

NamingException

fromReference

public void fromReference(Reference ref,
                          String prefix)

Restores the administered object from a clustered naming reference.

createContext

public JMSContext createContext()

JMS2.0 API method.

createContext

public JMSContext createContext(int mode)

JMS2.0 API method.

createContext

public JMSContext createContext(String userName,
                                String password)

JMS2.0 API method.

createContext

public JMSContext createContext(String userName,
                                String password,
                                int mode)

JMS2.0 API method.

createXAContext

public XAJMSContext createXAContext()

JMS2.0 API method.

createXAContext

public XAJMSContext createXAContext(String userName,
                                    String password)

JMS2.0 API method.