blob: 7b32eabe8b1c8fd5cc43bc117ce99b82d74ce87e [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>
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>JMSMessageSender (Apache Axis2)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="JMSMessageSender (Apache Axis2)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="class-use/JMSMessageSender.html">Use</a></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="../../../../../org/apache/axis2/transport/jms/JMSMessageReceiver.html" title="class in org.apache.axis2.transport.jms"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/axis2/transport/jms/JMSOutTransportInfo.html" title="class in org.apache.axis2.transport.jms"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/axis2/transport/jms/JMSMessageSender.html" target="_top">Frames</a></li>
<li><a href="JMSMessageSender.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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">org.apache.axis2.transport.jms</div>
<h2 title="Class JMSMessageSender" class="title">Class JMSMessageSender</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.axis2.transport.jms.JMSMessageSender</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">JMSMessageSender</span>
extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Performs the actual sending of a JMS message, and the subsequent committing of a JTA transaction
(if requested) or the local session transaction, if used. An instance of this class is unique
to a single message send out operation and will not be shared.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/axis2/transport/jms/JMSMessageSender.html#JMSMessageSender(javax.jms.Connection, javax.jms.Session, javax.jms.MessageProducer, javax.jms.Destination, int, boolean, java.lang.Boolean)">JMSMessageSender</a></strong>(<a href="http://docs.oracle.com/javaee/5/api/javax/jms/Connection.html?is-external=true" title="class or interface in javax.jms">Connection</a>&nbsp;connection,
<a href="http://docs.oracle.com/javaee/5/api/javax/jms/Session.html?is-external=true" title="class or interface in javax.jms">Session</a>&nbsp;session,
<a href="http://docs.oracle.com/javaee/5/api/javax/jms/MessageProducer.html?is-external=true" title="class or interface in javax.jms">MessageProducer</a>&nbsp;producer,
<a href="http://docs.oracle.com/javaee/5/api/javax/jms/Destination.html?is-external=true" title="class or interface in javax.jms">Destination</a>&nbsp;destination,
int&nbsp;cacheLevel,
boolean&nbsp;jmsSpec11,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;isQueue)</code>
<div class="block">This is a low-end method to support the one-time sends using JMS 1.0.2b</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/axis2/transport/jms/JMSMessageSender.html#JMSMessageSender(org.apache.axis2.transport.jms.JMSConnectionFactory, java.lang.String)">JMSMessageSender</a></strong>(<a href="../../../../../org/apache/axis2/transport/jms/JMSConnectionFactory.html" title="class in org.apache.axis2.transport.jms">JMSConnectionFactory</a>&nbsp;jmsConnectionFactory,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;targetAddress)</code>
<div class="block">Create a JMSSender using a JMSConnectionFactory and target EPR</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/transport/jms/JMSMessageSender.html#close()">close</a></strong>()</code>
<div class="block">Close non-shared producer, session and connection if any</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/transport/jms/JMSMessageSender.html#getCacheLevel()">getCacheLevel</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javaee/5/api/javax/jms/Connection.html?is-external=true" title="class or interface in javax.jms">Connection</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/transport/jms/JMSMessageSender.html#getConnection()">getConnection</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javaee/5/api/javax/jms/MessageProducer.html?is-external=true" title="class or interface in javax.jms">MessageProducer</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/transport/jms/JMSMessageSender.html#getProducer()">getProducer</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javaee/5/api/javax/jms/Session.html?is-external=true" title="class or interface in javax.jms">Session</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/transport/jms/JMSMessageSender.html#getSession()">getSession</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/transport/jms/JMSMessageSender.html#send(javax.jms.Message, org.apache.axis2.context.MessageContext)">send</a></strong>(<a href="http://docs.oracle.com/javaee/5/api/javax/jms/Message.html?is-external=true" title="class or interface in javax.jms">Message</a>&nbsp;message,
<a href="../../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgCtx)</code>
<div class="block">Perform actual send of JMS message to the Destination selected</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/transport/jms/JMSMessageSender.html#setCacheLevel(int)">setCacheLevel</a></strong>(int&nbsp;cacheLevel)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/transport/jms/JMSMessageSender.html#setConnection(javax.jms.Connection)">setConnection</a></strong>(<a href="http://docs.oracle.com/javaee/5/api/javax/jms/Connection.html?is-external=true" title="class or interface in javax.jms">Connection</a>&nbsp;connection)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/transport/jms/JMSMessageSender.html#setProducer(javax.jms.MessageProducer)">setProducer</a></strong>(<a href="http://docs.oracle.com/javaee/5/api/javax/jms/MessageProducer.html?is-external=true" title="class or interface in javax.jms">MessageProducer</a>&nbsp;producer)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/axis2/transport/jms/JMSMessageSender.html#setSession(javax.jms.Session)">setSession</a></strong>(<a href="http://docs.oracle.com/javaee/5/api/javax/jms/Session.html?is-external=true" title="class or interface in javax.jms">Session</a>&nbsp;session)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="JMSMessageSender(javax.jms.Connection, javax.jms.Session, javax.jms.MessageProducer, javax.jms.Destination, int, boolean, java.lang.Boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JMSMessageSender</h4>
<pre>public&nbsp;JMSMessageSender(<a href="http://docs.oracle.com/javaee/5/api/javax/jms/Connection.html?is-external=true" title="class or interface in javax.jms">Connection</a>&nbsp;connection,
<a href="http://docs.oracle.com/javaee/5/api/javax/jms/Session.html?is-external=true" title="class or interface in javax.jms">Session</a>&nbsp;session,
<a href="http://docs.oracle.com/javaee/5/api/javax/jms/MessageProducer.html?is-external=true" title="class or interface in javax.jms">MessageProducer</a>&nbsp;producer,
<a href="http://docs.oracle.com/javaee/5/api/javax/jms/Destination.html?is-external=true" title="class or interface in javax.jms">Destination</a>&nbsp;destination,
int&nbsp;cacheLevel,
boolean&nbsp;jmsSpec11,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>&nbsp;isQueue)</pre>
<div class="block">This is a low-end method to support the one-time sends using JMS 1.0.2b</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>connection</code> - the JMS Connection</dd><dd><code>session</code> - JMS Session</dd><dd><code>producer</code> - the MessageProducer</dd><dd><code>destination</code> - the JMS Destination</dd><dd><code>cacheLevel</code> - cacheLevel - None | Connection | Session | Producer</dd><dd><code>jmsSpec11</code> - true if the JMS 1.1 API should be used</dd><dd><code>isQueue</code> - posting to a Queue?</dd></dl>
</li>
</ul>
<a name="JMSMessageSender(org.apache.axis2.transport.jms.JMSConnectionFactory, java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JMSMessageSender</h4>
<pre>public&nbsp;JMSMessageSender(<a href="../../../../../org/apache/axis2/transport/jms/JMSConnectionFactory.html" title="class in org.apache.axis2.transport.jms">JMSConnectionFactory</a>&nbsp;jmsConnectionFactory,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;targetAddress)</pre>
<div class="block">Create a JMSSender using a JMSConnectionFactory and target EPR</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>jmsConnectionFactory</code> - the JMSConnectionFactory</dd><dd><code>targetAddress</code> - target EPR</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="send(javax.jms.Message, org.apache.axis2.context.MessageContext)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>send</h4>
<pre>public&nbsp;void&nbsp;send(<a href="http://docs.oracle.com/javaee/5/api/javax/jms/Message.html?is-external=true" title="class or interface in javax.jms">Message</a>&nbsp;message,
<a href="../../../../../org/apache/axis2/context/MessageContext.html" title="class in org.apache.axis2.context">MessageContext</a>&nbsp;msgCtx)</pre>
<div class="block">Perform actual send of JMS message to the Destination selected</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> - the JMS message</dd><dd><code>msgCtx</code> - the Axis2 MessageContext</dd></dl>
</li>
</ul>
<a name="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()</pre>
<div class="block">Close non-shared producer, session and connection if any</div>
</li>
</ul>
<a name="setConnection(javax.jms.Connection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConnection</h4>
<pre>public&nbsp;void&nbsp;setConnection(<a href="http://docs.oracle.com/javaee/5/api/javax/jms/Connection.html?is-external=true" title="class or interface in javax.jms">Connection</a>&nbsp;connection)</pre>
</li>
</ul>
<a name="setSession(javax.jms.Session)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSession</h4>
<pre>public&nbsp;void&nbsp;setSession(<a href="http://docs.oracle.com/javaee/5/api/javax/jms/Session.html?is-external=true" title="class or interface in javax.jms">Session</a>&nbsp;session)</pre>
</li>
</ul>
<a name="setProducer(javax.jms.MessageProducer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProducer</h4>
<pre>public&nbsp;void&nbsp;setProducer(<a href="http://docs.oracle.com/javaee/5/api/javax/jms/MessageProducer.html?is-external=true" title="class or interface in javax.jms">MessageProducer</a>&nbsp;producer)</pre>
</li>
</ul>
<a name="setCacheLevel(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCacheLevel</h4>
<pre>public&nbsp;void&nbsp;setCacheLevel(int&nbsp;cacheLevel)</pre>
</li>
</ul>
<a name="getCacheLevel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheLevel</h4>
<pre>public&nbsp;int&nbsp;getCacheLevel()</pre>
</li>
</ul>
<a name="getConnection()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConnection</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javaee/5/api/javax/jms/Connection.html?is-external=true" title="class or interface in javax.jms">Connection</a>&nbsp;getConnection()</pre>
</li>
</ul>
<a name="getProducer()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProducer</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javaee/5/api/javax/jms/MessageProducer.html?is-external=true" title="class or interface in javax.jms">MessageProducer</a>&nbsp;getProducer()</pre>
</li>
</ul>
<a name="getSession()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getSession</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javaee/5/api/javax/jms/Session.html?is-external=true" title="class or interface in javax.jms">Session</a>&nbsp;getSession()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="class-use/JMSMessageSender.html">Use</a></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="../../../../../org/apache/axis2/transport/jms/JMSMessageReceiver.html" title="class in org.apache.axis2.transport.jms"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/axis2/transport/jms/JMSOutTransportInfo.html" title="class in org.apache.axis2.transport.jms"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/axis2/transport/jms/JMSMessageSender.html" target="_top">Frames</a></li>
<li><a href="JMSMessageSender.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &copy; <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>