Google Git
Sign in
apache / tomee-site-pub / 476cf231b77b83a25b4407df84b6a5fd7c0d673a / . / jakartaee-10.0 / javadoc / jakarta / resource / spi / Connector.html
blob: e056770d45537885716e087b54e2276bb95919df [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>
<title>Connector</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<link rel="shortcut icon" href="/img/jakarta-favicon.ico">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Connector";
}
}
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><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/spi/ConnectionRequestInfo.html" title="interface in jakarta.resource.spi"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/resource/spi/DissociatableManagedConnection.html" title="interface in jakarta.resource.spi"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jakarta/resource/spi/Connector.html" target="_top">Frames</a></li>
<li><a href="Connector.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.element.detail">Element</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.spi</div>
<h2 title="Annotation Type Connector" class="title">Annotation Type Connector</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>@Documented
@Retention(value=RUNTIME)
@Target(value=TYPE)
public @interface <span class="memberNameLabel">Connector</span></pre>
<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. The Connector annotation is applied to the
JavaBean class.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6</dd>
<dt><span class="simpleTagLabel">Examples (en):</span></dt>
<dd><a href="../../../../../../tomee-9.0/examples/connector-war.html">connector-war</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.optional.element.summary">
<!-- -->
</a>
<h3>Optional Element Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Optional Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../jakarta/resource/spi/AuthenticationMechanism.html" title="annotation in jakarta.resource.spi">AuthenticationMechanism</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/spi/Connector.html#authMechanisms--">authMechanisms</a></span></code>
<div class="block">Specifies the authentication mechanisms supported by the resource
adapter.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/spi/Connector.html#description--">description</a></span></code>
<div class="block">Describes the resource adapter module.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/spi/Connector.html#displayName--">displayName</a></span></code>
<div class="block">An optional short name, providing information about the
resource adapter module, that is intended to be displayed
by tools.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/spi/Connector.html#eisType--">eisType</a></span></code>
<div class="block">Contains information about the type of EIS.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/spi/Connector.html#largeIcon--">largeIcon</a></span></code>
<div class="block">Specifies the file name for large GIF or JPEG icon images that are
used to represent the resource adapter in a GUI tool.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/spi/Connector.html#licenseDescription--">licenseDescription</a></span></code>
<div class="block">Specifies licensing requirements for the resource adapter module and an
optional description of the licensing terms.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/spi/Connector.html#licenseRequired--">licenseRequired</a></span></code>
<div class="block">Specifies whether a license is required to deploy and use this resource
adapter</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/spi/Connector.html#reauthenticationSupport--">reauthenticationSupport</a></span></code>
<div class="block">Specifies whether reauthentication is supported</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Class&lt;? extends <a href="../../../jakarta/resource/spi/work/WorkContext.html" title="interface in jakarta.resource.spi.work">WorkContext</a>&gt;[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/spi/Connector.html#requiredWorkContexts--">requiredWorkContexts</a></span></code>
<div class="block">Specifies a list of fully qualified classes that implements the
<a href="../../../jakarta/resource/spi/work/WorkContext.html" title="interface in jakarta.resource.spi.work"><code>WorkContext</code></a> interface that a resource adapter
requires the application server to support.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../jakarta/resource/spi/SecurityPermission.html" title="annotation in jakarta.resource.spi">SecurityPermission</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/spi/Connector.html#securityPermissions--">securityPermissions</a></span></code>
<div class="block">Specifies the extended security permissions required to be provided for
the operation of the resource adapter module</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/spi/Connector.html#smallIcon--">smallIcon</a></span></code>
<div class="block">Specifies the file name for small GIF or JPEG icon images that are
used to represent the resource adapter in a GUI tool.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../jakarta/resource/spi/TransactionSupport.TransactionSupportLevel.html" title="enum in jakarta.resource.spi">TransactionSupport.TransactionSupportLevel</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/spi/Connector.html#transactionSupport--">transactionSupport</a></span></code>
<div class="block">Specifies the level of transaction support provided by the resource
adapter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/spi/Connector.html#vendorName--">vendorName</a></span></code>
<div class="block">Specifies the name of the resource adapter provider vendor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/resource/spi/Connector.html#version--">version</a></span></code>
<div class="block">Specifies the version of the resource adapter implementation.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation.type.element.detail">
<!-- -->
</a>
<h3>Element Detail</h3>
<a name="description--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>description</h4>
<pre>public abstract&nbsp;java.lang.String[]&nbsp;description</pre>
<div class="block">Describes the resource adapter module.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>description</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="displayName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>displayName</h4>
<pre>public abstract&nbsp;java.lang.String[]&nbsp;displayName</pre>
<div class="block">An optional short name, providing information about the
resource adapter module, that is intended to be displayed
by tools.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>display name</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="smallIcon--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>smallIcon</h4>
<pre>public abstract&nbsp;java.lang.String[]&nbsp;smallIcon</pre>
<div class="block">Specifies the file name for small GIF or JPEG icon images that are
used to represent the resource adapter in a GUI tool.
Each smallIcon must be associated with a largeIcon element and the
application server must use the ordinal value in their respective
arrays to find the related pairs of icons.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>small icon file name</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="largeIcon--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>largeIcon</h4>
<pre>public abstract&nbsp;java.lang.String[]&nbsp;largeIcon</pre>
<div class="block">Specifies the file name for large GIF or JPEG icon images that are
used to represent the resource adapter in a GUI tool.
Each smallIcon must be associated with a largeIcon element and
the application server must use the ordinal value in their
respective arrays to find the related pairs of icons.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>large icon file name</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="vendorName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>vendorName</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;vendorName</pre>
<div class="block">Specifies the name of the resource adapter provider vendor.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>vendor name</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="eisType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>eisType</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;eisType</pre>
<div class="block">Contains information about the type of EIS. For example, the type of an
EIS can be product name of the EIS independent of any version info.This
helps in identifying EIS instances that can be used with this resource
adapter.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>type of EIS</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="version--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>version</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;version</pre>
<div class="block">Specifies the version of the resource adapter implementation.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>resource adapter version</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>""</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="licenseDescription--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>licenseDescription</h4>
<pre>public abstract&nbsp;java.lang.String[]&nbsp;licenseDescription</pre>
<div class="block">Specifies licensing requirements for the resource adapter module and an
optional description of the licensing terms.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>licensing requirements</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="licenseRequired--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>licenseRequired</h4>
<pre>public abstract&nbsp;boolean&nbsp;licenseRequired</pre>
<div class="block">Specifies whether a license is required to deploy and use this resource
adapter</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if licensed required</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="authMechanisms--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>authMechanisms</h4>
<pre>public abstract&nbsp;<a href="../../../jakarta/resource/spi/AuthenticationMechanism.html" title="annotation in jakarta.resource.spi">AuthenticationMechanism</a>[]&nbsp;authMechanisms</pre>
<div class="block">Specifies the authentication mechanisms supported by the resource
adapter.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Supported Authentication Mechanisms</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../jakarta/resource/spi/AuthenticationMechanism.html" title="annotation in jakarta.resource.spi"><code>AuthenticationMechanism</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="reauthenticationSupport--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reauthenticationSupport</h4>
<pre>public abstract&nbsp;boolean&nbsp;reauthenticationSupport</pre>
<div class="block">Specifies whether reauthentication is supported</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if reauthentication is supported</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>false</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="securityPermissions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>securityPermissions</h4>
<pre>public abstract&nbsp;<a href="../../../jakarta/resource/spi/SecurityPermission.html" title="annotation in jakarta.resource.spi">SecurityPermission</a>[]&nbsp;securityPermissions</pre>
<div class="block">Specifies the extended security permissions required to be provided for
the operation of the resource adapter module</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the extended security permissions</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../jakarta/resource/spi/SecurityPermission.html" title="annotation in jakarta.resource.spi"><code>SecurityPermission</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="transactionSupport--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>transactionSupport</h4>
<pre>public abstract&nbsp;<a href="../../../jakarta/resource/spi/TransactionSupport.TransactionSupportLevel.html" title="enum in jakarta.resource.spi">TransactionSupport.TransactionSupportLevel</a>&nbsp;transactionSupport</pre>
<div class="block">Specifies the level of transaction support provided by the resource
adapter.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>level of transaction support</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../jakarta/resource/spi/TransactionSupport.TransactionSupportLevel.html" title="enum in jakarta.resource.spi"><code>TransactionSupport.TransactionSupportLevel</code></a></dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>jakarta.resource.spi.TransactionSupport.TransactionSupportLevel.NoTransaction</dd>
</dl>
</li>
</ul>
</li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="requiredWorkContexts--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>requiredWorkContexts</h4>
<pre>public abstract&nbsp;java.lang.Class&lt;? extends <a href="../../../jakarta/resource/spi/work/WorkContext.html" title="interface in jakarta.resource.spi.work">WorkContext</a>&gt;[]&nbsp;requiredWorkContexts</pre>
<div class="block">Specifies a list of fully qualified classes that implements the
<a href="../../../jakarta/resource/spi/work/WorkContext.html" title="interface in jakarta.resource.spi.work"><code>WorkContext</code></a> interface that a resource adapter
requires the application server to support.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of class names that implement the work context interface</dd>
</dl>
<dl>
<dt>Default:</dt>
<dd>{}</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/spi/ConnectionRequestInfo.html" title="interface in jakarta.resource.spi"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/resource/spi/DissociatableManagedConnection.html" title="interface in jakarta.resource.spi"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jakarta/resource/spi/Connector.html" target="_top">Frames</a></li>
<li><a href="Connector.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#annotation.type.element.detail">Element</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>