| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>jakarta.resource.spi</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="jakarta.resource.spi"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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 class="navBarCell1Rev">Package</li> |
| <li>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/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../jakarta/resource/spi/endpoint/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/resource/spi/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package jakarta.resource.spi</h1> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/ActivationSpec.html" title="interface in jakarta.resource.spi">ActivationSpec</a></td> |
| <td class="colLast"> |
| <div class="block">This interface serves as a marker.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/BootstrapContext.html" title="interface in jakarta.resource.spi">BootstrapContext</a></td> |
| <td class="colLast"> |
| <div class="block">This provides a mechanism to pass a bootstrap context to a resource adapter |
| instance when it is bootstrapped.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/ConnectionEventListener.html" title="interface in jakarta.resource.spi">ConnectionEventListener</a></td> |
| <td class="colLast"> |
| <div class="block">The <code>ConnectionEventListener</code> interface provides an event |
| callback mechanism to enable an application server to receive |
| notifications from a <code>ManagedConnection</code> instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/ConnectionManager.html" title="interface in jakarta.resource.spi">ConnectionManager</a></td> |
| <td class="colLast"> |
| <div class="block">ConnectionManager interface provides a hook for the resource adapter to |
| pass a connection request to the application server.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/ConnectionRequestInfo.html" title="interface in jakarta.resource.spi">ConnectionRequestInfo</a></td> |
| <td class="colLast"> |
| <div class="block">The ConnectionRequestInfo interface enables a resource adapter to |
| pass its own request specific data structure across the connection |
| request flow.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/DissociatableManagedConnection.html" title="interface in jakarta.resource.spi">DissociatableManagedConnection</a></td> |
| <td class="colLast"> |
| <div class="block">This is a mix-in interface that may be optionally implemented by a |
| <code>ManagedConnection</code> implementation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/LazyAssociatableConnectionManager.html" title="interface in jakarta.resource.spi">LazyAssociatableConnectionManager</a></td> |
| <td class="colLast"> |
| <div class="block">This is a mix-in interface that may be optionally implemented by a |
| <code>ConnectionManager</code> implementation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/LazyEnlistableConnectionManager.html" title="interface in jakarta.resource.spi">LazyEnlistableConnectionManager</a></td> |
| <td class="colLast"> |
| <div class="block">This is a mix-in interface that may be optionally implemented by a |
| <code>ConnectionManager</code> implementation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/LazyEnlistableManagedConnection.html" title="interface in jakarta.resource.spi">LazyEnlistableManagedConnection</a></td> |
| <td class="colLast"> |
| <div class="block">This is a mix-in interface that may be optionally implemented by a |
| <code>ManagedConnection</code> implementation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/LocalTransaction.html" title="interface in jakarta.resource.spi">LocalTransaction</a></td> |
| <td class="colLast"> |
| <div class="block">LocalTransaction interface provides support for transactions that |
| are managed internal to an EIS resource manager, and do not require |
| an external transaction manager.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/ManagedConnection.html" title="interface in jakarta.resource.spi">ManagedConnection</a></td> |
| <td class="colLast"> |
| <div class="block">ManagedConnection instance represents a physical connection |
| to the underlying EIS.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/ManagedConnectionFactory.html" title="interface in jakarta.resource.spi">ManagedConnectionFactory</a></td> |
| <td class="colLast"> |
| <div class="block">ManagedConnectionFactory instance is a factory of both ManagedConnection |
| and EIS-specific connection factory instances.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/ManagedConnectionMetaData.html" title="interface in jakarta.resource.spi">ManagedConnectionMetaData</a></td> |
| <td class="colLast"> |
| <div class="block">The ManagedConnectionMetaData interface provides information about the |
| underlying EIS instance associated with a ManagedConnection instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/ResourceAdapter.html" title="interface in jakarta.resource.spi">ResourceAdapter</a></td> |
| <td class="colLast"> |
| <div class="block">This represents a resource adapter instance and contains operations for |
| lifecycle management and message endpoint setup.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/ResourceAdapterAssociation.html" title="interface in jakarta.resource.spi">ResourceAdapterAssociation</a></td> |
| <td class="colLast"> |
| <div class="block">This interface specifies the methods to associate a |
| <code>ResourceAdapter</code> object with other objects that |
| implement this interface like |
| <code>ManagedConnectionFactory</code> and <code>ActivationSpec</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/RetryableException.html" title="interface in jakarta.resource.spi">RetryableException</a></td> |
| <td class="colLast"> |
| <div class="block">A marker interface indicating that the Exception is transient.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/TransactionSupport.html" title="interface in jakarta.resource.spi">TransactionSupport</a></td> |
| <td class="colLast"> |
| <div class="block">This interface may be optionally implemented by a |
| <code>ManagedConnectionFactory</code> to provide its level of transaction |
| support at runtime.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/ValidatingManagedConnectionFactory.html" title="interface in jakarta.resource.spi">ValidatingManagedConnectionFactory</a></td> |
| <td class="colLast"> |
| <div class="block">This interface is implemented by a <code>ManagedConnectionFactory</code> |
| instance that supports the ability to validate |
| <code>ManagedConnection</code> objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/XATerminator.html" title="interface in jakarta.resource.spi">XATerminator</a></td> |
| <td class="colLast"> |
| <div class="block">The XATerminator interface is used for transaction completion and |
| crash recovery flows.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/ConnectionEvent.html" title="class in jakarta.resource.spi">ConnectionEvent</a></td> |
| <td class="colLast"> |
| <div class="block">The ConnectionEvent class provides information about the source of |
| a connection related event.A ConnectionEvent instance contains the |
| following information: |
| |
| Type of the connection event |
| ManagedConnection instance that generated the connection event.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/AuthenticationMechanism.CredentialInterface.html" title="enum in jakarta.resource.spi">AuthenticationMechanism.CredentialInterface</a></td> |
| <td class="colLast"> |
| <div class="block">An enumerated type that represents the various interfaces |
| that a resource adapter may support for the representation |
| of the credentials.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/TransactionSupport.TransactionSupportLevel.html" title="enum in jakarta.resource.spi">TransactionSupport.TransactionSupportLevel</a></td> |
| <td class="colLast"> |
| <div class="block">An enumerated type that represents the levels of transaction support |
| a resource adapter may support.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/ApplicationServerInternalException.html" title="class in jakarta.resource.spi">ApplicationServerInternalException</a></td> |
| <td class="colLast"> |
| <div class="block">An <code>ApplicationServerInternalException</code> is thrown |
| by an application |
| server to indicate error conditions specific to an application server.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/CommException.html" title="class in jakarta.resource.spi">CommException</a></td> |
| <td class="colLast"> |
| <div class="block">This indicates errors related to failed or interrupted |
| communication with an EIS instance.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/EISSystemException.html" title="class in jakarta.resource.spi">EISSystemException</a></td> |
| <td class="colLast"> |
| <div class="block">An <code>EISSystemException</code> is used to indicate any EIS |
| specific system-level |
| error conditions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/IllegalStateException.html" title="class in jakarta.resource.spi">IllegalStateException</a></td> |
| <td class="colLast"> |
| <div class="block">An <code>IllegalStateException</code> |
| is thrown from a method if the callee (resource |
| adapter or application server for system contracts) is in an illegal or |
| inappropriate state for the method invocation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/InvalidPropertyException.html" title="class in jakarta.resource.spi">InvalidPropertyException</a></td> |
| <td class="colLast"> |
| <div class="block">This exception is thrown to indicate invalid configuration |
| property settings.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/LocalTransactionException.html" title="class in jakarta.resource.spi">LocalTransactionException</a></td> |
| <td class="colLast"> |
| <div class="block">A <code>LocalTransactionException</code> represents various |
| error conditions related to the local transaction management contract.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/ResourceAdapterInternalException.html" title="class in jakarta.resource.spi">ResourceAdapterInternalException</a></td> |
| <td class="colLast"> |
| <div class="block">A <code>ResourceAdapterInternalException</code> indicates any |
| system-level error conditions related to a resource adapter.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/ResourceAllocationException.html" title="class in jakarta.resource.spi">ResourceAllocationException</a></td> |
| <td class="colLast"> |
| <div class="block">A <code>ResourceAllocationException</code> can be thrown by an |
| application server or |
| resource adapter to indicate any failure to allocate system resources |
| (example: threads, physical connections).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/RetryableUnavailableException.html" title="class in jakarta.resource.spi">RetryableUnavailableException</a></td> |
| <td class="colLast"> |
| <div class="block">A subclass of the <code>UnavailableException</code> that |
| indicates that the rejection of the work submission is transient.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/SecurityException.html" title="class in jakarta.resource.spi">SecurityException</a></td> |
| <td class="colLast"> |
| <div class="block">A <code>SecurityException</code> indicates error conditions |
| related to the security |
| contract between an application server and resource adapter.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/SharingViolationException.html" title="class in jakarta.resource.spi">SharingViolationException</a></td> |
| <td class="colLast"> |
| <div class="block">This is thrown to indicate a connection sharing violation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/UnavailableException.html" title="class in jakarta.resource.spi">UnavailableException</a></td> |
| <td class="colLast"> |
| <div class="block">This is thrown to indicate that a service is unavailable.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation"> |
| <caption><span>Annotation Types Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Annotation Type</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/Activation.html" title="annotation in jakarta.resource.spi">Activation</a></td> |
| <td class="colLast"> |
| <div class="block">Designates a JavaBean as an <code>ActivationSpec</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/AdministeredObject.html" title="annotation in jakarta.resource.spi">AdministeredObject</a></td> |
| <td class="colLast"> |
| <div class="block">Designates a JavaBean as an administered object.Administered objects are |
| specific to a messaging style or message provider.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/AuthenticationMechanism.html" title="annotation in jakarta.resource.spi">AuthenticationMechanism</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/ConfigProperty.html" title="annotation in jakarta.resource.spi">ConfigProperty</a></td> |
| <td class="colLast"> |
| <div class="block">Designates a JavaBean property as a configuration property</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/ConnectionDefinition.html" title="annotation in jakarta.resource.spi">ConnectionDefinition</a></td> |
| <td class="colLast"> |
| <div class="block">Defines a set of connection interfaces and classes pertaining to a particular |
| connection type.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/ConnectionDefinitions.html" title="annotation in jakarta.resource.spi">ConnectionDefinitions</a></td> |
| <td class="colLast"> |
| <div class="block">Defines a set of connection definitions that the JavaBean, that has been |
| annotated with this annotation, is a part of.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/Connector.html" title="annotation in jakarta.resource.spi">Connector</a></td> |
| <td class="colLast"> |
| <div class="block">The <code>Connector</code> annotation is a component-defining annotation and |
| it can be used by the resource adapter developer to specify that the JavaBean |
| is a resource adapter JavaBean.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../jakarta/resource/spi/SecurityPermission.html" title="annotation in jakarta.resource.spi">SecurityPermission</a></td> |
| <td class="colLast"> |
| <div class="block">The SecurityPermission annotation can be used by the developer, as part of |
| the Connector annotation, to specify the extended security permissions |
| required by the resource adapter</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| <!-- ======= 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 class="navBarCell1Rev">Package</li> |
| <li>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/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../jakarta/resource/spi/endpoint/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?jakarta/resource/spi/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
