blob: af29523edc8b3ae8bc074bb92e429bdefa0933c9 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>XATopicConnection</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="XATopicConnection";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":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/XASession.html" title="interface in jakarta.jms"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../jakarta/jms/XATopicConnectionFactory.html" title="interface in jakarta.jms"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?jakarta/jms/XATopicConnection.html" target="_top">Frames</a></li>
<li><a href="XATopicConnection.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 XATopicConnection" class="title">Interface XATopicConnection</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>java.lang.AutoCloseable, <a href="../../jakarta/jms/Connection.html" title="interface in jakarta.jms">Connection</a>, <a href="../../jakarta/jms/TopicConnection.html" title="interface in jakarta.jms">TopicConnection</a>, <a href="../../jakarta/jms/XAConnection.html" title="interface in jakarta.jms">XAConnection</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">XATopicConnection</span>
extends <a href="../../jakarta/jms/XAConnection.html" title="interface in jakarta.jms">XAConnection</a>, <a href="../../jakarta/jms/TopicConnection.html" title="interface in jakarta.jms">TopicConnection</a></pre>
<div class="block">An <code>XATopicConnection</code> provides the same create options as <code>TopicConnection</code> (optional). The Topic
connections created are transactional.
<p>
The <code>XATopicConnection</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>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../jakarta/jms/XAConnection.html" title="interface in jakarta.jms"><code>XAConnection</code></a></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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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/TopicSession.html" title="interface in jakarta.jms">TopicSession</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/jms/XATopicConnection.html#createTopicSession-boolean-int-">createTopicSession</a></span>(boolean&nbsp;transacted,
int&nbsp;acknowledgeMode)</code>
<div class="block">Creates a <code>TopicSession</code> object.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../jakarta/jms/XATopicSession.html" title="interface in jakarta.jms">XATopicSession</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/jms/XATopicConnection.html#createXATopicSession--">createXATopicSession</a></span>()</code>
<div class="block">Creates an <code>XATopicSession</code> object.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.jakarta.jms.XAConnection">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;jakarta.jms.<a href="../../jakarta/jms/XAConnection.html" title="interface in jakarta.jms">XAConnection</a></h3>
<code><a href="../../jakarta/jms/XAConnection.html#createSession-boolean-int-">createSession</a>, <a href="../../jakarta/jms/XAConnection.html#createXASession--">createXASession</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.jakarta.jms.TopicConnection">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;jakarta.jms.<a href="../../jakarta/jms/TopicConnection.html" title="interface in jakarta.jms">TopicConnection</a></h3>
<code><a href="../../jakarta/jms/TopicConnection.html#createConnectionConsumer-jakarta.jms.Topic-java.lang.String-jakarta.jms.ServerSessionPool-int-">createConnectionConsumer</a>, <a href="../../jakarta/jms/TopicConnection.html#createDurableConnectionConsumer-jakarta.jms.Topic-java.lang.String-java.lang.String-jakarta.jms.ServerSessionPool-int-">createDurableConnectionConsumer</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.jakarta.jms.Connection">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;jakarta.jms.<a href="../../jakarta/jms/Connection.html" title="interface in jakarta.jms">Connection</a></h3>
<code><a href="../../jakarta/jms/Connection.html#close--">close</a>, <a href="../../jakarta/jms/Connection.html#createConnectionConsumer-jakarta.jms.Destination-java.lang.String-jakarta.jms.ServerSessionPool-int-">createConnectionConsumer</a>, <a href="../../jakarta/jms/Connection.html#createSession--">createSession</a>, <a href="../../jakarta/jms/Connection.html#createSession-int-">createSession</a>, <a href="../../jakarta/jms/Connection.html#createSharedConnectionConsumer-jakarta.jms.Topic-java.lang.String-java.lang.String-jakarta.jms.ServerSessionPool-int-">createSharedConnectionConsumer</a>, <a href="../../jakarta/jms/Connection.html#createSharedDurableConnectionConsumer-jakarta.jms.Topic-java.lang.String-java.lang.String-jakarta.jms.ServerSessionPool-int-">createSharedDurableConnectionConsumer</a>, <a href="../../jakarta/jms/Connection.html#getClientID--">getClientID</a>, <a href="../../jakarta/jms/Connection.html#getExceptionListener--">getExceptionListener</a>, <a href="../../jakarta/jms/Connection.html#getMetaData--">getMetaData</a>, <a href="../../jakarta/jms/Connection.html#setClientID-java.lang.String-">setClientID</a>, <a href="../../jakarta/jms/Connection.html#setExceptionListener-jakarta.jms.ExceptionListener-">setExceptionListener</a>, <a href="../../jakarta/jms/Connection.html#start--">start</a>, <a href="../../jakarta/jms/Connection.html#stop--">stop</a></code></li>
</ul>
</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="createXATopicSession--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createXATopicSession</h4>
<pre><a href="../../jakarta/jms/XATopicSession.html" title="interface in jakarta.jms">XATopicSession</a>&nbsp;createXATopicSession()
throws <a href="../../jakarta/jms/JMSException.html" title="class in jakarta.jms">JMSException</a></pre>
<div class="block">Creates an <code>XATopicSession</code> object.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a newly created <code>XATopicSession</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 <code>XATopicConnection</code> object fails to create an <code>XATopicSession</code> due to some
internal error.</dd>
</dl>
</li>
</ul>
<a name="createTopicSession-boolean-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createTopicSession</h4>
<pre><a href="../../jakarta/jms/TopicSession.html" title="interface in jakarta.jms">TopicSession</a>&nbsp;createTopicSession(boolean&nbsp;transacted,
int&nbsp;acknowledgeMode)
throws <a href="../../jakarta/jms/JMSException.html" title="class in jakarta.jms">JMSException</a></pre>
<div class="block">Creates a <code>TopicSession</code> object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../jakarta/jms/TopicConnection.html#createTopicSession-boolean-int-">createTopicSession</a></code>&nbsp;in interface&nbsp;<code><a href="../../jakarta/jms/TopicConnection.html" title="interface in jakarta.jms">TopicConnection</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>transacted</code> - usage undefined</dd>
<dd><code>acknowledgeMode</code> - usage undefined</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a newly created <code>TopicSession</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 <code>XATopicConnection</code> object fails to create a <code>TopicSession</code> due to some
internal error.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../jakarta/jms/Session.html#AUTO_ACKNOWLEDGE"><code>Session.AUTO_ACKNOWLEDGE</code></a>,
<a href="../../jakarta/jms/Session.html#CLIENT_ACKNOWLEDGE"><code>Session.CLIENT_ACKNOWLEDGE</code></a>,
<a href="../../jakarta/jms/Session.html#DUPS_OK_ACKNOWLEDGE"><code>Session.DUPS_OK_ACKNOWLEDGE</code></a></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/XASession.html" title="interface in jakarta.jms"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../jakarta/jms/XATopicConnectionFactory.html" title="interface in jakarta.jms"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?jakarta/jms/XATopicConnection.html" target="_top">Frames</a></li>
<li><a href="XATopicConnection.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>