| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>MessageEndpointFactory</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="MessageEndpointFactory"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":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="../../../../javax/resource/spi/endpoint/MessageEndpoint.html" title="interface in javax.resource.spi.endpoint"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/resource/spi/endpoint/MessageEndpointFactory.html" target="_top">Frames</a></li> |
| <li><a href="MessageEndpointFactory.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">javax.resource.spi.endpoint</div> |
| <h2 title="Interface MessageEndpointFactory" class="title">Interface MessageEndpointFactory</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/openejb/core/mdb/EndpointFactory.html" title="class in org.apache.openejb.core.mdb">EndpointFactory</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">MessageEndpointFactory</span></pre> |
| <div class="block">This serves as a factory for creating message endpoints.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.5</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="../../../../javax/resource/spi/endpoint/MessageEndpoint.html" title="interface in javax.resource.spi.endpoint">MessageEndpoint</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/resource/spi/endpoint/MessageEndpointFactory.html#createEndpoint-javax.transaction.xa.XAResource-">createEndpoint</a></span>(javax.transaction.xa.XAResource xaResource)</code> |
| <div class="block">This is used to create a message endpoint.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../javax/resource/spi/endpoint/MessageEndpoint.html" title="interface in javax.resource.spi.endpoint">MessageEndpoint</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/resource/spi/endpoint/MessageEndpointFactory.html#createEndpoint-javax.transaction.xa.XAResource-long-">createEndpoint</a></span>(javax.transaction.xa.XAResource xaResource, |
| long timeout)</code> |
| <div class="block">This is used to create a message endpoint.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/resource/spi/endpoint/MessageEndpointFactory.html#getActivationName--">getActivationName</a></span>()</code> |
| <div class="block">Returns a unique name for the message endpoint deployment represented |
| by the <code>MessageEndpointFactory</code>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Class<?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/resource/spi/endpoint/MessageEndpointFactory.html#getEndpointClass--">getEndpointClass</a></span>()</code> |
| <div class="block">Return the <code>Class</code> object corresponding to the message |
| endpoint class.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/resource/spi/endpoint/MessageEndpointFactory.html#isDeliveryTransacted-java.lang.reflect.Method-">isDeliveryTransacted</a></span>(java.lang.reflect.Method method)</code> |
| <div class="block">This is used to find out whether message deliveries to a target method |
| on a message listener interface that is implemented by a message |
| endpoint or a target method in the <code>Class</code> returned by the |
| <code>getBeanClass</code> method, will be transacted or not.</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="createEndpoint-javax.transaction.xa.XAResource-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createEndpoint</h4> |
| <pre><a href="../../../../javax/resource/spi/endpoint/MessageEndpoint.html" title="interface in javax.resource.spi.endpoint">MessageEndpoint</a> createEndpoint(javax.transaction.xa.XAResource xaResource) |
| throws <a href="../../../../javax/resource/spi/UnavailableException.html" title="class in javax.resource.spi">UnavailableException</a></pre> |
| <div class="block">This is used to create a message endpoint. The message endpoint is |
| expected to implement the correct message listener type.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>xaResource</code> - an optional <code>XAResource</code> |
| instance used to get transaction notifications when the message delivery |
| is transacted.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a message endpoint instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/resource/spi/UnavailableException.html" title="class in javax.resource.spi">UnavailableException</a></code> - indicates a transient failure |
| in creating a message endpoint. Subsequent attempts to create a message |
| endpoint might succeed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createEndpoint-javax.transaction.xa.XAResource-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createEndpoint</h4> |
| <pre><a href="../../../../javax/resource/spi/endpoint/MessageEndpoint.html" title="interface in javax.resource.spi.endpoint">MessageEndpoint</a> createEndpoint(javax.transaction.xa.XAResource xaResource, |
| long timeout) |
| throws <a href="../../../../javax/resource/spi/UnavailableException.html" title="class in javax.resource.spi">UnavailableException</a></pre> |
| <div class="block">This is used to create a message endpoint. The message endpoint is |
| expected to implement the correct message listener type.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>xaResource</code> - an optional <code>XAResource</code> |
| instance used to get transaction notifications when the message delivery |
| is transacted.</dd> |
| <dd><code>timeout</code> - an optional value used to specify the time duration |
| (in milliseconds) within which the message endpoint needs to be |
| created by the <code>MessageEndpointFactory</code>. Otherwise, the |
| <code>MessageEndpointFactory</code> rejects the creation of the |
| <code>MessageEndpoint</code> with an UnavailableException. Note, this |
| does not offer real-time guarantees.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a message endpoint instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/resource/spi/UnavailableException.html" title="class in javax.resource.spi">UnavailableException</a></code> - indicates a transient failure |
| in creating a message endpoint. Subsequent attempts to create a message |
| endpoint might succeed.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isDeliveryTransacted-java.lang.reflect.Method-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDeliveryTransacted</h4> |
| <pre>boolean isDeliveryTransacted(java.lang.reflect.Method method) |
| throws java.lang.NoSuchMethodException</pre> |
| <div class="block">This is used to find out whether message deliveries to a target method |
| on a message listener interface that is implemented by a message |
| endpoint or a target method in the <code>Class</code> returned by the |
| <code>getBeanClass</code> method, will be transacted or not. |
| |
| The message endpoint may indicate its transacted delivery preferences |
| (at a per method level) through its deployment descriptor. The message |
| delivery preferences must not change during the lifetime of a |
| message endpoint.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>method</code> - description of a target method. This information about |
| the intended target method allows an application server to find out |
| whether the target method call will be transacted or not.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true, if message endpoint requires transacted message delivery.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.NoSuchMethodException</code> - indicates that the specified method |
| does not exist on the target endpoint.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getActivationName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getActivationName</h4> |
| <pre>java.lang.String getActivationName()</pre> |
| <div class="block">Returns a unique name for the message endpoint deployment represented |
| by the <code>MessageEndpointFactory</code>. If the message endpoint has |
| been deployed into a clustered application server then this method must |
| return the same name for that message endpoint’s activation in each |
| application server instance. |
| |
| It is recommended that this name be human-readable since this name may |
| be used by the resource adapter in ways that may be visible to a user |
| or administrator. |
| |
| It is also recommended that this name remain unchanged even in cases |
| when the application server is restarted or the message endpoint |
| redeployed.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new <code>String</code> instance representing the unique |
| name of the message endpoint deployment</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.7</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEndpointClass--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getEndpointClass</h4> |
| <pre>java.lang.Class<?> getEndpointClass()</pre> |
| <div class="block">Return the <code>Class</code> object corresponding to the message |
| endpoint class. For example, for a Message Driven Bean this is the |
| <code>Class</code> object corresponding to the application's MDB class. |
| |
| The resource adapter may use this to introspect the |
| message endpoint class to discover annotations, interfaces implemented, |
| etc. and modify the behavior of the resource adapter accordingly. |
| |
| A return value of <code>null</code> indicates that the |
| <code>MessageEndpoint</code> doesn't implement the business methods of |
| underlying message endpoint class.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A <code>Class</code> corresponding to the message endpoint class.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.7</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="../../../../javax/resource/spi/endpoint/MessageEndpoint.html" title="interface in javax.resource.spi.endpoint"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/resource/spi/endpoint/MessageEndpointFactory.html" target="_top">Frames</a></li> |
| <li><a href="MessageEndpointFactory.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> |
