Modified: websites/staging/deltaspike/trunk/content/retired/build.html
==============================================================================
--- websites/staging/deltaspike/trunk/content/retired/build.html (original)
+++ websites/staging/deltaspike/trunk/content/retired/build.html Sat Aug 1
21:44:56 2015
@@ -80,7 +80,18 @@
<div class="page-title">
<h1>Building DeltaSpike from source</h1>
</div>
- <div class="toc">
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink,
h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink,
dt:hover > .elementid-permalink { visibility: visible }</style>
+<div class="toc">
<ul>
<li><a href="#introduction">Introduction</a><ul>
<li><a href="#full-build">Full build</a></li>
@@ -116,78 +127,78 @@
</ul>
</div>
<hr />
-<h1 id="introduction">Introduction</h1>
+<h1 id="introduction">Introduction<a class="headerlink" href="#introduction"
title="Permanent link">¶</a></h1>
<p>Deltaspike uses <a href="http://maven.apache.org/";>maven</a> build tool to
automate the compilation, testing and packaging of the project</p>
-<h2 id="full-build">Full build</h2>
+<h2 id="full-build">Full build<a class="headerlink" href="#full-build"
title="Permanent link">¶</a></h2>
<div class="codehilite"><pre><span class="n">mvn</span> <span
class="n">clean</span> <span class="n">install</span>
</pre></div>
-<h2 id="build-with-test">Build with test</h2>
+<h2 id="build-with-test">Build with test<a class="headerlink"
href="#build-with-test" title="Permanent link">¶</a></h2>
<div class="codehilite"><pre><span class="n">mvn</span> <span
class="n">clean</span> <span class="n">install</span> <span
class="o">-</span><span class="n">POWB</span> <span class="o">//</span><span
class="n">execute</span> <span class="n">the</span> <span class="n">unit</span>
<span class="n">tests</span> <span class="n">with</span> <span
class="n">OpenWebBeans</span>
<span class="n">or</span>
<span class="n">mvn</span> <span class="n">clean</span> <span
class="n">install</span> <span class="o">-</span><span class="n">PWeld</span>
<span class="o">//</span><span class="n">execute</span> <span
class="n">the</span> <span class="n">unit</span> <span class="n">tests</span>
<span class="n">with</span> <span class="n">Weld</span>
</pre></div>
-<h2 id="integration-tests">Integration Tests</h2>
+<h2 id="integration-tests">Integration Tests<a class="headerlink"
href="#integration-tests" title="Permanent link">¶</a></h2>
<p>With the unpack Maven-Plugin all Arquillian-Tests get copied to the
integration-test module. Together with the special integration-tests they get
executed via a remote container. Currently we have configurations for the
following containers.</p>
-<h3 id="tomee">TomEE</h3>
+<h3 id="tomee">TomEE<a class="headerlink" href="#tomee" title="Permanent
link">¶</a></h3>
<p><strong>Executing the Arquillian tests with Apache TomEE</strong></p>
<div class="codehilite"><pre><span class="n">mvn</span> <span
class="n">clean</span> <span class="n">install</span> <span
class="o">-</span><span class="n">Ptomee</span><span class="o">-</span><span
class="n">build</span><span class="o">-</span><span class="n">managed</span>
</pre></div>
-<h3 id="jboss-as7">JBoss AS7</h3>
-<h4 id="without-existing-as7">Without existing AS7</h4>
+<h3 id="jboss-as7">JBoss AS7<a class="headerlink" href="#jboss-as7"
title="Permanent link">¶</a></h3>
+<h4 id="without-existing-as7">Without existing AS7<a class="headerlink"
href="#without-existing-as7" title="Permanent link">¶</a></h4>
<p><strong>Executing the Arquillian tests with JBoss AS7 (without AS7
installation)</strong></p>
<div class="codehilite"><pre><span class="n">mvn</span> <span
class="n">clean</span> <span class="n">install</span> <span
class="o">-</span><span class="n">Pjbossas</span><span class="o">-</span><span
class="n">build</span><span class="o">-</span><span
class="n">managed</span><span class="o">-</span>7
</pre></div>
-<h4 id="with-existing-as7">With existing AS7</h4>
+<h4 id="with-existing-as7">With existing AS7<a class="headerlink"
href="#with-existing-as7" title="Permanent link">¶</a></h4>
<p>Set JBoss_HOME</p>
<p><strong>Executing the Arquillian tests with JBoss AS7 (AS7 installation
required)</strong></p>
<div class="codehilite"><pre><span class="n">mvn</span> <span
class="n">clean</span> <span class="n">install</span> <span
class="o">-</span><span class="n">Pjbossas</span><span class="o">-</span><span
class="n">managed</span><span class="o">-</span>7
</pre></div>
-<h3 id="wildfly-8">WildFly 8</h3>
-<h4 id="without-existing-wf8">Without existing WF8</h4>
+<h3 id="wildfly-8">WildFly 8<a class="headerlink" href="#wildfly-8"
title="Permanent link">¶</a></h3>
+<h4 id="without-existing-wf8">Without existing WF8<a class="headerlink"
href="#without-existing-wf8" title="Permanent link">¶</a></h4>
<p><strong>Executing the Arquillian tests with JBoss-WF8 (without WF8
installation)</strong></p>
<div class="codehilite"><pre><span class="n">mvn</span> <span
class="n">clean</span> <span class="n">install</span> <span
class="o">-</span><span class="n">Pwildfly</span><span class="o">-</span><span
class="n">build</span><span class="o">-</span><span class="n">managed</span>
</pre></div>
-<h4 id="with-existing-wf8">With existing WF8</h4>
+<h4 id="with-existing-wf8">With existing WF8<a class="headerlink"
href="#with-existing-wf8" title="Permanent link">¶</a></h4>
<p>Set WILDFLY_HOME</p>
<p><strong>Executing the Arquillian tests with JBoss-WF8 (WF8 installation
required)</strong></p>
<div class="codehilite"><pre><span class="n">mvn</span> <span
class="n">clean</span> <span class="n">install</span> <span
class="o">-</span><span class="n">Pwildfly</span><span class="o">-</span><span
class="n">managed</span>
</pre></div>
-<h3 id="glassfish-31">GlassFish 3.1</h3>
-<h4 id="without-existing-gf3">Without existing GF3</h4>
+<h3 id="glassfish-31">GlassFish 3.1<a class="headerlink" href="#glassfish-31"
title="Permanent link">¶</a></h3>
+<h4 id="without-existing-gf3">Without existing GF3<a class="headerlink"
href="#without-existing-gf3" title="Permanent link">¶</a></h4>
<p><strong>Executing the Arquillian tests with GF3 (without GF3
installation)</strong></p>
<div class="codehilite"><pre><span class="n">mvn</span> <span
class="n">clean</span> <span class="n">install</span> <span
class="o">-</span><span class="n">Pglassfish</span><span
class="o">-</span><span class="n">build</span><span class="o">-</span><span
class="n">managed</span><span class="o">-</span>3
</pre></div>
-<h4 id="with-existing-gf3">With existing GF3</h4>
+<h4 id="with-existing-gf3">With existing GF3<a class="headerlink"
href="#with-existing-gf3" title="Permanent link">¶</a></h4>
<p>Install GlassFish (default setup without admin-password) and start
GlassFish with asadmin start-domain <strong>and</strong> asadmin
start-database</p>
<p><strong>Executing the Arquillian tests with Oracle Glassfish
3.1+</strong></p>
<div class="codehilite"><pre><span class="n">mvn</span> <span
class="n">clean</span> <span class="n">install</span> <span
class="o">-</span><span class="n">Pglassfish</span><span
class="o">-</span><span class="n">remote</span><span class="o">-</span>3<span
class="p">.</span>1
</pre></div>
-<h3 id="glassfish-4">GlassFish 4</h3>
-<h4 id="without-existing-gf4">Without existing GF4</h4>
+<h3 id="glassfish-4">GlassFish 4<a class="headerlink" href="#glassfish-4"
title="Permanent link">¶</a></h3>
+<h4 id="without-existing-gf4">Without existing GF4<a class="headerlink"
href="#without-existing-gf4" title="Permanent link">¶</a></h4>
<p><strong>Executing the Arquillian tests with GF4 (without GF4
installation)</strong></p>
<div class="codehilite"><pre><span class="n">mvn</span> <span
class="n">clean</span> <span class="n">install</span> <span
class="o">-</span><span class="n">Pglassfish</span><span
class="o">-</span><span class="n">build</span><span class="o">-</span><span
class="n">managed</span><span class="o">-</span>4
</pre></div>
-<h3 id="weblogic-12c">WebLogic 12c</h3>
+<h3 id="weblogic-12c">WebLogic 12c<a class="headerlink" href="#weblogic-12c"
title="Permanent link">¶</a></h3>
<p>Install WebLogic 12c. Start Confiuration Wizard to create a new basic
WebLogic Domain. Default options and domain name = base_domain, administrator
user name = weblogic1, administrator password = weblogic1.
Set WLS_HOME so that %WLS_HOME%\server\lib\weblogic.jar exists.
Start the domain.</p>
@@ -196,9 +207,9 @@ Start the domain.</p>
</pre></div>
-<h2 id="jenkins-builds">Jenkins Builds</h2>
+<h2 id="jenkins-builds">Jenkins Builds<a class="headerlink"
href="#jenkins-builds" title="Permanent link">¶</a></h2>
<p><a
href="https://builds.apache.org/view/A-D/view/DeltaSpike/";>https://builds.apache.org/view/A-D/view/DeltaSpike/</a></p>
-<h2 id="sonar">Sonar</h2>
+<h2 id="sonar">Sonar<a class="headerlink" href="#sonar" title="Permanent
link">¶</a></h2>
<p>https://analysis.apache.org/dashboard/index/org.apache.deltaspike:deltaspike-project</p>
</div>
</div>
@@ -206,7 +217,7 @@ Start the domain.</p>
<hr>
<footer>
- <p>Copyright © 2011-2014 The Apache Software Foundation, Licensed
under the Apache License, Version 2.0.</p>
+ <p>Copyright © 2011-2015 The Apache Software Foundation, Licensed
under the Apache License, Version 2.0.</p>
<p>Apache and the Apache feather logo are trademarks of The Apache
Software Foundation.</p>
</footer>
Modified: websites/staging/deltaspike/trunk/content/retired/community.html
==============================================================================
--- websites/staging/deltaspike/trunk/content/retired/community.html (original)
+++ websites/staging/deltaspike/trunk/content/retired/community.html Sat Aug 1
21:44:56 2015
@@ -80,7 +80,18 @@
<div class="page-title">
<h1>Community</h1>
</div>
- <div class="toc">
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink,
h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink,
dt:hover > .elementid-permalink { visibility: visible }</style>
+<div class="toc">
<ul>
<li><a href="#introduction">Introduction</a></li>
<li><a href="#users">Users</a></li>
@@ -96,28 +107,28 @@
</ul>
</div>
<hr />
-<h1 id="introduction">Introduction</h1>
-<h1 id="users">Users</h1>
+<h1 id="introduction">Introduction<a class="headerlink" href="#introduction"
title="Permanent link">¶</a></h1>
+<h1 id="users">Users<a class="headerlink" href="#users" title="Permanent
link">¶</a></h1>
<p>If you are a new user and you would like to start using DeltaSpike, you can
have a look at the <a href="documentation/">Documentation</a> and <a
href="mailto:[email protected]";>subscribe</a> our <a
href="mailto:[email protected]";>mailing list for users</a>.
If you have troubles to find the information you are looking for, you can also
ask in our <a href="#IRC">IRC-Channel</a>.</p>
<p>Furthermore, you can check our <a
href="#mailing-lists">mail-archives</a>.</p>
<p>Before you file a ticket in our <a
href="https://issues.apache.org/jira/browse/DELTASPIKE";>Jira</a>, please ask on
the mailing list if it's a known issue in case of a bug or if there is an
ongoing discussion in case of a feature.</p>
<p>You are very welcome to follow our twitter account <a
href="http://twitter.com/#!/DeltaSpikeTeam";>@DeltaSpikeTeam</a> and spread the
word of DeltaSpike with Tweets, Blog-Entries,...</p>
-<h1 id="getting-involved">Getting Involved</h1>
+<h1 id="getting-involved">Getting Involved<a class="headerlink"
href="#getting-involved" title="Permanent link">¶</a></h1>
<p>Everybody is welcome to get involved with our community. You can find
general information at <a
href="http://apache.org/foundation/getinvolved.html";>http://apache.org/foundation/getinvolved.html</a>
and <a
href="http://apache.org/foundation/how-it-works.html";>http://apache.org/foundation/how-it-works.html</a>.
The following sections provides some details about the different levels of
getting involved.</p>
<p>If you want to contribute with <a href="/documentation/">DeltaSpike
Documentation</a>, please read the <a href="documentation.html">instructions
about the Documentation</a> that adresses how to contribute, render and
publish it.</p>
-<h2 id="contributors">Contributors</h2>
+<h2 id="contributors">Contributors<a class="headerlink" href="#contributors"
title="Permanent link">¶</a></h2>
<p>Before you get a committer you have to contribute to our effort. E.g. you
can help users, participate in discussions on the dev list, submit patches,...
. Therefore, it's essential to file a/n <a
href="http://www.apache.org/licenses/icla.txt";>(I)CLA</a> or <a
href="http://www.apache.org/licenses/cla-corporate.txt";>CLA</a> and send it to
secretary at apache dot org (or fax it) as early as possible.</p>
<p>If you would like to submit a patch through Jira, you can have a look at
the <a href="suggested-git-workflows.html">suggested approach</a>.</p>
<p>Here is the contributors/committers page: <a
href="contributors.html">Contributors</a>.</p>
-<h2 id="committers">Committers</h2>
+<h2 id="committers">Committers<a class="headerlink" href="#committers"
title="Permanent link">¶</a></h2>
<p>Before you read this section, please ensure that you have read the
contributor section. All of you are welcome to join our development effort. <a
href="mailto:[email protected]";>Subscribe</a> our <a
href="mailto:[email protected]";>mailing list for developers</a> and
start contributing and help users.</p>
<p>Optionally <a
href="mailto:[email protected]";>subscribe</a> our <a
href="mailto:[email protected]";>mailing list for commits</a>.</p>
<p>Furthermore, you can check our <a
href="community.html#mailing-lists">mail-archives</a>.</p>
<p>Further details are available at <a
href="http://www.apache.org/dev/";>http://www.apache.org/dev/</a>.</p>
-<h1 id="mailing-lists">Mailing lists</h1>
+<h1 id="mailing-lists">Mailing lists<a class="headerlink"
href="#mailing-lists" title="Permanent link">¶</a></h1>
<table class="table">
<thead>
<tr>
@@ -159,11 +170,11 @@ about the Documentation</a> that adresse
</tbody>
</table>
-<h1 id="jira">JIRA</h1>
+<h1 id="jira">JIRA<a class="headerlink" href="#jira" title="Permanent
link">¶</a></h1>
<p>Any kind of issue has to be filed in our <a
href="https://issues.apache.org/jira/browse/DELTASPIKE";>issue-tracker</a>. If
you have any question, you can ask us (e.g. via the mailing list for users).</p>
-<h1 id="spread-the-word">Spread the word</h1>
+<h1 id="spread-the-word">Spread the word<a class="headerlink"
href="#spread-the-word" title="Permanent link">¶</a></h1>
<p>You are very welcome e.g. to write blog entries, tweet (#DeltaSpike) about
the project or just follow our twitter account (<a
href="http://twitter.com/#!/DeltaSpikeTeam";>@DeltaSpikeTeam</a>), ...</p>
-<h1 id="irc">IRC</h1>
+<h1 id="irc">IRC<a class="headerlink" href="#irc" title="Permanent
link">¶</a></h1>
<p>Usually discussions happen on the mailing list. Some informal discussions
take place in our IRC-Channel <a
href="irc://irc.freenode.net/deltaspike">irc://irc.freenode.net/deltaspike</a></p>
<div class="codehilite"><pre><span class="c1">//with the irssi command-line
client:</span>
<span class="err">$</span> <span class="n">irssi</span>
@@ -180,7 +191,7 @@ about the Documentation</a> that adresse
<hr>
<footer>
- <p>Copyright © 2011-2014 The Apache Software Foundation, Licensed
under the Apache License, Version 2.0.</p>
+ <p>Copyright © 2011-2015 The Apache Software Foundation, Licensed
under the Apache License, Version 2.0.</p>
<p>Apache and the Apache feather logo are trademarks of The Apache
Software Foundation.</p>
</footer>
Modified: websites/staging/deltaspike/trunk/content/retired/configuration.html
==============================================================================
--- websites/staging/deltaspike/trunk/content/retired/configuration.html
(original)
+++ websites/staging/deltaspike/trunk/content/retired/configuration.html Sat
Aug 1 21:44:56 2015
@@ -80,7 +80,18 @@
<div class="page-title">
<h1>DeltaSpike Configuration Mechanism</h1>
</div>
- <div class="toc">
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink,
h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink,
dt:hover > .elementid-permalink { visibility: visible }</style>
+<div class="toc">
<ul>
<li><a href="#configuration-basics">Configuration Basics</a><ul>
<li><a href="#benefits-for-production">Benefits for Production</a></li>
@@ -109,12 +120,12 @@
</ul>
</div>
<hr />
-<h1 id="configuration-basics">Configuration Basics</h1>
+<h1 id="configuration-basics">Configuration Basics<a class="headerlink"
href="#configuration-basics" title="Permanent link">¶</a></h1>
<p>The goal of the DeltaSpike configuration mechanism is to make it obsolete
to touch
released binaries for changing the configuration of your project.
All values which are needed in your code (but should not be hardcoded as
static final constants) can be
maintained via DeltaSpikes own configuration mechanism in a very flexible and
powerful way.</p>
-<h3 id="benefits-for-production">Benefits for Production</h3>
+<h3 id="benefits-for-production">Benefits for Production<a class="headerlink"
href="#benefits-for-production" title="Permanent link">¶</a></h3>
<p>Once a binary like a WAR file or an EAR got created and tested, it must
<em>not</em> get changed anymore.
The exact same binary which got created by the release manager will get moved
to the Test system,
then further propagated to the Staging environment and finally (if all people
are happy with it)
@@ -123,13 +134,13 @@ will get moved to the Production system.
inside the binary and allowing to amend this configuration (e.g. database
credentials,
some URLs from remote REST or SOAP endpoints, etc) from outside
like environment settings, JNDI or the current <a
href="projectstage.html">ProjectStage</a>.</p>
-<h3 id="drop-in-configuration">Drop-In Configuration</h3>
+<h3 id="drop-in-configuration">Drop-In Configuration<a class="headerlink"
href="#drop-in-configuration" title="Permanent link">¶</a></h3>
<p>This mechanism also allows for dynamic configuration in case of a JAR
drop-in.
By adding some JAR to the classpath, all it's contained configuration will get
picked up
and considered in the property value evaluation.
You could also use this mechanism to switch implementations of some SPI
(Service Provider Interface) in your own code.</p>
-<h3 id="cdi-extension-configuration">CDI-Extension Configuration</h3>
+<h3 id="cdi-extension-configuration">CDI-Extension Configuration<a
class="headerlink" href="#cdi-extension-configuration" title="Permanent
link">¶</a></h3>
<p>In some cases low-level configs are needed e.g. during the bootstrapping
process of the CDI container.</p>
<p>The good news: our DeltaSpike configuration mechanism does not rely on any
other EE mechanism to
be booted. Which means it can perfectly get used to even configure those parts
itself.
@@ -139,12 +150,12 @@ configured values which can be used in t
DeltaSpike needs such a low-level approach for several features internally,
but users can utilize it for their own needs as well.
This is done by using the <code>ConfigResolver</code> which resolves and
caches <code>ConfigSource</code>s per application.</p>
-<h3 id="userland-configuration">Userland Configuration</h3>
+<h3 id="userland-configuration">Userland Configuration<a class="headerlink"
href="#userland-configuration" title="Permanent link">¶</a></h3>
<p>DeltaSpike also provides a mechanism to inject those configured values
using the
<code>@ConfigProperty</code> CDI Qualifier.</p>
-<h1 id="configresolver">ConfigResolver</h1>
+<h1 id="configresolver">ConfigResolver<a class="headerlink"
href="#configresolver" title="Permanent link">¶</a></h1>
<p>The <code>ConfigResolver</code> is the central point to pick up configured
values in DeltaSpike.</p>
-<h3 id="getpropertyvalue">getPropertyValue()</h3>
+<h3 id="getpropertyvalue">getPropertyValue()<a class="headerlink"
href="#getpropertyvalue" title="Permanent link">¶</a></h3>
<p>The method <code>ConfigResolver#getPropertyValue(String key)</code> allows
to provide a string based key and
returns the configured value as <code>String</code>, or <code>null</code> if
no value has been found.</p>
<p><code>ConfigResolver#getAllPropertyValues(String key)</code> has a similar
contract but it returns a list which might
@@ -154,7 +165,7 @@ be empty if there are no configured valu
</pre></div>
-<h3
id="getprojectstageawarepropertyvalue">getProjectStageAwarePropertyValue()</h3>
+<h3
id="getprojectstageawarepropertyvalue">getProjectStageAwarePropertyValue()<a
class="headerlink" href="#getprojectstageawarepropertyvalue" title="Permanent
link">¶</a></h3>
<p>The method <code>ConfigResolver#getProjectStageAwarePropertyValue(String
key)</code> utilizes the
<a href="projectstage.html">DeltaSpike ProjectStage</a> mechanism to allow
configured values
to depend on the current <code>ProjectStage</code> of the system we run on.</p>
@@ -165,7 +176,7 @@ we found a configured value.</p>
<li>key + '.' + projectStage , e.g. "databaseconfig.username.Production"</li>
<li>key alone , e.g. "databaseconfig.username"</li>
</ul>
-<h3 id="getpropertyawarepropertyvalue">getPropertyAwarePropertyValue()</h3>
+<h3 id="getpropertyawarepropertyvalue">getPropertyAwarePropertyValue()<a
class="headerlink" href="#getpropertyawarepropertyvalue" title="Permanent
link">¶</a></h3>
<p>The method <code>ConfigResolver#getProjectStageAwarePropertyValue(String
key, String property)</code>
first looks up the configured value of the given property and uses this value
to determine
the final lookup path. All those lookups take the <a
href="projectstage.html">DeltaSpike ProjectStage</a>
@@ -188,7 +199,7 @@ lookup chain is used until a value got f
<li>key + '.' + projectstage, e.g. "databaseconfig.username.Production"</li>
<li>key, e.g. "databaseconfig.username"</li>
</ul>
-<h3 id="handling-of-default-values">handling of default values</h3>
+<h3 id="handling-of-default-values">handling of default values<a
class="headerlink" href="#handling-of-default-values" title="Permanent
link">¶</a></h3>
<p>There is a 2nd variant of all those methods where it is possible to provide
a
default value which gets returned instead of <code>null</code> or if the final
result is an empty String.</p>
<p><strong>Performance Hint:</strong></p>
@@ -197,7 +208,7 @@ The various getPropertyValue operations
the ConfigSources. This makes the overall calculation a bit slower, but allows
for values to change
dynamically if someone likes to e.g. implement a <code>JmxConfigSource</code>
(not yet part of DeltaSpike,
but easily implementable).</p>
-<h1 id="configsource">ConfigSource</h1>
+<h1 id="configsource">ConfigSource<a class="headerlink" href="#configsource"
title="Permanent link">¶</a></h1>
<p>A <code>ConfigSource</code> is exactly what it's name says: a source for
configured values.
The <code>ConfigResolver</code> uses all configured implementations of
<code>ConfigSource</code> to lookup the property in question.</p>
<p>Each 'ConfigSource' has a specified 'ordinal' which can be configured using
the key <code>deltaspike_ordinal</code>.
@@ -206,7 +217,7 @@ A higher ordinal means that the values t
ConfigSources. This is the trick which allows to amend configuration from
outside a binary - given
those outside ConfigSources have a higher <code>deltaspike_ordinal</code> than
the ones who pickup the values from
within the release binaries.</p>
-<h3 id="configsources-provided-by-default">ConfigSources provided by
default</h3>
+<h3 id="configsources-provided-by-default">ConfigSources provided by default<a
class="headerlink" href="#configsources-provided-by-default" title="Permanent
link">¶</a></h3>
<p>Per default there are implementations for the following config sources
(listed in the lookup order):</p>
<ul>
<li>System properties (deltaspike_ordinal = 400)</li>
@@ -221,7 +232,7 @@ within the release binaries.</p>
- If a custom implementation should be invoked <em>after</em> the default
implementations, use an ordinal-value < 100
- The <code>ConfigResolver</code> performs no caching. If your custom
ConfigSource operation is expensive, then you might
think about introducing some caching.</p>
-<h3 id="reordering-of-the-default-order-of-config-sources">Reordering of the
default order of Config-Sources</h3>
+<h3 id="reordering-of-the-default-order-of-config-sources">Reordering of the
default order of Config-Sources<a class="headerlink"
href="#reordering-of-the-default-order-of-config-sources" title="Permanent
link">¶</a></h3>
<p>To change the lookup order, you have to configure the ordinal in the
corresponding config source
(e.g. to change the config ordinal of the config source for system properties,
you have to set
the system property with the ordinal key 'deltaspike_ordinal' and the new
value).</p>
@@ -233,7 +244,7 @@ That means, you have to add e.g. <code>d
<p><strong>Hint:</strong></p>
<p>In case of <strong>property files</strong> which are supported by default
(<code>/META-INF/apache-deltaspike.properties</code>)
every file is handled as independent config-source, but all of them have
ordinal 400 by default (and can be reordered in a fine-grained manner).</p>
-<h2 id="custom-config-sources">Custom Config-Sources</h2>
+<h2 id="custom-config-sources">Custom Config-Sources<a class="headerlink"
href="#custom-config-sources" title="Permanent link">¶</a></h2>
<p>ConfigSources are picked up using the `java.util.ServiceLoader'
mechanism.</p>
<p>To add a custom config-source, you have to implement the interface
<code>ConfigSource</code> and register
your implementation in a file
@@ -248,7 +259,7 @@ via a <code>ConfigSourceProvider</code>,
<p>Have a look at the abstract base-implementation of
<code>ConfigSource</code> DeltaSpike is using internally,
if a custom implementation should load the ordinal value from the config-source
like the default implementations provided by DeltaSpike do.</p>
-<h3 id="propertyfileconfig">PropertyFileConfig</h3>
+<h3 id="propertyfileconfig">PropertyFileConfig<a class="headerlink"
href="#propertyfileconfig" title="Permanent link">¶</a></h3>
<p>For registering all your own property files of a certain name in your
classpath
to get picked up as <code>ConfigSource</code>s you can also provide a class
which implements the <code>PropertyFileConfig</code> interface.</p>
@@ -276,7 +287,7 @@ which implements the <code>PropertyFileC
</pre></div>
-<h1 id="type-safe-configuration">Type-safe configuration</h1>
+<h1 id="type-safe-configuration">Type-safe configuration<a class="headerlink"
href="#type-safe-configuration" title="Permanent link">¶</a></h1>
<p>DeltaSpike provides a way to directly inject configured values into your
code
via the qualifier <code>@ConfigProperty</code>.</p>
<div class="codehilite"><pre><span class="nd">@ApplicationScoped</span>
@@ -299,7 +310,7 @@ via the qualifier <code>@ConfigProperty<
<hr>
<footer>
- <p>Copyright © 2011-2014 The Apache Software Foundation, Licensed
under the Apache License, Version 2.0.</p>
+ <p>Copyright © 2011-2015 The Apache Software Foundation, Licensed
under the Apache License, Version 2.0.</p>
<p>Apache and the Apache feather logo are trademarks of The Apache
Software Foundation.</p>
</footer>
Modified:
websites/staging/deltaspike/trunk/content/retired/container-control.html
==============================================================================
--- websites/staging/deltaspike/trunk/content/retired/container-control.html
(original)
+++ websites/staging/deltaspike/trunk/content/retired/container-control.html
Sat Aug 1 21:44:56 2015
@@ -80,7 +80,18 @@
<div class="page-title">
<h1>Container & Control</h1>
</div>
- <div class="toc">
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink,
h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink,
dt:hover > .elementid-permalink { visibility: visible }</style>
+<div class="toc">
<ul>
<li><a href="#introduction">Introduction</a><ul>
<li><a href="#cdicontainer">CdiContainer</a></li>
@@ -96,13 +107,13 @@
</ul>
</div>
<hr />
-<h1 id="introduction">Introduction</h1>
+<h1 id="introduction">Introduction<a class="headerlink" href="#introduction"
title="Permanent link">¶</a></h1>
<p>There are basically two parts:</p>
<ul>
<li>The <code>CdiContainer</code> interface allows to boot and shutdown the
CDI container in SE applications.</li>
<li>The <code>ContextControl</code> interface allows to control the life-cycle
of the built-in contexts of the CDI container.</li>
</ul>
-<h2 id="cdicontainer">CdiContainer</h2>
+<h2 id="cdicontainer">CdiContainer<a class="headerlink" href="#cdicontainer"
title="Permanent link">¶</a></h2>
<p>You can use the <code>CdiContainerLoader</code> as a simple factory to gain
access to the underlying <code>CdiContainer</code> implementation. This is of
little interest for Java EE applications since the CDI Container
already gets properly booted and shut down by the Servlet container
integration.</p>
<div class="codehilite"><pre><span class="c1">// this will give you a
CdiContainer for Weld or OWB, depending on the jar you added</span>
@@ -122,7 +133,7 @@ already gets properly booted and shut do
</pre></div>
-<h2 id="contextcontrol-usage">ContextControl usage</h2>
+<h2 id="contextcontrol-usage">ContextControl usage<a class="headerlink"
href="#contextcontrol-usage" title="Permanent link">¶</a></h2>
<p>The <code>ContextControl</code> interface allows you to start and stop
built-in standard Contexts like <code>@RequestScoped</code>,
<code>@ConversationScoped</code>, <code>@SessionScoped</code>, etc. It is
provided as <code>@Dependent</code> bean and can get injected in the classic
CDI way. This is not only usable in Java SE projects but also very helpful in
Servlets and Java EE containers.</p>
<p><strong>Restarting the RequestContext in unit tests</strong></p>
<p>In unit testing it can be necessary to test with attached and also with
detached JPA entities. A very common approach for JPA is the <a
href="http://docs.redhat.com/docs/en-US/JBoss_Enterprise_Web_Server/1.0/html/Hibernate_Entity_Manager_Reference_Guide/transactions.html";>entitymanager-per-request
approach</a> and thus have a producer method which creates a @RequestScoped
EntityManager. Since a single unit test is usually treated as one ârequestâ
a problem arises detaching entities.</p>
@@ -174,7 +185,7 @@ You might face such issues, if you would
</pre></div>
-<h2 id="embedded-servlet-support">Embedded Servlet Support</h2>
+<h2 id="embedded-servlet-support">Embedded Servlet Support<a
class="headerlink" href="#embedded-servlet-support" title="Permanent
link">¶</a></h2>
<p>Starting with 1.0.2, you can use DeltaSpike to power embedded Servlet
runtimes. This work is done via Servlet Listeners. The configuration is
specific to each container, below are some examples.</p>
<p>The two main listeners are <code>CdiServletRequestListener</code> and
<code>CdiServletContextListener</code>. <code>CdiServletRequestListener</code>
is responsible for starting a <code>RequestContext</code> on each incoming
request. In most containers this is all you need. For Tomcat specifically,
you need to use <code>CdiServletContextListener</code> which registers the
<code>CdiServletRequestListener</code>.</p>
<p>The main usecase for this feature is for lightweight embedded runtimes,
microservices. For each of these, it is assumed that you are using the
following start up code somewhere:</p>
@@ -184,7 +195,7 @@ You might face such issues, if you would
</pre></div>
-<h3 id="jetty">Jetty</h3>
+<h3 id="jetty">Jetty<a class="headerlink" href="#jetty" title="Permanent
link">¶</a></h3>
<p>For Jetty, you need to add an <code>EventListener</code> which will be your
<code>CdiServletRequestListener</code>. The object must be instantiated. This
must be done before the server is started.</p>
<div class="codehilite"><pre><span class="n">Server</span> <span
class="n">server</span> <span class="o">=</span> <span class="k">new</span>
<span class="n">Server</span><span class="o">(</span><span
class="n">port</span><span class="o">);</span>
<span class="n">ServletContextHandler</span> <span class="n">context</span>
<span class="o">=</span> <span class="k">new</span> <span
class="n">ServletContextHandler</span><span class="o">(</span><span
class="n">ServletContextHandler</span><span class="o">.</span><span
class="na">SESSIONS</span><span class="o">);</span>
@@ -198,7 +209,7 @@ You might face such issues, if you would
</pre></div>
-<h3 id="undertow">Undertow</h3>
+<h3 id="undertow">Undertow<a class="headerlink" href="#undertow"
title="Permanent link">¶</a></h3>
<p>For Undertow, you register the <code>CdiServletRequestListener</code> via
<code>ListenerInfo</code> by passing in the class to their builders. Then you
add the <code>ListenerInfo</code> to your deployment before starting.</p>
<div class="codehilite"><pre><span class="n">ServletInfo</span> <span
class="n">servletInfo</span> <span class="o">=</span> <span
class="n">Servlets</span><span class="o">.</span><span
class="na">servlet</span><span class="o">(</span><span
class="s">"YourServletName"</span><span class="o">,</span> <span
class="n">YourServlet</span><span class="o">.</span><span
class="na">class</span><span class="o">).</span><span
class="na">setAsyncSupported</span><span class="o">(</span><span
class="kc">true</span><span class="o">)</span>
<span class="o">.</span><span class="na">setLoadOnStartup</span><span
class="o">(</span><span class="mi">1</span><span class="o">).</span><span
class="na">addMapping</span><span class="o">(</span><span
class="s">"/*"</span><span class="o">);</span>
@@ -218,7 +229,7 @@ You might face such issues, if you would
</pre></div>
-<h3 id="tomcat">Tomcat</h3>
+<h3 id="tomcat">Tomcat<a class="headerlink" href="#tomcat" title="Permanent
link">¶</a></h3>
<p>For Tomcat, you need to register the <code>CdiServletContextListener</code>
instead of the <code>CdiServletRequestListener</code>. It is added as an
<code>ApplicationListener</code> by passing in the class name as a
<code>String</code>.</p>
<div class="codehilite"><pre><span class="n">Tomcat</span> <span
class="n">tomcat</span> <span class="o">=</span> <span class="k">new</span>
<span class="n">Tomcat</span><span class="o">();</span>
<span class="n">tomcat</span><span class="o">.</span><span
class="na">setPort</span><span class="o">(</span><span
class="n">port</span><span class="o">);</span>
@@ -236,7 +247,7 @@ You might face such issues, if you would
<hr>
<footer>
- <p>Copyright © 2011-2014 The Apache Software Foundation, Licensed
under the Apache License, Version 2.0.</p>
+ <p>Copyright © 2011-2015 The Apache Software Foundation, Licensed
under the Apache License, Version 2.0.</p>
<p>Apache and the Apache feather logo are trademarks of The Apache
Software Foundation.</p>
</footer>
Modified: websites/staging/deltaspike/trunk/content/retired/core.html
==============================================================================
--- websites/staging/deltaspike/trunk/content/retired/core.html (original)
+++ websites/staging/deltaspike/trunk/content/retired/core.html Sat Aug 1
21:44:56 2015
@@ -80,7 +80,18 @@
<div class="page-title">
<h1>Core</h1>
</div>
- <p>Title: Core
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink,
h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink,
dt:hover > .elementid-permalink { visibility: visible }</style>
+<p>Title: Core
Notice: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -160,10 +171,10 @@ Notice: Licensed to the Apache Softwa
</ul>
</div>
<hr />
-<h1 id="core-api">Core - API</h1>
-<h2 id="deltaspike-configuration">DeltaSpike Configuration</h2>
+<h1 id="core-api">Core - API<a class="headerlink" href="#core-api"
title="Permanent link">¶</a></h1>
+<h2 id="deltaspike-configuration">DeltaSpike Configuration<a
class="headerlink" href="#deltaspike-configuration" title="Permanent
link">¶</a></h2>
<p>This is described in an own chapter solely targeting our <a
href="configuration.html">configuration</a> mechanics, API and SPI.</p>
-<h2 id="beanprovider">BeanProvider</h2>
+<h2 id="beanprovider">BeanProvider<a class="headerlink" href="#beanprovider"
title="Permanent link">¶</a></h2>
<p>The <code>BeanProvider</code> is a class which provides (static) util
methods which allow to lookup beans if it isn't possible to inject them via
<code>@Inject</code> or if the lookup depends on dynamic conditions. Instead of
using the term 'bean', the term 'contextual instance' is used because that's
the term used by CDI itself.</p>
<p>The following example shows a simple lookup. With the second parameter it's
possible to specify if the contextual instance is optional. If it isn't
expected that the contextual instance is optional, but no instance has been
found, an <code>IllegalStateException</code> will be thrown.</p>
<p>Resolving a simple contextual instance:</p>
@@ -223,7 +234,7 @@ Notice: Licensed to the Apache Softwa
</pre></div>
-<h2 id="beanmanagerprovider">BeanManagerProvider</h2>
+<h2 id="beanmanagerprovider">BeanManagerProvider<a class="headerlink"
href="#beanmanagerprovider" title="Permanent link">¶</a></h2>
<p>This mechanism provides access to the <code>BeanManager</code> by
registering the current <code>BeanManager</code> during the startup.
This is really handy if you like to access CDI functionality from places where
no CDI based injection is available.
If a simple but manual bean-lookup is needed, it's easier to use the
<code>BeanProvider</code>.</p>
@@ -239,11 +250,11 @@ If a simple but manual bean-lookup is ne
</pre></div>
-<h2 id="type-safe-projectstage">Type-safe ProjectStage</h2>
+<h2 id="type-safe-projectstage">Type-safe ProjectStage<a class="headerlink"
href="#type-safe-projectstage" title="Permanent link">¶</a></h2>
<p>The <a href="projectstage.html">DeltaSpike ProjectStage</a> mechanism allows
to use configuration and implementations depending on the
server environment you currently run on.</p>
-<h2 id="exclude">@Exclude</h2>
+<h2 id="exclude">@Exclude<a class="headerlink" href="#exclude"
title="Permanent link">¶</a></h2>
<p>With <code>@Exclude</code> it's possible to annotate beans which should be
ignored by CDI even if they are in a CDI enabled archive.</p>
<p>Excluding a bean in any case:</p>
<div class="codehilite"><pre><span class="nd">@Exclude</span>
@@ -312,7 +323,7 @@ This config entry won't be changed e.g.
</pre></div>
-<h3 id="custom-expressioninterpreter">Custom ExpressionInterpreter</h3>
+<h3 id="custom-expressioninterpreter">Custom ExpressionInterpreter<a
class="headerlink" href="#custom-expressioninterpreter" title="Permanent
link">¶</a></h3>
<p>Per default only a very simple and limited syntax is supported. In real
projects there are usually quite concrete requirements. Since it would be very
complex to support most of them, it's easier for users to implement an
optimized syntax.
For such cases a custom ExpressionInterpreter is needed:</p>
<div class="codehilite"><pre><span class="nd">@Alternative</span>
@@ -346,9 +357,9 @@ For such cases a custom ExpressionInterp
</pre></div>
-<h2 id="type-safe-view-config">Type-safe View-Config</h2>
+<h2 id="type-safe-view-config">Type-safe View-Config<a class="headerlink"
href="#type-safe-view-config" title="Permanent link">¶</a></h2>
<p>TODO (Overview)</p>
-<h2 id="literals">Literals</h2>
+<h2 id="literals">Literals<a class="headerlink" href="#literals"
title="Permanent link">¶</a></h2>
<p>Literals allow the instantiation of annotations by extending the abstract
class 'javax.enterprise.util.AnnotationLiteral'</p>
<p><strong>Example</strong></p>
<div class="codehilite"><pre><span class="kd">public</span> <span
class="kd">abstract</span> <span class="kd">class</span> <span
class="nc">PayByQualifier</span>
@@ -376,7 +387,7 @@ For such cases a custom ExpressionInterp
<li>SpecializesLiteral</li>
<li>TypedLiteral</li>
</ul>
-<h2 id="messages-i18n">Messages & I18n</h2>
+<h2 id="messages-i18n">Messages & I18n<a class="headerlink"
href="#messages-i18n" title="Permanent link">¶</a></h2>
<p>The following implementation is the minimal effort to use type-safe
messages (which are hardcoded in this case).</p>
<p><strong>Simple type-safe message</strong></p>
<div class="codehilite"><pre><span class="nd">@MessageBundle</span>
@@ -450,8 +461,8 @@ For such cases a custom ExpressionInterp
</pre></div>
-<h2 id="dynamic-message-builder">Dynamic Message Builder</h2>
-<h3 id="creating-message-instances">Creating message instances</h3>
+<h2 id="dynamic-message-builder">Dynamic Message Builder<a class="headerlink"
href="#dynamic-message-builder" title="Permanent link">¶</a></h2>
+<h3 id="creating-message-instances">Creating message instances<a
class="headerlink" href="#creating-message-instances" title="Permanent
link">¶</a></h3>
<p>The following implementation creates an instance of <code>Message</code>
for the key <code>hello</code>. The final text will be resolved and
interpolated lazily. Later on it might be supported to provide a different
<code>MessageContext</code> via <code>#toString(MessageContext)</code> like it
is in MyFaces CODI right now.</p>
<p>You can use <code>#argument(String)</code> to pass these arguments to the
message template specified on <code>#template(String)</code> method. The
template pattern uses printf-style format strings.</p>
<div class="codehilite"><pre><span class="kd">public</span> <span
class="kd">class</span> <span class="nc">MyBean</span>
@@ -492,8 +503,8 @@ For such cases a custom ExpressionInterp
</pre></div>
-<h3 id="customizing-the-message-context">Customizing the message context</h3>
-<h4 id="messageresolver">MessageResolver</h4>
+<h3 id="customizing-the-message-context">Customizing the message context<a
class="headerlink" href="#customizing-the-message-context" title="Permanent
link">¶</a></h3>
+<h4 id="messageresolver">MessageResolver<a class="headerlink"
href="#messageresolver" title="Permanent link">¶</a></h4>
<p>A message-resolver is responsible for creating the message-text based on
the message-descriptor (key or inline-text), the current locale (and in some
cases the message-payload).
(The supported format e.g. if it's required to escape a key, if inline-text is
supported,... depends on the concrete implementation.)
In case of a message-key, the message-resolver has to transform it to the
message-text by looking it up in a message source like a resource-bundle.</p>
@@ -509,7 +520,7 @@ In case of a message-key, the message-re
<p>The result of a <code>MessageResolver</code> is the message-text. The text
might contain placeholders which are processed by a
<code>MessageInterpolator</code></p>
-<h4 id="messageinterpolator">MessageInterpolator</h4>
+<h4 id="messageinterpolator">MessageInterpolator<a class="headerlink"
href="#messageinterpolator" title="Permanent link">¶</a></h4>
<p>A <code>MessageInterpolator</code> replaces the placeholders in a
message-text with the arguments of the message.</p>
<p><strong>Configuration of a message-interpolator</strong></p>
<p>Besides the static config via `@MessageContextConfig#messageInterpolator,
you can use it dynamically via passing a custom message-interpolator instance
to the current messageContext:</p>
@@ -521,7 +532,7 @@ In case of a message-key, the message-re
</pre></div>
-<h4 id="localeresolver">LocaleResolver</h4>
+<h4 id="localeresolver">LocaleResolver<a class="headerlink"
href="#localeresolver" title="Permanent link">¶</a></h4>
<p>A locale resolver provides the current locale. The locale is e.g. used to
by a <code>MessageResolver</code> to choose the correct language for the
message-text.</p>
<p><strong>Configuration of a locale-resolver</strong></p>
<p>Besides the static config via `@MessageContextConfig#localeResolver, you
can use it dynamically via passing a custom locale-resolver instance to the
current messageContext:</p>
@@ -533,7 +544,7 @@ In case of a message-key, the message-re
</pre></div>
-<h2 id="injecting-resources">Injecting Resources</h2>
+<h2 id="injecting-resources">Injecting Resources<a class="headerlink"
href="#injecting-resources" title="Permanent link">¶</a></h2>
<p>DeltaSpike has simple APIs for performing basic resource loading and
property file reading.</p>
<div class="codehilite"><pre><span class="nd">@Inject</span>
<span class="nd">@InjectableResource</span><span class="o">(</span><span
class="s">"myfile.properties"</span><span class="o">)</span>
@@ -542,7 +553,7 @@ In case of a message-key, the message-re
<p>This can be used to read files, from classpath or on your local file
system, using two default implementations:
<code>ClasspathResourceProvider</code> and <code>FileResourceProvider</code>.
They can be extended as well by implementing the
<code>InjectableResourceProvider</code> interface to allow reading from
alternate sources, if needed (e.g. database LOBs, NoSQL storage areas).</p>
-<h2 id="exception-control">Exception Control</h2>
+<h2 id="exception-control">Exception Control<a class="headerlink"
href="#exception-control" title="Permanent link">¶</a></h2>
<p>Exception handling in DeltaSpike is based around the CDI eventing model.
While
the implementation of exception handlers may not be the same as a CDI event,
and the programming model is not exactly the same as specifying a CDI event
@@ -559,7 +570,7 @@ infrastructure.</p>
most cases, you register an exception handler simply by annotating a handler
method. Alternatively, you can handle an exception programmatically, just as
you would observe an event in CDI.</p>
-<h3 id="usage">Usage</h3>
+<h3 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent
link">¶</a></h3>
<p>The entire exception handling process starts with an event. This helps keep
your application minimally coupled to DeltaSpike, but also allows for further
extension. Exception handling in DeltaSpike is all about letting you take care
@@ -591,7 +602,7 @@ an inventory database:</p>
class for use later within a try/catch block.</p>
<p>The event is fired with a new instance of
<code>ExceptionToCatchEvent</code> constructed
with the exception to be handled.</p>
-<h3 id="exception-handlers">Exception handlers</h3>
+<h3 id="exception-handlers">Exception handlers<a class="headerlink"
href="#exception-handlers" title="Permanent link">¶</a></h3>
<p>As an application developer (i.e., an end user of DeltaSpike's exception
handling), you'll be focused on writing exception handlers. An exception
handler is a method on a CDI bean that is invoked to handle a specific type of
@@ -620,7 +631,7 @@ class, have the same qualifiers, the sam
beans annotated with <code>@ExceptionHandler</code>. Exception handlers are
methods
which have a parameter which is an instance of <code>ExceptionEvent<T
extends
Throwable></code> annotated with the <code>@Handles</code> annotation.</p>
-<h4 id="exceptionhandler">@ExceptionHandler</h4>
+<h4 id="exceptionhandler">@ExceptionHandler<a class="headerlink"
href="#exceptionhandler" title="Permanent link">¶</a></h4>
<p>The <code>@ExceptionHandler</code> annotation is simply a marker annotation
that
instructs the DeltaSpike exception handling CDI extension to scan the bean for
handler methods.</p>
@@ -632,7 +643,7 @@ handler methods.</p>
<p>That's all there is to it. Now we can begin defining exception handling
methods on this bean.</p>
-<h4 id="handles-and-beforehandles">@Handles and @BeforeHandles</h4>
+<h4 id="handles-and-beforehandles">@Handles and @BeforeHandles<a
class="headerlink" href="#handles-and-beforehandles" title="Permanent
link">¶</a></h4>
<p><code>@Handles</code> is a method parameter annotation that designates a
method as an
exception handler. Exception handler methods are registered on beans annotated
with <code>@ExceptionHandler</code>. DeltaSpike will discover all such methods
at
@@ -721,7 +732,7 @@ muted), unless it re-enables itself by i
exceptions. Should a handler throw an unchecked exception it will propagate up
the stack and all handling done via DeltaSpike will cease. Any exception that
was being handled will be lost.</p>
-<h4 id="ordinal">Ordinal</h4>
+<h4 id="ordinal">Ordinal<a class="headerlink" href="#ordinal" title="Permanent
link">¶</a></h4>
<p>When DeltaSpike finds more than one handler for the same exception type, it
orders the handlers by ordinal. Handlers with higher ordinal are executed
before handlers with a lower ordinal. If DeltaSpike detects two handlers for
@@ -753,7 +764,7 @@ second method, which has the default ord
ordinal first</li>
<li>Continue above steps for each exception in stack</li>
</ol>
-<h3 id="exception-chain-processing">Exception Chain Processing</h3>
+<h3 id="exception-chain-processing">Exception Chain Processing<a
class="headerlink" href="#exception-chain-processing" title="Permanent
link">¶</a></h3>
<p>When an exception is thrown, chances are it's nested (wrapped) inside other
exceptions. (If you've ever examined a server log, you'll appreciate this
fact). The collection of exceptions in its entirety is termed an exception
@@ -793,14 +804,14 @@ order:</p>
<p>If there's a handler for <code>PersistenceException</code>, it will likely
prevent the
handlers for <code>EJBException</code> from being invoked, which is a good
thing since
what useful information can really be obtained from
<code>EJBException</code>?</p>
-<h3 id="apis-for-exception-information-and-flow-control">APIs for exception
information and flow control</h3>
+<h3 id="apis-for-exception-information-and-flow-control">APIs for exception
information and flow control<a class="headerlink"
href="#apis-for-exception-information-and-flow-control" title="Permanent
link">¶</a></h3>
<p>There are two APIs provided by DeltaSpike that should be familiar to
application developers:</p>
<ul>
<li><code>ExceptionEvent</code></li>
<li><code>ExceptionStackEvent</code></li>
</ul>
-<h5 id="exceptionevent">ExceptionEvent</h5>
+<h5 id="exceptionevent">ExceptionEvent<a class="headerlink"
href="#exceptionevent" title="Permanent link">¶</a></h5>
<p>In addition to providing information about the exception being handled, the
<code>ExceptionEvent</code> object contains methods to control the exception
handling
process, such as rethrowing the exception, aborting the handler chain or
@@ -827,12 +838,12 @@ object to give flow control to the handl
<p>Once a handler is invoked it is muted, meaning it will not be run again for
that exception chain, unless it's explicitly marked as unmuted via the
<code>unmute()</code> method on <code>ExceptionEvent</code>.</p>
-<h2 id="scopes">Scopes</h2>
+<h2 id="scopes">Scopes<a class="headerlink" href="#scopes" title="Permanent
link">¶</a></h2>
<p>DeltaSpike Core provides the API and SPI for several scopes. Currently all
scopes are only implemented in the <a href="jsf.html#scopes">JSF module</a>.
</p>
-<h3 id="windowscoped">@WindowScoped</h3>
-<h3 id="viewaccessscoped">@ViewAccessScoped</h3>
-<h3 id="groupedconversationscoped">@GroupedConversationScoped</h3>
-<h2 id="creating-a-custom-cdi-scope">Creating a custom CDI Scope</h2>
+<h3 id="windowscoped">@WindowScoped<a class="headerlink" href="#windowscoped"
title="Permanent link">¶</a></h3>
+<h3 id="viewaccessscoped">@ViewAccessScoped<a class="headerlink"
href="#viewaccessscoped" title="Permanent link">¶</a></h3>
+<h3 id="groupedconversationscoped">@GroupedConversationScoped<a
class="headerlink" href="#groupedconversationscoped" title="Permanent
link">¶</a></h3>
+<h2 id="creating-a-custom-cdi-scope">Creating a custom CDI Scope<a
class="headerlink" href="#creating-a-custom-cdi-scope" title="Permanent
link">¶</a></h2>
<p>If you want to create a custom CDI scope to match your needs, you will need
to follow these steps:</p>
<p>First, create an Annotation with annotated with @javax.inject.Scope;
Example:</p>
<div class="codehilite"><pre><span class="nd">@Scope</span>
@@ -898,7 +909,7 @@ that exception chain, unless it's explic
</pre></div>
-<h2 id="deactivatable">Deactivatable</h2>
+<h2 id="deactivatable">Deactivatable<a class="headerlink"
href="#deactivatable" title="Permanent link">¶</a></h2>
<p>DeltaSpike allows you to deactivate its own Extensions. You just need to
implement your <a href="spi.html#classdeactivator">ClassDeactivator</a>.</p>
<p>The ClassDeactivator should be resolved by any ConfigSource using the key
<code>org.apache.deltaspike.core.spi.activation.ClassDeactivator</code>. For
example, we can disable SecurityExtension having the following class:</p>
<div class="codehilite"><pre><span class="kd">public</span> <span
class="kd">class</span> <span class="nc">CustomClassDeactivator</span> <span
class="kd">implements</span> <span class="n">ClassDeactivator</span>
@@ -924,48 +935,48 @@ that exception chain, unless it's explic
</pre></div>
-<h1 id="core-utils">Core - Utils</h1>
+<h1 id="core-utils">Core - Utils<a class="headerlink" href="#core-utils"
title="Permanent link">¶</a></h1>
<p>DeltaSpike provides many utility-classes (no constructor / static methods)
that can be useful for your project.</p>
<p>Below you can find an information about these classes.</p>
-<h2 id="arraysutils">ArraysUtils</h2>
+<h2 id="arraysutils">ArraysUtils<a class="headerlink" href="#arraysutils"
title="Permanent link">¶</a></h2>
<p>A collection of utilities for working with Arrays</p>
<ul>
<li><code>#asSet</code> - Create a set from an array. If the array contains
duplicate objects, the last object in the array will be placed in resultant
set.</li>
</ul>
-<h2 id="beanutils">BeanUtils</h2>
+<h2 id="beanutils">BeanUtils<a class="headerlink" href="#beanutils"
title="Permanent link">¶</a></h2>
<p>A set of utility methods for working with beans.</p>
<ul>
<li><code>#getQualifiers</code> - Extract the qualifiers from a set of
annotations.</li>
<li><code>#extractAnnotation</code> - Extract the annotations.</li>
<li><code>#createInjectionPoints</code> - Given a method, and the bean on
which the method is declared, create a collection of injection points
representing the parameters of the method.</li>
</ul>
-<h2 id="classdeactivationutils">ClassDeactivationUtils</h2>
+<h2 id="classdeactivationutils">ClassDeactivationUtils<a class="headerlink"
href="#classdeactivationutils" title="Permanent link">¶</a></h2>
<p>Helper methods for <code>ClassDeactivator</code></p>
<ul>
<li><code>#isActivated</code> - Evaluates if the given
<code>Deactivatable</code> is active.</li>
</ul>
<p>To add a custom <code>ClassDeactivator</code> add
<code>org.apache.deltaspike.core.spi.activation.ClassDeactivator=my.CustomClassDeactivator</code>
to <code>META-INF\apache-deltaspike.properties</code>.
Or configure it via a custom <code>ConfigSource</code>.</p>
-<h2 id="exceptionutils">ExceptionUtils</h2>
+<h2 id="exceptionutils">ExceptionUtils<a class="headerlink"
href="#exceptionutils" title="Permanent link">¶</a></h2>
<p>Helper methods to deal with Exceptions</p>
<ul>
<li><code>#throwAsRuntimeException</code> - helper which allows to use a trick
to throw a catched checked exception without a wrapping exception.</li>
<li><code>#changeAndThrowException</code> - helper which allows to use a trick
to throw a cached checked exception without a wrapping exception.</li>
</ul>
-<h2 id="propertyfileutils">PropertyFileUtils</h2>
+<h2 id="propertyfileutils">PropertyFileUtils<a class="headerlink"
href="#propertyfileutils" title="Permanent link">¶</a></h2>
<p>Helper methods for Property files</p>
<ul>
<li><code>#resolvePropertyFiles</code> - Allows to lookup for resource bundle
files.</li>
<li><code>#loadProperties</code> - Load a Properties file from the given
URL.</li>
<li><code>#getResourceBundle</code> - Return the ResourceBundle for the
current default Locale.</li>
</ul>
-<h2 id="proxyutils">ProxyUtils</h2>
+<h2 id="proxyutils">ProxyUtils<a class="headerlink" href="#proxyutils"
title="Permanent link">¶</a></h2>
<p>Helper for CDI proxies</p>
<ul>
<li><code>#getUnproxiedClass</code> - Return class of the real
implementation.</li>
<li><code>#isProxiedClass</code> - Analyses if the given class is a generated
proxy class.</li>
</ul>
-<h2 id="stringutils">StringUtils</h2>
+<h2 id="stringutils">StringUtils<a class="headerlink" href="#stringutils"
title="Permanent link">¶</a></h2>
<p>A collection of utilities for working with Strings.</p>
<ul>
<li><code>#isEmpty</code> - return true if the String is null or empty (
<code>string.trim().isEmpty()</code> )</li>
@@ -976,7 +987,7 @@ Or configure it via a custom <code>Confi
<hr>
<footer>
- <p>Copyright © 2011-2014 The Apache Software Foundation, Licensed
under the Apache License, Version 2.0.</p>
+ <p>Copyright © 2011-2015 The Apache Software Foundation, Licensed
under the Apache License, Version 2.0.</p>
<p>Apache and the Apache feather logo are trademarks of The Apache
Software Foundation.</p>
</footer>
