All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.jms.ConnectionFactory Maven / Gradle / Ivy

There is a newer version: 2.0.1
Show newest version
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package javax.jms;

/** A {@code 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 {@code 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 {@code javax.jndi.Referenceable} and * {@code 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. * * @version 1.1 - February 1, 2002 * @author Mark Hapner * @author Rich Burridge * @author Kate Stout * * @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 {@code 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 */ 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 {@code 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 */ Connection createConnection(String userName, String password) throws JMSException; /** * Creates a JMSContext with the default user identity * and an unspecified sessionMode. *

* A connection and session are created for use by the new JMSContext. * The connection is created in stopped mode but will be automatically started * when a JMSConsumer is created. *

* The behaviour of the session that is created depends on * whether this method is called in a Java SE environment, * in the Java EE application client container, or in the Java EE web or EJB container. * If this method is called in the Java EE web or EJB container then the * behaviour of the session also depends on whether or not * there is an active JTA transaction in progress. *

* In a Java SE environment or in the Java EE application client container: *

    *
  • The session will be non-transacted and received messages will be acknowledged automatically * using an acknowledgement mode of {@code JMSContext.AUTO_ACKNOWLEDGE} * For a definition of the meaning of this acknowledgement mode see the link below. *
*

* In a Java EE web or EJB container, when there is an active JTA transaction in progress: *

    *
  • The session will participate in the JTA transaction and will be committed or rolled back * when that transaction is committed or rolled back, * not by calling the {@code JMSContext}'s {@code commit} or {@code rollback} methods. *
*

* In the Java EE web or EJB container, when there is no active JTA transaction in progress: *

    *
  • The session will be non-transacted and received messages will be acknowledged automatically * using an acknowledgement mode of {@code JMSContext.AUTO_ACKNOWLEDGE} * For a definition of the meaning of this acknowledgement mode see the link below. *
* * @return a newly created JMSContext * * @exception JMSRuntimeException if the JMS provider fails to create the * JMSContext due to some internal error. * @exception JMSSecurityRuntimeException if client authentication fails due to * an invalid user name or password. * @since 2.0 * * @see JMSContext#AUTO_ACKNOWLEDGE * * @see javax.jms.ConnectionFactory#createContext(int) * @see javax.jms.ConnectionFactory#createContext(java.lang.String, java.lang.String) * @see javax.jms.ConnectionFactory#createContext(java.lang.String, java.lang.String, int) * @see javax.jms.JMSContext#createContext(int) */ JMSContext createContext(); /** * Creates a JMSContext with the specified user identity * and an unspecified sessionMode. *

* A connection and session are created for use by the new JMSContext. * The connection is created in stopped mode but will be automatically started * when a JMSConsumer. *

* The behaviour of the session that is created depends on * whether this method is called in a Java SE environment, * in the Java EE application client container, or in the Java EE web or EJB container. * If this method is called in the Java EE web or EJB container then the * behaviour of the session also depends on whether or not * there is an active JTA transaction in progress. *

* In a Java SE environment or in the Java EE application client container: *

    *
  • The session will be non-transacted and received messages will be acknowledged automatically * using an acknowledgement mode of {@code JMSContext.AUTO_ACKNOWLEDGE} * For a definition of the meaning of this acknowledgement mode see the link below. *
*

* In a Java EE web or EJB container, when there is an active JTA transaction in progress: *

    *
  • The session will participate in the JTA transaction and will be committed or rolled back * when that transaction is committed or rolled back, * not by calling the {@code JMSContext}'s {@code commit} or {@code rollback} methods. *
*

* In the Java EE web or EJB container, when there is no active JTA transaction in progress: *

    *
  • The session will be non-transacted and received messages will be acknowledged automatically * using an acknowledgement mode of {@code JMSContext.AUTO_ACKNOWLEDGE} * For a definition of the meaning of this acknowledgement mode see the link below. *
* * @param userName the caller's user name * @param password the caller's password * * @return a newly created JMSContext * * @exception JMSRuntimeException if the JMS provider fails to create the * JMSContext due to some internal error. * @exception JMSSecurityRuntimeException if client authentication fails due to * an invalid user name or password. * @since 2.0 * * @see JMSContext#AUTO_ACKNOWLEDGE * * @see javax.jms.ConnectionFactory#createContext() * @see javax.jms.ConnectionFactory#createContext(int) * @see javax.jms.ConnectionFactory#createContext(java.lang.String, java.lang.String, int) * @see javax.jms.JMSContext#createContext(int) */ JMSContext createContext(String userName, String password); /** Creates a JMSContext with the specified user identity * and the specified session mode. *

* A connection and session are created for use by the new JMSContext. * The JMSContext is created in stopped mode but will be automatically started * when a JMSConsumer is created. *

* The effect of setting the {@code sessionMode} * argument depends on whether this method is called in a Java SE environment, * in the Java EE application client container, or in the Java EE web or EJB container. * If this method is called in the Java EE web or EJB container then the * effect of setting the {@code sessionMode} argument also depends on * whether or not there is an active JTA transaction in progress. *

* In a Java SE environment or in the Java EE application client container: *

    *
  • If {@code sessionMode} is set to {@code JMSContext.SESSION_TRANSACTED} then the session * will use a local transaction which may subsequently be committed or rolled back * by calling the {@code JMSContext}'s {@code commit} or {@code rollback} methods. *
  • If {@code sessionMode} is set to any of * {@code JMSContext.CLIENT_ACKNOWLEDGE}, * {@code JMSContext.AUTO_ACKNOWLEDGE} or * {@code JMSContext.DUPS_OK_ACKNOWLEDGE}. * then the session will be non-transacted and * messages received by this session will be acknowledged * according to the value of {@code sessionMode}. * For a definition of the meaning of these acknowledgement modes see the links below. *
*

* In a Java EE web or EJB container, when there is an active JTA transaction in progress: *

    *
  • The argument {@code sessionMode} is ignored. * The session will participate in the JTA transaction and will be committed or rolled back * when that transaction is committed or rolled back, * not by calling the {@code JMSContext}'s {@code commit} or {@code rollback} methods. * Since the argument is ignored, developers are recommended to use * {@code createSession()}, which has no arguments, instead of this method. *
*

* In the Java EE web or EJB container, when there is no active JTA transaction in progress: *

    *
  • The argument {@code acknowledgeMode} must be set to either of * {@code JMSContext.AUTO_ACKNOWLEDGE} or * {@code JMSContext.DUPS_OK_ACKNOWLEDGE}. * The session will be non-transacted and messages received by this session will be acknowledged * automatically according to the value of {@code acknowledgeMode}. * For a definition of the meaning of these acknowledgement modes see the links below. * The values {@code JMSContext.SESSION_TRANSACTED} and {@code JMSContext.CLIENT_ACKNOWLEDGE} may not be used. *
* @param userName the caller's user name * @param password the caller's password * @param sessionMode indicates which of four possible session modes will be used. *
    *
  • If this method is called in a Java SE environment or in the Java EE application client container, * the permitted values are * {@code JMSContext.SESSION_TRANSACTED}, * {@code JMSContext.CLIENT_ACKNOWLEDGE}, * {@code JMSContext.AUTO_ACKNOWLEDGE} and * {@code JMSContext.DUPS_OK_ACKNOWLEDGE}. *
  • If this method is called in the Java EE web or EJB container when there is an active JTA transaction in progress * then this argument is ignored. *
  • If this method is called in the Java EE web or EJB container when there is no active JTA transaction in progress, the permitted values are * {@code JMSContext.AUTO_ACKNOWLEDGE} and * {@code JMSContext.DUPS_OK_ACKNOWLEDGE}. * In this case the values {@code JMSContext.TRANSACTED} and {@code JMSContext.CLIENT_ACKNOWLEDGE} are not permitted. *
* * @return a newly created JMSContext * * @exception JMSRuntimeException if the JMS provider fails to create the * JMSContext due to some internal error. * @exception JMSSecurityRuntimeException if client authentication fails due to * an invalid user name or password. * @since 2.0 * @see JMSContext#SESSION_TRANSACTED * @see JMSContext#CLIENT_ACKNOWLEDGE * @see JMSContext#AUTO_ACKNOWLEDGE * @see JMSContext#DUPS_OK_ACKNOWLEDGE * * @see javax.jms.ConnectionFactory#createContext() * @see javax.jms.ConnectionFactory#createContext(int) * @see javax.jms.ConnectionFactory#createContext(java.lang.String, java.lang.String) * @see javax.jms.JMSContext#createContext(int) */ JMSContext createContext(String userName, String password, int sessionMode); /** Creates a JMSContext with the default user identity * and the specified session mode. *

* A connection and session are created for use by the new JMSContext. * The JMSContext is created in stopped mode but will be automatically started * when a JMSConsumer is created. *

* The effect of setting the {@code sessionMode} * argument depends on whether this method is called in a Java SE environment, * in the Java EE application client container, or in the Java EE web or EJB container. * If this method is called in the Java EE web or EJB container then the * effect of setting the {@code sessionMode} argument also depends on * whether or not there is an active JTA transaction in progress. *

* In a Java SE environment or in the Java EE application client container: *

    *
  • If {@code sessionMode} is set to {@code JMSContext.SESSION_TRANSACTED} then the session * will use a local transaction which may subsequently be committed or rolled back * by calling the {@code JMSContext}'s {@code commit} or {@code rollback} methods. *
  • If {@code sessionMode} is set to any of * {@code JMSContext.CLIENT_ACKNOWLEDGE}, * {@code JMSContext.AUTO_ACKNOWLEDGE} or * {@code JMSContext.DUPS_OK_ACKNOWLEDGE}. * then the session will be non-transacted and * messages received by this session will be acknowledged * according to the value of {@code sessionMode}. * For a definition of the meaning of these acknowledgement modes see the links below. *
*

* In a Java EE web or EJB container, when there is an active JTA transaction in progress: *

    *
  • The argument {@code sessionMode} is ignored. * The session will participate in the JTA transaction and will be committed or rolled back * when that transaction is committed or rolled back, * not by calling the {@code JMSContext}'s {@code commit} or {@code rollback} methods. * Since the argument is ignored, developers are recommended to use * {@code createSession()}, which has no arguments, instead of this method. *
*

* In the Java EE web or EJB container, when there is no active JTA transaction in progress: *

    *
  • The argument {@code acknowledgeMode} must be set to either of * {@code JMSContext.AUTO_ACKNOWLEDGE} or * {@code JMSContext.DUPS_OK_ACKNOWLEDGE}. * The session will be non-transacted and messages received by this session will be acknowledged * automatically according to the value of {@code acknowledgeMode}. * For a definition of the meaning of these acknowledgement modes see the links below. * The values {@code JMSContext.SESSION_TRANSACTED} and {@code JMSContext.CLIENT_ACKNOWLEDGE} may not be used. *
* * @param sessionMode indicates which of four possible session modes will be used. *
    *
  • If this method is called in a Java SE environment or in the Java EE application client container, * the permitted values are * {@code JMSContext.SESSION_TRANSACTED}, * {@code JMSContext.CLIENT_ACKNOWLEDGE}, * {@code JMSContext.AUTO_ACKNOWLEDGE} and * {@code JMSContext.DUPS_OK_ACKNOWLEDGE}. *
  • If this method is called in the Java EE web or EJB container when there is an active JTA transaction in progress * then this argument is ignored. *
  • If this method is called in the Java EE web or EJB container when there is no active JTA transaction in progress, the permitted values are * {@code JMSContext.AUTO_ACKNOWLEDGE} and * {@code JMSContext.DUPS_OK_ACKNOWLEDGE}. * In this case the values {@code JMSContext.TRANSACTED} and {@code JMSContext.CLIENT_ACKNOWLEDGE} are not permitted. *
* * @return a newly created JMSContext * * @exception JMSRuntimeException if the JMS provider fails to create the * JMSContext due to some internal error. * @exception JMSSecurityRuntimeException if client authentication fails due to * an invalid user name or password. * @since 2.0 * * @see JMSContext#SESSION_TRANSACTED * @see JMSContext#CLIENT_ACKNOWLEDGE * @see JMSContext#AUTO_ACKNOWLEDGE * @see JMSContext#DUPS_OK_ACKNOWLEDGE * * @see javax.jms.ConnectionFactory#createContext() * @see javax.jms.ConnectionFactory#createContext(java.lang.String, java.lang.String) * @see javax.jms.ConnectionFactory#createContext(java.lang.String, java.lang.String, int) * @see javax.jms.JMSContext#createContext(int) */ JMSContext createContext(int sessionMode); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy