javax::jms::ConnectionFactory Class Reference

A ConnectionFactory object encapsulates a set of connection configuration parameters that has been defined by an administrator. More...

#include <javax_jms_ConnectionFactory.h>

Inheritance diagram for javax::jms::ConnectionFactory:

[legend]Collaboration diagram for javax::jms::ConnectionFactory:

[legend]List of all members.

Public Types
enum	{   xmogDefaultFlags = xmog_base::GLOBAL, xmogMajorVersion = 3, xmogMinorVersion = 2, xmogPatchVersion = 9,   xmogBuildNumber = 2047 }
typedef ::xmog_java_array_template< ::javax::jms::ConnectionFactory >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::javax::jms::ConnectionFactory > >	array2D
Public Member Functions
virtual ::javax::jms::Connection	createConnection (const ::java::lang::String &userName, const ::java::lang::String &password,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Creates a connection with the specified user identity.
virtual ::javax::jms::Connection	createConnection (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Creates a connection with the default user identity.

---

Detailed Description

A ConnectionFactory object encapsulates a set of connection configuration parameters that has been defined by an administrator.

A client uses it to create a connection with a JMS provider.

A ConnectionFactory object is a JMS administered object and supports concurrent use.

JMS administered objects are objects containing configuration information that are created by an administrator and later used by JMS clients. They make it practical to administer the JMS API in the enterprise.

Although the interfaces for administered objects do not explicitly depend on the Java Naming and Directory Interface (JNDI) API, the JMS API establishes the convention that JMS clients find administered objects by looking them up in a JNDI namespace.

An administrator can place an administered object anywhere in a namespace. The JMS API does not define a naming policy.

It is expected that JMS providers will provide the tools an administrator needs to create and configure administered objects in a JNDI namespace. JMS provider implementations of administered objects should be both javax.jndi.Referenceable and java.io.Serializable so that they can be stored in all JNDI naming contexts. In addition, it is recommended that these implementations follow the JavaBeans^{<font size="-2">TM</font>} design patterns.

This strategy provides several benefits:

• It hides provider-specific details from JMS clients.
• It abstracts administrative information into objects in the Java programming language ("Java objects") that are easily organized and administered from a common management console.
• Since there will be JNDI providers for all popular naming services, this means that JMS providers can deliver one implementation of administered objects that will run everywhere.

An administered object should not hold on to any remote resources. Its lookup should not use remote resources other than those used by the JNDI API itself.

Clients should think of administered objects as local Java objects. Looking them up should not have any hidden side effects or use surprising amounts of local resources.

Author:

Mark Hapner

Rich Burridge

Kate Stout

---

Member Function Documentation

virtual ::javax::jms::Connection javax::jms::ConnectionFactory::createConnection (  const ::java::lang::String &  userName, const ::java::lang::String &  password, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Creates a connection with the specified user identity. The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called. Parameters: userName  the caller's user name password  the caller's password p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: a newly created connection

virtual ::javax::jms::Connection javax::jms::ConnectionFactory::createConnection (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Creates a connection with the default user identity. The connection is created in stopped mode. No messages will be delivered until the Connection.start method is explicitly called. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: a newly created connection

---

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

• javax_jms_ConnectionFactory.h

---