001: /*
002: * JBoss, Home of Professional Open Source.
003: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
004: * as indicated by the @author tags. See the copyright.txt file in the
005: * distribution for a full listing of individual contributors.
006: *
007: * This is free software; you can redistribute it and/or modify it
008: * under the terms of the GNU Lesser General Public License as
009: * published by the Free Software Foundation; either version 2.1 of
010: * the License, or (at your option) any later version.
011: *
012: * This software is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this software; if not, write to the Free
019: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021: */
022: package javax.jms;
023:
024: /** A <CODE>ConnectionFactory</CODE> object encapsulates a set of connection
025: * configuration
026: * parameters that has been defined by an administrator. A client uses
027: * it to create a connection with a JMS provider.
028: *
029: * <P>A <CODE>ConnectionFactory</CODE> object is a JMS administered object and
030: * supports concurrent use.
031: *
032: * <P>JMS administered objects are objects containing configuration
033: * information that are created by an administrator and later used by
034: * JMS clients. They make it practical to administer the JMS API in the
035: * enterprise.
036: *
037: * <P>Although the interfaces for administered objects do not explicitly
038: * depend on the Java Naming and Directory Interface (JNDI) API, the JMS API
039: * establishes the convention that JMS clients find administered objects by
040: * looking them up in a JNDI namespace.
041: *
042: * <P>An administrator can place an administered object anywhere in a
043: * namespace. The JMS API does not define a naming policy.
044: *
045: * <P>It is expected that JMS providers will provide the tools an
046: * administrator needs to create and configure administered objects in a
047: * JNDI namespace. JMS provider implementations of administered objects
048: * should be both <CODE>javax.jndi.Referenceable</CODE> and
049: * <CODE>java.io.Serializable</CODE> so that they can be stored in all
050: * JNDI naming contexts. In addition, it is recommended that these
051: * implementations follow the JavaBeans<SUP><FONT SIZE="-2">TM</FONT></SUP>
052: * design patterns.
053: *
054: * <P>This strategy provides several benefits:
055: *
056: * <UL>
057: * <LI>It hides provider-specific details from JMS clients.
058: * <LI>It abstracts administrative information into objects in the Java
059: * programming language ("Java objects")
060: * that are easily organized and administered from a common
061: * management console.
062: * <LI>Since there will be JNDI providers for all popular naming
063: * services, this means that JMS providers can deliver one implementation
064: * of administered objects that will run everywhere.
065: * </UL>
066: *
067: * <P>An administered object should not hold on to any remote resources.
068: * Its lookup should not use remote resources other than those used by the
069: * JNDI API itself.
070: *
071: * <P>Clients should think of administered objects as local Java objects.
072: * Looking them up should not have any hidden side effects or use surprising
073: * amounts of local resources.
074: *
075: * @see javax.jms.Connection
076: * @see javax.jms.QueueConnectionFactory
077: * @see javax.jms.TopicConnectionFactory
078: */
079:
080: public interface ConnectionFactory {
081: /** Creates a connection with the default user identity.
082: * The connection is created in stopped mode. No messages
083: * will be delivered until the <code>Connection.start</code> method
084: * is explicitly called.
085: *
086: * @return a newly created connection
087: *
088: * @exception JMSException if the JMS provider fails to create the
089: * connection due to some internal error.
090: * @exception JMSSecurityException if client authentication fails due to
091: * an invalid user name or password.
092: * @since 1.1
093: */
094: public Connection createConnection() throws JMSException;
095:
096: /** Creates a connection with the specified user identity.
097: * The connection is created in stopped mode. No messages
098: * will be delivered until the <code>Connection.start</code> method
099: * is explicitly called.
100: *
101: * @param userName the caller's user name
102: * @param password the caller's password
103: *
104: * @return a newly created connection
105: *
106: * @exception JMSException if the JMS provider fails to create the
107: * connection due to some internal error.
108: * @exception JMSSecurityException if client authentication fails due to
109: * an invalid user name or password.
110: * @since 1.1
111: */
112: public Connection createConnection(String userName, String password)
113: throws JMSException;
114: }
|