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 2020/02/05 11:59:20 UTC
svn commit: r1873629 [3/18] - /deltaspike/site/trunk/content/documentation/
Modified: deltaspike/site/trunk/content/documentation/configuration.html
URL: http://svn.apache.org/viewvc/deltaspike/site/trunk/content/documentation/configuration.html?rev=1873629&r1=1873628&r2=1873629&view=diff
==============================================================================
--- deltaspike/site/trunk/content/documentation/configuration.html (original)
+++ deltaspike/site/trunk/content/documentation/configuration.html Wed Feb 5 11:59:19 2020
@@ -1,1205 +1,1205 @@
-<!DOCTYPE html>
-<head>
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
- <meta name="description" content="deltaspike-generate-pages">
- <meta name="author" content="chm">
- <!-- No caching headers -->
- <meta http-equiv="cache-control" content="no-cache"/>
- <meta http-equiv="pragma" content="no-cache"/>
- <meta http-equiv="expires" content="-1"/>
-
- <title>DeltaSpike Configuration Mechanism</title>
-
- <!--
- 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
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
- -->
-
- <!-- Styles -->
- <link href="https://deltaspike.apache.org/resources/css/bootstrap.css" rel="stylesheet">
- <link href="https://deltaspike.apache.org/resources/css/bootstrap-responsive.css" rel="stylesheet">
- <link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/3.1.0/css/font-awesome.min.css" rel="stylesheet">
-
-
-
-
- <!-- Tocify - nice dynamic autoscrolling TOC -->
- <link href="https://cdnjs.cloudflare.com/ajax/libs/jquery.tocify/1.9.0/stylesheets/jquery.tocify.min.css" rel="stylesheet">
- <script src="https://code.jquery.com/jquery-1.11.3.min.js"></script>
- <script src="https://cdnjs.cloudflare.com/ajax/libs/jqueryui/1.11.4/jquery-ui.min.js"></script>
- <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery.tocify/1.9.0/javascripts/jquery.tocify.min.js"></script>
-
-
- <script type="text/javascript">
- $(function () {
- $("#toc").tocify({
- scrollTo: 50,
- extendPage: true,
- context: "#doc-content",
- selectors: "h2,h3,h4,h5"
- });
- $(".fallback-toc").hide();
- });
- </script>
-
-
- <style type="text/css">
- /* Stylesheet for CodeRay to match GitHub theme | MIT License | http://foundation.zurb.com */
-/*pre.CodeRay {background-color:#f7f7f8;}*/
-.CodeRay .line-numbers{border-right:1px solid #d8d8d8;padding:0 0.5em 0 .25em}
-.CodeRay span.line-numbers{display:inline-block;margin-right:.5em;color:rgba(0,0,0,.3)}
-.CodeRay .line-numbers strong{font-weight: normal}
-table.CodeRay{border-collapse:separate;border-spacing:0;margin-bottom:0;border:0;background:none}
-table.CodeRay td{vertical-align: top}
-table.CodeRay td.line-numbers{text-align:right}
-table.CodeRay td.line-numbers>pre{padding:0;color:rgba(0,0,0,.3)}
-table.CodeRay td.code{padding:0 0 0 .5em}
-table.CodeRay td.code>pre{padding:0}
-.CodeRay .debug{color:#fff !important;background:#000080 !important}
-.CodeRay .annotation{color:#007}
-.CodeRay .attribute-name{color:#000080}
-.CodeRay .attribute-value{color:#700}
-.CodeRay .binary{color:#509}
-.CodeRay .comment{color:#998;font-style:italic}
-.CodeRay .char{color:#04d}
-.CodeRay .char .content{color:#04d}
-.CodeRay .char .delimiter{color:#039}
-.CodeRay .class{color:#458;font-weight:bold}
-.CodeRay .complex{color:#a08}
-.CodeRay .constant,.CodeRay .predefined-constant{color:#008080}
-.CodeRay .color{color:#099}
-.CodeRay .class-variable{color:#369}
-.CodeRay .decorator{color:#b0b}
-.CodeRay .definition{color:#099}
-.CodeRay .delimiter{color:#000}
-.CodeRay .doc{color:#970}
-.CodeRay .doctype{color:#34b}
-.CodeRay .doc-string{color:#d42}
-.CodeRay .escape{color:#666}
-.CodeRay .entity{color:#800}
-.CodeRay .error{color:#808}
-.CodeRay .exception{color:inherit}
-.CodeRay .filename{color:#099}
-.CodeRay .function{color:#900;font-weight:bold}
-.CodeRay .global-variable{color:#008080}
-.CodeRay .hex{color:#058}
-.CodeRay .integer,.CodeRay .float{color:#099}
-.CodeRay .include{color:#555}
-.CodeRay .inline{color:#00}
-.CodeRay .inline .inline{background:#ccc}
-.CodeRay .inline .inline .inline{background:#bbb}
-.CodeRay .inline .inline-delimiter{color:#d14}
-.CodeRay .inline-delimiter{color:#d14}
-.CodeRay .important{color:#555;font-weight:bold}
-.CodeRay .interpreted{color:#b2b}
-.CodeRay .instance-variable{color:#008080}
-.CodeRay .label{color:#970}
-.CodeRay .local-variable{color:#963}
-.CodeRay .octal{color:#40e}
-.CodeRay .predefined{color:#369}
-.CodeRay .preprocessor{color:#579}
-.CodeRay .pseudo-class{color:#555}
-.CodeRay .directive{font-weight:bold}
-.CodeRay .type{font-weight:bold}
-.CodeRay .predefined-type{color:inherit}
-.CodeRay .reserved,.CodeRay .keyword {color:#000;font-weight:bold}
-.CodeRay .key{color:#808}
-.CodeRay .key .delimiter{color:#606}
-.CodeRay .key .char{color:#80f}
-.CodeRay .value{color:#088}
-.CodeRay .regexp .delimiter{color:#808}
-.CodeRay .regexp .content{color:#808}
-.CodeRay .regexp .modifier{color:#808}
-.CodeRay .regexp .char{color:#d14}
-.CodeRay .regexp .function{color:#404;font-weight:bold}
-.CodeRay .string{color:#d20}
-.CodeRay .string .string .string{background:#ffd0d0}
-.CodeRay .string .content{color:#d14}
-.CodeRay .string .char{color:#d14}
-.CodeRay .string .delimiter{color:#d14}
-.CodeRay .shell{color:#d14}
-.CodeRay .shell .delimiter{color:#d14}
-.CodeRay .symbol{color:#990073}
-.CodeRay .symbol .content{color:#a60}
-.CodeRay .symbol .delimiter{color:#630}
-.CodeRay .tag{color:#008080}
-.CodeRay .tag-special{color:#d70}
-.CodeRay .variable{color:#036}
-.CodeRay .insert{background:#afa}
-.CodeRay .delete{background:#faa}
-.CodeRay .change{color:#aaf;background:#007}
-.CodeRay .head{color:#f8f;background:#505}
-.CodeRay .insert .insert{color:#080}
-.CodeRay .delete .delete{color:#800}
-.CodeRay .change .change{color:#66f}
-.CodeRay .head .head{color:#f4f}
-
- body {
- padding-top: 60px;
- padding-bottom: 40px;
- }
-
- .toc-like {
- border-radius: 6px;
- border: 1px solid #ccc;
- }
-
- .toc-like li {
- line-height: 30px;
- text-indent: 10px;
- }
-
- .toc-like li.custom-toc-header {
- font-weight: bold;
- background: #666;
- color: white;
- cursor: initial !important;
- padding: 5px;
- }
-
- .toc-like li.custom-toc-header a {
- color: white;
- font-style: normal;
- text-shadow: none;
- padding: 0;
- }
-
- .toc-like li.custom-toc-header:hover a {
- background: #666;
- }
-
- .page-title {
- text-align: left;
- }
-
- #doc-content h2,
- #doc-content h3,
- #doc-content h4,
- #doc-content h5,
- #doc-content h6 {
- padding-top: 0;
- margin-top: 25px;
- margin-bottom: 10px;
- line-height: 1.4em;
- }
-
- #doc-content h2 {
- border-bottom: 1px solid lightgrey;
- }
-
-
- </style>
-
- <script type="text/javascript">
-
- var _gaq = _gaq || [];
- _gaq.push(['_setAccount', 'UA-36103647-1']);
- _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="navbar navbar-fixed-top">
- <div class="navbar-inner">
- <div class="container">
- <a class="btn btn-navbar" data-toggle="collapse"
- data-target=".nav-collapse"> <span class="icon-bar"></span> <span
- class="icon-bar"></span> <span class="icon-bar"></span>
- </a>
- <a class="brand logocolor" href="../index.html">Apache DeltaSpike</a>
-
- <div class="nav-collapse">
-
-
- <ul class="nav">
- <li><a href="../index.html">Home</a></li>
- <li class="active"><a href="../documentation">Documentation</a></li>
- <li ><a href="../javadoc.html">Javadoc</a></li>
- <li ><a href="../source.html">Source</a></li>
- <li ><a href="../download.html">Download</a></li>
- <li ><a href="../community.html">Community</a></li>
- <!-- <li><a href="./support.html">Support</a></li> -->
- <li ><a href="../news.html">News</a></li>
- </ul>
- </div>
- <!--/.nav-collapse -->
- <form id="search-form" action="https://www.google.com/search"
- method="get" class="navbar-search pull-right">
- <input value="deltaspike.apache.org" name="sitesearch"
- type="hidden"> <input class="search-query" name="q"
- id="query" type="text">
- </form>
- </div>
- </div>
-</div>
-
-<div class="container">
- <div class="row-fluid">
-
-
-
- <div class="span8">
- <div class="page-title">
- <h1>DeltaSpike Configuration Mechanism</h1>
- </div>
-
- <div id="doc-content">
- <div class="sect1">
-<h2 id="_introduction">Introduction</h2>
-<div class="sectionbody">
-<div class="paragraph">
-<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
-DeltaSpike’s own configuration mechanism in a very flexible and powerful
-way.</p>
-</div>
-<div class="sect2">
-<h3 id="_benefits_for_production">Benefits for Production</h3>
-<div class="paragraph">
-<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) will get moved to the Production system. And all this
-without any changes on the binary itself!</p>
-</div>
-<div class="paragraph">
-<p>The Apache DeltaSpike configuration system makes this possible by
-providing a default configuration 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>
-</div>
-</div>
-<div class="sect2">
-<h3 id="_drop_in_configuration">Drop-In Configuration</h3>
-<div class="paragraph">
-<p>This mechanism also allows for dynamic configuration in case of a JAR
-drop-in. By adding some JAR to the classpath, all its 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>
-</div>
-</div>
-<div class="sect2">
-<h3 id="_cdi_extension_configuration">CDI-Extension Configuration</h3>
-<div class="paragraph">
-<p>In some cases low-level configs are needed, for example during the bootstrapping
-process of the CDI container.</p>
-</div>
-<div class="paragraph">
-<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. Since the mechanism does not
-rely on CDI it can for example be used to configure CDI-Extensions.</p>
-</div>
-<div class="paragraph">
-<p>Currently this is, for example, used to configure the value of the current <a href="projectstage.html">ProjectStage</a>, configured values which can be
-used in the expressions for <code>@Exclude</code>, 'Deactivatable', etc. 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 ConfigSources per
-application.</p>
-</div>
-</div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_accessing_configured_values_using_configresolver">Accessing configured values using ConfigResolver</h2>
-<div class="sectionbody">
-<div class="paragraph">
-<p>The <code>ConfigResolver</code> is the central point to access configuration in DeltaSpike. There are several different APIs
- and ways to access the individual configured values, each suitable for a different purpose:</p>
-</div>
-<div class="ulist">
-<ul>
-<li>
-<p><code>ConfigResolver</code> methods for easy programmatic access to values</p>
-</li>
-<li>
-<p><code>TypedResolver</code> API for typed configuration values and precise control over resolution</p>
-</li>
-<li>
-<p><code>@ConfigProperty</code> for injection of configured values into beans</p>
-</li>
-<li>
-<p>interface based configuration</p>
-</li>
-</ul>
-</div>
-<div class="paragraph">
-<p>All four mechanisms are described in the following sections.</p>
-</div>
-<div class="sect2">
-<h3 id="_configresolver_methods">ConfigResolver methods</h3>
-<div class="paragraph">
-<p>ConfigResolver offers several methods for easy access to String values of configured properties.</p>
-</div>
-<div class="sect3">
-<h4 id="_getpropertyvalue">getPropertyValue()</h4>
-<div class="paragraph">
-<p>The method <code>ConfigResolver#getPropertyValue(String key)</code> returns the value configured for a given key
-as <code>String</code>, or <code>null</code> if no value has been found.</p>
-</div>
-<div class="paragraph">
-<p><code>ConfigResolver#getAllPropertyValues(String key)</code> has a similar contract
-but it returns a list which might be empty if there are no configured
-values for the given key.</p>
-</div>
-<div class="paragraph">
-<p>This is a code excerpt about how to do a simple lookup in the deltaspike
-configuration:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="java"><span class="predefined-type">String</span> dbUserName = ConfigResolver.getPropertyValue(<span class="string"><span class="delimiter">"</span><span class="content">databaseconfig.username</span><span class="delimiter">"</span></span>);</code></pre>
-</div>
-</div>
-</div>
-<div class="sect3">
-<h4 id="_getprojectstageawarepropertyvalue">getProjectStageAwarePropertyValue()</h4>
-<div class="paragraph">
-<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 running system.</p>
-</div>
-<div class="paragraph">
-<p>This is done by first looking up the ProjectStage (this internally
-happens with the DeltaSpike ConfigResolver as well) and then go down the
-following lookup chain until we found a configured value.</p>
-</div>
-<div class="ulist">
-<ul>
-<li>
-<p>key + '.' + projectStage , e.g. "databaseconfig.username.Production"</p>
-</li>
-<li>
-<p>key alone , e.g. "databaseconfig.username"</p>
-</li>
-</ul>
-</div>
-</div>
-<div class="sect3">
-<h4 id="_getpropertyawarepropertyvalue">getPropertyAwarePropertyValue()</h4>
-<div class="paragraph">
-<p>The method
-<code>ConfigResolver#getPropertyAwarePropertyValue(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> mechanism into account.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="java"><span class="predefined-type">String</span> dbUserName = ConfigResolver.getPropertyAwarePropertyValue(<span class="string"><span class="delimiter">"</span><span class="content">databaseconfig.username</span><span class="delimiter">"</span></span>, <span class="string"><span class="delimiter">"</span><span class="content">dbvendor</span><span class="delimiter">"</span></span>);</code></pre>
-</div>
-</div>
-<div class="sect4">
-<h5 id="_property_value_resolution_sequence">Property value resolution sequence</h5>
-<div class="paragraph">
-<p>The following lookup sequence will be performed until a value is found:
-First, the value of the <em>parameter</em> property is resolved:</p>
-</div>
-<div class="ulist">
-<ul>
-<li>
-<p>propertyValue = property + '.' + projectStage, e.g. "dbvendor.Production"</p>
-</li>
-<li>
-<p>if nothing found: propertyValue = property, e.g. "dbvendor"</p>
-</li>
-</ul>
-</div>
-<div class="paragraph">
-<p>Let’s assume we found the value 'mysql' for our dbvendor. In this case
-the following lookup chain is used until a value got found:</p>
-</div>
-<div class="ulist">
-<ul>
-<li>
-<p>key + '.' + propertyValue + '.' + projectstage, e.g. "databaseconfig.username.mysql.Production"</p>
-</li>
-<li>
-<p>key + '.' + propertyValue, e.g. "databaseconfig.username.mysql"</p>
-</li>
-<li>
-<p>key + '.' + projectStage, e.g. "databaseconfig.username.Production"</p>
-</li>
-<li>
-<p>key, e.g. "databaseconfig.username"</p>
-</li>
-</ul>
-</div>
-</div>
-</div>
-<div class="sect3">
-<h4 id="_handling_of_default_values">Handling of Default Values</h4>
-<div class="paragraph">
-<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>
-</div>
-<div class="admonitionblock tip">
-<table>
-<tr>
-<td class="icon">
-<i class="fa icon-tip" title="Tip"></i>
-</td>
-<td class="content">
-<div class="title">Performance Hint</div>
-The only <code>ConfigResolver</code> operation which is cached is the determination
-of the <code>ConfigSources</code>. The various getPropertyValue operations are not
-cached in the ConfigResolver but might be cached in the ConfigSources.
-This makes the overall calculation a bit slower, but allows for values
-to change dynamically if someone likes to for example implement a
-<code>JmxConfigSource</code> (not yet part of DeltaSpike, but easily implementable).
-You can also use the <a href="#DynamicReloading">TypedResolver</a> with the <code>cacheFor(TimeUnit, long)</code> setting to cache the resolved values on the caller side.
-</td>
-</tr>
-</table>
-</div>
-</div>
-</div>
-<div class="sect2">
-<h3 id="_variable_replacement_in_configured_values">Variable Replacement in Configured Values</h3>
-<div class="paragraph">
-<p>Since version 1.6.1, DeltaSpike also supports using 'variables' inside configured values.
-You can e.g. define a single configuration key for your server and use it in other configuration values</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre>document.server.url=http://localhost:8081
-myapp.document.lists=${document.server.url}/docapp/list
-myapp.document.admin=${document.server.url}/docadmin/app</pre>
-</div>
-</div>
-<div class="paragraph">
-<p>A variable name starts with <code>${</code> and ends with <code>}</code>.</p>
-</div>
-<div class="paragraph">
-<p>Variable support is enabled by default.
-If you like to use the <code>ConfigResolver</code> without variable support you need to use the methods with the <code>evaluateVariables</code> parameter set to <code>false</code>.</p>
-</div>
-</div>
-<div class="sect2">
-<h3 id="_typedresolver_api">TypedResolver API</h3>
-<div class="paragraph">
-<p>Very often the configured values represent more than just strings — number types and booleans are commonly used as
-configuration types. ConfigResolver provides a builder-style API to access configuration values as specific types.</p>
-</div>
-<div class="paragraph">
-<p>The API is accessed by a call to <code>ConfigResolver.resolve(propertyKey)</code>.</p>
-</div>
-<div class="paragraph">
-<p>The simplest usage of the API is resolution of a String property, equivalent to a call to
-<code>ConfigResolver.getPropertyValue(propertyKey)</code>.</p>
-</div>
-<div class="listingblock">
-<div class="title">Simple example of TypedResolver</div>
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="java"><span class="predefined-type">String</span> userName = ConfigResolver.resolve(<span class="string"><span class="delimiter">"</span><span class="content">user.name</span><span class="delimiter">"</span></span>).getValue();</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>The call to <code>ConfigResolver.resolve(..)</code> returns a builder which has methods to refine the resolution, including the
-following:</p>
-</div>
-<div class="ulist">
-<ul>
-<li>
-<p><code>as(Class<N> clazz)</code> — defines the return type of the property</p>
-</li>
-<li>
-<p><code>parameterizedBy(String propertyName)</code> — sets a parameter for the resolution, similarly as in
-<a href="#_getpropertyawarepropertyvalue">ConfigResolver.getPropertyAwarePropertyValue</a></p>
-</li>
-<li>
-<p><code>withCurrentProjectStage(boolean with)</code> — indicates whether the current ProjectStage should be taken into account
-for the resolution</p>
-</li>
-<li>
-<p><code>strictly(boolean strictly)</code> — indicates, whether the <a href="#_property_value_resolution_sequence">property value
-resolution sequence</a> should be taken into account. When set to true, the sequence is not followed.</p>
-</li>
-<li>
-<p><code>withDefault(T value)</code> — sets the default value, used in case the resolution returns <code>null</code></p>
-</li>
-<li>
-<p><code>getValue()</code> — terminates the builder and returns the resolved value with the appropriate type</p>
-</li>
-</ul>
-</div>
-<div class="listingblock">
-<div class="title">A more complete example of TypedResolver</div>
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="java"><span class="predefined-type">Integer</span> dbPort = ConfigResolver
- .resolve(<span class="string"><span class="delimiter">"</span><span class="content">db.port</span><span class="delimiter">"</span></span>)
- .as(<span class="predefined-type">Integer</span>.class)
- .withProjectStage(<span class="predefined-constant">true</span>)
- .parameterizedBy(<span class="string"><span class="delimiter">"</span><span class="content">db.vendor</span><span class="delimiter">"</span></span>)
- .withDefault(<span class="integer">3306</span>)
- .getValue();</code></pre>
-</div>
-</div>
-<div class="sect3">
-<h4 id="_supported_types">Supported types</h4>
-<div class="paragraph">
-<p>The types supported out of the box include: String, Integer, Long, Float, Double, Boolean, Class.
-Custom types can be supported by providing an implementation of the <code>ConfigResolver.Converter</code> interface.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="java"><span class="predefined-type">Date</span> deadline = ConfigResolver.resolve(<span class="string"><span class="delimiter">"</span><span class="content">deadline</span><span class="delimiter">"</span></span>).as(<span class="predefined-type">Date</span>.class, <span class="keyword">new</span> CustomDateConverter()).getValue());</code></pre>
-</div>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="java"><span class="directive">public</span> <span class="type">class</span> <span class="class">CustomDateConverter</span> <span class="directive">implements</span> ConfigResolver.Converter<<span class="predefined-type">Date</span>> {
-
- <span class="annotation">@Override</span>
- <span class="directive">public</span> <span class="predefined-type">Date</span> convert(<span class="predefined-type">String</span> value)
- {
- <span class="predefined-type">String</span><span class="type">[]</span> parts = value.split(<span class="string"><span class="delimiter">"</span><span class="content">-</span><span class="delimiter">"</span></span>);
- <span class="keyword">return</span> <span class="keyword">new</span> <span class="predefined-type">GregorianCalendar</span>(<span class="predefined-type">Integer</span>.valueOf(parts[<span class="integer">0</span>]), <span class="predefined-type">Integer</span>.valueOf(parts[<span class="integer">1</span>]),
- <span class="predefined-type">Integer</span>.valueOf(parts[<span class="integer">2</span>])).getTime();
- }
-}</code></pre>
-</div>
-</div>
-</div>
-<div class="sect3">
-<h4 id="_dynamic_reloading">Dynamic Reloading</h4>
-<div class="paragraph">
-<p>The TypedResolver can also be used to efficiently cache configured values.
-That way you can pick up configuration which might get changed during runtime on the fly.
-E.g. if you have a ConfigSource which picks up the values from a database table.
-Instead of resolving the configured value at the beginning you simply invoke <code>.getValue()</code> on your TypedResolver each time you need the value.</p>
-</div>
-<div class="listingblock">
-<div class="title">Working with dynamically changing values</div>
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="java"><span class="directive">private</span> ConfigResolver.TypedResolver<<span class="predefined-type">String</span>> urlConfig
- = ConfigResolver.resolve(<span class="string"><span class="delimiter">"</span><span class="content">myapp.some.remote.rest.url</span><span class="delimiter">"</span></span>)
- .logChanges(<span class="predefined-constant">true</span>)
- .cacheFor(<span class="predefined-type">TimeUnit</span>.MINUTES, <span class="integer">5</span>);
-
-...
-
-connecTo( urlConfig.getValue() );</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>The sample above will log any value changes in the configuration (<code>logChanges(true)</code>) and internally cache the configured value for 5 minutes (<code>cacheFor(TimeUnit.MINUTES, 5)</code>).
-Only after that time the configured value will get evaluate again.</p>
-</div>
-<div class="admonitionblock tip">
-<table>
-<tr>
-<td class="icon">
-<i class="fa icon-tip" title="Tip"></i>
-</td>
-<td class="content">
-Note that the 'cache' is only held within the very TypedResolver instance.
-If you use different <code>TypedResolver</code> instances (e.g. in different classes) then you might get different cache timeouts.
-</td>
-</tr>
-</table>
-</div>
-</div>
-<div class="sect3">
-<h4 id="_list_values_handling">List Values handling</h4>
-<div class="paragraph">
-<p>As of DeltaSpike-1.8.0, the <code>Typed Resolver</code> is also able to handle list values.
-Resolve a list of e.g. retry interval values via:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="java"><span class="predefined-type">List</span><<span class="predefined-type">Integer</span>> retryIntervals
- = ConfigResolver.resolve(<span class="string"><span class="delimiter">"</span><span class="content">myapp.retry.intervalls</span><span class="delimiter">"</span></span>)
- .as(<span class="predefined-type">Integer</span>.class)
- .asList()
- .getValue();</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>The values get configured as comma (<code>','</code>) separated value String.
-A Comma inside a value can be escaped with a backslash (<code>\,</code>), backslashes should be escaped with double-backslash (<code>\\</code>).
-Trailing and leading whitespaces get trimmed for each value.</p>
-</div>
-</div>
-</div>
-<div class="sect2">
-<h3 id="_injection_of_configured_values_into_beans_using_configproperty">Injection of configured values into beans using @ConfigProperty</h3>
-<div class="paragraph">
-<p>DeltaSpike provides a way to inject configured values into your code via the qualifier <code>@ConfigProperty</code>.
-The supported types are the same as the <a href="#_supported_types">supported types of the TypedResolver</a>.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@ApplicationScoped</span>
-<span class="directive">public</span> <span class="type">class</span> <span class="class">SomeRandomService</span>
-{
- <span class="annotation">@Inject</span>
- <span class="annotation">@ConfigProperty</span>(name = <span class="string"><span class="delimiter">"</span><span class="content">endpoint.poll.interval</span><span class="delimiter">"</span></span>)
- <span class="directive">private</span> <span class="predefined-type">Integer</span> pollInterval;
-
- <span class="annotation">@Inject</span>
- <span class="annotation">@ConfigProperty</span>(name = <span class="string"><span class="delimiter">"</span><span class="content">endpoint.poll.servername</span><span class="delimiter">"</span></span>)
- <span class="directive">private</span> <span class="predefined-type">String</span> pollUrl;
-
- ...
- }</code></pre>
-</div>
-</div>
-<div class="sect3">
-<h4 id="_custom_configproperty_types">Custom ConfigProperty types</h4>
-<div class="paragraph">
-<p>Custom types can be injected using <code>@ConfigProperty</code> by providing a custom producer.
-DeltaSpike provides a base implementation for custom producers in the class <code>BaseConfigPropertyProducer</code>
-which offers the following methods:
-* <code>getStringPropertyValue</code> — looks for the property name in <code>@ConfigProperty</code> annotation on the injection point.
-If not found, it looks for it in other annotations on the injection point.
-* <code>getPropertyValue</code> — a shortcut to <a href="#_configresolver">ConfigResolver#getProjectStageAwarePropertyValue</a>
-* <code>getAnnotation</code> — extracts any annotation type from the injection point, useful when a custom annotation
-is used instead of <code>@ConfigProperty</code></p>
-</div>
-<div class="paragraph">
-<p>The following example uses <code>getStringPropertyValue</code> and a custom <code>@Location</code> annotation annotated <code>@ConfigProperty</code>.
-In such case, the <code>@Location</code> annotation is bound to a single fixed property name and acts as a type-safe replacement
-for <code>@ConfigProperty(name = "locationId")</code>.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@ApplicationScoped</span>
-<span class="directive">public</span> <span class="type">class</span> <span class="class">CustomConfigPropertyProducer</span> <span class="directive">extends</span> BaseConfigPropertyProducer {
-
- <span class="annotation">@Produces</span>
- <span class="annotation">@Dependent</span>
- <span class="annotation">@Location</span>
- <span class="directive">public</span> LocationId produceLocationId(InjectionPoint injectionPoint)
- {
- <span class="predefined-type">String</span> configuredValue = getStringPropertyValue(injectionPoint);
-
- <span class="keyword">return</span> LocationId.valueOf(configuredValue.trim().toUpperCase());
- }
-}</code></pre>
-</div>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@Target</span>({ FIELD, METHOD })
-<span class="annotation">@Retention</span>(RUNTIME)
-<span class="annotation">@ConfigProperty</span>(name = <span class="string"><span class="delimiter">"</span><span class="content">locationId</span><span class="delimiter">"</span></span>, defaultValue = <span class="string"><span class="delimiter">"</span><span class="content">LOCATION_X</span><span class="delimiter">"</span></span>)
-<span class="annotation">@Qualifier</span>
-<span class="directive">public</span> <span class="annotation">@interface</span> Location {}</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>The <code>@ConfigProperty</code> annotation doesn’t need to be used at all. Instead, a custom annotation can be provided and
-obtained in the producer using <code>getAnnotation</code> and <code>getPropertyValue</code>:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@ApplicationScoped</span>
-<span class="directive">public</span> <span class="type">class</span> <span class="class">NumberConfigPropertyProducer</span> <span class="directive">extends</span> BaseConfigPropertyProducer
-{
- <span class="annotation">@Produces</span>
- <span class="annotation">@Dependent</span>
- <span class="annotation">@NumberConfig</span>(name = <span class="string"><span class="delimiter">"</span><span class="content">unused</span><span class="delimiter">"</span></span>)
- <span class="directive">public</span> <span class="predefined-type">Float</span> produceNumberProperty(InjectionPoint injectionPoint) <span class="directive">throws</span> <span class="exception">ParseException</span>
- {
- <span class="comment">// resolve the annotation</span>
- NumberConfig metaData = getAnnotation(injectionPoint, NumberConfig.class);
-
- <span class="comment">// get the configured value from the underlying configuration system</span>
- <span class="predefined-type">String</span> configuredValue = getPropertyValue(metaData.name(), metaData.defaultValue());
-
- <span class="comment">// format according to the given pattern</span>
- <span class="predefined-type">DecimalFormat</span> df = <span class="keyword">new</span> <span class="predefined-type">DecimalFormat</span>(metaData.pattern(), <span class="keyword">new</span> <span class="predefined-type">DecimalFormatSymbols</span>(<span class="predefined-type">Locale</span>.US));
- <span class="keyword">return</span> df.parse(configuredValue).floatValue();
- }
-}</code></pre>
-</div>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@Qualifier</span>
-<span class="directive">public</span> <span class="annotation">@interface</span> NumberConfig
-{
- <span class="annotation">@Nonbinding</span>
- <span class="predefined-type">String</span> name();
-
- <span class="annotation">@Nonbinding</span>
- <span class="predefined-type">String</span> defaultValue() <span class="keyword">default</span> ConfigProperty.NULL;
-
- <span class="annotation">@Nonbinding</span>
- <span class="predefined-type">String</span> pattern() <span class="keyword">default</span> <span class="string"><span class="delimiter">"</span><span class="content">#0.00</span><span class="delimiter">"</span></span>;
-}</code></pre>
-</div>
-</div>
-</div>
-</div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_interface_based_configuration">Interface based configuration</h2>
-<div class="sectionbody">
-<div class="paragraph">
-<p>The interfaces decorated with <code>@Configuration</code> are converted during CDI startup
-to Beans matching the interface type. Concretely this interface:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code>@Configuration
-public interface MyConfig {
-}</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>Will use accessible using:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code>@Inject
-private MyConfig config;</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>To define a configuration entry in this mode you define an interface method
-and decorate it with <code>@ConfigProperty</code> exactly as a normal injection:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code>@Configuration
-public interface MyConfig {
- @ConfigProperty(name = "my.config")
- String url();
-}</code></pre>
-</div>
-</div>
-<div class="admonitionblock tip">
-<table>
-<tr>
-<td class="icon">
-<i class="fa icon-tip" title="Tip"></i>
-</td>
-<td class="content">
-this mode also supports primitives like <code>int</code>, <code>boolean</code>, …​ as returned types.
-</td>
-</tr>
-</table>
-</div>
-<div class="paragraph">
-<p>The methods are no parameter and not returning void methods.</p>
-</div>
-<div class="paragraph">
-<p>If all your keys use the same prefix you can configure it on <code>@Configuration</code>:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code>@Configuration(prefix = "client.")
-public interface MyConfig {
- @ConfigProperty(name = "url")
- String url();
-
- @ConfigProperty(name = "timeout", defaultValue = "30000")
- long timeout();
-}</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>Finally, you can also access the caching feature of the <code>TypedResolver</code> through <code>@Configuration</code>:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code>@Configuration(cacheFor = 30, cacheUnit = TimeUnit.SECONDS)
-public interface MyConfig {
- @ConfigProperty(name = "url")
- String url();
-
- @ConfigProperty(name = "timeout", defaultValue = "30000")
- long timeout();
-}</code></pre>
-</div>
-</div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_providing_configuration_using_configsources">Providing configuration using ConfigSources</h2>
-<div class="sectionbody">
-<div class="paragraph">
-<p>A <code>ConfigSource</code> is exactly what its 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>
-</div>
-<div class="paragraph">
-<p>Each 'ConfigSource' has a specified 'ordinal' which can be configured
-using the key <code>deltaspike_ordinal</code>. This ordinal get’s used to determine
-the importance of the values taken from the very ConfigSource. A higher
-ordinal means that the values taken from this ConfigSource will override
-values from less important 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>
-</div>
-<div class="sect2">
-<h3 id="_configsources_provided_by_default">ConfigSources Provided by Default</h3>
-<div class="paragraph">
-<p>By default there are implementations for the following configuration sources
-(listed in the lookup order):</p>
-</div>
-<div class="ulist">
-<ul>
-<li>
-<p>System properties (deltaspike_ordinal = 400)</p>
-</li>
-<li>
-<p>Environment properties (deltaspike_ordinal = 300)</p>
-</li>
-<li>
-<p>JNDI values (deltaspike_ordinal = 200, the base name is "java:comp/env/deltaspike/")</p>
-</li>
-<li>
-<p>All apache-deltaspike.properties files on the classpath (deltaspike_ordinal = 100, default filename is "META-INF/apache-deltaspike.properties")</p>
-</li>
-<li>
-<p>A property file in user.home <code>~/.deltaspike/apache-deltaspike.properties</code> (if exists, deltaspike_ordinal = 100)</p>
-</li>
-</ul>
-</div>
-<div class="paragraph">
-<p><strong>It is possible to change this order and to add custom configuration sources.</strong></p>
-</div>
-<div class="admonitionblock tip">
-<table>
-<tr>
-<td class="icon">
-<i class="fa icon-tip" title="Tip"></i>
-</td>
-<td class="content">
-<div class="title">Important Tips Especially for Custom Implementations</div>
-- The config-source with the highest ordinal gets used first. - If a custom
-implementation should be invoked <em>before</em> the default implementations,
-use an ordinal-value > 400. - 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.
-</td>
-</tr>
-</table>
-</div>
-</div>
-<div class="sect2">
-<h3 id="_reordering_of_the_default_order_of_configsources">Reordering of the Default Order of ConfigSources</h3>
-<div class="paragraph">
-<p>To change the lookup order, you have to configure the ordinal in the
-corresponding configuration source (e.g. to change the configuration ordinal of the
-configuration source for system properties, you have to set the system property
-with the ordinal key 'deltaspike_ordinal' and the new value).</p>
-</div>
-<div class="paragraph">
-<p>Example with <code>/META-INF/apache-deltaspike.properties</code>: If the properties
-file/s should be used <strong>before</strong> the other implementations, you have to
-configure an ordinal > 400. That means, you have to add for example
-<code>deltaspike_ordinal=401</code>.</p>
-</div>
-<div class="paragraph">
-<p>Each single property file is treated as own <code>ConfigSource</code> and thus can
-have different <code>deltaspike_ordinal</code> values!</p>
-</div>
-<div class="admonitionblock note">
-<table>
-<tr>
-<td class="icon">
-<i class="fa icon-note" title="Note"></i>
-</td>
-<td class="content">
-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).
-</td>
-</tr>
-</table>
-</div>
-</div>
-<div class="sect2">
-<h3 id="_custom_configsources">Custom ConfigSources</h3>
-<div class="paragraph">
-<p>ConfigSources are picked up using the `java.util.ServiceLoader'
-mechanism.</p>
-</div>
-<div class="paragraph">
-<p>To add a custom config-source, you have to implement the interface
-<code>ConfigSource</code> and register your implementation in a file
-<code>/META-INF/services/org.apache.deltaspike.core.spi.config.ConfigSource</code>
-by writing the fully qualified class name of the custom implementation/s
-into it.</p>
-</div>
-<div class="paragraph">
-<p>If you need dynamic ConfigSources you can also register a
-<code>ConfigSourceProvider</code> in a similar way. This is useful if you like to
-dynamically pick up multiple ConfigSources of the same kind. For example, if you
-like to pick up all <code>myproject.properties</code> files from all the JARs in
-your classpath.</p>
-</div>
-<div class="paragraph">
-<p>Please note that a single <code>ConfigSource</code> should be either registered
-directly or via a <code>ConfigSourceProvider</code>, but never both ways.</p>
-</div>
-<div class="admonitionblock tip">
-<table>
-<tr>
-<td class="icon">
-<i class="fa icon-tip" title="Tip"></i>
-</td>
-<td class="content">
-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.
-</td>
-</tr>
-</table>
-</div>
-<div class="paragraph">
-<p>Since 1.8.0 you can also decorate a CDI <code>ConfigSource</code> with <code>@Source</code> and it will
-be added to DeltaSpike configuration <strong>once the CDI container is started</strong> (it means
-you can’t use this source in an <code>Extension</code>).</p>
-</div>
-<div class="sect3">
-<h4 id="_propertyfileconfig">PropertyFileConfig</h4>
-<div class="paragraph">
-<p>For registering all your own property files of a certain name in your
-classpath to get picked up as ConfigSources you can also provide a
-class which implements the <code>PropertyFileConfig</code> interface.</p>
-</div>
-<div class="paragraph">
-<p>If <code>getPropertyFileName()</code> returns an URL, e.g. <code><a href="file:///var/opt/myapp/my.properties"" class="bare">file:///var/opt/myapp/my.properties"</a></code> then this will be used to pick up the configured values.
-In other words: with using <code>file://</code> you can specify a file on the file system.</p>
-</div>
-<div class="paragraph">
-<p>The method <code>isOptional</code> indicates whether your custom property file is mandatory.
-If a mandatory property file is not found during deployment, DeltaSpike throws
-an <code>IllegalStateException</code> and stops the deployment.</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="java"><span class="directive">public</span> <span class="type">class</span> <span class="class">MyCustomPropertyFileConfig</span> <span class="directive">implements</span> PropertyFileConfig
-{
- <span class="annotation">@Override</span>
- <span class="directive">public</span> <span class="predefined-type">String</span> getPropertyFileName()
- {
- <span class="keyword">return</span> <span class="string"><span class="delimiter">"</span><span class="content">myconfig.properties</span><span class="delimiter">"</span></span>;
- }
-
- <span class="annotation">@Override</span>
- <span class="directive">public</span> <span class="type">boolean</span> isOptional()
- {
- <span class="keyword">return</span> <span class="predefined-constant">false</span>;
- }
-}</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p><em>Note: If you are using WildFly with EAR packaging and with
-ear-subdeployments-isolated=true, then your EAR should have a deployment
-dependency to the module that contains the property file.</em></p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="xml"><span class="tag"><jboss-deployment-structure></span>
- <span class="tag"><ear-subdeployments-isolated></span>true<span class="tag"></ear-subdeployments-isolated></span>
- <span class="tag"><deployment></span>
- <span class="tag"><dependencies></span>
- <span class="comment"><!-- This module contains the custom PropertyFileConfig and the property file --></span>
- <span class="tag"><module</span> <span class="attribute-name">name</span>=<span class="string"><span class="delimiter">"</span><span class="content">deployment.yourproject.ear.yoursubmodule.jar</span><span class="delimiter">"</span></span> <span class="attribute-name">meta-inf</span>=<span class="string"><span class="delimiter">"</span><span class="content">import</span><span class="delimiter">"</span></span> <span class="tag">/></span>
- <span class="tag"></dependencies></span>
- <span class="tag"></deployment></span>
-<span class="tag"></jboss-deployment-structure></span></code></pre>
-</div>
-</div>
-</div>
-</div>
-</div>
-</div>
-<div class="sect1">
-<h2 id="_filtering_configured_values">Filtering configured values</h2>
-<div class="sectionbody">
-<div class="paragraph">
-<p>It is possible to perform filtering on all configured values on their way between the ConfigSource and user code.
-This might be useful for example for decryption of values from an encrypted ConfigSource or to hide passwords from a
-log.</p>
-</div>
-<div class="paragraph">
-<p>DeltaSpike doesn’t provide any filters by default but custom filters can be provided by implementing the
-<code>ConfigFilter</code> interface. This is then enabled either using the ServiceLoader mechanism or by calling
-<code>ConfigResolver.addConfigFilter(ConfigFilter)</code>. Provided ConfigFilters are then enabled for the whole application.</p>
-</div>
-<div class="paragraph">
-<p>Once some filters are provided, all operations of ConfigResolver return filtered values.</p>
-</div>
-<div class="listingblock">
-<div class="title">A custom ConfigFilter</div>
-<div class="content">
-<pre class="CodeRay highlight"><code data-lang="java"><span class="directive">public</span> <span class="type">class</span> <span class="class">DecryptingConfigFilter</span> <span class="directive">implements</span> ConfigFilter
-{
- <span class="directive">private</span> DefaultCipherService ciperSvc = <span class="keyword">new</span> DefaultCipherService();
- <span class="directive">private</span> <span class="predefined-type">String</span> masterSalt = <span class="string"><span class="delimiter">"</span><span class="content">someApplicationMasterSalt</span><span class="delimiter">"</span></span>;
-
- <span class="annotation">@Override</span>
- <span class="directive">public</span> <span class="predefined-type">String</span> filterValue(<span class="predefined-type">String</span> key, <span class="predefined-type">String</span> value)
- {
- <span class="keyword">if</span> (key.contains(<span class="string"><span class="delimiter">"</span><span class="content">password</span><span class="delimiter">"</span></span>))
- {
- <span class="keyword">try</span>
- {
- <span class="keyword">return</span> cipherSvc.decrypt(value, masterSalt);
- }
- <span class="keyword">catch</span> (<span class="exception">Exception</span> e)
- {
- <span class="keyword">return</span> value;
- }
- }
- <span class="keyword">return</span> value;
- }
-
- <span class="annotation">@Override</span>
- <span class="directive">public</span> <span class="predefined-type">String</span> filterValueForLog(<span class="predefined-type">String</span> key, <span class="predefined-type">String</span> value)
- {
- <span class="keyword">if</span> (key.contains(<span class="string"><span class="delimiter">"</span><span class="content">password</span><span class="delimiter">"</span></span>))
- {
- <span class="keyword">return</span> <span class="string"><span class="delimiter">"</span><span class="content">***************</span><span class="delimiter">"</span></span>;
- }
-
- <span class="keyword">return</span> value;
- }
-}</code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>For more information about the <code>CipherService</code> please see the <a href="encryption.html">Encryption</a> section.</p>
-</div>
-<div class="paragraph">
-<p>Since 1.8.0 you can also decorate a CDI <code>ConfigFilter</code> with <code>@Filter</code> and it will
-be added to DeltaSpike configuration <strong>once the CDI container is started</strong> (Note that this means
-you can’t use this ConfigFilter in a CDI <code>Extension</code>).</p>
-</div>
-</div>
-</div>
- </div>
- </div>
-
-
- <div class="span4">
- <div id="toc">
- <div class="moduledeps">
- <ul class="toc-like nav nav-list">
-
-
-
- </ul>
- </div>
- </div>
-
- <div class="fallback-toc">
- <ul class="sectlevel1">
-<li><a href="#_introduction">Introduction</a>
-<ul class="sectlevel2">
-<li><a href="#_benefits_for_production">Benefits for Production</a></li>
-<li><a href="#_drop_in_configuration">Drop-In Configuration</a></li>
-<li><a href="#_cdi_extension_configuration">CDI-Extension Configuration</a></li>
-</ul>
-</li>
-<li><a href="#_accessing_configured_values_using_configresolver">Accessing configured values using ConfigResolver</a>
-<ul class="sectlevel2">
-<li><a href="#_configresolver_methods">ConfigResolver methods</a>
-<ul class="sectlevel3">
-<li><a href="#_getpropertyvalue">getPropertyValue()</a></li>
-<li><a href="#_getprojectstageawarepropertyvalue">getProjectStageAwarePropertyValue()</a></li>
-<li><a href="#_getpropertyawarepropertyvalue">getPropertyAwarePropertyValue()</a>
-<ul class="sectlevel4">
-<li><a href="#_property_value_resolution_sequence">Property value resolution sequence</a></li>
-</ul>
-</li>
-<li><a href="#_handling_of_default_values">Handling of Default Values</a></li>
-</ul>
-</li>
-<li><a href="#_variable_replacement_in_configured_values">Variable Replacement in Configured Values</a></li>
-<li><a href="#_typedresolver_api">TypedResolver API</a>
-<ul class="sectlevel3">
-<li><a href="#_supported_types">Supported types</a></li>
-<li><a href="#_dynamic_reloading">Dynamic Reloading</a></li>
-<li><a href="#_list_values_handling">List Values handling</a></li>
-</ul>
-</li>
-<li><a href="#_injection_of_configured_values_into_beans_using_configproperty">Injection of configured values into beans using @ConfigProperty</a>
-<ul class="sectlevel3">
-<li><a href="#_custom_configproperty_types">Custom ConfigProperty types</a></li>
-</ul>
-</li>
-</ul>
-</li>
-<li><a href="#_interface_based_configuration">Interface based configuration</a></li>
-<li><a href="#_providing_configuration_using_configsources">Providing configuration using ConfigSources</a>
-<ul class="sectlevel2">
-<li><a href="#_configsources_provided_by_default">ConfigSources Provided by Default</a></li>
-<li><a href="#_reordering_of_the_default_order_of_configsources">Reordering of the Default Order of ConfigSources</a></li>
-<li><a href="#_custom_configsources">Custom ConfigSources</a>
-<ul class="sectlevel3">
-<li><a href="#_propertyfileconfig">PropertyFileConfig</a></li>
-</ul>
-</li>
-</ul>
-</li>
-<li><a href="#_filtering_configured_values">Filtering configured values</a></li>
-</ul>
- </div>
-
- </div>
-
-
- </div>
- <div class="row">
- <hr>
- <footer>
- <p>Copyright © 2011-2016 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>
- </div>
-</div>
-
-</body>
+<!DOCTYPE html>
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <meta name="description" content="deltaspike-generate-pages">
+ <meta name="author" content="chm">
+ <!-- No caching headers -->
+ <meta http-equiv="cache-control" content="no-cache"/>
+ <meta http-equiv="pragma" content="no-cache"/>
+ <meta http-equiv="expires" content="-1"/>
+
+ <title>DeltaSpike Configuration Mechanism</title>
+
+ <!--
+ 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
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+ -->
+
+ <!-- Styles -->
+ <link href="https://deltaspike.apache.org/resources/css/bootstrap.css" rel="stylesheet">
+ <link href="https://deltaspike.apache.org/resources/css/bootstrap-responsive.css" rel="stylesheet">
+ <link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/3.1.0/css/font-awesome.min.css" rel="stylesheet">
+
+
+
+
+ <!-- Tocify - nice dynamic autoscrolling TOC -->
+ <link href="https://cdnjs.cloudflare.com/ajax/libs/jquery.tocify/1.9.0/stylesheets/jquery.tocify.min.css" rel="stylesheet">
+ <script src="https://code.jquery.com/jquery-1.11.3.min.js"></script>
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/jqueryui/1.11.4/jquery-ui.min.js"></script>
+ <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery.tocify/1.9.0/javascripts/jquery.tocify.min.js"></script>
+
+
+ <script type="text/javascript">
+ $(function () {
+ $("#toc").tocify({
+ scrollTo: 50,
+ extendPage: true,
+ context: "#doc-content",
+ selectors: "h2,h3,h4,h5"
+ });
+ $(".fallback-toc").hide();
+ });
+ </script>
+
+
+ <style type="text/css">
+ /* Stylesheet for CodeRay to match GitHub theme | MIT License | http://foundation.zurb.com */
+/*pre.CodeRay {background-color:#f7f7f8;}*/
+.CodeRay .line-numbers{border-right:1px solid #d8d8d8;padding:0 0.5em 0 .25em}
+.CodeRay span.line-numbers{display:inline-block;margin-right:.5em;color:rgba(0,0,0,.3)}
+.CodeRay .line-numbers strong{font-weight: normal}
+table.CodeRay{border-collapse:separate;border-spacing:0;margin-bottom:0;border:0;background:none}
+table.CodeRay td{vertical-align: top}
+table.CodeRay td.line-numbers{text-align:right}
+table.CodeRay td.line-numbers>pre{padding:0;color:rgba(0,0,0,.3)}
+table.CodeRay td.code{padding:0 0 0 .5em}
+table.CodeRay td.code>pre{padding:0}
+.CodeRay .debug{color:#fff !important;background:#000080 !important}
+.CodeRay .annotation{color:#007}
+.CodeRay .attribute-name{color:#000080}
+.CodeRay .attribute-value{color:#700}
+.CodeRay .binary{color:#509}
+.CodeRay .comment{color:#998;font-style:italic}
+.CodeRay .char{color:#04d}
+.CodeRay .char .content{color:#04d}
+.CodeRay .char .delimiter{color:#039}
+.CodeRay .class{color:#458;font-weight:bold}
+.CodeRay .complex{color:#a08}
+.CodeRay .constant,.CodeRay .predefined-constant{color:#008080}
+.CodeRay .color{color:#099}
+.CodeRay .class-variable{color:#369}
+.CodeRay .decorator{color:#b0b}
+.CodeRay .definition{color:#099}
+.CodeRay .delimiter{color:#000}
+.CodeRay .doc{color:#970}
+.CodeRay .doctype{color:#34b}
+.CodeRay .doc-string{color:#d42}
+.CodeRay .escape{color:#666}
+.CodeRay .entity{color:#800}
+.CodeRay .error{color:#808}
+.CodeRay .exception{color:inherit}
+.CodeRay .filename{color:#099}
+.CodeRay .function{color:#900;font-weight:bold}
+.CodeRay .global-variable{color:#008080}
+.CodeRay .hex{color:#058}
+.CodeRay .integer,.CodeRay .float{color:#099}
+.CodeRay .include{color:#555}
+.CodeRay .inline{color:#00}
+.CodeRay .inline .inline{background:#ccc}
+.CodeRay .inline .inline .inline{background:#bbb}
+.CodeRay .inline .inline-delimiter{color:#d14}
+.CodeRay .inline-delimiter{color:#d14}
+.CodeRay .important{color:#555;font-weight:bold}
+.CodeRay .interpreted{color:#b2b}
+.CodeRay .instance-variable{color:#008080}
+.CodeRay .label{color:#970}
+.CodeRay .local-variable{color:#963}
+.CodeRay .octal{color:#40e}
+.CodeRay .predefined{color:#369}
+.CodeRay .preprocessor{color:#579}
+.CodeRay .pseudo-class{color:#555}
+.CodeRay .directive{font-weight:bold}
+.CodeRay .type{font-weight:bold}
+.CodeRay .predefined-type{color:inherit}
+.CodeRay .reserved,.CodeRay .keyword {color:#000;font-weight:bold}
+.CodeRay .key{color:#808}
+.CodeRay .key .delimiter{color:#606}
+.CodeRay .key .char{color:#80f}
+.CodeRay .value{color:#088}
+.CodeRay .regexp .delimiter{color:#808}
+.CodeRay .regexp .content{color:#808}
+.CodeRay .regexp .modifier{color:#808}
+.CodeRay .regexp .char{color:#d14}
+.CodeRay .regexp .function{color:#404;font-weight:bold}
+.CodeRay .string{color:#d20}
+.CodeRay .string .string .string{background:#ffd0d0}
+.CodeRay .string .content{color:#d14}
+.CodeRay .string .char{color:#d14}
+.CodeRay .string .delimiter{color:#d14}
+.CodeRay .shell{color:#d14}
+.CodeRay .shell .delimiter{color:#d14}
+.CodeRay .symbol{color:#990073}
+.CodeRay .symbol .content{color:#a60}
+.CodeRay .symbol .delimiter{color:#630}
+.CodeRay .tag{color:#008080}
+.CodeRay .tag-special{color:#d70}
+.CodeRay .variable{color:#036}
+.CodeRay .insert{background:#afa}
+.CodeRay .delete{background:#faa}
+.CodeRay .change{color:#aaf;background:#007}
+.CodeRay .head{color:#f8f;background:#505}
+.CodeRay .insert .insert{color:#080}
+.CodeRay .delete .delete{color:#800}
+.CodeRay .change .change{color:#66f}
+.CodeRay .head .head{color:#f4f}
+
+ body {
+ padding-top: 60px;
+ padding-bottom: 40px;
+ }
+
+ .toc-like {
+ border-radius: 6px;
+ border: 1px solid #ccc;
+ }
+
+ .toc-like li {
+ line-height: 30px;
+ text-indent: 10px;
+ }
+
+ .toc-like li.custom-toc-header {
+ font-weight: bold;
+ background: #666;
+ color: white;
+ cursor: initial !important;
+ padding: 5px;
+ }
+
+ .toc-like li.custom-toc-header a {
+ color: white;
+ font-style: normal;
+ text-shadow: none;
+ padding: 0;
+ }
+
+ .toc-like li.custom-toc-header:hover a {
+ background: #666;
+ }
+
+ .page-title {
+ text-align: left;
+ }
+
+ #doc-content h2,
+ #doc-content h3,
+ #doc-content h4,
+ #doc-content h5,
+ #doc-content h6 {
+ padding-top: 0;
+ margin-top: 25px;
+ margin-bottom: 10px;
+ line-height: 1.4em;
+ }
+
+ #doc-content h2 {
+ border-bottom: 1px solid lightgrey;
+ }
+
+
+ </style>
+
+ <script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-36103647-1']);
+ _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="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="btn btn-navbar" data-toggle="collapse"
+ data-target=".nav-collapse"> <span class="icon-bar"></span> <span
+ class="icon-bar"></span> <span class="icon-bar"></span>
+ </a>
+ <a class="brand logocolor" href="../index.html">Apache DeltaSpike</a>
+
+ <div class="nav-collapse">
+
+
+ <ul class="nav">
+ <li><a href="../index.html">Home</a></li>
+ <li class="active"><a href="../documentation">Documentation</a></li>
+ <li ><a href="../javadoc.html">Javadoc</a></li>
+ <li ><a href="../source.html">Source</a></li>
+ <li ><a href="../download.html">Download</a></li>
+ <li ><a href="../community.html">Community</a></li>
+ <!-- <li><a href="./support.html">Support</a></li> -->
+ <li ><a href="../news.html">News</a></li>
+ </ul>
+ </div>
+ <!--/.nav-collapse -->
+ <form id="search-form" action="https://www.google.com/search"
+ method="get" class="navbar-search pull-right">
+ <input value="deltaspike.apache.org" name="sitesearch"
+ type="hidden"> <input class="search-query" name="q"
+ id="query" type="text">
+ </form>
+ </div>
+ </div>
+</div>
+
+<div class="container">
+ <div class="row-fluid">
+
+
+
+ <div class="span8">
+ <div class="page-title">
+ <h1>DeltaSpike Configuration Mechanism</h1>
+ </div>
+
+ <div id="doc-content">
+ <div class="sect1">
+<h2 id="_introduction">Introduction</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<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
+DeltaSpike’s own configuration mechanism in a very flexible and powerful
+way.</p>
+</div>
+<div class="sect2">
+<h3 id="_benefits_for_production">Benefits for Production</h3>
+<div class="paragraph">
+<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) will get moved to the Production system. And all this
+without any changes on the binary itself!</p>
+</div>
+<div class="paragraph">
+<p>The Apache DeltaSpike configuration system makes this possible by
+providing a default configuration 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>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_drop_in_configuration">Drop-In Configuration</h3>
+<div class="paragraph">
+<p>This mechanism also allows for dynamic configuration in case of a JAR
+drop-in. By adding some JAR to the classpath, all its 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>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_cdi_extension_configuration">CDI-Extension Configuration</h3>
+<div class="paragraph">
+<p>In some cases low-level configs are needed, for example during the bootstrapping
+process of the CDI container.</p>
+</div>
+<div class="paragraph">
+<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. Since the mechanism does not
+rely on CDI it can for example be used to configure CDI-Extensions.</p>
+</div>
+<div class="paragraph">
+<p>Currently this is, for example, used to configure the value of the current <a href="projectstage.html">ProjectStage</a>, configured values which can be
+used in the expressions for <code>@Exclude</code>, 'Deactivatable', etc. 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 ConfigSources per
+application.</p>
+</div>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_accessing_configured_values_using_configresolver">Accessing configured values using ConfigResolver</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>The <code>ConfigResolver</code> is the central point to access configuration in DeltaSpike. There are several different APIs
+ and ways to access the individual configured values, each suitable for a different purpose:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p><code>ConfigResolver</code> methods for easy programmatic access to values</p>
+</li>
+<li>
+<p><code>TypedResolver</code> API for typed configuration values and precise control over resolution</p>
+</li>
+<li>
+<p><code>@ConfigProperty</code> for injection of configured values into beans</p>
+</li>
+<li>
+<p>interface based configuration</p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
+<p>All four mechanisms are described in the following sections.</p>
+</div>
+<div class="sect2">
+<h3 id="_configresolver_methods">ConfigResolver methods</h3>
+<div class="paragraph">
+<p>ConfigResolver offers several methods for easy access to String values of configured properties.</p>
+</div>
+<div class="sect3">
+<h4 id="_getpropertyvalue">getPropertyValue()</h4>
+<div class="paragraph">
+<p>The method <code>ConfigResolver#getPropertyValue(String key)</code> returns the value configured for a given key
+as <code>String</code>, or <code>null</code> if no value has been found.</p>
+</div>
+<div class="paragraph">
+<p><code>ConfigResolver#getAllPropertyValues(String key)</code> has a similar contract
+but it returns a list which might be empty if there are no configured
+values for the given key.</p>
+</div>
+<div class="paragraph">
+<p>This is a code excerpt about how to do a simple lookup in the deltaspike
+configuration:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="java"><span class="predefined-type">String</span> dbUserName = ConfigResolver.getPropertyValue(<span class="string"><span class="delimiter">"</span><span class="content">databaseconfig.username</span><span class="delimiter">"</span></span>);</code></pre>
+</div>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_getprojectstageawarepropertyvalue">getProjectStageAwarePropertyValue()</h4>
+<div class="paragraph">
+<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 running system.</p>
+</div>
+<div class="paragraph">
+<p>This is done by first looking up the ProjectStage (this internally
+happens with the DeltaSpike ConfigResolver as well) and then go down the
+following lookup chain until we found a configured value.</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>key + '.' + projectStage , e.g. "databaseconfig.username.Production"</p>
+</li>
+<li>
+<p>key alone , e.g. "databaseconfig.username"</p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_getpropertyawarepropertyvalue">getPropertyAwarePropertyValue()</h4>
+<div class="paragraph">
+<p>The method
+<code>ConfigResolver#getPropertyAwarePropertyValue(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> mechanism into account.</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="java"><span class="predefined-type">String</span> dbUserName = ConfigResolver.getPropertyAwarePropertyValue(<span class="string"><span class="delimiter">"</span><span class="content">databaseconfig.username</span><span class="delimiter">"</span></span>, <span class="string"><span class="delimiter">"</span><span class="content">dbvendor</span><span class="delimiter">"</span></span>);</code></pre>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_property_value_resolution_sequence">Property value resolution sequence</h5>
+<div class="paragraph">
+<p>The following lookup sequence will be performed until a value is found:
+First, the value of the <em>parameter</em> property is resolved:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>propertyValue = property + '.' + projectStage, e.g. "dbvendor.Production"</p>
+</li>
+<li>
+<p>if nothing found: propertyValue = property, e.g. "dbvendor"</p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
+<p>Let’s assume we found the value 'mysql' for our dbvendor. In this case
+the following lookup chain is used until a value got found:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>key + '.' + propertyValue + '.' + projectstage, e.g. "databaseconfig.username.mysql.Production"</p>
+</li>
+<li>
+<p>key + '.' + propertyValue, e.g. "databaseconfig.username.mysql"</p>
+</li>
+<li>
+<p>key + '.' + projectStage, e.g. "databaseconfig.username.Production"</p>
+</li>
+<li>
+<p>key, e.g. "databaseconfig.username"</p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_handling_of_default_values">Handling of Default Values</h4>
+<div class="paragraph">
+<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>
+</div>
+<div class="admonitionblock tip">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-tip" title="Tip"></i>
+</td>
+<td class="content">
+<div class="title">Performance Hint</div>
+The only <code>ConfigResolver</code> operation which is cached is the determination
+of the <code>ConfigSources</code>. The various getPropertyValue operations are not
+cached in the ConfigResolver but might be cached in the ConfigSources.
+This makes the overall calculation a bit slower, but allows for values
+to change dynamically if someone likes to for example implement a
+<code>JmxConfigSource</code> (not yet part of DeltaSpike, but easily implementable).
+You can also use the <a href="#DynamicReloading">TypedResolver</a> with the <code>cacheFor(TimeUnit, long)</code> setting to cache the resolved values on the caller side.
+</td>
+</tr>
+</table>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_variable_replacement_in_configured_values">Variable Replacement in Configured Values</h3>
+<div class="paragraph">
+<p>Since version 1.6.1, DeltaSpike also supports using 'variables' inside configured values.
+You can e.g. define a single configuration key for your server and use it in other configuration values</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre>document.server.url=http://localhost:8081
+myapp.document.lists=${document.server.url}/docapp/list
+myapp.document.admin=${document.server.url}/docadmin/app</pre>
+</div>
+</div>
+<div class="paragraph">
+<p>A variable name starts with <code>${</code> and ends with <code>}</code>.</p>
+</div>
+<div class="paragraph">
+<p>Variable support is enabled by default.
+If you like to use the <code>ConfigResolver</code> without variable support you need to use the methods with the <code>evaluateVariables</code> parameter set to <code>false</code>.</p>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_typedresolver_api">TypedResolver API</h3>
+<div class="paragraph">
+<p>Very often the configured values represent more than just strings — number types and booleans are commonly used as
+configuration types. ConfigResolver provides a builder-style API to access configuration values as specific types.</p>
+</div>
+<div class="paragraph">
+<p>The API is accessed by a call to <code>ConfigResolver.resolve(propertyKey)</code>.</p>
+</div>
+<div class="paragraph">
+<p>The simplest usage of the API is resolution of a String property, equivalent to a call to
+<code>ConfigResolver.getPropertyValue(propertyKey)</code>.</p>
+</div>
+<div class="listingblock">
+<div class="title">Simple example of TypedResolver</div>
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="java"><span class="predefined-type">String</span> userName = ConfigResolver.resolve(<span class="string"><span class="delimiter">"</span><span class="content">user.name</span><span class="delimiter">"</span></span>).getValue();</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>The call to <code>ConfigResolver.resolve(..)</code> returns a builder which has methods to refine the resolution, including the
+following:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p><code>as(Class<N> clazz)</code> — defines the return type of the property</p>
+</li>
+<li>
+<p><code>parameterizedBy(String propertyName)</code> — sets a parameter for the resolution, similarly as in
+<a href="#_getpropertyawarepropertyvalue">ConfigResolver.getPropertyAwarePropertyValue</a></p>
+</li>
+<li>
+<p><code>withCurrentProjectStage(boolean with)</code> — indicates whether the current ProjectStage should be taken into account
+for the resolution</p>
+</li>
+<li>
+<p><code>strictly(boolean strictly)</code> — indicates, whether the <a href="#_property_value_resolution_sequence">property value
+resolution sequence</a> should be taken into account. When set to true, the sequence is not followed.</p>
+</li>
+<li>
+<p><code>withDefault(T value)</code> — sets the default value, used in case the resolution returns <code>null</code></p>
+</li>
+<li>
+<p><code>getValue()</code> — terminates the builder and returns the resolved value with the appropriate type</p>
+</li>
+</ul>
+</div>
+<div class="listingblock">
+<div class="title">A more complete example of TypedResolver</div>
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="java"><span class="predefined-type">Integer</span> dbPort = ConfigResolver
+ .resolve(<span class="string"><span class="delimiter">"</span><span class="content">db.port</span><span class="delimiter">"</span></span>)
+ .as(<span class="predefined-type">Integer</span>.class)
+ .withProjectStage(<span class="predefined-constant">true</span>)
+ .parameterizedBy(<span class="string"><span class="delimiter">"</span><span class="content">db.vendor</span><span class="delimiter">"</span></span>)
+ .withDefault(<span class="integer">3306</span>)
+ .getValue();</code></pre>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_supported_types">Supported types</h4>
+<div class="paragraph">
+<p>The types supported out of the box include: String, Integer, Long, Float, Double, Boolean, Class.
+Custom types can be supported by providing an implementation of the <code>ConfigResolver.Converter</code> interface.</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="java"><span class="predefined-type">Date</span> deadline = ConfigResolver.resolve(<span class="string"><span class="delimiter">"</span><span class="content">deadline</span><span class="delimiter">"</span></span>).as(<span class="predefined-type">Date</span>.class, <span class="keyword">new</span> CustomDateConverter()).getValue());</code></pre>
+</div>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="java"><span class="directive">public</span> <span class="type">class</span> <span class="class">CustomDateConverter</span> <span class="directive">implements</span> ConfigResolver.Converter<<span class="predefined-type">Date</span>> {
+
+ <span class="annotation">@Override</span>
+ <span class="directive">public</span> <span class="predefined-type">Date</span> convert(<span class="predefined-type">String</span> value)
+ {
+ <span class="predefined-type">String</span><span class="type">[]</span> parts = value.split(<span class="string"><span class="delimiter">"</span><span class="content">-</span><span class="delimiter">"</span></span>);
+ <span class="keyword">return</span> <span class="keyword">new</span> <span class="predefined-type">GregorianCalendar</span>(<span class="predefined-type">Integer</span>.valueOf(parts[<span class="integer">0</span>]), <span class="predefined-type">Integer</span>.valueOf(parts[<span class="integer">1</span>]),
+ <span class="predefined-type">Integer</span>.valueOf(parts[<span class="integer">2</span>])).getTime();
+ }
+}</code></pre>
+</div>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_dynamic_reloading">Dynamic Reloading</h4>
+<div class="paragraph">
+<p>The TypedResolver can also be used to efficiently cache configured values.
+That way you can pick up configuration which might get changed during runtime on the fly.
+E.g. if you have a ConfigSource which picks up the values from a database table.
+Instead of resolving the configured value at the beginning you simply invoke <code>.getValue()</code> on your TypedResolver each time you need the value.</p>
+</div>
+<div class="listingblock">
+<div class="title">Working with dynamically changing values</div>
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="java"><span class="directive">private</span> ConfigResolver.TypedResolver<<span class="predefined-type">String</span>> urlConfig
+ = ConfigResolver.resolve(<span class="string"><span class="delimiter">"</span><span class="content">myapp.some.remote.rest.url</span><span class="delimiter">"</span></span>)
+ .logChanges(<span class="predefined-constant">true</span>)
+ .cacheFor(<span class="predefined-type">TimeUnit</span>.MINUTES, <span class="integer">5</span>);
+
+...
+
+connecTo( urlConfig.getValue() );</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>The sample above will log any value changes in the configuration (<code>logChanges(true)</code>) and internally cache the configured value for 5 minutes (<code>cacheFor(TimeUnit.MINUTES, 5)</code>).
+Only after that time the configured value will get evaluate again.</p>
+</div>
+<div class="admonitionblock tip">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-tip" title="Tip"></i>
+</td>
+<td class="content">
+Note that the 'cache' is only held within the very TypedResolver instance.
+If you use different <code>TypedResolver</code> instances (e.g. in different classes) then you might get different cache timeouts.
+</td>
+</tr>
+</table>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_list_values_handling">List Values handling</h4>
+<div class="paragraph">
+<p>As of DeltaSpike-1.8.0, the <code>Typed Resolver</code> is also able to handle list values.
+Resolve a list of e.g. retry interval values via:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="java"><span class="predefined-type">List</span><<span class="predefined-type">Integer</span>> retryIntervals
+ = ConfigResolver.resolve(<span class="string"><span class="delimiter">"</span><span class="content">myapp.retry.intervalls</span><span class="delimiter">"</span></span>)
+ .as(<span class="predefined-type">Integer</span>.class)
+ .asList()
+ .getValue();</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>The values get configured as comma (<code>','</code>) separated value String.
+A Comma inside a value can be escaped with a backslash (<code>\,</code>), backslashes should be escaped with double-backslash (<code>\\</code>).
+Trailing and leading whitespaces get trimmed for each value.</p>
+</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_injection_of_configured_values_into_beans_using_configproperty">Injection of configured values into beans using @ConfigProperty</h3>
+<div class="paragraph">
+<p>DeltaSpike provides a way to inject configured values into your code via the qualifier <code>@ConfigProperty</code>.
+The supported types are the same as the <a href="#_supported_types">supported types of the TypedResolver</a>.</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@ApplicationScoped</span>
+<span class="directive">public</span> <span class="type">class</span> <span class="class">SomeRandomService</span>
+{
+ <span class="annotation">@Inject</span>
+ <span class="annotation">@ConfigProperty</span>(name = <span class="string"><span class="delimiter">"</span><span class="content">endpoint.poll.interval</span><span class="delimiter">"</span></span>)
+ <span class="directive">private</span> <span class="predefined-type">Integer</span> pollInterval;
+
+ <span class="annotation">@Inject</span>
+ <span class="annotation">@ConfigProperty</span>(name = <span class="string"><span class="delimiter">"</span><span class="content">endpoint.poll.servername</span><span class="delimiter">"</span></span>)
+ <span class="directive">private</span> <span class="predefined-type">String</span> pollUrl;
+
+ ...
+ }</code></pre>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_custom_configproperty_types">Custom ConfigProperty types</h4>
+<div class="paragraph">
+<p>Custom types can be injected using <code>@ConfigProperty</code> by providing a custom producer.
+DeltaSpike provides a base implementation for custom producers in the class <code>BaseConfigPropertyProducer</code>
+which offers the following methods:
+* <code>getStringPropertyValue</code> — looks for the property name in <code>@ConfigProperty</code> annotation on the injection point.
+If not found, it looks for it in other annotations on the injection point.
+* <code>getPropertyValue</code> — a shortcut to <a href="#_configresolver">ConfigResolver#getProjectStageAwarePropertyValue</a>
+* <code>getAnnotation</code> — extracts any annotation type from the injection point, useful when a custom annotation
+is used instead of <code>@ConfigProperty</code></p>
+</div>
+<div class="paragraph">
+<p>The following example uses <code>getStringPropertyValue</code> and a custom <code>@Location</code> annotation annotated <code>@ConfigProperty</code>.
+In such case, the <code>@Location</code> annotation is bound to a single fixed property name and acts as a type-safe replacement
+for <code>@ConfigProperty(name = "locationId")</code>.</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@ApplicationScoped</span>
+<span class="directive">public</span> <span class="type">class</span> <span class="class">CustomConfigPropertyProducer</span> <span class="directive">extends</span> BaseConfigPropertyProducer {
+
+ <span class="annotation">@Produces</span>
+ <span class="annotation">@Dependent</span>
+ <span class="annotation">@Location</span>
+ <span class="directive">public</span> LocationId produceLocationId(InjectionPoint injectionPoint)
+ {
+ <span class="predefined-type">String</span> configuredValue = getStringPropertyValue(injectionPoint);
+
+ <span class="keyword">return</span> LocationId.valueOf(configuredValue.trim().toUpperCase());
+ }
+}</code></pre>
+</div>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code data-lang="java"><span class="annotation">@Target</span>({ FIELD, METHOD })
+<span class="annotation">@Retention</span>(RUNTIME)
+<span class="annotation">@ConfigProperty</span>(name = <span class="string"><span class="delimiter">"</span><span class="content">locationId</span><span class="delimiter">"</span></span>, defaultValue = <span class="string"><span class="delimiter">"</span><span class="content">LOCATION_X</span><span class="delimiter">"</span></span>)
+<span class="annotation">@Qualifier</span>
[... 485 lines stripped ...]