You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@deltaspike.apache.org by st...@apache.org on 2018/01/03 18:01:00 UTC
svn commit: r1819992 - in /deltaspike/site/trunk/content/documentation:
build.html configure.html core.html scheduler.html snapshots.html
test-control.html
Author: struberg
Date: Wed Jan 3 18:01:00 2018
New Revision: 1819992
URL: http://svn.apache.org/viewvc?rev=1819992&view=rev
Log:
Site checkin for project Apache DeltaSpike Documentation
Modified:
deltaspike/site/trunk/content/documentation/build.html
deltaspike/site/trunk/content/documentation/configure.html
deltaspike/site/trunk/content/documentation/core.html
deltaspike/site/trunk/content/documentation/scheduler.html
deltaspike/site/trunk/content/documentation/snapshots.html
deltaspike/site/trunk/content/documentation/test-control.html
Modified: deltaspike/site/trunk/content/documentation/build.html
URL: http://svn.apache.org/viewvc/deltaspike/site/trunk/content/documentation/build.html?rev=1819992&r1=1819991&r2=1819992&view=diff
==============================================================================
--- deltaspike/site/trunk/content/documentation/build.html (original)
+++ deltaspike/site/trunk/content/documentation/build.html Wed Jan 3 18:01:00 2018
@@ -277,7 +277,7 @@ table.CodeRay td.code>pre{padding:0}
<p>The DeltaSpike source (modules and examples) is provided for inspection, contribution and testing purposes. The source must be built with Maven, which has been used to automate the compilation, testing and packaging processes. Arquillian tests are included with the source and a CDI implementation or container can be specified with which to carry out the tests.</p>
</div>
<div class="paragraph">
-<p>In all cases, to obtain the DeltaSpike source, <a href="https://deltaspike.apache.org/download.html">download</a> <code>deltaspike-project-1.8.0-source-release.zip</code> and extract the contents.</p>
+<p>In all cases, to obtain the DeltaSpike source, <a href="https://deltaspike.apache.org/download.html">download</a> <code>deltaspike-project-1.8.1-source-release.zip</code> and extract the contents.</p>
</div>
<div class="admonitionblock note">
<table>
@@ -301,7 +301,7 @@ You can also obtain the DeltaSpike sourc
</div>
<div class="listingblock">
<div class="content">
-<pre class="CodeRay highlight"><code data-lang="shell">$ cd /path/to/deltaspike-project-1.8.0/
+<pre class="CodeRay highlight"><code data-lang="shell">$ cd /path/to/deltaspike-project-1.8.1/
$ mvn clean install</code></pre>
</div>
</div>
Modified: deltaspike/site/trunk/content/documentation/configure.html
URL: http://svn.apache.org/viewvc/deltaspike/site/trunk/content/documentation/configure.html?rev=1819992&r1=1819991&r2=1819992&view=diff
==============================================================================
--- deltaspike/site/trunk/content/documentation/configure.html (original)
+++ deltaspike/site/trunk/content/documentation/configure.html Wed Jan 3 18:01:00 2018
@@ -309,7 +309,7 @@ You can also opt to use the lastest Delt
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><properties></span>
- <span class="tag"><deltaspike.version></span>1.8.0<span class="tag"></deltaspike.version></span>
+ <span class="tag"><deltaspike.version></span>1.8.1<span class="tag"></deltaspike.version></span>
<span class="tag"></properties></span></code></pre>
</div>
</div>
@@ -418,7 +418,7 @@ repositories {
}
dependencyManagement {
imports {
- mavenBom 'org.apache.deltaspike.distribution:distributions-bom:1.8.0'
+ mavenBom 'org.apache.deltaspike.distribution:distributions-bom:1.8.1'
}
}
dependencies {
Modified: deltaspike/site/trunk/content/documentation/core.html
URL: http://svn.apache.org/viewvc/deltaspike/site/trunk/content/documentation/core.html?rev=1819992&r1=1819991&r2=1819992&view=diff
==============================================================================
--- deltaspike/site/trunk/content/documentation/core.html (original)
+++ deltaspike/site/trunk/content/documentation/core.html Wed Jan 3 18:01:00 2018
@@ -1785,6 +1785,106 @@ The following example shows how it would
</div>
</div>
<div class="sect1">
+<h2 id="__futureable_configuration">@Futureable configuration</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>The strategy to find the <code>ExecutorService</code> associated to the <code>@Futureable</code> name is the following one:</p>
+</div>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>Check if there is a CDI bean of type <code>ExecutorService</code> with the name of the pool, if not try 2</p>
+</li>
+<li>
+<p>Check if there is a JNDI entry matching the pool name directly or prefixed with <code>java:app/</code>, <code>java:global/</code>, <code>java:global/threads/</code>, <code>java:global/deltaspike/</code>, <code>java:</code>, if not try 3</p>
+</li>
+<li>
+<p>Read the configuration and create a <code>ThreadPoolExecutor</code></p>
+</li>
+</ol>
+</div>
+<div class="admonitionblock important">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-important" title="Important"></i>
+</td>
+<td class="content">
+the instance is looked up only once so from the first time it was read you can’t change any configuration anymore.
+</td>
+</tr>
+</table>
+</div>
+<div class="paragraph">
+<p>If you rely on the last option (configured executor) here are the keys you can set in DeltaSpike configuration:</p>
+</div>
+<table class="tableblock frame-all grid-all spread">
+<colgroup>
+<col style="width: 33%;">
+<col style="width: 33%;">
+<col style="width: 33%;">
+</colgroup>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Key</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Default</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">futurable.pool.<pool name>.coreSize</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The core size of the pool.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number of available processors</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">futurable.pool.<pool name>.maxSize</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The max size of the pool.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">coreSize value</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">futurable.pool.<pool name>.keepAlive.value</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Pool keep alive (when a thread is released).</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">0</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">futurable.pool.<pool name>.keepAlive.unit</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Unit of keepAlive.value. It must match a <code>TIMEUNIT</code> name.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">MILLISECONDS</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">futurable.pool.<pool name>.queue.type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The task queue type of the executor. Can be <code>ARRAY</code> to use an <code>ArrayBlockingQueue</code>, <code>LINKED</code> for a <code>LinkedBlockingQueue</code> or <code>SYNCHRONOUS</code> for a <code>SynchronousQueue</code>.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">LINKED</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">futurable.pool.<pool name>.queue.fair</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">For synchronous and array queue types, if the queue is fair.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">futurable.pool.<pool name>.queue.size</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">For array queue type, the size of the queue.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">1024</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">futurable.pool.<pool name>.queue.capacity</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">For linked queue type, the capacity of the queue.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Integer.MAX_VALUE</code></p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">futurable.pool.<pool name>.threadFactory.name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">If set a CDI bean matching the value will be looked up and used as <code>ThreadFactory</code>.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">none, <code>Executors.defaultThreadFactory()</code> is used</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">futurable.pool.<pool name>.rejectedExecutionHandler.name</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">If set a CDI bean matching the value will be looked up and used as <code>RejectedExecutionHandler</code>.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">none, <code>ThreadPoolExecutor.AbortPolicy</code> is used</p></td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+<div class="sect1">
<h2 id="_utilities">Utilities</h2>
<div class="sectionbody">
<div class="paragraph">
@@ -2043,6 +2143,7 @@ objects, the last object in the array wi
</ul>
</li>
<li><a href="#_asynchronous_operations">Asynchronous Operations</a></li>
+<li><a href="#__futureable_configuration">@Futureable configuration</a></li>
<li><a href="#_utilities">Utilities</a>
<ul class="sectlevel2">
<li><a href="#_annotationutils">AnnotationUtils</a></li>
Modified: deltaspike/site/trunk/content/documentation/scheduler.html
URL: http://svn.apache.org/viewvc/deltaspike/site/trunk/content/documentation/scheduler.html?rev=1819992&r1=1819991&r2=1819992&view=diff
==============================================================================
--- deltaspike/site/trunk/content/documentation/scheduler.html (original)
+++ deltaspike/site/trunk/content/documentation/scheduler.html Wed Jan 3 18:01:00 2018
@@ -609,7 +609,7 @@ Such an adapter just needs to implement
<div class="sectionbody">
<div class="paragraph">
<p>It is possible to replace the default integration with Quartz. Any scheduler that supports cron-expressions for job-classes can be used.
-For more information, see <a href="https://deltaspike.apache.org/javadoc/1.8.0/org/apache/deltaspike/scheduler/spi/Scheduler.html">Scheduler javadoc</a>.</p>
+For more information, see <a href="https://deltaspike.apache.org/javadoc/1.8.1/org/apache/deltaspike/scheduler/spi/Scheduler.html">Scheduler javadoc</a>.</p>
</div>
</div>
</div>
Modified: deltaspike/site/trunk/content/documentation/snapshots.html
URL: http://svn.apache.org/viewvc/deltaspike/site/trunk/content/documentation/snapshots.html?rev=1819992&r1=1819991&r2=1819992&view=diff
==============================================================================
--- deltaspike/site/trunk/content/documentation/snapshots.html (original)
+++ deltaspike/site/trunk/content/documentation/snapshots.html Wed Jan 3 18:01:00 2018
@@ -343,7 +343,7 @@ Snapshots provide previews of DeltaSpike
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><properties></span>
- <span class="tag"><deltaspike.version></span>1.8.1-SNAPSHOT<span class="tag"></deltaspike.version></span>
+ <span class="tag"><deltaspike.version></span>1.8.2-SNAPSHOT<span class="tag"></deltaspike.version></span>
<span class="tag"></properties></span></code></pre>
</div>
</div>
Modified: deltaspike/site/trunk/content/documentation/test-control.html
URL: http://svn.apache.org/viewvc/deltaspike/site/trunk/content/documentation/test-control.html?rev=1819992&r1=1819991&r2=1819992&view=diff
==============================================================================
--- deltaspike/site/trunk/content/documentation/test-control.html (original)
+++ deltaspike/site/trunk/content/documentation/test-control.html Wed Jan 3 18:01:00 2018
@@ -956,6 +956,31 @@ jar {
<h2 id="_spi">SPI</h2>
<div class="sectionbody">
<div class="sect2">
+<h3 id="_mockfilter">MockFilter</h3>
+<div class="paragraph">
+<p>Please make sure that you are aware of <a href="#__MockFrameworks">Integration of Mock Frameworks</a> before you continue with this section.</p>
+</div>
+<div class="paragraph">
+<p>If you would like to exclude some parts of your application- and/or test-code
+so that they arenât eligible for the mocking mechanism,
+you can provide an own implementation of <code>org.apache.deltaspike.testcontrol.spi.mock.MockFilter</code> and
+register it in <code>/META-INF/services/org.apache.deltaspike.testcontrol.spi.mock.MockFilter</code>.</p>
+</div>
+<div class="paragraph">
+<p>That’s quite special and you need to know the CDI-SPI a bit.
+To get an idea about the required steps, you can have a look at the default implementation used by DeltaSpike-Test itself.</p>
+</div>
+<div class="paragraph">
+<p>Such a filter is also needed in case you would like to customize DeltaSpike-Test.
+For example to provide an <code>@Alternative</code> implementation for DynamicMockManager,
+you need to implement <code>org.apache.deltaspike.testcontrol.api.mock.DynamicMockManager</code>, annotate it with <code>@Alternative</code>,
+ensure that you keep the type-information with <code>@Typed</code>,
+configure the alternative bean in <code>/META-INF/beans.xml</code> (in the test-classpath) and
+provide a custom <code>MockFilter</code> (as described above) which excludes the custom mock-manager.
+(Otherwise DeltaSpike-Test will try to mock the custom mock-manager.)</p>
+</div>
+</div>
+<div class="sect2">
<h3 id="_externalcontainer">ExternalContainer</h3>
<div class="paragraph">
<p>org.apache.deltaspike.testcontrol.spi.ExternalContainer allows to
@@ -1053,6 +1078,7 @@ Currently DeltaSpike provides:</p>
</li>
<li><a href="#_spi">SPI</a>
<ul class="sectlevel2">
+<li><a href="#_mockfilter">MockFilter</a></li>
<li><a href="#_externalcontainer">ExternalContainer</a></li>
</ul>
</li>