jakartaee-9.0/javadoc/jakarta/jms/JMSConnectionFactoryDefinition.html - tomee-site-pub - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!-- NewPage -->
 <html lang="en">
 <head>
 <title>JMSConnectionFactoryDefinition</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="JMSConnectionFactoryDefinition";
         }
     }
     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/jms/JMSConnectionFactory.html" title="annotation in jakarta.jms"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../jakarta/jms/JMSConnectionFactoryDefinitions.html" title="annotation in jakarta.jms"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../index.html?jakarta/jms/JMSConnectionFactoryDefinition.html" target="_top">Frames</a></li>
 <li><a href="JMSConnectionFactoryDefinition.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><a href="#annotation.type.required.element.summary">Required</a>&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.jms</div>
 <h2 title="Annotation Type JMSConnectionFactoryDefinition" class="title">Annotation Type JMSConnectionFactoryDefinition</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <hr>
 <br>
 <pre>@Target(value=TYPE)
  @Retention(value=RUNTIME)
 public @interface <span class="memberNameLabel">JMSConnectionFactoryDefinition</span></pre>
 <div class="block">An application may use this annotation to specify a Jakarta Messaging <code>ConnectionFactory</code> resource that it requires in its operational environment. This provides information that can be
  used at the application's deployment to provision the required resource and allows an application to be deployed into
  a Jakarta EE environment with more minimal administrative configuration.
  <p>
  The <code>ConnectionFactory</code> resource may be configured by setting the annotation elements for commonly used
  properties. Additional properties may be specified using the <code>properties</code> element. Once defined, a
  <code>ConnectionFactory</code> resource may be referenced by a component in the same way as any other
  <code>ConnectionFactory</code> resource, for example by using the <code>lookup</code> element of the <code>Resource</code>
  annotation.</div>
 <dl>
 <dt><span class="simpleTagLabel">Since:</span></dt>
 <dd>JMS 2.0</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../jakarta/annotation/Resource.html" title="annotation in jakarta.annotation"><code>Resource</code></a></dd>
 </dl>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="annotation.type.required.element.summary">
 <!--   -->
 </a>
 <h3>Required Element Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation">
 <caption><span>Required Elements</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Required Element and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/jms/JMSConnectionFactoryDefinition.html#name--">name</a></span></code>
 <div class="block">JNDI name of the Jakarta Messaging connection factory being defined.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 <!-- =========== 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>java.lang.String</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/jms/JMSConnectionFactoryDefinition.html#className--">className</a></span></code>
 <div class="block">Fully-qualified name of the Jakarta Messaging connection factory implementation class.</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/jms/JMSConnectionFactoryDefinition.html#clientId--">clientId</a></span></code>
 <div class="block">Client id to use for connection.</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/jms/JMSConnectionFactoryDefinition.html#description--">description</a></span></code>
 <div class="block">Description of this Jakarta Messaging connection factory.</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/jms/JMSConnectionFactoryDefinition.html#interfaceName--">interfaceName</a></span></code>
 <div class="block">Fully qualified name of the Jakarta Messaging connection factory interface.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/jms/JMSConnectionFactoryDefinition.html#maxPoolSize--">maxPoolSize</a></span></code>
 <div class="block">Maximum number of connections that should be concurrently allocated for a connection pool.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/jms/JMSConnectionFactoryDefinition.html#minPoolSize--">minPoolSize</a></span></code>
 <div class="block">Minimum number of connections that should be concurrently allocated for a connection pool.</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/jms/JMSConnectionFactoryDefinition.html#password--">password</a></span></code>
 <div class="block">Password to use for connection authentication.</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/jms/JMSConnectionFactoryDefinition.html#properties--">properties</a></span></code>
 <div class="block">Jakarta Messaging connection factory property.</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/jms/JMSConnectionFactoryDefinition.html#resourceAdapter--">resourceAdapter</a></span></code>
 <div class="block">Resource adapter name.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/jms/JMSConnectionFactoryDefinition.html#transactional--">transactional</a></span></code>
 <div class="block">Set to <code>false</code> if connections should not participate in transactions.</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/jms/JMSConnectionFactoryDefinition.html#user--">user</a></span></code>
 <div class="block">User name to use for connection authentication.</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="name--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>name</h4>
 <pre>public abstract&nbsp;java.lang.String&nbsp;name</pre>
 <div class="block">JNDI name of the Jakarta Messaging connection factory being defined.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The JNDI name of the Jakarta Messaging connection factory being defined.</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
 <ul class="blockList">
 <li class="blockList"><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">Description of this Jakarta Messaging connection factory.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The description of this Jakarta Messaging connection factory.</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="interfaceName--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>interfaceName</h4>
 <pre>public abstract&nbsp;java.lang.String&nbsp;interfaceName</pre>
 <div class="block">Fully qualified name of the Jakarta Messaging connection factory interface. Permitted values are
  <code>jakarta.jms.ConnectionFactory</code> or <code>jakarta.jms.QueueConnectionFactory</code> or
  <code>jakarta.jms.TopicConnectionFactory</code>. If not specified then <code>jakarta.jms.ConnectionFactory</code> will be used.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The fully qualified name of the Jakarta Messaging connection factory interface.</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>"jakarta.jms.ConnectionFactory"</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="className--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>className</h4>
 <pre>public abstract&nbsp;java.lang.String&nbsp;className</pre>
 <div class="block">Fully-qualified name of the Jakarta Messaging connection factory implementation class. Ignored if a resource adapter is used.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The fully-qualified name of the Jakarta Messaging connection factory implementation class.</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="resourceAdapter--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>resourceAdapter</h4>
 <pre>public abstract&nbsp;java.lang.String&nbsp;resourceAdapter</pre>
 <div class="block">Resource adapter name. If not specified then the application server will define the default behaviour, which may or
  may not involve the use of a resource adapter.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The resource adapter name.</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="user--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>user</h4>
 <pre>public abstract&nbsp;java.lang.String&nbsp;user</pre>
 <div class="block">User name to use for connection authentication.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The user name to use for connection authentication.</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="password--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>password</h4>
 <pre>public abstract&nbsp;java.lang.String&nbsp;password</pre>
 <div class="block">Password to use for connection authentication.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The password to use for connection authentication.</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="clientId--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>clientId</h4>
 <pre>public abstract&nbsp;java.lang.String&nbsp;clientId</pre>
 <div class="block">Client id to use for connection.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The client id to use for connection.</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>""</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="properties--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>properties</h4>
 <pre>public abstract&nbsp;java.lang.String[]&nbsp;properties</pre>
 <div class="block">Jakarta Messaging connection factory property. This may be a vendor-specific property or a less commonly used
  <code>ConnectionFactory</code> property.

  <p>
  Properties are specified using the format: <i>propertyName=propertyValue</i> with one property per array element.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The Jakarta Messaging connection factory property.</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>{}</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="transactional--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>transactional</h4>
 <pre>public abstract&nbsp;boolean&nbsp;transactional</pre>
 <div class="block">Set to <code>false</code> if connections should not participate in transactions.

  <p>
  Default is to enlist in a transaction when one is active or becomes active.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>Whether connections should participate in transactions.</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>true</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="maxPoolSize--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>maxPoolSize</h4>
 <pre>public abstract&nbsp;int&nbsp;maxPoolSize</pre>
 <div class="block">Maximum number of connections that should be concurrently allocated for a connection pool.

  <p>
  Default is vendor-specific.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The maximum number of connections that should be concurrently allocated for a connection pool.</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>-1</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="minPoolSize--">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>minPoolSize</h4>
 <pre>public abstract&nbsp;int&nbsp;minPoolSize</pre>
 <div class="block">Minimum number of connections that should be concurrently allocated for a connection pool.

  <p>
  Default is vendor-specific.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The minimum number of connections that should be concurrently allocated for a connection pool.</dd>
 </dl>
 <dl>
 <dt>Default:</dt>
 <dd>-1</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/jms/JMSConnectionFactory.html" title="annotation in jakarta.jms"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../jakarta/jms/JMSConnectionFactoryDefinitions.html" title="annotation in jakarta.jms"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../index.html?jakarta/jms/JMSConnectionFactoryDefinition.html" target="_top">Frames</a></li>
 <li><a href="JMSConnectionFactoryDefinition.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><a href="#annotation.type.required.element.summary">Required</a>&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>
	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
	<!-- NewPage -->
	<html lang="en">
	<head>
	<title>JMSConnectionFactoryDefinition</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="JMSConnectionFactoryDefinition";
	}
	}
	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/jms/JMSConnectionFactory.html" title="annotation in jakarta.jms"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../jakarta/jms/JMSConnectionFactoryDefinitions.html" title="annotation in jakarta.jms"><span class="typeNameLink">Next Class</span></a></li>
	</ul>
	<ul class="navList">
	<li><a href="../../index.html?jakarta/jms/JMSConnectionFactoryDefinition.html" target="_top">Frames</a></li>
	<li><a href="JMSConnectionFactoryDefinition.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>Field \| </li>
	<li><a href="#annotation.type.required.element.summary">Required</a> \| </li>
	<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </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.jms</div>
	<h2 title="Annotation Type JMSConnectionFactoryDefinition" class="title">Annotation Type JMSConnectionFactoryDefinition</h2>
	</div>
	<div class="contentContainer">
	<div class="description">
	<ul class="blockList">
	<li class="blockList">
	<hr>
	<br>
	<pre>@Target(value=TYPE)
	@Retention(value=RUNTIME)
	public @interface <span class="memberNameLabel">JMSConnectionFactoryDefinition</span></pre>
	<div class="block">An application may use this annotation to specify a Jakarta Messaging <code>ConnectionFactory</code> resource that it requires in its operational environment. This provides information that can be
	used at the application's deployment to provision the required resource and allows an application to be deployed into
	a Jakarta EE environment with more minimal administrative configuration.
	<p>
	The <code>ConnectionFactory</code> resource may be configured by setting the annotation elements for commonly used
	properties. Additional properties may be specified using the <code>properties</code> element. Once defined, a
	<code>ConnectionFactory</code> resource may be referenced by a component in the same way as any other
	<code>ConnectionFactory</code> resource, for example by using the <code>lookup</code> element of the <code>Resource</code>
	annotation.</div>
	<dl>
	<dt><span class="simpleTagLabel">Since:</span></dt>
	<dd>JMS 2.0</dd>
	<dt><span class="seeLabel">See Also:</span></dt>
	<dd><a href="../../jakarta/annotation/Resource.html" title="annotation in jakarta.annotation"><code>Resource</code></a></dd>
	</dl>
	</li>
	</ul>
	</div>
	<div class="summary">
	<ul class="blockList">
	<li class="blockList">
	<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== -->
	<ul class="blockList">
	<li class="blockList"><a name="annotation.type.required.element.summary">
	<!-- -->
	</a>
	<h3>Required Element Summary</h3>
	<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation">
	<caption><span>Required Elements</span><span class="tabEnd"> </span></caption>
	<tr>
	<th class="colFirst" scope="col">Modifier and Type</th>
	<th class="colLast" scope="col">Required Element and Description</th>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code>java.lang.String</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/jms/JMSConnectionFactoryDefinition.html#name--">name</a></span></code>
	<div class="block">JNDI name of the Jakarta Messaging connection factory being defined.</div>
	</td>
	</tr>
	</table>
	</li>
	</ul>
	<!-- =========== 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"> </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>java.lang.String</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/jms/JMSConnectionFactoryDefinition.html#className--">className</a></span></code>
	<div class="block">Fully-qualified name of the Jakarta Messaging connection factory implementation class.</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/jms/JMSConnectionFactoryDefinition.html#clientId--">clientId</a></span></code>
	<div class="block">Client id to use for connection.</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/jms/JMSConnectionFactoryDefinition.html#description--">description</a></span></code>
	<div class="block">Description of this Jakarta Messaging connection factory.</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/jms/JMSConnectionFactoryDefinition.html#interfaceName--">interfaceName</a></span></code>
	<div class="block">Fully qualified name of the Jakarta Messaging connection factory interface.</div>
	</td>
	</tr>
	<tr class="altColor">
	<td class="colFirst"><code>int</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/jms/JMSConnectionFactoryDefinition.html#maxPoolSize--">maxPoolSize</a></span></code>
	<div class="block">Maximum number of connections that should be concurrently allocated for a connection pool.</div>
	</td>
	</tr>
	<tr class="rowColor">
	<td class="colFirst"><code>int</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/jms/JMSConnectionFactoryDefinition.html#minPoolSize--">minPoolSize</a></span></code>
	<div class="block">Minimum number of connections that should be concurrently allocated for a connection pool.</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/jms/JMSConnectionFactoryDefinition.html#password--">password</a></span></code>
	<div class="block">Password to use for connection authentication.</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/jms/JMSConnectionFactoryDefinition.html#properties--">properties</a></span></code>
	<div class="block">Jakarta Messaging connection factory property.</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/jms/JMSConnectionFactoryDefinition.html#resourceAdapter--">resourceAdapter</a></span></code>
	<div class="block">Resource adapter name.</div>
	</td>
	</tr>
	<tr class="rowColor">
	<td class="colFirst"><code>boolean</code></td>
	<td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/jms/JMSConnectionFactoryDefinition.html#transactional--">transactional</a></span></code>
	<div class="block">Set to <code>false</code> if connections should not participate in transactions.</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/jms/JMSConnectionFactoryDefinition.html#user--">user</a></span></code>
	<div class="block">User name to use for connection authentication.</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="name--">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>name</h4>
	<pre>public abstract java.lang.String name</pre>
	<div class="block">JNDI name of the Jakarta Messaging connection factory being defined.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>The JNDI name of the Jakarta Messaging connection factory being defined.</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
	<ul class="blockList">
	<li class="blockList"><a name="description--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>description</h4>
	<pre>public abstract java.lang.String description</pre>
	<div class="block">Description of this Jakarta Messaging connection factory.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>The description of this Jakarta Messaging connection factory.</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>""</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="interfaceName--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>interfaceName</h4>
	<pre>public abstract java.lang.String interfaceName</pre>
	<div class="block">Fully qualified name of the Jakarta Messaging connection factory interface. Permitted values are
	<code>jakarta.jms.ConnectionFactory</code> or <code>jakarta.jms.QueueConnectionFactory</code> or
	<code>jakarta.jms.TopicConnectionFactory</code>. If not specified then <code>jakarta.jms.ConnectionFactory</code> will be used.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>The fully qualified name of the Jakarta Messaging connection factory interface.</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>"jakarta.jms.ConnectionFactory"</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="className--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>className</h4>
	<pre>public abstract java.lang.String className</pre>
	<div class="block">Fully-qualified name of the Jakarta Messaging connection factory implementation class. Ignored if a resource adapter is used.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>The fully-qualified name of the Jakarta Messaging connection factory implementation class.</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>""</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="resourceAdapter--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>resourceAdapter</h4>
	<pre>public abstract java.lang.String resourceAdapter</pre>
	<div class="block">Resource adapter name. If not specified then the application server will define the default behaviour, which may or
	may not involve the use of a resource adapter.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>The resource adapter name.</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>""</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="user--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>user</h4>
	<pre>public abstract java.lang.String user</pre>
	<div class="block">User name to use for connection authentication.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>The user name to use for connection authentication.</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>""</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="password--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>password</h4>
	<pre>public abstract java.lang.String password</pre>
	<div class="block">Password to use for connection authentication.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>The password to use for connection authentication.</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>""</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="clientId--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>clientId</h4>
	<pre>public abstract java.lang.String clientId</pre>
	<div class="block">Client id to use for connection.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>The client id to use for connection.</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>""</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="properties--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>properties</h4>
	<pre>public abstract java.lang.String[] properties</pre>
	<div class="block">Jakarta Messaging connection factory property. This may be a vendor-specific property or a less commonly used
	<code>ConnectionFactory</code> property.

	<p>
	Properties are specified using the format: <i>propertyName=propertyValue</i> with one property per array element.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>The Jakarta Messaging connection factory property.</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>{}</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="transactional--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>transactional</h4>
	<pre>public abstract boolean transactional</pre>
	<div class="block">Set to <code>false</code> if connections should not participate in transactions.

	<p>
	Default is to enlist in a transaction when one is active or becomes active.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>Whether connections should participate in transactions.</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>true</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="maxPoolSize--">
	<!-- -->
	</a>
	<ul class="blockList">
	<li class="blockList">
	<h4>maxPoolSize</h4>
	<pre>public abstract int maxPoolSize</pre>
	<div class="block">Maximum number of connections that should be concurrently allocated for a connection pool.

	<p>
	Default is vendor-specific.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>The maximum number of connections that should be concurrently allocated for a connection pool.</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>-1</dd>
	</dl>
	</li>
	</ul>
	</li>
	</ul>
	<ul class="blockList">
	<li class="blockList"><a name="minPoolSize--">
	<!-- -->
	</a>
	<ul class="blockListLast">
	<li class="blockList">
	<h4>minPoolSize</h4>
	<pre>public abstract int minPoolSize</pre>
	<div class="block">Minimum number of connections that should be concurrently allocated for a connection pool.

	<p>
	Default is vendor-specific.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>The minimum number of connections that should be concurrently allocated for a connection pool.</dd>
	</dl>
	<dl>
	<dt>Default:</dt>
	<dd>-1</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/jms/JMSConnectionFactory.html" title="annotation in jakarta.jms"><span class="typeNameLink">Prev Class</span></a></li>
	<li><a href="../../jakarta/jms/JMSConnectionFactoryDefinitions.html" title="annotation in jakarta.jms"><span class="typeNameLink">Next Class</span></a></li>
	</ul>
	<ul class="navList">
	<li><a href="../../index.html?jakarta/jms/JMSConnectionFactoryDefinition.html" target="_top">Frames</a></li>
	<li><a href="JMSConnectionFactoryDefinition.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>Field \| </li>
	<li><a href="#annotation.type.required.element.summary">Required</a> \| </li>
	<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </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>