| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>ResourceAdapterMetaData</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="ResourceAdapterMetaData"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":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/resource/cci/RecordFactory.html" title="interface in jakarta.resource.cci"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/resource/cci/ResourceWarning.html" title="class in jakarta.resource.cci"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/resource/cci/ResourceAdapterMetaData.html" target="_top">Frames</a></li> |
| <li><a href="ResourceAdapterMetaData.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.resource.cci</div> |
| <h2 title="Interface ResourceAdapterMetaData" class="title">Interface ResourceAdapterMetaData</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ResourceAdapterMetaData</span></pre> |
| <div class="block">The interface <code>javax.resource.cci.ResourceAdapterMetaData</code> |
| provides information about capabilities of a resource adapter |
| implementation. Note that this interface does not provide information |
| about an EIS instance that is connected through the resource adapter. |
| |
| <p>A CCI client uses a <code>ConnectionFactory.getMetaData</code> to |
| get metadata information about the resource adapter. The |
| <code>getMetaData</code> method does not require that an active |
| connection to an EIS instance should have been established. |
| |
| <p>The ResourceAdapterMetaData can be extended to provide more |
| information specific to a resource adapter implementation.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>0.8</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/resource/cci/ConnectionFactory.html" title="interface in jakarta.resource.cci"><code>ConnectionFactory</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"> </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>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/cci/ResourceAdapterMetaData.html#getAdapterName--">getAdapterName</a></span>()</code> |
| <div class="block">Gets a tool displayable name of the resource adapter.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/cci/ResourceAdapterMetaData.html#getAdapterShortDescription--">getAdapterShortDescription</a></span>()</code> |
| <div class="block">Gets a tool displayable short desription of the resource |
| adapter.</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="../../../jakarta/resource/cci/ResourceAdapterMetaData.html#getAdapterVendorName--">getAdapterVendorName</a></span>()</code> |
| <div class="block">Gets the name of the vendor that has provided the resource |
| adapter.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/cci/ResourceAdapterMetaData.html#getAdapterVersion--">getAdapterVersion</a></span>()</code> |
| <div class="block">Gets the version of the resource adapter.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.String[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/cci/ResourceAdapterMetaData.html#getInteractionSpecsSupported--">getInteractionSpecsSupported</a></span>()</code> |
| <div class="block">Returns an array of fully-qualified names of InteractionSpec |
| types supported by the CCI implementation for this resource |
| adapter.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/cci/ResourceAdapterMetaData.html#getSpecVersion--">getSpecVersion</a></span>()</code> |
| <div class="block">Returns a string representation of the version of the |
| connector architecture specification that is supported by |
| the resource adapter.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/cci/ResourceAdapterMetaData.html#supportsExecuteWithInputAndOutputRecord--">supportsExecuteWithInputAndOutputRecord</a></span>()</code> |
| <div class="block">Returns true if the implementation class for the Interaction |
| interface implements public boolean execute(InteractionSpec |
| ispec, Record input, Record output) method; otherwise the |
| method returns false.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/cci/ResourceAdapterMetaData.html#supportsExecuteWithInputRecordOnly--">supportsExecuteWithInputRecordOnly</a></span>()</code> |
| <div class="block">Returns true if the implementation class for the Interaction |
| interface implements public Record execute(InteractionSpec |
| ispec, Record input) method; otherwise the method returns |
| false.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/cci/ResourceAdapterMetaData.html#supportsLocalTransactionDemarcation--">supportsLocalTransactionDemarcation</a></span>()</code> |
| <div class="block">Returns true if the resource adapter implements the LocalTransaction |
| interface and supports local transaction demarcation on the |
| underlying EIS instance through the LocalTransaction interface.</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="getAdapterVersion--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAdapterVersion</h4> |
| <pre>java.lang.String getAdapterVersion()</pre> |
| <div class="block">Gets the version of the resource adapter.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String representing version of the resource adapter</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAdapterVendorName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAdapterVendorName</h4> |
| <pre>java.lang.String getAdapterVendorName()</pre> |
| <div class="block">Gets the name of the vendor that has provided the resource |
| adapter.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String representing name of the vendor that has |
| provided the resource adapter</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAdapterName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAdapterName</h4> |
| <pre>java.lang.String getAdapterName()</pre> |
| <div class="block">Gets a tool displayable name of the resource adapter.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String representing the name of the resource adapter</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAdapterShortDescription--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAdapterShortDescription</h4> |
| <pre>java.lang.String getAdapterShortDescription()</pre> |
| <div class="block">Gets a tool displayable short desription of the resource |
| adapter.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String describing the resource adapter</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSpecVersion--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSpecVersion</h4> |
| <pre>java.lang.String getSpecVersion()</pre> |
| <div class="block">Returns a string representation of the version of the |
| connector architecture specification that is supported by |
| the resource adapter.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>String representing the supported version of |
| the connector architecture</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInteractionSpecsSupported--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInteractionSpecsSupported</h4> |
| <pre>java.lang.String[] getInteractionSpecsSupported()</pre> |
| <div class="block">Returns an array of fully-qualified names of InteractionSpec |
| types supported by the CCI implementation for this resource |
| adapter. Note that the fully-qualified class name is for |
| the implementation class of an InteractionSpec. This method |
| may be used by tools vendor to find information on the |
| supported InteractionSpec types. The method should return |
| an array of length 0 if the CCI implementation does not |
| define specific InteractionSpec types.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Array of fully-qualified class names of |
| InteractionSpec classes supported by this |
| resource adapter's CCI implementation</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/resource/cci/InteractionSpec.html" title="interface in jakarta.resource.cci"><code>InteractionSpec</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="supportsExecuteWithInputAndOutputRecord--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>supportsExecuteWithInputAndOutputRecord</h4> |
| <pre>boolean supportsExecuteWithInputAndOutputRecord()</pre> |
| <div class="block">Returns true if the implementation class for the Interaction |
| interface implements public boolean execute(InteractionSpec |
| ispec, Record input, Record output) method; otherwise the |
| method returns false.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>boolean depending on method support</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/resource/cci/Interaction.html" title="interface in jakarta.resource.cci"><code>Interaction</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="supportsExecuteWithInputRecordOnly--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>supportsExecuteWithInputRecordOnly</h4> |
| <pre>boolean supportsExecuteWithInputRecordOnly()</pre> |
| <div class="block">Returns true if the implementation class for the Interaction |
| interface implements public Record execute(InteractionSpec |
| ispec, Record input) method; otherwise the method returns |
| false.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>boolean depending on method support</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/resource/cci/Interaction.html" title="interface in jakarta.resource.cci"><code>Interaction</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="supportsLocalTransactionDemarcation--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>supportsLocalTransactionDemarcation</h4> |
| <pre>boolean supportsLocalTransactionDemarcation()</pre> |
| <div class="block">Returns true if the resource adapter implements the LocalTransaction |
| interface and supports local transaction demarcation on the |
| underlying EIS instance through the LocalTransaction interface.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if resource adapter supports resource manager |
| local transaction demarcation through LocalTransaction |
| interface; false otherwise</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../jakarta/resource/cci/LocalTransaction.html" title="interface in jakarta.resource.cci"><code>LocalTransaction</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/resource/cci/RecordFactory.html" title="interface in jakarta.resource.cci"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../jakarta/resource/cci/ResourceWarning.html" title="class in jakarta.resource.cci"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/resource/cci/ResourceAdapterMetaData.html" target="_top">Frames</a></li> |
| <li><a href="ResourceAdapterMetaData.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> |
