You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tomee.apache.org by db...@apache.org on 2018/12/02 00:12:51 UTC
svn commit: r1847931 [9/22] - in /tomee/site/trunk/content:
latest/docs/admin/cluster/ latest/docs/admin/configuration/
latest/docs/advanced/applicationcomposer/ latest/docs/advanced/client/
latest/docs/advanced/jms/ latest/docs/advanced/setup/ latest/...
Added: tomee/site/trunk/content/master/docs/admin/configuration/containers.html
URL: http://svn.apache.org/viewvc/tomee/site/trunk/content/master/docs/admin/configuration/containers.html?rev=1847931&view=auto
==============================================================================
--- tomee/site/trunk/content/master/docs/admin/configuration/containers.html (added)
+++ tomee/site/trunk/content/master/docs/admin/configuration/containers.html Sun Dec 2 00:12:50 2018
@@ -0,0 +1,903 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+ <meta charset="UTF-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+ <title>Apache TomEE</title>
+ <meta name="description"
+ content="Apache TomEE is a lightweight, yet powerful, JavaEE Application server with feature rich tooling." />
+ <meta name="keywords" content="tomee,asf,apache,javaee,jee,shade,embedded,test,junit,applicationcomposer,maven,arquillian" />
+ <meta name="author" content="Luka Cvetinovic for Codrops" />
+ <link rel="icon" href="../../../../favicon.ico">
+ <link rel="icon" type="image/png" href="../../../../favicon.png">
+ <meta name="msapplication-TileColor" content="#80287a">
+ <meta name="theme-color" content="#80287a">
+ <link rel="stylesheet" type="text/css" href="../../../../css/normalize.css">
+ <link rel="stylesheet" type="text/css" href="../../../../css/bootstrap.css">
+ <link rel="stylesheet" type="text/css" href="../../../../css/owl.css">
+ <link rel="stylesheet" type="text/css" href="../../../../css/animate.css">
+ <link rel="stylesheet" type="text/css" href="../../../../fonts/font-awesome-4.1.0/css/font-awesome.min.css">
+ <link rel="stylesheet" type="text/css" href="../../../../fonts/eleganticons/et-icons.css">
+ <link rel="stylesheet" type="text/css" href="../../../../css/jqtree.css">
+ <link rel="stylesheet" type="text/css" href="../../../../css/idea.css">
+ <link rel="stylesheet" type="text/css" href="../../../../css/cardio.css">
+
+ <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="preloader">
+ <img src="../../../../img/loader.gif" alt="Preloader image">
+ </div>
+ <nav class="navbar">
+ <div class="container">
+ <div class="row"> <div class="col-md-12">
+
+ <!-- Brand and toggle get grouped for better mobile display -->
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="navbar-brand" href="/">
+ <span>
+
+
+ <img src="../../../../img/logo-active.png">
+
+
+ </span>
+ Apache TomEE
+ </a>
+ </div>
+ <!-- Collect the nav links, forms, and other content for toggling -->
+ <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
+ <ul class="nav navbar-nav navbar-right main-nav">
+ <li><a href="../../../../docs.html">Documentation</a></li>
+ <li><a href="../../../../community/index.html">Community</a></li>
+ <li><a href="../../../../security/index.html">Security</a></li>
+ <li><a href="../../../../download-ng.html">Downloads</a></li>
+ </ul>
+ </div>
+ <!-- /.navbar-collapse -->
+ </div></div>
+ </div>
+ <!-- /.container-fluid -->
+ </nav>
+
+
+ <div id="main-block" class="container section-padded">
+ <div class="row title">
+ <div class="col-md-12">
+ <div class='page-header'>
+
+ <div class='btn-toolbar pull-right' style="z-index: 2000;">
+ <div class='btn-group'>
+ <a class="btn" href="../../../../master/docs/admin/configuration/containers.pdf"><i class="fa fa-file-pdf-o"></i> Download as PDF</a>
+ </div>
+ </div>
+
+ <h1>Resources</h1>
+ </div>
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-12">
+ <div id="preamble">
+<div class="sectionbody">
+<div class="paragraph">
+<p>All containers will be created automatically - which means you don’t need to define them
+if you don’t need to tune their configuration - when a bean of their type if found.</p>
+</div>
+<div class="paragraph">
+<p>To avoid that use <code>openejb.offline</code> property and set it to <code>true</code>. See <a href="server.html">Server Configuration</a> for more detail.</p>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="__stateless">@Stateless</h3>
+<div class="paragraph">
+<p>A <code>@Stateless</code> container.</p>
+</div>
+<div class="paragraph">
+<p>Declarable in tomee.xml via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-xml" data-lang="xml"><Container id="Foo" type="STATELESS">
+ AccessTimeout = 30 seconds
+ MaxSize = 10
+ MinSize = 0
+ StrictPooling = true
+ MaxAge = 0 hours
+ ReplaceAged = true
+ ReplaceFlushed = false
+ MaxAgeOffset = -1
+ IdleTimeout = 0 minutes
+ GarbageCollection = false
+ SweepInterval = 5 minutes
+ CallbackThreads = 5
+ CloseTimeout = 5 minutes
+ UseOneSchedulerThreadByBean = false
+ EvictionThreads = 1
+</Container></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Declarable in properties via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">Foo = new://Container?type=STATELESS
+Foo.AccessTimeout = 30 seconds
+Foo.MaxSize = 10
+Foo.MinSize = 0
+Foo.StrictPooling = true
+Foo.MaxAge = 0 hours
+Foo.ReplaceAged = true
+Foo.ReplaceFlushed = false
+Foo.MaxAgeOffset = -1
+Foo.IdleTimeout = 0 minutes
+Foo.GarbageCollection = false
+Foo.SweepInterval = 5 minutes
+Foo.CallbackThreads = 5
+Foo.CloseTimeout = 5 minutes
+Foo.UseOneSchedulerThreadByBean = false
+Foo.EvictionThreads = 1</code></pre>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_configuration">Configuration</h4>
+<div class="sect4">
+<h5 id="_accesstimeout">AccessTimeout</h5>
+<div class="paragraph">
+<p>Specifies the time an invokation should wait for an instance
+of the pool to become available.</p>
+</div>
+<div class="paragraph">
+<p>After the timeout is reached, if an instance in the pool cannot
+be obtained, the method invocation will fail.</p>
+</div>
+<div class="paragraph">
+<p>Usable time units: nanoseconds, microsecons, milliseconds,
+seconds, minutes, hours, days. Or any combination such as
+"1 hour and 27 minutes and 10 seconds"</p>
+</div>
+<div class="paragraph">
+<p>Any usage of the <code>javax.ejb.AccessTimeout</code> annotation will
+override this setting for the bean or method where the
+annotation is used.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_maxsize">MaxSize</h5>
+<div class="paragraph">
+<p>Specifies the size of the bean pools for this stateless
+SessionBean container. If StrictPooling is not used, instances
+will still be created beyond this number if there is demand, but
+they will not be returned to the pool and instead will be
+immediately destroyed.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_minsize">MinSize</h5>
+<div class="paragraph">
+<p>Specifies the minimum number of bean instances that should be in
+the pool for each bean. Pools are prefilled to the minimum on
+startup. Note this will create start order dependencies between
+other beans that also eagerly start, such as other <code>@Stateless</code>
+beans with a minimum or <code>@Singleton</code> beans using <code>@Startup</code>. The
+start order.</p>
+</div>
+<div class="paragraph">
+<p>The minimum pool size is rigidly maintained. Instances in the
+minimum side of the pool are not eligible for <code>IdleTimeout</code> or
+<code>GarbageCollection</code>, but are subject to <code>MaxAge</code> and flushing.</p>
+</div>
+<div class="paragraph">
+<p>If the pool is flushed it is immediately refilled to the minimum
+size with <code>MaxAgeOffset</code> applied. If an instance from the minimum
+side of the pool reaches its <code>MaxAge</code>, it is also immediately
+replaced. Replacement is done in a background queue using the
+number of threads specified by <code>CallbackThreads</code>.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_strictpooling">StrictPooling</h5>
+<div class="paragraph">
+<p>StrictPooling tells the container what to do when the pool
+reaches it’s maximum size and there are incoming requests that
+need instances.</p>
+</div>
+<div class="paragraph">
+<p>With strict pooling, requests will have to wait for instances to
+become available. The pool size will never grow beyond the the
+set <code>MaxSize</code> value. The maximum amount of time a request should
+wait is specified via the <code>AccessTimeout</code> setting.</p>
+</div>
+<div class="paragraph">
+<p>Without strict pooling, the container will create temporary
+instances to meet demand. The instances will last for just one
+method invocation and then are removed.</p>
+</div>
+<div class="paragraph">
+<p>Setting <code>StrictPooling</code> to <code>false</code> and <code>MaxSize</code> to <code>0</code> will result in
+no pooling. Instead instances will be created on demand and live
+for exactly one method call before being removed.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_maxage">MaxAge</h5>
+<div class="paragraph">
+<p>Specifies the maximum time that an instance should live before
+it should be retired and removed from use. This will happen
+gracefully. Useful for situations where bean instances are
+designed to hold potentially expensive resources such as memory
+or file handles and need to be periodically cleared out.</p>
+</div>
+<div class="paragraph">
+<p>Usable time units: nanoseconds, microsecons, milliseconds,
+seconds, minutes, hours, days. Or any combination such as
+<code>1 hour and 27 minutes and 10 seconds</code></p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_replaceaged">ReplaceAged</h5>
+<div class="paragraph">
+<p>When <code>ReplaceAged</code> is enabled, any instances in the pool that
+expire due to reaching their <code>MaxAge</code> will be replaced immediately
+so that the pool will remain at its current size. Replacement
+is done in a background queue so that incoming threads will not
+have to wait for instance creation.</p>
+</div>
+<div class="paragraph">
+<p>The aim of his option is to prevent user requests from paying
+the instance creation cost as <code>MaxAge</code> is enforced, potentially
+while under heavy load at peak hours.</p>
+</div>
+<div class="paragraph">
+<p>Instances from the minimum side of the pool are always replaced
+when they reach their <code>MaxAge</code>, this setting dictates the
+treatment of non-minimum instances.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_replaceflushed">ReplaceFlushed</h5>
+<div class="paragraph">
+<p>When <code>ReplaceFlushed</code> is enabled, any instances in the pool that
+are flushed will be replaced immediately so that the pool will
+remain at its current size. Replacement is done in a background
+queue so that incoming threads will not have to wait for
+instance creation.</p>
+</div>
+<div class="paragraph">
+<p>The aim of his option is to prevent user requests from paying
+the instance creation cost if a flush performed while under
+heavy load at peak hours.</p>
+</div>
+<div class="paragraph">
+<p>Instances from the minimum side of the pool are always replaced
+when they are flushed, this setting dictates the treatment of
+non-minimum instances.</p>
+</div>
+<div class="paragraph">
+<p>A bean may flush its pool by casting the <code>SessionContext</code> to
+<code>Flushable</code> and calling <code>flush()</code>. See <code>SweepInterval</code> for details on
+how flush is performed.</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-java" data-lang="java">import javax.annotation.Resource;
+import javax.ejb.SessionContext;
+import javax.ejb.Stateless;
+import java.io.Flushable;
+import java.io.IOException;
+
+public class MyBean {
+
+ private SessionContext sessionContext;
+
+ public void flush() throws IOException {
+
+ ((Flushable) sessionContext).flush();
+ }
+}</code></pre>
+</div>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_maxageoffset">MaxAgeOffset</h5>
+<div class="paragraph">
+<p>Applies to MaxAge usage and would rarely be changed, but is a
+nice feature to understand.</p>
+</div>
+<div class="paragraph">
+<p>When the container first starts and the pool is filled to the
+minimum size, all those "minimum" instances will have the same
+creation time and therefore all expire at the same time dictated
+by the <code>MaxAge</code> setting. To protect against this sudden drop
+scenario and provide a more gradual expiration from the start
+the container will spread out the age of the instances that fill
+the pool to the minimum using an offset.</p>
+</div>
+<div class="paragraph">
+<p>The <code>MaxAgeOffset</code> is not the final value of the offset, but
+rather it is used in creating the offset and allows the
+spreading to push the initial ages into the future or into the
+past. The pool is filled at startup as follows:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-java" data-lang="java">for (int i = 0; i < poolMin; i++) {
+ long ageOffset = (maxAge / poolMin * i * maxAgeOffset) % maxAge;
+ pool.add(new Bean(), ageOffset));
+}</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>The default <code>MaxAgeOffset</code> is -1 which causes the initial
+instances in the pool to live a bit longer before expiring. As
+a concrete example, let’s say the MinSize is 4 and the MaxAge is
+100 years. The generated offsets for the four instances created
+at startup would be 0, -25, -50, -75. So the first instance
+would be "born" at age 0, die at 100, living 100 years. The
+second instance would be born at -25, die at 100, living a total
+of 125 years. The third would live 150 years. The fourth 175
+years.</p>
+</div>
+<div class="paragraph">
+<p>A <code>MaxAgeOffset</code> of 1 would cause instances to be "born" older
+and therefore die sooner. Using the same example <code>MinSize</code> of 4
+and <code>MaxAge</code> of <code>100 years</code>, the life spans of these initial four
+instances would be 100, 75, 50, and 25 years respectively.</p>
+</div>
+<div class="paragraph">
+<p>A <code>MaxAgeOffset</code> of 0 will cause no "spreading" of the age of the
+first instances used to fill the pool to the minimum and these
+instances will of course reach their MaxAge at the same time.
+It is possible to set to decimal values such as -0.5, 0.5, -1.2,
+or 1.2.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_idletimeout">IdleTimeout</h5>
+<div class="paragraph">
+<p>Specifies the maximum time that an instance should be allowed to
+sit idly in the pool without use before it should be retired and
+removed.</p>
+</div>
+<div class="paragraph">
+<p>Usable time units: nanoseconds, microsecons, milliseconds,
+seconds, minutes, hours, days. Or any combination such as
+"1 hour and 27 minutes and 10 seconds"</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_garbagecollection">GarbageCollection</h5>
+<div class="paragraph">
+<p>Allows Garbage Collection to be used as a mechanism for shrinking
+the pool. When set to true all instances in the pool, excluding
+the minimum, are eligible for garbage collection by the virtual
+machine as per the rules of <code>java.lang.ref.SoftReference</code> and can be
+claimed by the JVM to free memory. Instances garbage collected
+will have their <code>@PreDestroy</code> methods called during finalization.</p>
+</div>
+<div class="paragraph">
+<p>In the OpenJDK VM the <code>-XX:SoftRefLRUPolicyMSPerMB</code> flag can adjust
+how aggressively SoftReferences are collected. The default
+OpenJDK setting is 1000, resulting in inactive pooled instances
+living one second of lifetime per free megabyte in the heap, which
+is very aggressive. The setting should be increased to get the
+most out of the <code>GarbageCollection</code> feature of the pool. Much
+higher settings are safe. Even a setting as high as 3600000 (1
+hour per free MB in the heap) does not affect the ability for the
+VM to garbage collect SoftReferences in the event that memory is
+needed to avoid an <code>OutOfMemoryException</code>.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_sweepinterval">SweepInterval</h5>
+<div class="paragraph">
+<p>The frequency in which the container will sweep the pool and
+evict expired instances. Eviction is how the <code>IdleTimeout</code>,
+<code>MaxAge</code>, and pool "flush" functionality is enforced. Higher
+intervals are better.</p>
+</div>
+<div class="paragraph">
+<p>Instances in use are excluded from sweeping. Should an instance
+expire while in use it will be evicted immediately upon return
+to the pool. Effectively <code>MaxAge</code> and flushes will be enforced as
+a part of normal activity or sweeping, while IdleTimeout is only
+enforcable via sweeping. This makes aggressive sweeping less
+important for a pool under moderate load.</p>
+</div>
+<div class="paragraph">
+<p>Usable time units: nanoseconds, microsecons, milliseconds,
+seconds, minutes, hours, days. Or any combination such as
+<code>1 hour and 27 minutes and 10 seconds</code></p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_callbackthreads">CallbackThreads</h5>
+<div class="paragraph">
+<p>When sweeping the pool for expired instances a thread pool is
+used to process calling <code>@PreDestroy</code> on expired instances as well
+as creating new instances as might be required to fill the pool
+to the minimum after a Flush or <code>MaxAge</code> expiration. The
+<code>CallbackThreads</code> setting dictates the size of the thread pool and
+is shared by all beans deployed in the container.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_closetimeout">CloseTimeout</h5>
+<div class="paragraph">
+<p>PostConstruct methods are invoked on all instances in the pool
+when the bean is undeployed and its pool is closed. The
+<code>CloseTimeout</code> specifies the maximum time to wait for the pool to
+close and <code>PostConstruct</code> methods to be invoked.</p>
+</div>
+<div class="paragraph">
+<p>Usable time units: nanoseconds, microsecons, milliseconds,
+seconds, minutes, hours, days. Or any combination such as
+<code>1 hour and 27 minutes and 10 seconds</code></p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_useoneschedulerthreadbybean">UseOneSchedulerThreadByBean</h5>
+<div class="paragraph">
+<p>back to previous behavior (TomEE 1.x) where 1 scheduler thread was used for stateless eviction
+by bean (ie for 500 stateless beans you get 500 eviction threads)</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_evictionthreads">EvictionThreads</h5>
+<div class="paragraph">
+<p>number of threads to associate to eviction threads (1 is not bad for most applications)</p>
+</div>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="__stateful">@Stateful</h3>
+<div class="paragraph">
+<p>A <code>@Stateful</code> container.</p>
+</div>
+<div class="paragraph">
+<p>Declarable in tomee.xml via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-xml" data-lang="xml"><Container id="Foo" type="STATEFUL">
+ AccessTimeout = 30 seconds
+ Cache = org.apache.openejb.core.stateful.SimpleCache
+ Passivator = org.apache.openejb.core.stateful.SimplePassivater
+ TimeOut = 20
+ Frequency = 60
+ Capacity = 1000
+ BulkPassivate = 100
+</Container></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Declarable in properties via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">Foo = new://Container?type=STATEFUL
+Foo.AccessTimeout = 30 seconds
+Foo.Cache = org.apache.openejb.core.stateful.SimpleCache
+Foo.Passivator = org.apache.openejb.core.stateful.SimplePassivater
+Foo.TimeOut = 20
+Foo.Frequency = 60
+Foo.Capacity = 1000
+Foo.BulkPassivate = 100</code></pre>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_configuration_2">Configuration</h4>
+<div class="sect4">
+<h5 id="_accesstimeout_2">AccessTimeout</h5>
+<div class="paragraph">
+<p>Specifies the maximum time an invocation could wait for the
+<code>@Stateful</code> bean instance to become available before giving up.</p>
+</div>
+<div class="paragraph">
+<p>After the timeout is reached a <code>javax.ejb.ConcurrentAccessTimeoutException</code>
+will be thrown.</p>
+</div>
+<div class="paragraph">
+<p>Usable time units: nanoseconds, microsecons, milliseconds,
+seconds, minutes, hours, days. Or any combination such as
+"1 hour and 27 minutes and 10 seconds"</p>
+</div>
+<div class="paragraph">
+<p>Any usage of the <code>javax.ejb.AccessTimeout</code> annotation will
+override this setting for the bean or method where the
+annotation is used.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_cache">Cache</h5>
+<div class="paragraph">
+<p>The cache is responsible for managing stateful bean
+instances. The cache can page instances to disk as memory
+is filled and can destroy abandoned instances. A different
+cache implementation can be used by setting this property
+to the fully qualified class name of the Cache implementation.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_passivator">Passivator</h5>
+<div class="paragraph">
+<p>The passivator is responsible for writing beans to disk
+at passivation time. Different passivators can be used
+by setting this property to the fully qualified class name
+of the <code>PassivationStrategy</code> implementation. The passivator
+is not responsible for invoking any callbacks or other
+processing, its only responsibly is to write the bean state
+to disk.</p>
+</div>
+<div class="paragraph">
+<p>Known implementations:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>org.apache.openejb.core.stateful.RAFPassivater</p>
+</li>
+<li>
+<p>org.apache.openejb.core.stateful.SimplePassivater</p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_timeout">TimeOut</h5>
+<div class="paragraph">
+<p>Specifies the time a bean can be idle before it is removed by the container.</p>
+</div>
+<div class="paragraph">
+<p>This value is measured in minutes. A value of 5 would
+result in a time-out of 5 minutes between invocations.
+A value of -1 would mean no timeout.
+A value of 0 would mean a bean can be immediately removed by the container.</p>
+</div>
+<div class="paragraph">
+<p>Any usage of the <code>javax.ejb.StatefulTimeout</code> annotation will
+override this setting for the bean where the annotation is used.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_frequency">Frequency</h5>
+<div class="paragraph">
+<p>Specifies the frequency (in seconds) at which the bean cache is checked for
+idle beans.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_capacity">Capacity</h5>
+<div class="paragraph">
+<p>Specifies the size of the bean pools for this
+stateful SessionBean container.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_bulkpassivate">BulkPassivate</h5>
+<div class="paragraph">
+<p>Property name that specifies the number of instances
+to passivate at one time when doing bulk passivation.</p>
+</div>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="__singleton">@Singleton</h3>
+<div class="paragraph">
+<p>A <code>@Singleton</code> container.</p>
+</div>
+<div class="paragraph">
+<p>Declarable in tomee.xml via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-xml" data-lang="xml"><Container id="Foo" type="SINGLETON">
+ AccessTimeout = 30 seconds
+</Container></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Declarable in properties via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">Foo = new://Container?type=SINGLETON
+Foo.AccessTimeout = 30 seconds</code></pre>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_configuration_3">Configuration</h4>
+<div class="sect4">
+<h5 id="_accesstimeout_3">AccessTimeout</h5>
+<div class="paragraph">
+<p>Specifies the maximum time an invocation could wait for the
+<code>@Singleton</code> bean instance to become available before giving up.</p>
+</div>
+<div class="paragraph">
+<p>After the timeout is reached a <code>javax.ejb.ConcurrentAccessTimeoutException</code>
+will be thrown.</p>
+</div>
+<div class="paragraph">
+<p>Usable time units: nanoseconds, microsecons, milliseconds,
+seconds, minutes, hours, days. Or any combination such as
+<code>1 hour and 27 minutes and 10 seconds</code></p>
+</div>
+<div class="paragraph">
+<p>Any usage of the <code>javax.ejb.AccessTimeout</code> annotation will
+override this setting for the bean or method where the
+annotation is used.</p>
+</div>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="__messagedriven">@MessageDriven</h3>
+<div class="paragraph">
+<p>A MDB container.</p>
+</div>
+<div class="paragraph">
+<p>Declarable in tomee.xml via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-xml" data-lang="xml"><Container id="Foo" type="MESSAGE">
+ ResourceAdapter = Default JMS Resource Adapter
+ MessageListenerInterface = javax.jms.MessageListener
+ ActivationSpecClass = org.apache.activemq.ra.ActiveMQActivationSpec
+ InstanceLimit = 10
+ FailOnUnknowActivationSpec = true
+</Container></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Declarable in properties via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">Foo = new://Container?type=MESSAGE
+Foo.ResourceAdapter = Default JMS Resource Adapter
+Foo.MessageListenerInterface = javax.jms.MessageListener
+Foo.ActivationSpecClass = org.apache.activemq.ra.ActiveMQActivationSpec
+Foo.InstanceLimit = 10
+Foo.FailOnUnknowActivationSpec = true</code></pre>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_configuration_4">Configuration</h4>
+<div class="sect4">
+<h5 id="_resourceadapter">ResourceAdapter</h5>
+<div class="paragraph">
+<p>The resource adapter delivers messages to the container</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_messagelistenerinterface">MessageListenerInterface</h5>
+<div class="paragraph">
+<p>Specifies the message listener interface handled by this container</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_activationspecclass">ActivationSpecClass</h5>
+<div class="paragraph">
+<p>Specifies the activation spec class</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_instancelimit">InstanceLimit</h5>
+<div class="paragraph">
+<p>Specifies the maximum number of bean instances that are
+allowed to exist for each MDB deployment.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_failonunknowactivationspec">FailOnUnknowActivationSpec</h5>
+<div class="paragraph">
+<p>Log a warning if true or throw an exception if false is an activation spec can’t be respected</p>
+</div>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="__managed">@Managed</h3>
+<div class="paragraph">
+<p>A managed bean container.</p>
+</div>
+<div class="paragraph">
+<p>Declarable in tomee.xml via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-xml" data-lang="xml"><Container id="Foo" type="MANAGED" /></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Declarable in properties via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">Foo = new://Container?type=MANAGED</code></pre>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_cmp_entity">CMP entity</h3>
+<div class="paragraph">
+<p>A CMP bean container.</p>
+</div>
+<div class="paragraph">
+<p>Declarable in tomee.xml via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-xml" data-lang="xml"><Container id="Foo" type="CMP_ENTITY">
+ CmpEngineFactory = org.apache.openejb.core.cmp.jpa.JpaCmpEngineFactory
+</Container></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Declarable in properties via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">Foo = new://Container?type=CMP_ENTITY
+Foo.CmpEngineFactory = org.apache.openejb.core.cmp.jpa.JpaCmpEngineFactory</code></pre>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_configuration_5">Configuration</h4>
+<div class="sect4">
+<h5 id="_cmpenginefactory">CmpEngineFactory</h5>
+<div class="paragraph">
+<p>The engine to use for this container. By default TomEE only provides the JPA implementation.</p>
+</div>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_bmp_entity">BMP entity</h3>
+<div class="paragraph">
+<p>A BMP entity container.</p>
+</div>
+<div class="paragraph">
+<p>Declarable in tomee.xml via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-xml" data-lang="xml"><Container id="Foo" type="BMP_ENTITY">
+ PoolSize = 10
+</Container></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Declarable in properties via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">Foo = new://Container?type=BMP_ENTITY
+Foo.PoolSize = 10</code></pre>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_configuration_6">Configuration</h4>
+<div class="sect4">
+<h5 id="_poolsize">PoolSize</h5>
+<div class="paragraph">
+<p>Specifies the size of the bean pools for this
+bmp entity container.</p>
+</div>
+</div>
+</div>
+</div>
+ </div>
+
+ </div>
+ </div>
+<footer>
+ <div class="container">
+ <div class="row">
+ <div class="col-sm-6 text-center-mobile">
+ <h3 class="white">Be simple. Be certified. Be Tomcat.</h3>
+ <h5 class="light regular light-white">"A good application in a good server"</h5>
+ <ul class="social-footer">
+ <li><a href="https://www.facebook.com/ApacheTomEE/"><i class="fa fa-facebook"></i></a></li>
+ <li><a href="https://twitter.com/apachetomee"><i class="fa fa-twitter"></i></a></li>
+ <li><a href="https://plus.google.com/communities/105208241852045684449"><i class="fa fa-google-plus"></i></a></li>
+ </ul>
+ </div>
+ <div class="col-sm-6 text-center-mobile">
+ <div class="row opening-hours">
+ <div class="col-sm-3 text-center-mobile">
+ <h5><a href="../../../../latest/docs/documentation.html" class="white">Documentation</a></h5>
+ <ul class="list-unstyled">
+ <li><a href="../../../../latest/docs/admin/configuration/index.html" class="regular light-white">How to configure</a></li>
+ <li><a href="../../../../latest/docs/admin/file-layout.html" class="regular light-white">Dir. Structure</a></li>
+ <li><a href="../../../../latest/docs/developer/testing/index.html" class="regular light-white">Testing</a></li>
+ <li><a href="../../../../latest/docs/admin/cluster/index.html" class="regular light-white">Clustering</a></li>
+ </ul>
+ </div>
+ <div class="col-sm-3 text-center-mobile">
+ <h5><a href="../../../../examples.html" class="white">Examples</a></h5>
+ <ul class="list-unstyled">
+ <li><a href="../../../../latest/examples/simple-cdi-interceptor.html" class="regular light-white">CDI Interceptor</a></li>
+ <li><a href="../../../../latest/examples/rest-cdi.html" class="regular light-white">REST with CDI</a></li>
+ <li><a href="../../../../latest/examples/ejb-examples.html" class="regular light-white">EJB</a></li>
+ <li><a href="../../../../latest/examples/jsf-managedBean-and-ejb.html" class="regular light-white">JSF</a></li>
+ </ul>
+ </div>
+ <div class="col-sm-3 text-center-mobile">
+ <h5><a href="../../../../community/index.html" class="white">Community</a></h5>
+ <ul class="list-unstyled">
+ <li><a href="../../../../community/contributors.html" class="regular light-white">Contributors</a></li>
+ <li><a href="../../../../community/social.html" class="regular light-white">Social</a></li>
+ <li><a href="../../../../community/sources.html" class="regular light-white">Sources</a></li>
+ </ul>
+ </div>
+ <div class="col-sm-3 text-center-mobile">
+ <h5><a href="../../../../security/index.html" class="white">Security</a></h5>
+ <ul class="list-unstyled">
+ <li><a href="http://apache.org/security" target="_blank" class="regular light-white">Apache Security</a></li>
+ <li><a href="http://apache.org/security/projects.html" target="_blank" class="regular light-white">Security Projects</a></li>
+ <li><a href="http://cve.mitre.org" target="_blank" class="regular light-white">CVE</a></li>
+ </ul>
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="row bottom-footer text-center-mobile">
+ <div class="col-sm-12 light-white">
+ <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>
+ </div>
+ </div>
+ </div>
+ </footer>
+ <!-- Holder for mobile navigation -->
+ <div class="mobile-nav">
+ <ul>
+ <li><a hef="../../../../latest/docs/admin/index.html">Administrators</a>
+ <li><a hef="../../../../latest/docs/developer/index.html">Developers</a>
+ <li><a hef="../../../../latest/docs/advanced/index.html">Advanced</a>
+ <li><a hef="../../../../community/index.html">Community</a>
+ </ul>
+ <a href="#" class="close-link"><i class="arrow_up"></i></a>
+ </div>
+ <!-- Scripts -->
+ <script src="../../../../js/jquery-1.11.1.min.js"></script>
+ <script src="../../../../js/owl.carousel.min.js"></script>
+ <script src="../../../../js/bootstrap.min.js"></script>
+ <script src="../../../../js/wow.min.js"></script>
+ <script src="../../../../js/typewriter.js"></script>
+ <script src="../../../../js/jquery.onepagenav.js"></script>
+ <script src="../../../../js/tree.jquery.js"></script>
+ <script src="../../../../js/highlight.pack.js"></script>
+ <script src="../../../../js/main.js"></script>
+ </body>
+
+</html>
+
Propchange: tomee/site/trunk/content/master/docs/admin/configuration/containers.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: tomee/site/trunk/content/master/docs/admin/configuration/index.html
URL: http://svn.apache.org/viewvc/tomee/site/trunk/content/master/docs/admin/configuration/index.html?rev=1847931&view=auto
==============================================================================
--- tomee/site/trunk/content/master/docs/admin/configuration/index.html (added)
+++ tomee/site/trunk/content/master/docs/admin/configuration/index.html Sun Dec 2 00:12:50 2018
@@ -0,0 +1,222 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+ <meta charset="UTF-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+ <title>Apache TomEE</title>
+ <meta name="description"
+ content="Apache TomEE is a lightweight, yet powerful, JavaEE Application server with feature rich tooling." />
+ <meta name="keywords" content="tomee,asf,apache,javaee,jee,shade,embedded,test,junit,applicationcomposer,maven,arquillian" />
+ <meta name="author" content="Luka Cvetinovic for Codrops" />
+ <link rel="icon" href="../../../../favicon.ico">
+ <link rel="icon" type="image/png" href="../../../../favicon.png">
+ <meta name="msapplication-TileColor" content="#80287a">
+ <meta name="theme-color" content="#80287a">
+ <link rel="stylesheet" type="text/css" href="../../../../css/normalize.css">
+ <link rel="stylesheet" type="text/css" href="../../../../css/bootstrap.css">
+ <link rel="stylesheet" type="text/css" href="../../../../css/owl.css">
+ <link rel="stylesheet" type="text/css" href="../../../../css/animate.css">
+ <link rel="stylesheet" type="text/css" href="../../../../fonts/font-awesome-4.1.0/css/font-awesome.min.css">
+ <link rel="stylesheet" type="text/css" href="../../../../fonts/eleganticons/et-icons.css">
+ <link rel="stylesheet" type="text/css" href="../../../../css/jqtree.css">
+ <link rel="stylesheet" type="text/css" href="../../../../css/idea.css">
+ <link rel="stylesheet" type="text/css" href="../../../../css/cardio.css">
+
+ <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="preloader">
+ <img src="../../../../img/loader.gif" alt="Preloader image">
+ </div>
+ <nav class="navbar">
+ <div class="container">
+ <div class="row"> <div class="col-md-12">
+
+ <!-- Brand and toggle get grouped for better mobile display -->
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="navbar-brand" href="/">
+ <span>
+
+
+ <img src="../../../../img/logo-active.png">
+
+
+ </span>
+ Apache TomEE
+ </a>
+ </div>
+ <!-- Collect the nav links, forms, and other content for toggling -->
+ <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
+ <ul class="nav navbar-nav navbar-right main-nav">
+ <li><a href="../../../../docs.html">Documentation</a></li>
+ <li><a href="../../../../community/index.html">Community</a></li>
+ <li><a href="../../../../security/index.html">Security</a></li>
+ <li><a href="../../../../download-ng.html">Downloads</a></li>
+ </ul>
+ </div>
+ <!-- /.navbar-collapse -->
+ </div></div>
+ </div>
+ <!-- /.container-fluid -->
+ </nav>
+
+
+ <div id="main-block" class="container section-padded">
+ <div class="row title">
+ <div class="col-md-12">
+ <div class='page-header'>
+
+ <div class='btn-toolbar pull-right' style="z-index: 2000;">
+ <div class='btn-group'>
+ <a class="btn" href="../../../../master/docs/admin/configuration/index.pdf"><i class="fa fa-file-pdf-o"></i> Download as PDF</a>
+ </div>
+ </div>
+
+ <h1>Server Configuration</h1>
+ </div>
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-12">
+ <div class="sect2">
+<h3 id="_container">Container</h3>
+<div class="paragraph">
+<p>TomEE specific configuration (ie not inherited one from Tomcat) is based on properties. Therefore
+you can fully configure TomEE using properties in <code>conf/system.properties</code>.
+However for convenience it also provides a hybrid XML alternative a.k.a. <code>conf/tomee.xml</code>.</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p><a href="server.html">Server Configuration: Properties</a>.</p>
+</li>
+<li>
+<p><a href="resources.html">Resources</a></p>
+</li>
+<li>
+<p><a href="containers.html">Containers</a></p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_application">Application</h3>
+<div class="paragraph">
+<p>Some settings can be specific to applications, these ones are also properties based and
+are read in <code>WEB-INF/application.properties</code>. When you can’t use <code>tomee.xml</code> to configure
+resources you can use <code>WEB-INF/resources.xml</code> which inherit from <code>tomee.xml</code> its syntax
+but binds the resources to the application and reuses the application classloader.</p>
+</div>
+<div class="paragraph">
+<p>More about <a href="application.html">Container Configuration</a>.</p>
+</div>
+</div>
+ </div>
+
+ </div>
+ </div>
+<footer>
+ <div class="container">
+ <div class="row">
+ <div class="col-sm-6 text-center-mobile">
+ <h3 class="white">Be simple. Be certified. Be Tomcat.</h3>
+ <h5 class="light regular light-white">"A good application in a good server"</h5>
+ <ul class="social-footer">
+ <li><a href="https://www.facebook.com/ApacheTomEE/"><i class="fa fa-facebook"></i></a></li>
+ <li><a href="https://twitter.com/apachetomee"><i class="fa fa-twitter"></i></a></li>
+ <li><a href="https://plus.google.com/communities/105208241852045684449"><i class="fa fa-google-plus"></i></a></li>
+ </ul>
+ </div>
+ <div class="col-sm-6 text-center-mobile">
+ <div class="row opening-hours">
+ <div class="col-sm-3 text-center-mobile">
+ <h5><a href="../../../../latest/docs/documentation.html" class="white">Documentation</a></h5>
+ <ul class="list-unstyled">
+ <li><a href="../../../../latest/docs/admin/configuration/index.html" class="regular light-white">How to configure</a></li>
+ <li><a href="../../../../latest/docs/admin/file-layout.html" class="regular light-white">Dir. Structure</a></li>
+ <li><a href="../../../../latest/docs/developer/testing/index.html" class="regular light-white">Testing</a></li>
+ <li><a href="../../../../latest/docs/admin/cluster/index.html" class="regular light-white">Clustering</a></li>
+ </ul>
+ </div>
+ <div class="col-sm-3 text-center-mobile">
+ <h5><a href="../../../../examples.html" class="white">Examples</a></h5>
+ <ul class="list-unstyled">
+ <li><a href="../../../../latest/examples/simple-cdi-interceptor.html" class="regular light-white">CDI Interceptor</a></li>
+ <li><a href="../../../../latest/examples/rest-cdi.html" class="regular light-white">REST with CDI</a></li>
+ <li><a href="../../../../latest/examples/ejb-examples.html" class="regular light-white">EJB</a></li>
+ <li><a href="../../../../latest/examples/jsf-managedBean-and-ejb.html" class="regular light-white">JSF</a></li>
+ </ul>
+ </div>
+ <div class="col-sm-3 text-center-mobile">
+ <h5><a href="../../../../community/index.html" class="white">Community</a></h5>
+ <ul class="list-unstyled">
+ <li><a href="../../../../community/contributors.html" class="regular light-white">Contributors</a></li>
+ <li><a href="../../../../community/social.html" class="regular light-white">Social</a></li>
+ <li><a href="../../../../community/sources.html" class="regular light-white">Sources</a></li>
+ </ul>
+ </div>
+ <div class="col-sm-3 text-center-mobile">
+ <h5><a href="../../../../security/index.html" class="white">Security</a></h5>
+ <ul class="list-unstyled">
+ <li><a href="http://apache.org/security" target="_blank" class="regular light-white">Apache Security</a></li>
+ <li><a href="http://apache.org/security/projects.html" target="_blank" class="regular light-white">Security Projects</a></li>
+ <li><a href="http://cve.mitre.org" target="_blank" class="regular light-white">CVE</a></li>
+ </ul>
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="row bottom-footer text-center-mobile">
+ <div class="col-sm-12 light-white">
+ <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>
+ </div>
+ </div>
+ </div>
+ </footer>
+ <!-- Holder for mobile navigation -->
+ <div class="mobile-nav">
+ <ul>
+ <li><a hef="../../../../latest/docs/admin/index.html">Administrators</a>
+ <li><a hef="../../../../latest/docs/developer/index.html">Developers</a>
+ <li><a hef="../../../../latest/docs/advanced/index.html">Advanced</a>
+ <li><a hef="../../../../community/index.html">Community</a>
+ </ul>
+ <a href="#" class="close-link"><i class="arrow_up"></i></a>
+ </div>
+ <!-- Scripts -->
+ <script src="../../../../js/jquery-1.11.1.min.js"></script>
+ <script src="../../../../js/owl.carousel.min.js"></script>
+ <script src="../../../../js/bootstrap.min.js"></script>
+ <script src="../../../../js/wow.min.js"></script>
+ <script src="../../../../js/typewriter.js"></script>
+ <script src="../../../../js/jquery.onepagenav.js"></script>
+ <script src="../../../../js/tree.jquery.js"></script>
+ <script src="../../../../js/highlight.pack.js"></script>
+ <script src="../../../../js/main.js"></script>
+ </body>
+
+</html>
+
Propchange: tomee/site/trunk/content/master/docs/admin/configuration/index.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: tomee/site/trunk/content/master/docs/admin/configuration/resources.html
URL: http://svn.apache.org/viewvc/tomee/site/trunk/content/master/docs/admin/configuration/resources.html?rev=1847931&view=auto
==============================================================================
--- tomee/site/trunk/content/master/docs/admin/configuration/resources.html (added)
+++ tomee/site/trunk/content/master/docs/admin/configuration/resources.html Sun Dec 2 00:12:50 2018
@@ -0,0 +1,998 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+ <meta charset="UTF-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+ <title>Apache TomEE</title>
+ <meta name="description"
+ content="Apache TomEE is a lightweight, yet powerful, JavaEE Application server with feature rich tooling." />
+ <meta name="keywords" content="tomee,asf,apache,javaee,jee,shade,embedded,test,junit,applicationcomposer,maven,arquillian" />
+ <meta name="author" content="Luka Cvetinovic for Codrops" />
+ <link rel="icon" href="../../../../favicon.ico">
+ <link rel="icon" type="image/png" href="../../../../favicon.png">
+ <meta name="msapplication-TileColor" content="#80287a">
+ <meta name="theme-color" content="#80287a">
+ <link rel="stylesheet" type="text/css" href="../../../../css/normalize.css">
+ <link rel="stylesheet" type="text/css" href="../../../../css/bootstrap.css">
+ <link rel="stylesheet" type="text/css" href="../../../../css/owl.css">
+ <link rel="stylesheet" type="text/css" href="../../../../css/animate.css">
+ <link rel="stylesheet" type="text/css" href="../../../../fonts/font-awesome-4.1.0/css/font-awesome.min.css">
+ <link rel="stylesheet" type="text/css" href="../../../../fonts/eleganticons/et-icons.css">
+ <link rel="stylesheet" type="text/css" href="../../../../css/jqtree.css">
+ <link rel="stylesheet" type="text/css" href="../../../../css/idea.css">
+ <link rel="stylesheet" type="text/css" href="../../../../css/cardio.css">
+
+ <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="preloader">
+ <img src="../../../../img/loader.gif" alt="Preloader image">
+ </div>
+ <nav class="navbar">
+ <div class="container">
+ <div class="row"> <div class="col-md-12">
+
+ <!-- Brand and toggle get grouped for better mobile display -->
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="navbar-brand" href="/">
+ <span>
+
+
+ <img src="../../../../img/logo-active.png">
+
+
+ </span>
+ Apache TomEE
+ </a>
+ </div>
+ <!-- Collect the nav links, forms, and other content for toggling -->
+ <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
+ <ul class="nav navbar-nav navbar-right main-nav">
+ <li><a href="../../../../docs.html">Documentation</a></li>
+ <li><a href="../../../../community/index.html">Community</a></li>
+ <li><a href="../../../../security/index.html">Security</a></li>
+ <li><a href="../../../../download-ng.html">Downloads</a></li>
+ </ul>
+ </div>
+ <!-- /.navbar-collapse -->
+ </div></div>
+ </div>
+ <!-- /.container-fluid -->
+ </nav>
+
+
+ <div id="main-block" class="container section-padded">
+ <div class="row title">
+ <div class="col-md-12">
+ <div class='page-header'>
+
+ <div class='btn-toolbar pull-right' style="z-index: 2000;">
+ <div class='btn-group'>
+ <a class="btn" href="../../../../master/docs/admin/configuration/resources.pdf"><i class="fa fa-file-pdf-o"></i> Download as PDF</a>
+ </div>
+ </div>
+
+ <h1>Resources</h1>
+ </div>
+ </div>
+ </div>
+ <div class="row">
+
+ <div class="col-md-12">
+ <div id="preamble">
+<div class="sectionbody">
+<div class="paragraph">
+<p>In TomEE resources are mainly "singleton" (understood as defined once per server or application). Technically
+it can be anything but you will probably meet more Datasources than other type of resources.</p>
+</div>
+<div class="paragraph">
+<p>Most resources will be created automatically if there is no matching resources - by name and type -
+when an injection will be found. To avoid that use <code>openejb.offline</code> property and set it to <code>true</code>.
+See <a href="server.html">Server Configuration</a> for more detail.</p>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_definition_a_resource_how_does_it_work">Definition a resource: how does it work?</h3>
+<div class="paragraph">
+<p>Before all let see how properties syntax is equivalent to XML one (system.properties and tomee.xml typically).</p>
+</div>
+<div class="paragraph">
+<p>Properties syntax uses dot notation to represent setters/properties which are plain properties in XML syntax
+and a URL syntax with query parameters to define the resource where it is directly the resource and tag attributes in XML.
+Finally the id is an attribute in XML and the key of the resource definition in properties.</p>
+</div>
+<div class="paragraph">
+<p>Let see it with a sample, both delcarations are the same:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">myDataSource = new://Resource?type=DataSource
+myDataSource.JdbcUrl = jdbc:hsqldb:mem:site
+myDataSource.UserName = sa</code></pre>
+</div>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-xml" data-lang="xml"><Resource id="myDataSource" type="DataSource">
+ JdbcUrl = jdbc:hsqldb:mem:site
+ UserName = sa
+</Resource></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>One started you can get injected any resource using <code>@Resource</code>:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-java" data-lang="java">@Resource(name = "myDataSource")
+private DataSource dataSource;</code></pre>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_factory_syntax">Factory syntax</h3>
+<div class="paragraph">
+<p>Here are the attributes of a resource:</p>
+</div>
+<table class="tableblock frame-all grid-all spread table table-bordered">
+<colgroup>
+<col style="width: 33.3333%;">
+<col style="width: 33.3333%;">
+<col style="width: 33.3334%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Name</th>
+<th class="tableblock halign-left valign-top">Optional</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">name of the resource, will match <code>openejb:Resource/id</code> in JNDI tree.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">provider</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">define a default resource definition using service-jar.xml</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">class-name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">specify which class to instantiate</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">factory-name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">specify which method to invoke on the class-name when specified to create the resource</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">properties-provider</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">a class responsible to provide to tomee the properties to use, it can have a property <code>serviceId</code> to know which resource it is.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">classpath</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">a classpath to use to create the resource. Note: if not implementing an interface the resource will be isolated from the applications.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">aliases</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">other names for the resource, allows for instance to share the same pool for a datasource used with multiple names in applications.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">post-construct/pre-destroy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">methods called when creating/destroying the resources.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Lazy</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">for resources set them to be created when first accessed and not when deployed</p></td>
+</tr>
+</tbody>
+</table>
+<div class="paragraph">
+<p>TomEE supports some implicit properties for resources but sometimes you just want to fully control the
+resource and not use implicit properties which can be affected to a property which doesn’t expect such a value (typically the case
+if you create a custom Oracle datasource). For such case you can set <code>SkipImplicitAttributes</code> property to <code>true</code> and your resource
+will ignore implicit properties.</p>
+</div>
+<div class="paragraph">
+<p>Implicit properties are:</p>
+</div>
+<table class="tableblock frame-all grid-all spread table table-bordered">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Name</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">transactionManager</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The JTA transaction manager</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">ServiceId</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the "id" of the resource (its name)</p></td>
+</tr>
+</tbody>
+</table>
+<div class="paragraph">
+<p>In the same spirit you can skip properties fallback using <code>SkipPropertiesFallback</code> and setting it to <code>true</code>. It typically avoids to
+fallback all unset properties (no matching property found) to a <code>Properties</code> instance and set it if one matching property is found.
+In Oracle case for instance it matches the connection properties which can have side effects.</p>
+</div>
+<div class="sect4">
+<h5 id="_value_ciphering">Value ciphering</h5>
+<div class="paragraph">
+<p>The propertie values support ciphering using the syntax <code>cipher:{algorithm}:{cipheredValue}</code>, for instance <code>cipher:Static3DES:xMH5uM1V9vQzVUv5LG7YLA==</code> will
+be read as <code>Passw0rd</code>. Ciphers can be computed using <code>tomee.sh</code> script: <code>${tomee.home}/bin/tomee.sh cipher Passw0rd</code>.</p>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_common_resources">Common Resources</h3>
+<div class="sect3">
+<h4 id="_datasources">DataSources</h4>
+<div class="paragraph">
+<p>DataSources have defaults for all values and a default datasource can be provided automatically but if you want to
+configure it here are the common properties:</p>
+</div>
+<div class="paragraph">
+<p>You can set the boolean <code>JtaManaged</code> to false if you don’t want your datasource to be using JTA - if you manage transactions yourself.</p>
+</div>
+<div class="paragraph">
+<p>Then other configurations are linked the pool the datasource is using. By default TomEE uses <a href="https://tomcat.apache.org/tomcat-7.0-doc/jdbc-pool.html">tomcat-jdbc</a> but we also provide
+<a href="https://commons.apache.org/proper/commons-dbcp/configuration.html">commons-dbcp</a> (2 for TomEE 7.x and 1 for TomEE 1.x).
+The properties are then the related configurations with these particular
+entries we try to keep in sync for both:</p>
+</div>
+<table class="tableblock frame-all grid-all spread table table-bordered">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Name</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">JdbcDriver</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the jdbc driver of the datasource</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">JdbcUrl</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the jdbc url of the datasource</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Username</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the user to use</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Password</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">the password of the user</p></td>
+</tr>
+</tbody>
+</table>
+<div class="sect4">
+<h5 id="_password_and_ciphering">Password and ciphering</h5>
+<div class="paragraph">
+<p>DataSource were the first resource to support password ciphering. Originally it was another property which is still supported.
+It is called <code>PasswordCipher</code>. Its value is the ciphering algorithm and it affects the password value. However <code>cipher:xxx</code>
+is still supported on <code>Password</code> value. Default <code>PasswordCipher</code> being <code>PlainText</code> it behaves as no ciphering is in place by default.</p>
+</div>
+<div class="paragraph">
+<p>Sample:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">ds = new://Resource?type=javax.sql.DataSource
+# our password is "Passw0rd"
+ds.Password = xMH5uM1V9vQzVUv5LG7YLA==
+ds.PasswordCipher = Static3DES</code></pre>
+</div>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_advanced_datasource_configuration">Advanced DataSource configuration</h5>
+<div class="paragraph">
+<p>TomEE also provides few utilities you can add in DataSource properties:</p>
+</div>
+<table class="tableblock frame-all grid-all spread table table-bordered">
+<colgroup>
+<col style="width: 50%;">
+<col style="width: 50%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Name</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">LogSql</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Should SQL be logged (using TomEE logger)</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">LogSqlPackages</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">if set the logging will show the matching packages (separated by comma) inline when logging the query, allows to know where a query comes from</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Flushable</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">if true the datasource can be casted as a Flushable to recreate the pool</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">ResetOnError</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">if a <code>SQLException</code> happens the pool is automatically recreated. Configuration is either "true" to do it each time an exception occurs, <code>x</code> or <code>retry(x)</code> to do it and retry until maximum <code>x</code> times</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">ResetOnErrorMethods</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">which methods are handled by ResetOnError</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">TomEEProxyHandler</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Custom <code>InvocationHandler</code> wrapping the datasource calls</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">DataSourceCreator</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">which pool to use, <code>dbcp</code>, <code>tomcat</code>, <code>dbcp-alternative</code> (DBCP and TomEE proxying instead of DBCP JTA integration), <code>simple</code> (no pooling)</p></td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="sect4">
+<h5 id="_datasource_and_jta">DataSource and JTA</h5>
+<div class="paragraph">
+<p><code>JtaManaged</code> determines wether or not this data source should be JTA managed
+or user managed. If set to 'true' it will automatically be enrolled
+in any ongoing transactions. Calling begin/commit/rollback or setAutoCommit
+on the datasource or connection will not be allowed. If you need to perform
+these functions yourself, set <code>JtaManaged</code> to <code>false</code></p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_datasource_and_jpa">DataSource and JPA</h5>
+<div class="paragraph">
+<p>In terms of JPA persistence.xml:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p><code>JtaManaged=true</code> can be used as a 'jta-data-source'</p>
+</li>
+<li>
+<p><code>JtaManaged=false</code> can be used as a 'non-jta-data-source'</p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_activemqresourceadapter">ActiveMQResourceAdapter</h3>
+<div class="paragraph">
+<p>Declarable in tomee.xml via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-xml" data-lang="xml"><Resource id="Foo" type="ActiveMQResourceAdapter">
+ BrokerXmlConfig = broker:(tcp://localhost:61616)?useJmx=false
+ ServerUrl = vm://localhost?waitForStart=20000&async=true
+ DataSource = Default Unmanaged JDBC Database
+ StartupTimeout = 10 seconds
+</Resource></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Declarable in properties via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">Foo = new://Resource?type=ActiveMQResourceAdapter
+Foo.BrokerXmlConfig = broker:(tcp://localhost:61616)?useJmx=false
+Foo.ServerUrl = vm://localhost?waitForStart=20000&async=true
+Foo.DataSource = Default Unmanaged JDBC Database
+Foo.StartupTimeout = 10 seconds</code></pre>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_configuration">Configuration</h4>
+<div class="sect4">
+<h5 id="_brokerxmlconfig">BrokerXmlConfig</h5>
+<div class="paragraph">
+<p>Broker configuration URI as defined by ActiveMQ
+see <a href="http://activemq.apache.org/broker-configuration-uri.html" class="bare">http://activemq.apache.org/broker-configuration-uri.html</a>
+BrokerXmlConfig xbean:file:conf/activemq.xml - Requires xbean-spring.jar and dependencies</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_serverurl">ServerUrl</h5>
+<div class="paragraph">
+<p>Broker address</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_datasource">DataSource</h5>
+<div class="paragraph">
+<p>DataSource for persistence messages</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_startuptimeout">StartupTimeout</h5>
+<div class="paragraph">
+<p>How long to wait for broker startup</p>
+</div>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_javax_jms_connectionfactory">javax.jms.ConnectionFactory</h3>
+<div class="paragraph">
+<p>An ActiveMQ (JMS) connection factory.</p>
+</div>
+<div class="paragraph">
+<p>Declarable in tomee.xml via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-xml" data-lang="xml"><Resource id="Foo" type="javax.jms.ConnectionFactory">
+ ResourceAdapter = Default JMS Resource Adapter
+ TransactionSupport = xa
+ PoolMaxSize = 10
+ PoolMinSize = 0
+ ConnectionMaxWaitTime = 5 seconds
+ ConnectionMaxIdleTime = 15 Minutes
+</Resource></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Declarable in properties via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">Foo = new://Resource?type=javax.jms.ConnectionFactory
+Foo.ResourceAdapter = Default JMS Resource Adapter
+Foo.TransactionSupport = xa
+Foo.PoolMaxSize = 10
+Foo.PoolMinSize = 0
+Foo.ConnectionMaxWaitTime = 5 seconds
+Foo.ConnectionMaxIdleTime = 15 Minutes</code></pre>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_configuration_2">Configuration</h4>
+<div class="sect4">
+<h5 id="_resourceadapter">ResourceAdapter</h5>
+<div class="paragraph">
+<p>An ActiveMQ (JMS) resource adapter.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_transactionsupport">TransactionSupport</h5>
+<div class="paragraph">
+<p>Specifies if the connection is enrolled in global transaction
+allowed values: <code>xa</code>, <code>local</code> or <code>none</code>. Default to <code>xa</code>.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_poolmaxsize">PoolMaxSize</h5>
+<div class="paragraph">
+<p>Maximum number of physical connection to the ActiveMQ broker.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_poolminsize">PoolMinSize</h5>
+<div class="paragraph">
+<p>Minimum number of physical connection to the ActiveMQ broker.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_connectionmaxwaittime">ConnectionMaxWaitTime</h5>
+<div class="paragraph">
+<p>Maximum amount of time to wait for a connection.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_connectionmaxidletime">ConnectionMaxIdleTime</h5>
+<div class="paragraph">
+<p>Maximum amount of time a connection can be idle before being reclaimed.</p>
+</div>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_javax_jms_queue">javax.jms.Queue</h3>
+<div class="paragraph">
+<p>An ActiveMQ (JMS) queue.</p>
+</div>
+<div class="paragraph">
+<p>Declarable in tomee.xml via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-xml" data-lang="xml"><Resource id="Foo" type="javax.jms.Queue">
+ # not set means id
+ destination =
+</Resource></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Declarable in properties via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">Foo = new://Resource?type=javax.jms.Queue
+# not set means id
+Foo.destination =</code></pre>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_configuration_3">Configuration</h4>
+<div class="sect4">
+<h5 id="_destination">destination</h5>
+<div class="paragraph">
+<p>Specifies the name of the queue</p>
+</div>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_javax_jms_topic">javax.jms.Topic</h3>
+<div class="paragraph">
+<p>An ActiveMQ (JMS) topic.</p>
+</div>
+<div class="paragraph">
+<p>Declarable in tomee.xml via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-xml" data-lang="xml"><Resource id="Foo" type="javax.jms.Topic">
+ # not set means id
+ destination =
+</Resource></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Declarable in properties via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">Foo = new://Resource?type=javax.jms.Topic
+# not set means id
+Foo.destination =</code></pre>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_configuration_4">Configuration</h4>
+<div class="sect4">
+<h5 id="_destination_2">destination</h5>
+<div class="paragraph">
+<p>Specifies the name of the topic</p>
+</div>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_org_omg_corba_orb">org.omg.CORBA.ORB</h3>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-note" title="Note"></i>
+</td>
+<td class="content">
+to use it you need to add an implementation of corba.
+</td>
+</tr>
+</table>
+</div>
+<div class="paragraph">
+<p>Declarable in tomee.xml via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-xml" data-lang="xml"><Resource id="Foo" type="org.omg.CORBA.ORB" /></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Declarable in properties via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">Foo = new://Resource?type=org.omg.CORBA.ORB</code></pre>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_javax_mail_session">javax.mail.Session</h3>
+<div class="paragraph">
+<p>A mail session.</p>
+</div>
+<div class="paragraph">
+<p>Declarable in tomee.xml via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-xml" data-lang="xml"><Resource id="mail/mysession" type="javax.mail.Session">
+ mail.transport.protocol = smtp
+ mail.smtp.host = smtp.provider.com
+ mail.smtp.auth = true
+ mail.smtp.starttls.enable = true
+ mail.smtp.port = 587
+ mail.smtp.user = user@provider.com
+ password = abcdefghij
+</Resource></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Declarable in properties via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">mail/mysession = new://Resource?type=javax.mail.Session
+mail/mysession.mail.transport.protocol = smtp
+mail/mysession.mail.smtp.host = smtp.provider.com
+mail/mysession.mail.smtp.auth = true
+mail/mysession.mail.smtp.starttls.enable = true
+mail/mysession.mail.smtp.port = 587
+mail/mysession.mail.smtp.user = user@provider.com
+mail/mysession.password = abcdefghij</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>The properties are <code>javax.mail.Session</code> ones with the addition of <code>useDefault</code> which specifies if <code>getDefaultInstance()</code>
+or <code>getInstance</code> is used to create the session. <code>getDefaultInstance()</code> will ensure that several calls are done with the
+same configuration and return the same instance. For tomee it is likely better to rely on <code>getInstance()</code>(ie keep <code>useDefault</code> to false)
+and use <code>aliases</code> option of the resource to define an alias if you need to share the same instance accross multiple names.</p>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_managedexecutorservice">ManagedExecutorService</h3>
+<div class="paragraph">
+<p>A concurrency utility for EE executor service.</p>
+</div>
+<div class="paragraph">
+<p>Declarable in tomee.xml via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-xml" data-lang="xml"><Resource id="Foo" type="ManagedExecutorService">
+ Core = 5
+ Max = 25
+ KeepAlive = 5 s
+ Queue = 15
+ ThreadFactory = org.apache.openejb.threads.impl.ManagedThreadFactoryImpl
+ Lazy = true
+</Resource></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Declarable in properties via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">Foo = new://Resource?type=ManagedExecutorService
+Foo.Core = 5
+Foo.Max = 25
+Foo.KeepAlive = 5 s
+Foo.Queue = 15
+Foo.ThreadFactory = org.apache.openejb.threads.impl.ManagedThreadFactoryImpl
+Foo.Lazy = true</code></pre>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_configuration_5">Configuration</h4>
+<div class="sect4">
+<h5 id="_core">Core</h5>
+<div class="paragraph">
+<p>The pool core size.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_max">Max</h5>
+<div class="paragraph">
+<p>The pool max size.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_keepalive">KeepAlive</h5>
+<div class="paragraph">
+<p>The thread keep alive time (in duration format)</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_queue">Queue</h5>
+<div class="paragraph">
+<p>The queue type size.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_threadfactory">ThreadFactory</h5>
+<div class="paragraph">
+<p>The thread factory implementation class.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_lazy">Lazy</h5>
+<div class="paragraph">
+<p>If set to true the pool is created when first accessed otherwise it is created at startup.</p>
+</div>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_managedscheduledexecutorservice">ManagedScheduledExecutorService</h3>
+<div class="paragraph">
+<p>Inherit from <code>ManagedExecutorService</code> and adds scheduling abilities.</p>
+</div>
+<div class="paragraph">
+<p>Declarable in tomee.xml via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-xml" data-lang="xml"><Resource id="Foo" type="ManagedScheduledExecutorService">
+ Core = 5
+ ThreadFactory = org.apache.openejb.threads.impl.ManagedThreadFactoryImpl
+ Lazy = true
+</Resource></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Declarable in properties via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">Foo = new://Resource?type=ManagedScheduledExecutorService
+Foo.Core = 5
+Foo.ThreadFactory = org.apache.openejb.threads.impl.ManagedThreadFactoryImpl
+Foo.Lazy = true</code></pre>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_configuration_6">Configuration</h4>
+<div class="paragraph">
+<p>See <code>ManagedExecutorService</code>.</p>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_managedthreadfactory">ManagedThreadFactory</h3>
+<div class="paragraph">
+<p>A thread factory for a <code>ManagedExecutorService</code>.</p>
+</div>
+<div class="paragraph">
+<p>Declarable in tomee.xml via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-xml" data-lang="xml"><Resource id="Foo" type="ManagedThreadFactory">
+ Prefix = openejb-managed-thread-
+ Lazy = true
+</Resource></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Declarable in properties via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">Foo = new://Resource?type=ManagedThreadFactory
+Foo.Prefix = openejb-managed-thread-
+Foo.Lazy = true</code></pre>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_configuration_7">Configuration</h4>
+<div class="sect4">
+<h5 id="_prefix">Prefix</h5>
+<div class="paragraph">
+<p>The thread prefix (suffixed with thread id).</p>
+</div>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_contextservice">ContextService</h3>
+<div class="paragraph">
+<p>A concurrency utilities for JavaEE context service. It allows to create
+contextual proxies (inheriting from security, classloader…​contexts).</p>
+</div>
+<div class="paragraph">
+<p>Declarable in tomee.xml via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-xml" data-lang="xml"><Resource id="Foo" type="ContextService" /></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Declarable in properties via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">Foo = new://Resource?type=ContextService</code></pre>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_jndiprovider_inject_remote_clients">JndiProvider: inject remote clients</h3>
+<div class="paragraph">
+<p>A thread factory for a <code>ManagedExecutorService</code>.
+Default implementation is <code>org.apache.openejb.threads.impl.ManagedThreadFactoryImpl</code>.</p>
+</div>
+<div class="paragraph">
+<p>Declarable in tomee.xml via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-xml" data-lang="xml"><Resource id="Foo" type="ManagedThreadFactory">
+ Prefix = openejb-managed-thread-
+ Lazy = true
+</Resource></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Declarable in properties via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">Foo = new://Resource?type=ManagedThreadFactory
+Foo.Prefix = openejb-managed-thread-
+Foo.Lazy = true</code></pre>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_configuration_8">Configuration</h4>
+<div class="sect4">
+<h5 id="_prefix_2">Prefix</h5>
+<div class="paragraph">
+<p>The thread prefix (suffixed with thread id).</p>
+</div>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_contextservice_2">ContextService</h3>
+<div class="paragraph">
+<p>A concurrency utilities for JavaEE context service. It allows to create
+contextual proxies (inheriting from security, classloader…​contexts).</p>
+</div>
+<div class="paragraph">
+<p>Declarable in tomee.xml via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-xml" data-lang="xml"><Resource id="Foo" type="ContextService" /></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Declarable in properties via</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-bash" data-lang="bash">Foo = new://Resource?type=ContextService</code></pre>
+</div>
+</div>
+</div>
+ </div>
+
+ </div>
+ </div>
+<footer>
+ <div class="container">
+ <div class="row">
+ <div class="col-sm-6 text-center-mobile">
+ <h3 class="white">Be simple. Be certified. Be Tomcat.</h3>
+ <h5 class="light regular light-white">"A good application in a good server"</h5>
+ <ul class="social-footer">
+ <li><a href="https://www.facebook.com/ApacheTomEE/"><i class="fa fa-facebook"></i></a></li>
+ <li><a href="https://twitter.com/apachetomee"><i class="fa fa-twitter"></i></a></li>
+ <li><a href="https://plus.google.com/communities/105208241852045684449"><i class="fa fa-google-plus"></i></a></li>
+ </ul>
+ </div>
+ <div class="col-sm-6 text-center-mobile">
+ <div class="row opening-hours">
+ <div class="col-sm-3 text-center-mobile">
+ <h5><a href="../../../../latest/docs/documentation.html" class="white">Documentation</a></h5>
+ <ul class="list-unstyled">
+ <li><a href="../../../../latest/docs/admin/configuration/index.html" class="regular light-white">How to configure</a></li>
+ <li><a href="../../../../latest/docs/admin/file-layout.html" class="regular light-white">Dir. Structure</a></li>
+ <li><a href="../../../../latest/docs/developer/testing/index.html" class="regular light-white">Testing</a></li>
+ <li><a href="../../../../latest/docs/admin/cluster/index.html" class="regular light-white">Clustering</a></li>
+ </ul>
+ </div>
+ <div class="col-sm-3 text-center-mobile">
+ <h5><a href="../../../../examples.html" class="white">Examples</a></h5>
+ <ul class="list-unstyled">
+ <li><a href="../../../../latest/examples/simple-cdi-interceptor.html" class="regular light-white">CDI Interceptor</a></li>
+ <li><a href="../../../../latest/examples/rest-cdi.html" class="regular light-white">REST with CDI</a></li>
+ <li><a href="../../../../latest/examples/ejb-examples.html" class="regular light-white">EJB</a></li>
+ <li><a href="../../../../latest/examples/jsf-managedBean-and-ejb.html" class="regular light-white">JSF</a></li>
+ </ul>
+ </div>
+ <div class="col-sm-3 text-center-mobile">
+ <h5><a href="../../../../community/index.html" class="white">Community</a></h5>
+ <ul class="list-unstyled">
+ <li><a href="../../../../community/contributors.html" class="regular light-white">Contributors</a></li>
+ <li><a href="../../../../community/social.html" class="regular light-white">Social</a></li>
+ <li><a href="../../../../community/sources.html" class="regular light-white">Sources</a></li>
+ </ul>
+ </div>
+ <div class="col-sm-3 text-center-mobile">
+ <h5><a href="../../../../security/index.html" class="white">Security</a></h5>
+ <ul class="list-unstyled">
+ <li><a href="http://apache.org/security" target="_blank" class="regular light-white">Apache Security</a></li>
+ <li><a href="http://apache.org/security/projects.html" target="_blank" class="regular light-white">Security Projects</a></li>
+ <li><a href="http://cve.mitre.org" target="_blank" class="regular light-white">CVE</a></li>
+ </ul>
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="row bottom-footer text-center-mobile">
+ <div class="col-sm-12 light-white">
+ <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>
+ </div>
+ </div>
+ </div>
+ </footer>
+ <!-- Holder for mobile navigation -->
+ <div class="mobile-nav">
+ <ul>
+ <li><a hef="../../../../latest/docs/admin/index.html">Administrators</a>
+ <li><a hef="../../../../latest/docs/developer/index.html">Developers</a>
+ <li><a hef="../../../../latest/docs/advanced/index.html">Advanced</a>
+ <li><a hef="../../../../community/index.html">Community</a>
+ </ul>
+ <a href="#" class="close-link"><i class="arrow_up"></i></a>
+ </div>
+ <!-- Scripts -->
+ <script src="../../../../js/jquery-1.11.1.min.js"></script>
+ <script src="../../../../js/owl.carousel.min.js"></script>
+ <script src="../../../../js/bootstrap.min.js"></script>
+ <script src="../../../../js/wow.min.js"></script>
+ <script src="../../../../js/typewriter.js"></script>
+ <script src="../../../../js/jquery.onepagenav.js"></script>
+ <script src="../../../../js/tree.jquery.js"></script>
+ <script src="../../../../js/highlight.pack.js"></script>
+ <script src="../../../../js/main.js"></script>
+ </body>
+
+</html>
+
Propchange: tomee/site/trunk/content/master/docs/admin/configuration/resources.html
------------------------------------------------------------------------------
svn:eol-style = native