| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>XAConnectionFactory</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="XAConnectionFactory"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../index-all.html">Index</a></li> |
| <li><a href="../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../jakarta/jms/XAConnection.html" title="interface in jakarta.jms"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/jms/XAJMSContext.html" title="interface in jakarta.jms"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/jms/XAConnectionFactory.html" target="_top">Frames</a></li> |
| <li><a href="XAConnectionFactory.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.jms</div> |
| <h2 title="Interface XAConnectionFactory" class="title">Interface XAConnectionFactory</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../jakarta/jms/XAQueueConnectionFactory.html" title="interface in jakarta.jms">XAQueueConnectionFactory</a>, <a href="../../jakarta/jms/XATopicConnectionFactory.html" title="interface in jakarta.jms">XATopicConnectionFactory</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">XAConnectionFactory</span></pre> |
| <div class="block">The <code>XAConnectionFactory</code> interface is a base interface for the <code>XAQueueConnectionFactory</code> and |
| <code>XATopicConnectionFactory</code> interfaces. |
| |
| <p> |
| Some application servers provide support for grouping JTA capable resource use into a distributed transaction |
| (optional). To include Jakarta Messaging API transactions in a JTA transaction, an application server requires a JTA aware JMS |
| provider. A Jakarta Messaging provider exposes its JTA support using an <code>XAConnectionFactory</code> object, which an application |
| server uses to create <code>XAConnection</code> objects. |
| |
| <p> |
| <code>XAConnectionFactory</code> objects are Jakarta Messaging administered objects, just like <code>ConnectionFactory</code> objects. It is |
| expected that application servers will find them using the Java Naming and Directory Interface (JNDI) API. |
| |
| <p> |
| The <code>XAConnectionFactory</code> interface is optional. Jakarta Messaging providers are not required to support this interface. This |
| interface is for use by Jakarta Messaging providers to support transactional environments. Client programs are strongly encouraged |
| to use the transactional support available in their environment, rather than use these XA interfaces directly.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>JMS 1.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../jakarta/jms/XAConnection.html" title="interface in jakarta.jms">XAConnection</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/jms/XAConnectionFactory.html#createXAConnection--">createXAConnection</a></span>()</code> |
| <div class="block">Creates an <code>XAConnection</code> with the default user identity.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../jakarta/jms/XAConnection.html" title="interface in jakarta.jms">XAConnection</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/jms/XAConnectionFactory.html#createXAConnection-java.lang.String-java.lang.String-">createXAConnection</a></span>(java.lang.String userName, |
| java.lang.String password)</code> |
| <div class="block">Creates an <code>XAConnection</code> with the specified user identity.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../jakarta/jms/XAJMSContext.html" title="interface in jakarta.jms">XAJMSContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/jms/XAConnectionFactory.html#createXAContext--">createXAContext</a></span>()</code> |
| <div class="block">Creates a <code>XAJMSContext</code> with the default user identity</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../jakarta/jms/XAJMSContext.html" title="interface in jakarta.jms">XAJMSContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/jms/XAConnectionFactory.html#createXAContext-java.lang.String-java.lang.String-">createXAContext</a></span>(java.lang.String userName, |
| java.lang.String password)</code> |
| <div class="block">Creates a JMSContext with the specified user identity</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="createXAConnection--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createXAConnection</h4> |
| <pre><a href="../../jakarta/jms/XAConnection.html" title="interface in jakarta.jms">XAConnection</a> createXAConnection() |
| throws <a href="../../jakarta/jms/JMSException.html" title="class in jakarta.jms">JMSException</a></pre> |
| <div class="block">Creates an <code>XAConnection</code> with the default user identity. The connection is created in stopped mode. No |
| messages will be delivered until the <code>Connection.start</code> method is explicitly called.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a newly created <code>XAConnection</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../jakarta/jms/JMSException.html" title="class in jakarta.jms">JMSException</a></code> - if the Jakarta Messaging provider fails to create an XA connection due to some internal error.</dd> |
| <dd><code><a href="../../jakarta/jms/JMSSecurityException.html" title="class in jakarta.jms">JMSSecurityException</a></code> - if client authentication fails due to an invalid user name or password.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>JMS 1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createXAConnection-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createXAConnection</h4> |
| <pre><a href="../../jakarta/jms/XAConnection.html" title="interface in jakarta.jms">XAConnection</a> createXAConnection(java.lang.String userName, |
| java.lang.String password) |
| throws <a href="../../jakarta/jms/JMSException.html" title="class in jakarta.jms">JMSException</a></pre> |
| <div class="block">Creates an <code>XAConnection</code> with the specified user identity. The connection is created in stopped mode. No |
| messages will be delivered until the <code>Connection.start</code> method is explicitly called.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>userName</code> - the caller's user name</dd> |
| <dd><code>password</code> - the caller's password</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a newly created <code>XAConnection</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../jakarta/jms/JMSException.html" title="class in jakarta.jms">JMSException</a></code> - if the Jakarta Messaging provider fails to create an XA connection due to some internal error.</dd> |
| <dd><code><a href="../../jakarta/jms/JMSSecurityException.html" title="class in jakarta.jms">JMSSecurityException</a></code> - if client authentication fails due to an invalid user name or password.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>JMS 1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createXAContext--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createXAContext</h4> |
| <pre><a href="../../jakarta/jms/XAJMSContext.html" title="interface in jakarta.jms">XAJMSContext</a> createXAContext()</pre> |
| <div class="block">Creates a <code>XAJMSContext</code> with the default user identity |
| |
| <p> |
| A connection and session are created for use by the new <code>XAJMSContext</code>. The connection is created in stopped |
| mode but will be automatically started when a <code>JMSConsumer</code> is created.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a newly created <code>XAJMSContext</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../jakarta/jms/JMSRuntimeException.html" title="class in jakarta.jms">JMSRuntimeException</a></code> - if the Jakarta Messaging provider fails to create the <code>XAJMSContext</code> due to some internal |
| error.</dd> |
| <dd><code><a href="../../jakarta/jms/JMSSecurityRuntimeException.html" title="class in jakarta.jms">JMSSecurityRuntimeException</a></code> - if client authentication fails due to an invalid user name or password.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>JMS 2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createXAContext-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>createXAContext</h4> |
| <pre><a href="../../jakarta/jms/XAJMSContext.html" title="interface in jakarta.jms">XAJMSContext</a> createXAContext(java.lang.String userName, |
| java.lang.String password)</pre> |
| <div class="block">Creates a JMSContext with the specified user identity |
| |
| <p> |
| A connection and session are created for use by the new <code>XAJMSContext</code>. The connection is created in stopped |
| mode but will be automatically started when a <code>JMSConsumer</code> is created.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>userName</code> - the caller's user name</dd> |
| <dd><code>password</code> - the caller's password</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a newly created JMSContext</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../jakarta/jms/JMSRuntimeException.html" title="class in jakarta.jms">JMSRuntimeException</a></code> - if the Jakarta Messaging provider fails to create the JMSContext due to some internal error.</dd> |
| <dd><code><a href="../../jakarta/jms/JMSSecurityRuntimeException.html" title="class in jakarta.jms">JMSSecurityRuntimeException</a></code> - if client authentication fails due to an invalid user name or password.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>JMS 2.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../index-all.html">Index</a></li> |
| <li><a href="../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../jakarta/jms/XAConnection.html" title="interface in jakarta.jms"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/jms/XAJMSContext.html" title="interface in jakarta.jms"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/jms/XAConnectionFactory.html" target="_top">Frames</a></li> |
| <li><a href="XAConnectionFactory.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
