public interface ConnectionFactory
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 Jakarta Messaging provider.
A ConnectionFactory
object is a Jakarta Messaging administered object and supports concurrent use.
Jakarta Messaging administered objects are objects containing configuration information that are created by an administrator and later used by Jakarta Messaging clients. They make it practical to administer the Jakarta Messaging API in the enterprise.
Although the interfaces for administered objects do not explicitly depend on the Java Naming and Directory Interface (JNDI) API, the Jakarta Messaging API establishes the convention that Jakarta Messaging clients find administered objects by looking them up in a JNDI namespace.
An administrator can place an administered object anywhere in a namespace. The Jakarta Messaging API does not define a naming policy.
It is expected that Jakarta Messaging providers will provide the tools an administrator needs to create and configure administered
objects in a JNDI namespace. Jakarta Messaging 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:
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.
Connection
,
QueueConnectionFactory
,
TopicConnectionFactory
Modifier and Type | Method and Description |
---|---|
Connection |
createConnection()
Creates a connection with the default user identity.
|
Connection |
createConnection(String userName,
String password)
Creates a connection with the specified user identity.
|
JMSContext |
createContext()
Creates a JMSContext with the default user identity and an unspecified sessionMode.
|
JMSContext |
createContext(int sessionMode)
Creates a JMSContext with the default user identity and the specified session mode.
|
JMSContext |
createContext(String userName,
String password)
Creates a JMSContext with the specified user identity and an unspecified sessionMode.
|
JMSContext |
createContext(String userName,
String password,
int sessionMode)
Creates a JMSContext with the specified user identity and the specified session mode.
|
Connection createConnection() throws JMSException
Connection.start
method is explicitly called.JMSException
- if the Jakarta Messaging provider fails to create the connection due to some internal error.JMSSecurityException
- if client authentication fails due to an invalid user name or password.Connection createConnection(String userName, String password) throws JMSException
Connection.start
method is explicitly called.userName
- the caller's user namepassword
- the caller's passwordJMSException
- if the Jakarta Messaging provider fails to create the connection due to some internal error.JMSSecurityException
- if client authentication fails due to an invalid user name or password.JMSContext createContext()
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 Jakarta EE application client container, or in the Jakarta EE web or EJB container. If this method is called in the Jakarta 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 Jakarta EE application client container:
JMSContext.AUTO_ACKNOWLEDGE
For a definition of the meaning of this acknowledgement
mode see the link below.
In a Jakarta EE web or EJB container, when there is an active JTA transaction in progress:
JMSContext
's commit
or rollback
methods.
In the Jakarta EE web or EJB container, when there is no active JTA transaction in progress:
JMSContext.AUTO_ACKNOWLEDGE
For a definition of the meaning of this acknowledgement
mode see the link below.
JMSRuntimeException
- if the Jakarta Messaging provider fails to create the JMSContext due to some internal error.JMSSecurityRuntimeException
- if client authentication fails due to an invalid user name or password.JMSContext.AUTO_ACKNOWLEDGE
,
createContext(int)
,
createContext(java.lang.String, java.lang.String)
,
createContext(java.lang.String, java.lang.String, int)
,
JMSContext.createContext(int)
JMSContext createContext(String userName, String password)
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 Jakarta EE application client container, or in the Jakarta EE web or EJB container. If this method is called in the Jakarta 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 Jakarta EE application client container:
JMSContext.AUTO_ACKNOWLEDGE
For a definition of the meaning of this acknowledgement
mode see the link below.
In a Jakarta EE web or EJB container, when there is an active JTA transaction in progress:
JMSContext
's commit
or rollback
methods.
In the Jakarta EE web or EJB container, when there is no active JTA transaction in progress:
JMSContext.AUTO_ACKNOWLEDGE
For a definition of the meaning of this acknowledgement
mode see the link below.
userName
- the caller's user namepassword
- the caller's passwordJMSRuntimeException
- if the Jakarta Messaging provider fails to create the JMSContext due to some internal error.JMSSecurityRuntimeException
- if client authentication fails due to an invalid user name or password.JMSContext.AUTO_ACKNOWLEDGE
,
createContext()
,
createContext(int)
,
createContext(java.lang.String, java.lang.String, int)
,
JMSContext.createContext(int)
JMSContext createContext(String userName, String password, int sessionMode)
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 sessionMode
argument depends on whether this method is called in a Java SE
environment, in the Jakarta EE application client container, or in the Jakarta EE web or EJB container. If this method is
called in the Jakarta EE web or EJB container then the effect of setting the sessionMode
argument also depends
on whether or not there is an active JTA transaction in progress.
In a Java SE environment or in the Jakarta EE application client container:
sessionMode
is set to JMSContext.SESSION_TRANSACTED
then the session will use a local
transaction which may subsequently be committed or rolled back by calling the JMSContext
's commit
or
rollback
methods.
sessionMode
is set to any of JMSContext.CLIENT_ACKNOWLEDGE
,
JMSContext.AUTO_ACKNOWLEDGE
or 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
sessionMode
. For a definition of the meaning of these acknowledgement modes see the links below.
In a Jakarta EE web or EJB container, when there is an active JTA transaction in progress:
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 JMSContext
's
commit
or rollback
methods. Since the argument is ignored, developers are recommended to use
createContext(String userName, String password)
instead of this method.
In the Jakarta EE web or EJB container, when there is no active JTA transaction in progress:
acknowledgeMode
must be set to either of JMSContext.AUTO_ACKNOWLEDGE
or
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 acknowledgeMode
. For a definition of the meaning of
these acknowledgement modes see the links below. The values JMSContext.SESSION_TRANSACTED
and
JMSContext.CLIENT_ACKNOWLEDGE
may not be used.
userName
- the caller's user namepassword
- the caller's passwordsessionMode
- indicates which of four possible session modes will be used.
JMSContext.SESSION_TRANSACTED
, JMSContext.CLIENT_ACKNOWLEDGE
,
JMSContext.AUTO_ACKNOWLEDGE
and JMSContext.DUPS_OK_ACKNOWLEDGE
.
JMSContext.AUTO_ACKNOWLEDGE
and JMSContext.DUPS_OK_ACKNOWLEDGE
. In this case
the values JMSContext.TRANSACTED
and JMSContext.CLIENT_ACKNOWLEDGE
are not permitted.
JMSRuntimeException
- if the Jakarta Messaging provider fails to create the JMSContext due to some internal error.JMSSecurityRuntimeException
- if client authentication fails due to an invalid user name or password.JMSContext.SESSION_TRANSACTED
,
JMSContext.CLIENT_ACKNOWLEDGE
,
JMSContext.AUTO_ACKNOWLEDGE
,
JMSContext.DUPS_OK_ACKNOWLEDGE
,
createContext()
,
createContext(int)
,
createContext(java.lang.String, java.lang.String)
,
JMSContext.createContext(int)
JMSContext createContext(int sessionMode)
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 sessionMode
argument depends on whether this method is called in a Java SE
environment, in the Jakarta EE application client container, or in the Jakarta EE web or EJB container. If this method is
called in the Jakarta EE web or EJB container then the effect of setting the sessionMode
argument also depends
on whether or not there is an active JTA transaction in progress.
In a Java SE environment or in the Jakarta EE application client container:
sessionMode
is set to JMSContext.SESSION_TRANSACTED
then the session will use a local
transaction which may subsequently be committed or rolled back by calling the JMSContext
's commit
or
rollback
methods.
sessionMode
is set to any of JMSContext.CLIENT_ACKNOWLEDGE
,
JMSContext.AUTO_ACKNOWLEDGE
or 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
sessionMode
. For a definition of the meaning of these acknowledgement modes see the links below.
In a Jakarta EE web or EJB container, when there is an active JTA transaction in progress:
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 JMSContext
's
commit
or rollback
methods. Since the argument is ignored, developers are recommended to use
createContext()
instead of this method.
In the Jakarta EE web or EJB container, when there is no active JTA transaction in progress:
acknowledgeMode
must be set to either of JMSContext.AUTO_ACKNOWLEDGE
or
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 acknowledgeMode
. For a definition of the meaning of
these acknowledgement modes see the links below. The values JMSContext.SESSION_TRANSACTED
and
JMSContext.CLIENT_ACKNOWLEDGE
may not be used.
sessionMode
- indicates which of four possible session modes will be used.
JMSContext.SESSION_TRANSACTED
, JMSContext.CLIENT_ACKNOWLEDGE
,
JMSContext.AUTO_ACKNOWLEDGE
and JMSContext.DUPS_OK_ACKNOWLEDGE
.
JMSContext.AUTO_ACKNOWLEDGE
and JMSContext.DUPS_OK_ACKNOWLEDGE
. In this case
the values JMSContext.TRANSACTED
and JMSContext.CLIENT_ACKNOWLEDGE
are not permitted.
JMSRuntimeException
- if the Jakarta Messaging provider fails to create the JMSContext due to some internal error.JMSSecurityRuntimeException
- if client authentication fails due to an invalid user name or password.JMSContext.SESSION_TRANSACTED
,
JMSContext.CLIENT_ACKNOWLEDGE
,
JMSContext.AUTO_ACKNOWLEDGE
,
JMSContext.DUPS_OK_ACKNOWLEDGE
,
createContext()
,
createContext(java.lang.String, java.lang.String)
,
createContext(java.lang.String, java.lang.String, int)
,
JMSContext.createContext(int)
Copyright © 2021 JBoss by Red Hat. All rights reserved.