blob: d8e655cd911abf3f46badc3aafa8064bd8152e3d [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Uses of Interface org.apache.activemq.artemis.api.core.client.ClientSession (ActiveMQ Artemis Website 2.33.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<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="Uses of Interface org.apache.activemq.artemis.api.core.client.ClientSession (ActiveMQ Artemis Website 2.33.0 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../index.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="header">
<h2 title="Uses of Interface org.apache.activemq.artemis.api.core.client.ClientSession" class="title">Uses of Interface<br>org.apache.activemq.artemis.api.core.client.ClientSession</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary">
<caption><span>Packages that use <a href="../ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="#org.apache.activemq.artemis.api.core.client">org.apache.activemq.artemis.api.core.client</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="#org.apache.activemq.artemis.api.core.management">org.apache.activemq.artemis.api.core.management</a></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList">
<section><a id="org.apache.activemq.artemis.api.core.client">
<!-- -->
</a>
<h3>Uses of <a href="../ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession</a> in <a href="../package-summary.html">org.apache.activemq.artemis.api.core.client</a></h3>
<table class="useSummary">
<caption><span>Methods in <a href="../package-summary.html">org.apache.activemq.artemis.api.core.client</a> that return <a href="../ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientSessionFactory.</span><code><span class="memberNameLink"><a href="../ClientSessionFactory.html#createSession()">createSession</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates a <em>non-transacted</em> session.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientSessionFactory.</span><code><span class="memberNameLink"><a href="../ClientSessionFactory.html#createSession(boolean,boolean)">createSession</a></span>&#8203;(boolean&nbsp;autoCommitSends,
boolean&nbsp;autoCommitAcks)</code></th>
<td class="colLast">
<div class="block">Creates a session.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientSessionFactory.</span><code><span class="memberNameLink"><a href="../ClientSessionFactory.html#createSession(boolean,boolean,boolean)">createSession</a></span>&#8203;(boolean&nbsp;xa,
boolean&nbsp;autoCommitSends,
boolean&nbsp;autoCommitAcks)</code></th>
<td class="colLast">
<div class="block">Creates a session.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientSessionFactory.</span><code><span class="memberNameLink"><a href="../ClientSessionFactory.html#createSession(boolean,boolean,boolean,boolean)">createSession</a></span>&#8203;(boolean&nbsp;xa,
boolean&nbsp;autoCommitSends,
boolean&nbsp;autoCommitAcks,
boolean&nbsp;preAcknowledge)</code></th>
<td class="colLast">
<div class="block">Creates a session.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientSessionFactory.</span><code><span class="memberNameLink"><a href="../ClientSessionFactory.html#createSession(boolean,boolean,int)">createSession</a></span>&#8203;(boolean&nbsp;autoCommitSends,
boolean&nbsp;autoCommitAcks,
int&nbsp;ackBatchSize)</code></th>
<td class="colLast">
<div class="block">Creates a session.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientSessionFactory.</span><code><span class="memberNameLink"><a href="../ClientSessionFactory.html#createSession(java.lang.String,java.lang.String,boolean,boolean,boolean,boolean,int)">createSession</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;username,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;password,
boolean&nbsp;xa,
boolean&nbsp;autoCommitSends,
boolean&nbsp;autoCommitAcks,
boolean&nbsp;preAcknowledge,
int&nbsp;ackBatchSize)</code></th>
<td class="colLast">
<div class="block">Creates an <em>authenticated</em> session.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientSessionFactory.</span><code><span class="memberNameLink"><a href="../ClientSessionFactory.html#createSession(java.lang.String,java.lang.String,boolean,boolean,boolean,boolean,int,java.lang.String)">createSession</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;username,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;password,
boolean&nbsp;xa,
boolean&nbsp;autoCommitSends,
boolean&nbsp;autoCommitAcks,
boolean&nbsp;preAcknowledge,
int&nbsp;ackBatchSize,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;clientID)</code></th>
<td class="colLast">
<div class="block">Creates an <em>authenticated</em> session.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientSessionFactory.</span><code><span class="memberNameLink"><a href="../ClientSessionFactory.html#createTransactedSession()">createTransactedSession</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates a <em>transacted</em> session.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientSessionFactory.</span><code><span class="memberNameLink"><a href="../ClientSessionFactory.html#createXASession()">createXASession</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates a session with XA transaction semantics.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientSession.</span><code><span class="memberNameLink"><a href="../ClientSession.html#setSendAcknowledgementHandler(org.apache.activemq.artemis.api.core.client.SendAcknowledgementHandler)">setSendAcknowledgementHandler</a></span>&#8203;(<a href="../SendAcknowledgementHandler.html" title="interface in org.apache.activemq.artemis.api.core.client">SendAcknowledgementHandler</a>&nbsp;handler)</code></th>
<td class="colLast">
<div class="block">Sets a <code>SendAcknowledgementHandler</code> for this session.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ClientSession.</span><code><span class="memberNameLink"><a href="../ClientSession.html#start()">start</a></span>()</code></th>
<td class="colLast">
<div class="block">Starts the session.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Constructors in <a href="../package-summary.html">org.apache.activemq.artemis.api.core.client</a> with parameters of type <a href="../ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../ClientRequestor.html#%3Cinit%3E(org.apache.activemq.artemis.api.core.client.ClientSession,java.lang.String)">ClientRequestor</a></span>&#8203;(<a href="../ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession</a>&nbsp;session,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;requestAddress)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../ClientRequestor.html#%3Cinit%3E(org.apache.activemq.artemis.api.core.client.ClientSession,org.apache.activemq.artemis.api.core.SimpleString)">ClientRequestor</a></span>&#8203;(<a href="../ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession</a>&nbsp;session,
<a href="../../SimpleString.html" title="class in org.apache.activemq.artemis.api.core">SimpleString</a>&nbsp;requestAddress)</code></th>
<td class="colLast">
<div class="block">Constructor for the ClientRequestor.</div>
</td>
</tr>
</tbody>
</table>
</section>
</li>
<li class="blockList">
<section><a id="org.apache.activemq.artemis.api.core.management">
<!-- -->
</a>
<h3>Uses of <a href="../ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession</a> in <a href="../../management/package-summary.html">org.apache.activemq.artemis.api.core.management</a></h3>
<table class="useSummary">
<caption><span>Methods in <a href="../../management/package-summary.html">org.apache.activemq.artemis.api.core.management</a> with parameters of type <a href="../ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ManagementHelper.</span><code><span class="memberNameLink"><a href="../../management/ManagementHelper.html#doManagement(org.apache.activemq.artemis.api.core.client.ClientSession,org.apache.activemq.artemis.api.core.management.ManagementHelper.MessageAcceptor,org.apache.activemq.artemis.api.core.management.ManagementHelper.MessageAcceptor,org.apache.activemq.artemis.api.core.management.ManagementHelper.MessageAcceptor)">doManagement</a></span>&#8203;(<a href="../ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession</a>&nbsp;session,
<a href="../../management/ManagementHelper.MessageAcceptor.html" title="interface in org.apache.activemq.artemis.api.core.management">ManagementHelper.MessageAcceptor</a>&nbsp;setup,
<a href="../../management/ManagementHelper.MessageAcceptor.html" title="interface in org.apache.activemq.artemis.api.core.management">ManagementHelper.MessageAcceptor</a>&nbsp;ok,
<a href="../../management/ManagementHelper.MessageAcceptor.html" title="interface in org.apache.activemq.artemis.api.core.management">ManagementHelper.MessageAcceptor</a>&nbsp;failed)</code></th>
<td class="colLast">
<div class="block">Utility function to reuse a ClientSessionConnection and perform a single management operation via core.</div>
</td>
</tr>
</tbody>
</table>
<table class="useSummary">
<caption><span>Constructors in <a href="../../management/package-summary.html">org.apache.activemq.artemis.api.core.management</a> with parameters of type <a href="../ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../management/ActiveMQManagementProxy.html#%3Cinit%3E(org.apache.activemq.artemis.api.core.client.ClientSession)">ActiveMQManagementProxy</a></span>&#8203;(<a href="../ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">ClientSession</a>&nbsp;session)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</section>
</li>
</ul>
</li>
</ul>
</div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../../index.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../ClientSession.html" title="interface in org.apache.activemq.artemis.api.core.client">Class</a></li>
<li class="navBarCell1Rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>