| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| |
| <meta charset="UTF-8"> |
| <title>Containers and Resources</title> |
| <meta name="description" content="Apache TomEE"> |
| <meta name="author" content="Apache TomEE"> |
| <meta name="google-translate-customization" content="f36a520c08f4c9-0a04e86a9c075ce9-g265f3196f697cf8f-10"> |
| <meta http-equiv="Pragma" content="no-cache"> |
| <meta http-equiv="Expires" content="0"> |
| <meta http-equiv="Cache-Control" content="no-store, no-cache, must-revalidate, max-age=0"> |
| |
| <!-- Le HTML5 shim, for IE6-8 support of HTML elements --> |
| <!--[if lt IE 9]> |
| <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> |
| <![endif]--> |
| |
| <!-- Le styles --> |
| <link href="./resources/css/bootstrap.css" rel="stylesheet"> |
| <link href="./resources/css/prettify.css" rel="stylesheet"> |
| <!--link href="./resources/css/bootstrap-mods.css" rel="stylesheet"--> |
| <link href="./resources/css/main.css" rel="stylesheet"> |
| <link href="./resources/font-awesome-4.6.3/css/font-awesome.min.css" rel="stylesheet"> |
| |
| <script type="text/javascript"> |
| var t = encodeURIComponent(document.title.replace(/^\s+|\s+$/g,"")); |
| var u = encodeURIComponent(""+document.URL); |
| |
| function fbshare () { |
| window.open( |
| "http://www.facebook.com/sharer/sharer.php?u="+u, |
| 'Share on Facebook', |
| 'width=640,height=426'); |
| }; |
| function gpshare () { |
| window.open( |
| "https://plus.google.com/share?url="+u, |
| 'Share on Google+', |
| 'width=584,height=385'); |
| }; |
| function twshare () { |
| window.open( |
| "https://twitter.com/intent/tweet?url="+u+"&text="+t, |
| 'Share on Twitter', |
| 'width=800,height=526'); |
| }; |
| function pinshare () { |
| window.open("//www.pinterest.com/pin/create/button/?url="+u+"&media=http%3A%2F%2Ftomee.apache.org%2Fresources%2Fimages%2Ffeather-logo.png&description="+t, |
| 'Share on Pinterest', |
| 'width=800,height=526'); |
| }; |
| </script> |
| |
| <!-- Le fav and touch icons --> |
| <link rel="shortcut icon" href="./favicon.ico"> |
| <link rel="apple-touch-icon" href="./resources/images/apple-touch-icon.png"> |
| <link rel="apple-touch-icon" sizes="72x72" href="./resources/images/apple-touch-icon-72x72.png"> |
| <link rel="apple-touch-icon" sizes="114x114" href="./resources/images/apple-touch-icon-114x114.png"> |
| |
| <script src="./resources/js/prettify.js" type="text/javascript"></script> |
| <script src="./resources/js/jquery-latest.js"></script> |
| <script src="http://platform.twitter.com/widgets.js" type="text/javascript"></script> |
| <script src="./resources/js/common.js"></script> |
| <script src="./resources/js/prettyprint.js"></script> |
| <!--script src="//assets.pinterest.com/js/pinit.js" type="text/javascript" async></script//--> |
| |
| <script type="text/javascript"> |
| |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-2717626-1']); |
| _gaq.push(['_setDomainName', 'apache.org']); |
| _gaq.push(['_trackPageview']); |
| |
| (function() { |
| var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; |
| ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); |
| })(); |
| |
| </script> |
| </head> |
| |
| <body> |
| |
| <div class="topbar" data-dropdown="dropdown"> |
| <div class="fill"> |
| <div class="container"> |
| <a class="brand" href="./index.html">Apache TomEE</a> |
| <ul class="nav"> |
| <li class="dropdown"> |
| <a class="dropdown-toggle" data-toggle="dropdown" href="#"> |
| Apache |
| <b class="caret"></b> |
| </a> |
| <ul class="dropdown-menu"> |
| <!-- <li><a href="./misc/whoweare.html">Who we are?</a></li> --> |
| <!-- <li><a href="./misc/heritage.html">Heritage</a></li> --> |
| <li><a href="http://www.apache.org">Apache Home</a></li> |
| <!-- <li><a href="./misc/resources.html">Resources</a></li> --> |
| <li><a href="./misc/contact.html">Contact</a></li> |
| <li><a href="./misc/legal.html">Legal</a></li> |
| <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li> |
| <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li> |
| <li class="divider"/> |
| <li><a href="http://www.apache.org/security">Security</a></li> |
| </ul> |
| </li> |
| <li><a href="./index.html">Home</a></li> |
| <li><a href="./downloads.html">Downloads</a></li> |
| <li><a href="./documentation.html">Documentation</a></li> |
| <li><a href="./examples-trunk/index.html">Examples</a></li> |
| <li><a href="./support.html">Support</a></li> |
| <li><a href="./contribute.html">Contribute</a></li> |
| <li><a href="./security/index.html">Security</a></li> |
| </ul> |
| |
| <!-- Google CSE Search Box Begins --> |
| <FORM class="pull-right" id="searchbox_010475492895890475512:_t4iqjrgx90" action="http://www.google.com/cse"> |
| <INPUT type="hidden" name="cx" value="010475492895890475512:_t4iqjrgx90"> |
| <INPUT type="hidden" name="cof" value="FORID:0"> |
| <INPUT size="18" width="130" style="width:130px" name="q" type="text" placeholder="Search"> |
| </FORM> |
| <!--<SCRIPT type="text/javascript" src="http://www.google.com/coop/cse/brand?form=searchbox_010475492895890475512:_t4iqjrgx90"></SCRIPT>--> |
| <!-- Google CSE Search Box Ends --> |
| </div> |
| </div> |
| </div> |
| |
| <div class="container"> |
| |
| |
| <div class="page-header"> |
| <small><a href="./index.html">Home</a></small><br> |
| <h1>Containers and Resources |
| |
| <div style="float: right; position: relative; bottom: -10px; "> |
| <a onclick="javascript:gpshare()" class="gp-share sprite" title="Share on Google+">share [gp]</a> |
| <a onclick="javascript:fbshare()" class="fb-share sprite" title="Share on Facebook">share [fb]</a> |
| <a onclick="javascript:twshare()" class="tw-share sprite" title="Share on Twitter">share [tw]</a> |
| <a onclick="javascript:pinshare()" class="pin-share sprite" title="Share on Pinterest">share [pin]</a> |
| <a data-toggle="modal" href="#edit" class="edit-page" title="Contribute to this Page">contribute</a> |
| </div> |
| </h1> |
| </div> |
| |
| <p><div id="PageContent"> |
| <p><a name="ContainersandResources-containers"></a></p></p> |
| |
| <p><a name="ContainersandResources-DefaultCMPContainercontainer"></a></p> |
| |
| <h2><a name="ContainersandResources-CMPENTITY"></a>CMP_ENTITY</h2> |
| |
| <p>Declarable in tomee.xml via</p> |
| |
| <div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent"> |
| <pre class="code-xml"><span class="code-tag"><Container id=<span class="code-quote">"Foo"</span> type=<span class="code-quote">"CMP_ENTITY"</span>></span> |
| <span class="code-tag"></Container></span> |
| </pre> |
| </div></div> |
| |
| <p>Declarable in properties via</p> |
| |
| <div style="border-width: 1px;" class="panel"><div class="panelContent"> |
| <p>Foo = new://Container?type=CMP_ENTITY</p> |
| </div></div> |
| |
| <p>Supports the following properties</p> |
| |
| <div class="table-wrap"> |
| <table class="confluenceTable"><tbody> |
| <tr> |
| <th > Property Name </th> |
| <th > Description </th> |
| </tr> |
| <tr> |
| <td > CmpEngineFactory </td> |
| <td > Default value is <em>org.apache.openejb.core.cmp.jpa.JpaCmpEngineFactory</em>.</td> |
| </tr> |
| </tbody></table> |
| </div> |
| |
| <p><a name="ContainersandResources-TransactionManager"></a></p> |
| |
| <h2><a name="ContainersandResources-TxMgr"></a>TransactionManager</h2> |
| |
| <p>Declarable in tomee.xml via</p> |
| |
| <div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent"> |
| <pre class="code-xml"><span class="code-tag"><TransactionManager type=<span class="code-quote">"javax.transaction.TransactionManager"</span>></span> |
| <span class="code-tag"></TransactionManager></span> |
| </pre> |
| </div></div> |
| |
| <p>Supports the following properties</p> |
| |
| <div class="table-wrap"> |
| <table class="confluenceTable"><tbody> |
| <tr> |
| <th > Property Name </th> |
| <th > Description </th> |
| </tr> |
| <tr> |
| <td > defaultTransactionTimeoutSeconds </td> |
| <td > Default value is <em>10 minutes</em>.</td> |
| </tr> |
| </tbody></table> |
| </div> |
| |
| <p><a name="ContainersandResources-DefaultBMPContainercontainer"></a></p> |
| |
| <h2><a name="ContainersandResources-BMPENTITY"></a>BMP_ENTITY</h2> |
| |
| <p>Declarable in tomee.xml via</p> |
| |
| <div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent"> |
| <pre class="code-xml"><span class="code-tag"><Container id=<span class="code-quote">"Foo"</span> type=<span class="code-quote">"BMP_ENTITY"</span>></span> |
| <span class="code-tag"></Container></span> |
| </pre> |
| </div></div> |
| |
| <p>Declarable in properties via</p> |
| |
| <div style="border-width: 1px;" class="panel"><div class="panelContent"> |
| <p>Foo = new://Container?type=BMP_ENTITY</p> |
| </div></div> |
| |
| <p>Supports the following properties</p> |
| |
| <div class="table-wrap"> |
| <table class="confluenceTable"><tbody> |
| <tr> |
| <th > Property Name </th> |
| <th > Description </th> |
| </tr> |
| <tr> |
| <td > PoolSize </td> |
| <td > Specifies the size of the bean pools for this<br class="atl-forced-newline"> bmp entity container.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>10</em>.</td> |
| </tr> |
| </tbody></table> |
| </div> |
| |
| <p><a name="ContainersandResources-DefaultStatelessContainercontainer"></a></p> |
| |
| <h2><a name="ContainersandResources-STATELESS"></a>STATELESS</h2> |
| |
| <p>Declarable in tomee.xml via</p> |
| |
| <div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent"> |
| <pre class="code-xml"><span class="code-tag"><Container id=<span class="code-quote">"Foo"</span> type=<span class="code-quote">"STATELESS"</span>></span> |
| <span class="code-tag"></Container></span> |
| </pre> |
| </div></div> |
| |
| <p>Declarable in properties via</p> |
| |
| <div style="border-width: 1px;" class="panel"><div class="panelContent"> |
| <p>Foo = new://Container?type=STATELESS</p> |
| </div></div> |
| |
| <p>Supports the following properties</p> |
| |
| <div class="table-wrap"> |
| <table class="confluenceTable"><tbody> |
| <tr> |
| <th > Property Name </th> |
| <th > Description </th> |
| </tr> |
| <tr> |
| <td > TimeOut </td> |
| <td > Specifies the time to wait between invocations. This<br class="atl-forced-newline"> value is measured in milliseconds. A value of 5 would<br class="atl-forced-newline"> result in a time-out of 5 milliseconds between invocations.<br class="atl-forced-newline"> A value of zero would mean no timeout.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>0</em>.</td> |
| </tr> |
| <tr> |
| <td > PoolSize </td> |
| <td > Specifies the size of the bean pools for this<br class="atl-forced-newline"> stateless SessionBean container.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>10</em>.</td> |
| </tr> |
| <tr> |
| <td > StrictPooling </td> |
| <td > StrictPooling tells the container what to do when the pool<br class="atl-forced-newline"> reaches it's maximum size and there are incoming requests<br class="atl-forced-newline"> that need instances.<br class="atl-forced-newline"> <br class="atl-forced-newline"> With strict pooling, requests will have to wait for instances<br class="atl-forced-newline"> to become available. The pool size will never grow beyond the<br class="atl-forced-newline"> the set PoolSize value.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Without strict pooling, the container will create temporary<br class="atl-forced-newline"> instances to meet demand. The instances will last for just one<br class="atl-forced-newline"> method invocation and then are removed.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>true</em>.</td> |
| </tr> |
| </tbody></table> |
| </div> |
| |
| <p><a name="ContainersandResources-DefaultStatefulContainercontainer"></a></p> |
| |
| <h2><a name="ContainersandResources-STATEFUL"></a>STATEFUL</h2> |
| |
| <p>Declarable in tomee.xml via</p> |
| |
| <div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent"> |
| <pre class="code-xml"><span class="code-tag"><Container id=<span class="code-quote">"Foo"</span> type=<span class="code-quote">"STATEFUL"</span>></span> |
| <span class="code-tag"></Container></span> |
| </pre> |
| </div></div> |
| |
| <p>Declarable in properties via</p> |
| |
| <div style="border-width: 1px;" class="panel"><div class="panelContent"> |
| <p>Foo = new://Container?type=STATEFUL</p> |
| </div></div> |
| |
| <p>Supports the following properties</p> |
| |
| <div class="table-wrap"> |
| <table class="confluenceTable"><tbody> |
| <tr> |
| <th > Property Name </th> |
| <th > Description </th> |
| </tr> |
| <tr> |
| <td > Passivator </td> |
| <td > The passivator is responsible for writing beans to disk<br class="atl-forced-newline"> at passivation time. Different passivators can be used<br class="atl-forced-newline"> by setting this property to the fully qualified class name<br class="atl-forced-newline"> of the PassivationStrategy implementation. The passivator<br class="atl-forced-newline"> is not responsible for invoking any callbacks or other<br class="atl-forced-newline"> processing, its only responsibly is to write the bean state<br class="atl-forced-newline"> to disk.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Known implementations:<br class="atl-forced-newline"> org.apache.openejb.core.stateful.RAFPassivater<br class="atl-forced-newline"> org.apache.openejb.core.stateful.SimplePassivater<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>org.apache.openejb.core.stateful.SimplePassivater</em>.</td> |
| </tr> |
| <tr> |
| <td > TimeOut </td> |
| <td > Specifies the time to wait between invocations. This<br class="atl-forced-newline"> value is measured in minutes. A value of 5 would<br class="atl-forced-newline"> result in a time-out of 5 minutes between invocations.<br class="atl-forced-newline"> A value of zero would mean no timeout.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>20</em>.</td> |
| </tr> |
| <tr> |
| <td > PoolSize </td> |
| <td > Specifies the size of the bean pools for this<br class="atl-forced-newline"> stateful SessionBean container.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>1000</em>.</td> |
| </tr> |
| <tr> |
| <td > BulkPassivate </td> |
| <td > Property name that specifies the number of instances<br class="atl-forced-newline"> to passivate at one time when doing bulk passivation.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>100</em>.</td> |
| </tr> |
| </tbody></table> |
| </div> |
| |
| <p><a name="ContainersandResources-DefaultMDBContainercontainer"></a></p> |
| |
| <h2><a name="ContainersandResources-MESSAGE"></a>MESSAGE</h2> |
| |
| <p>Declarable in tomee.xml via</p> |
| |
| <div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent"> |
| <pre class="code-xml"><span class="code-tag"><Container id=<span class="code-quote">"Foo"</span> type=<span class="code-quote">"MESSAGE"</span>></span> |
| <span class="code-tag"></Container></span> |
| </pre> |
| </div></div> |
| |
| <p>Declarable in properties via</p> |
| |
| <div style="border-width: 1px;" class="panel"><div class="panelContent"> |
| <p>Foo = new://Container?type=MESSAGE</p> |
| </div></div> |
| |
| <p>Supports the following properties</p> |
| |
| <div class="table-wrap"> |
| <table class="confluenceTable"><tbody> |
| <tr> |
| <th > Property Name </th> |
| <th > Description </th> |
| </tr> |
| <tr> |
| <td > ResourceAdapter </td> |
| <td > The resource adapter delivers messages to the container<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>Default JMS Resource Adapter</em>.</td> |
| </tr> |
| <tr> |
| <td > MessageListenerInterface </td> |
| <td > Specifies the message listener interface handled by this container<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>javax.jms.MessageListener</em>.</td> |
| </tr> |
| <tr> |
| <td > ActivationSpecClass </td> |
| <td > Specifies the activation spec class<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>org.apache.activemq.ra.ActiveMQActivationSpec</em>.</td> |
| </tr> |
| <tr> |
| <td > InstanceLimit </td> |
| <td > Specifies the maximum number of bean instances that are<br class="atl-forced-newline"> allowed to exist for each MDB deployment.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>10</em>.</td> |
| </tr> |
| </tbody></table> |
| </div> |
| |
| <p><a name="ContainersandResources-resources"></a></p> |
| |
| <h1><a name="ContainersandResources-Resources"></a>Resources</h1> |
| |
| <p><a name="ContainersandResources-DefaultJDBCDatabaseresource"></a></p> |
| |
| <h2><a name="ContainersandResources-javax.sql.DataSource"></a>javax.sql.DataSource</h2> |
| |
| <p>Declarable in tomee.xml via</p> |
| |
| <div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent"> |
| <pre class="code-xml"><span class="code-tag"><Resource id=<span class="code-quote">"Foo"</span> type=<span class="code-quote">"javax.sql.DataSource"</span>></span> |
| <span class="code-tag"></Resource></span> |
| </pre> |
| </div></div> |
| |
| <p>Declarable in properties via</p> |
| |
| <div style="border-width: 1px;" class="panel"><div class="panelContent"> |
| <p>Foo = new://Resource?type=javax.sql.DataSource</p> |
| </div></div> |
| |
| <p>Supports the following properties</p> |
| |
| <div class="table-wrap"> |
| <table class="confluenceTable"><tbody> |
| <tr> |
| <th > Property Name </th> |
| <th > Description </th> |
| </tr> |
| <tr> |
| <td > JtaManaged </td> |
| <td > Determines wether or not this data source should be JTA managed<br class="atl-forced-newline"> or user managed. If set to 'true' it will automatically be enrolled<br class="atl-forced-newline"> in any ongoing transactions. Calling begin/commit/rollback or setAutoCommit<br class="atl-forced-newline"> on the datasource or connection will not be allowed. If you need to perform<br class="atl-forced-newline"> these functions yourself, set JtaManaged to 'false'<br class="atl-forced-newline"> <br class="atl-forced-newline"> In terms of JPA persistence.xml:<br class="atl-forced-newline"> "JtaManaged=true" can be used as a 'jta-data-source'<br class="atl-forced-newline"> "JtaManaged=false" can be used as a 'non-jta-data-source'<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>true</em>.</td> |
| </tr> |
| <tr> |
| <td > JdbcDriver </td> |
| <td > Driver class name<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>org.hsqldb.jdbcDriver</em>.</td> |
| </tr> |
| <tr> |
| <td > JdbcUrl </td> |
| <td > Url for creating connections<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>jdbc:hsqldb:file:data/hsqldb/hsqldb</em>.</td> |
| </tr> |
| <tr> |
| <td > UserName </td> |
| <td > Default user name<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>sa</em>.</td> |
| </tr> |
| <tr> |
| <td > Password </td> |
| <td > Default password</td> |
| </tr> |
| <tr> |
| <td > ConnectionProperties </td> |
| <td > The connection properties that will be sent to the JDBC<br class="atl-forced-newline"> driver when establishing new connections<br class="atl-forced-newline"> <br class="atl-forced-newline"> Format of the string must be [propertyName=property;]*<br class="atl-forced-newline"> <br class="atl-forced-newline"> NOTE - The "user" and "password" properties will be passed<br class="atl-forced-newline"> explicitly, so they do not need to be included here.</td> |
| </tr> |
| <tr> |
| <td > DefaultAutoCommit </td> |
| <td > The default auto-commit state of new connections<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>true</em>.</td> |
| </tr> |
| <tr> |
| <td > DefaultReadOnly </td> |
| <td > The default read-only state of new connections<br class="atl-forced-newline"> If not set then the setReadOnly method will not be called.<br class="atl-forced-newline"> (Some drivers don't support read only mode, ex: Informix)</td> |
| </tr> |
| <tr> |
| <td > DefaultTransactionIsolation </td> |
| <td > The default TransactionIsolation state of new connections<br class="atl-forced-newline"> If not set then the setTransactionIsolation method will not<br class="atl-forced-newline"> be called. The allowed values for this property are:<br class="atl-forced-newline"> NONE<br class="atl-forced-newline"> READ_COMMITTED<br class="atl-forced-newline"> READ_UNCOMMITTED<br class="atl-forced-newline"> REPEATABLE_READ<br class="atl-forced-newline"> SERIALIZABLE<br class="atl-forced-newline"> <br class="atl-forced-newline"> Note: Most JDBC drivers do not support all isolation levels</td> |
| </tr> |
| <tr> |
| <td > InitialSize </td> |
| <td > The initial number of connections that are created when the<br class="atl-forced-newline"> pool is started<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>0</em>.</td> |
| </tr> |
| <tr> |
| <td > MaxActive </td> |
| <td > The maximum number of active connections that can be<br class="atl-forced-newline"> allocated from this pool at the same time, or a negative<br class="atl-forced-newline"> number for no limit.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>20</em>.</td> |
| </tr> |
| <tr> |
| <td > MaxIdle </td> |
| <td > The maximum number of connections that can remain idle in<br class="atl-forced-newline"> the pool, without extra ones being released, or a negative<br class="atl-forced-newline"> number for no limit.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>20</em>.</td> |
| </tr> |
| <tr> |
| <td > MinIdle </td> |
| <td > The minimum number of connections that can remain idle in<br class="atl-forced-newline"> the pool, without extra ones being created, or zero to<br class="atl-forced-newline"> create none.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>0</em>.</td> |
| </tr> |
| <tr> |
| <td > MaxWait </td> |
| <td > The maximum number of milliseconds that the pool will wait<br class="atl-forced-newline"> (when there are no available connections) for a connection<br class="atl-forced-newline"> to be returned before throwing an exception, or -1 to wait<br class="atl-forced-newline"> indefinitely.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>-1</em>.</td> |
| </tr> |
| <tr> |
| <td > ValidationQuery </td> |
| <td > The SQL query that will be used to validate connections from<br class="atl-forced-newline"> this pool before returning them to the caller. If specified,<br class="atl-forced-newline"> this query MUST be an SQL SELECT statement that returns at<br class="atl-forced-newline"> least one row.</td> |
| </tr> |
| <tr> |
| <td > TestOnBorrow </td> |
| <td > If true connections will be validated before being borrowed<br class="atl-forced-newline"> from the pool. If the validation fails, the connection is<br class="atl-forced-newline"> destroyed, and a new conection will be retrieved from the<br class="atl-forced-newline"> pool (and validated).<br class="atl-forced-newline"> <br class="atl-forced-newline"> NOTE - for a true value to have any effect, the<br class="atl-forced-newline"> ValidationQuery parameter must be set.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>true</em>.</td> |
| </tr> |
| <tr> |
| <td > TestOnReturn </td> |
| <td > If true connections will be validated before being returned<br class="atl-forced-newline"> to the pool. If the validation fails, the connection is<br class="atl-forced-newline"> destroyed instead of being returned to the pool.<br class="atl-forced-newline"> <br class="atl-forced-newline"> NOTE - for a true value to have any effect, the<br class="atl-forced-newline"> ValidationQuery parameter must be set.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>false</em>.</td> |
| </tr> |
| <tr> |
| <td > TestWhileIdle </td> |
| <td > If true connections will be validated by the idle connection<br class="atl-forced-newline"> evictor (if any). If the validation fails, the connection is<br class="atl-forced-newline"> destroyed and removed from the pool<br class="atl-forced-newline"> <br class="atl-forced-newline"> NOTE - for a true value to have any effect, the<br class="atl-forced-newline"> timeBetweenEvictionRunsMillis property must be a positive<br class="atl-forced-newline"> number and the ValidationQuery parameter must be set.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>false</em>.</td> |
| </tr> |
| <tr> |
| <td > TimeBetweenEvictionRunsMillis </td> |
| <td > The number of milliseconds to sleep between runs of the idle<br class="atl-forced-newline"> connection evictor thread. When set to a negative number, no<br class="atl-forced-newline"> idle connection evictor thread will be run.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>-1</em>.</td> |
| </tr> |
| <tr> |
| <td > NumTestsPerEvictionRun </td> |
| <td > The number of connectionss to examine during each run of the<br class="atl-forced-newline"> idle connection evictor thread (if any).<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>3</em>.</td> |
| </tr> |
| <tr> |
| <td > MinEvictableIdleTimeMillis </td> |
| <td > The minimum amount of time a connection may sit idle in the<br class="atl-forced-newline"> pool before it is eligable for eviction by the idle<br class="atl-forced-newline"> connection evictor (if any).<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>1800000</em>.</td> |
| </tr> |
| <tr> |
| <td > PoolPreparedStatements </td> |
| <td > If true, a statement pool is created for each Connection and<br class="atl-forced-newline"> PreparedStatements created by one of the following methods are<br class="atl-forced-newline"> pooled:<br class="atl-forced-newline"> public PreparedStatement prepareStatement(String sql);<br class="atl-forced-newline"> public PreparedStatement prepareStatement(String sql,<br class="atl-forced-newline"> int resultSetType,<br class="atl-forced-newline"> int resultSetConcurrency)<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>false</em>.</td> |
| </tr> |
| <tr> |
| <td > MaxOpenPreparedStatements </td> |
| <td > The maximum number of open statements that can be allocated<br class="atl-forced-newline"> from the statement pool at the same time, or zero for no<br class="atl-forced-newline"> limit.<br class="atl-forced-newline"> <br class="atl-forced-newline"> NOTE - Some drivers have limits on the number of open<br class="atl-forced-newline"> statements, so make sure there are some resources left<br class="atl-forced-newline"> for the other (non-prepared) statements.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>0</em>.</td> |
| </tr> |
| <tr> |
| <td > AccessToUnderlyingConnectionAllowed </td> |
| <td > If true the raw physical connection to the database can be<br class="atl-forced-newline"> accessed using the following construct:<br class="atl-forced-newline"> Connection conn = ds.getConnection();<br class="atl-forced-newline"> Connection rawConn = ((DelegatingConnection) conn).getInnermostDelegate();<br class="atl-forced-newline"> ...<br class="atl-forced-newline"> conn.close()<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default is false, because misbehaving programs can do harmfull<br class="atl-forced-newline"> things to the raw connection shuch as closing the raw<br class="atl-forced-newline"> connection or continuing to use the raw connection after it<br class="atl-forced-newline"> has been assigned to another logical connection. Be carefull<br class="atl-forced-newline"> and only use when you need direct access to driver specific<br class="atl-forced-newline"> extentions.<br class="atl-forced-newline"> <br class="atl-forced-newline"> NOTE: Do NOT close the underlying connection, only the<br class="atl-forced-newline"> original logical connection wrapper.<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>false</em>.</td> |
| </tr> |
| </tbody></table> |
| </div> |
| |
| <p><a name="ContainersandResources-DefaultJMSResourceAdapterresource"></a></p> |
| |
| <h2><a name="ContainersandResources-ActiveMQResourceAdapter"></a>ActiveMQResourceAdapter</h2> |
| |
| <p>Declarable in tomee.xml via</p> |
| |
| <div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent"> |
| <pre class="code-xml"><span class="code-tag"><Resource id=<span class="code-quote">"Foo"</span> type=<span class="code-quote">"ActiveMQResourceAdapter"</span>></span> |
| <span class="code-tag"></Resource></span> |
| </pre> |
| </div></div> |
| |
| <p>Declarable in properties via</p> |
| |
| <div style="border-width: 1px;" class="panel"><div class="panelContent"> |
| <p>Foo = new://Resource?type=ActiveMQResourceAdapter</p> |
| </div></div> |
| |
| <p>Supports the following properties</p> |
| |
| <div class="table-wrap"> |
| <table class="confluenceTable"><tbody> |
| <tr> |
| <th > Property Name </th> |
| <th > Description </th> |
| </tr> |
| <tr> |
| <td > BrokerXmlConfig </td> |
| <td > Broker configuration<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>broker:(tcp://localhost:61616)?useJmx=false</em>.</td> |
| </tr> |
| <tr> |
| <td > ServerUrl </td> |
| <td > Broker address<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>vm://localhost?async=true</em>.</td> |
| </tr> |
| <tr> |
| <td > DataSource </td> |
| <td > DataSource for persistence messages<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>Default Unmanaged JDBC Database</em>.</td> |
| </tr> |
| </tbody></table> |
| </div> |
| |
| <p><a name="ContainersandResources-DefaultJMSConnectionFactoryresource"></a></p> |
| |
| <h2><a name="ContainersandResources-javax.jms.ConnectionFactory"></a>javax.jms.ConnectionFactory</h2> |
| |
| <p>Declarable in tomee.xml via</p> |
| |
| <div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent"> |
| <pre class="code-xml"><span class="code-tag"><Resource id=<span class="code-quote">"Foo"</span> type=<span class="code-quote">"javax.jms.ConnectionFactory"</span>></span> |
| <span class="code-tag"></Resource></span> |
| </pre> |
| </div></div> |
| |
| <p>Declarable in properties via</p> |
| |
| <div style="border-width: 1px;" class="panel"><div class="panelContent"> |
| <p>Foo = new://Resource?type=javax.jms.ConnectionFactory</p> |
| </div></div> |
| |
| <p>Supports the following properties</p> |
| |
| <div class="table-wrap"> |
| <table class="confluenceTable"><tbody> |
| <tr> |
| <th > Property Name </th> |
| <th > Description </th> |
| </tr> |
| <tr> |
| <td > ResourceAdapter </td> |
| <td > Default value is <em>Default JMS Resource Adapter</em>.</td> |
| </tr> |
| <tr> |
| <td > TransactionSupport </td> |
| <td > Specifies if the connection is enrolled in global transaction<br class="atl-forced-newline"> allowed values: xa, local or none<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>xa</em>.</td> |
| </tr> |
| <tr> |
| <td > PoolMaxSize </td> |
| <td > Maximum number of physical connection to the ActiveMQ broker<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>10</em>.</td> |
| </tr> |
| <tr> |
| <td > PoolMinSize </td> |
| <td > Minimum number of physical connection to the ActiveMQ broker<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>0</em>.</td> |
| </tr> |
| <tr> |
| <td > ConnectionMaxWaitMilliseconds </td> |
| <td > Maximum amount of time to wait for a connection<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>5000</em>.</td> |
| </tr> |
| <tr> |
| <td > ConnectionMaxIdleMinutes </td> |
| <td > Maximum amount of time a connection can be idle before being reclaimed<br class="atl-forced-newline"> <br class="atl-forced-newline"> Default value is <em>15</em>.</td> |
| </tr> |
| </tbody></table> |
| </div> |
| |
| <p><a name="ContainersandResources-DefaultQueueresource"></a></p> |
| |
| <h2><a name="ContainersandResources-javax.jms.Queue"></a>javax.jms.Queue</h2> |
| |
| <p>Declarable in tomee.xml via</p> |
| |
| <div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent"> |
| <pre class="code-xml"><span class="code-tag"><Resource id=<span class="code-quote">"Foo"</span> type=<span class="code-quote">"javax.jms.Queue"</span>></span> |
| <span class="code-tag"></Resource></span> |
| </pre> |
| </div></div> |
| |
| <p>Declarable in properties via</p> |
| |
| <div style="border-width: 1px;" class="panel"><div class="panelContent"> |
| <p>Foo = new://Resource?type=javax.jms.Queue</p> |
| </div></div> |
| |
| <p>Supports the following properties</p> |
| |
| <div class="table-wrap"> |
| <table class="confluenceTable"><tbody> |
| <tr> |
| <th > Property Name </th> |
| <th > Description </th> |
| </tr> |
| <tr> |
| <td > destination </td> |
| <td > Specifies the name of the queue</td> |
| </tr> |
| </tbody></table> |
| </div> |
| |
| <p><a name="ContainersandResources-DefaultTopicresource"></a></p> |
| |
| <h2><a name="ContainersandResources-javax.jms.Topic"></a>javax.jms.Topic</h2> |
| |
| <p>Declarable in tomee.xml via</p> |
| |
| <div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent"> |
| <pre class="code-xml"><span class="code-tag"><Resource id=<span class="code-quote">"Foo"</span> type=<span class="code-quote">"javax.jms.Topic"</span>></span> |
| <span class="code-tag"></Resource></span> |
| </pre> |
| </div></div> |
| |
| <p>Declarable in properties via</p> |
| |
| <div style="border-width: 1px;" class="panel"><div class="panelContent"> |
| <p>Foo = new://Resource?type=javax.jms.Topic</p> |
| </div></div> |
| |
| <p>Supports the following properties</p> |
| |
| <div class="table-wrap"> |
| <table class="confluenceTable"><tbody> |
| <tr> |
| <th > Property Name </th> |
| <th > Description </th> |
| </tr> |
| <tr> |
| <td > destination </td> |
| <td > Specifies the name of the topic</td> |
| </tr> |
| </tbody></table> |
| </div> |
| |
| <p><a name="ContainersandResources-DefaultORBresource"></a></p> |
| |
| <h2><a name="ContainersandResources-org.omg.CORBA.ORB"></a>org.omg.CORBA.ORB</h2> |
| |
| <p>Declarable in tomee.xml via</p> |
| |
| <div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent"> |
| <pre class="code-xml"><span class="code-tag"><Resource id=<span class="code-quote">"Foo"</span> type=<span class="code-quote">"org.omg.CORBA.ORB"</span>></span> |
| <span class="code-tag"></Resource></span> |
| </pre> |
| </div></div> |
| |
| <p>Declarable in properties via</p> |
| |
| <div style="border-width: 1px;" class="panel"><div class="panelContent"> |
| <p>Foo = new://Resource?type=org.omg.CORBA.ORB</p> |
| </div></div> |
| |
| <p>No properties.</p> |
| |
| <p><a name="ContainersandResources-DefaultMailSessionresource"></a></p> |
| |
| <h2><a name="ContainersandResources-javax.mail.Session"></a>javax.mail.Session</h2> |
| |
| <p>Declarable in tomee.xml via</p> |
| |
| <div style="border-width: 1px;" class="code panel"><div class="codeContent panelContent"> |
| <pre class="code-xml"><span class="code-tag"><Resource id=<span class="code-quote">"Foo"</span> type=<span class="code-quote">"javax.mail.Session"</span>></span> |
| <span class="code-tag"></Resource></span> |
| </pre> |
| </div></div> |
| |
| <p>Declarable in properties via</p> |
| |
| <div style="border-width: 1px;" class="panel"><div class="panelContent"> |
| <p>Foo = new://Resource?type=javax.mail.Session</p> |
| </div></div> |
| |
| <p>No properties.</p> |
| |
| |
| |
| |
| <div id="edit" class="modal hide fade in" style="display: none; "> |
| <div class="modal-header"> |
| <a class="close" data-dismiss="modal">x</a> |
| |
| <h3>Thank you for contributing to the documentation!</h3> |
| </div> |
| <div class="modal-body"> |
| <h4>Any help with the documentation is greatly appreciated.</h4> |
| <p>All edits are reviewed before going live, so feel free to do much more than fix typos or links. If you see a page that could benefit from an entire rewrite, we'd be thrilled to review it. Don't be surprised if we like it so much we ask you for help with other pages :)</p> |
| <small>NOTICE: unless indicated otherwise on the pages in question, all editable content available from apache.org is presumed to be licensed under the Apache License (AL) version 2.0 and hence all submissions to apache.org treated as formal Contributions under the license terms.</small> |
| <!--[if gt IE 6]> |
| <h4>Internet Explorer Users</h4> |
| <p>If you are not an Apache committer, click the Yes link and enter a <i>anonymous</i> for the username and leave the password empty</p> |
| <![endif]--> |
| |
| </div> |
| <div class="modal-footer"> |
| Do you have an Apache ID? |
| <a href="javascript:void(location.href='https://cms.apache.org/redirect?uri='+escape(location.href))" class="btn">Yes</a> |
| <a href="javascript:void(location.href='https://anonymous:@cms.apache.org/redirect?uri='+escape(location.href))" class="btn">No</a> |
| </div> |
| </div> |
| <script src="./resources/js/bootstrap-modal.js"></script> |
| |
| <footer> |
| <p>Copyright © 1999-2016 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. |
| Apache TomEE, TomEE, Apache, the Apache feather logo, and the Apache TomEE project logo are trademarks of The Apache Software Foundation. |
| All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p> |
| </footer> |
| |
| </div> <!-- /container --> |
| |
| <!-- Javascript |
| ================================================== --> |
| <!-- Placed at the end of the document so the pages load faster --> |
| <script src="./resources/js/bootstrap-dropdown.js"></script> |
| |
| </body> |
| </html> |
