javax.jms.ConnectionFactory Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source
* Copyright 2005, JBoss Inc., and individual contributors as indicated
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package javax.jms;
/** 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 JavaBeansTM
* 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.
*
* @see javax.jms.Connection
* @see javax.jms.QueueConnectionFactory
* @see javax.jms.TopicConnectionFactory
*/
public interface ConnectionFactory
{
/** 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.
*
* @return a newly created connection
*
* @exception JMSException if the JMS provider fails to create the
* connection due to some internal error.
* @exception JMSSecurityException if client authentication fails due to
* an invalid user name or password.
* @since 1.1
*/
public Connection createConnection() throws JMSException;
/** 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.
*
* @param userName the caller's user name
* @param password the caller's password
*
* @return a newly created connection
*
* @exception JMSException if the JMS provider fails to create the
* connection due to some internal error.
* @exception JMSSecurityException if client authentication fails due to
* an invalid user name or password.
* @since 1.1
*/
public Connection createConnection(String userName, String password) throws JMSException;
}