TAMAYA-178: Regenerate page after fixes in markdown
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/commit/816057e5 Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/tree/816057e5 Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/diff/816057e5 Branch: refs/heads/asf-site Commit: 816057e575652c04ec8699739c297a985de3ff74 Parents: 01943a7 Author: Phil Ottlinger <[email protected]> Authored: Sun Nov 27 21:27:29 2016 +0100 Committer: Phil Ottlinger <[email protected]> Committed: Sun Nov 27 21:27:29 2016 +0100 ---------------------------------------------------------------------- about.html | 16 +- api.html | 152 +++++++++++++++---- archive.html | 34 +---- blog/2016/first-post.html | 12 +- blog/2016/fourth-post.html | 2 +- blog/2016/second-post.html | 2 +- blog/2016/third-post.html | 2 +- community.html | 20 +-- core.html | 20 ++- devguide.html | 4 +- download.html | 20 +-- examples.html | 4 +- extensions.html | 203 +++++++++++--------------- extensions/mod_builder.html | 2 +- extensions/mod_camel.html | 6 +- extensions/mod_cdi.html | 12 +- extensions/mod_classloader_support.html | 8 +- extensions/mod_collections.html | 6 +- extensions/mod_consul.html | 6 +- extensions/mod_environment.html | 6 +- extensions/mod_etcd.html | 6 +- extensions/mod_events.html | 210 +++++++-------------------- extensions/mod_filter.html | 42 +++--- extensions/mod_formats.html | 117 +++++---------- extensions/mod_functions.html | 6 +- extensions/mod_injection.html | 35 ++--- extensions/mod_jodatime.html | 6 +- extensions/mod_json.html | 13 +- extensions/mod_management.html | 8 +- extensions/mod_metamodel-staged.html | 8 +- extensions/mod_model.html | 6 +- extensions/mod_mutable_config.html | 177 +++++++++++++--------- extensions/mod_optional.html | 6 +- extensions/mod_osgi.html | 18 +-- extensions/mod_remote.html | 8 +- extensions/mod_resolver.html | 4 +- extensions/mod_resources.html | 4 +- extensions/mod_server.html | 6 +- extensions/mod_spi-support.html | 8 +- extensions/mod_spring.html | 8 +- extensions/mod_yaml.html | 11 +- feed.xml | 165 +++++---------------- highleveldesign.html | 4 +- history.html | 4 +- index.html | 161 ++++---------------- quickstart.html | 4 +- release-guide.html | 6 +- sitemap.xml | 166 ++++++++++----------- source.html | 4 +- start.html | 2 +- usecases.html | 4 +- 51 files changed, 751 insertions(+), 1013 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/816057e5/about.html ---------------------------------------------------------------------- diff --git a/about.html b/about.html index faeadcd..6753a9b 100644 --- a/about.html +++ b/about.html @@ -100,13 +100,13 @@ <p><em>2013-09-24</em></p> <p> -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque vel diam purus. Curabitur ut nisi lacus. -Nam id nisl quam. Donec a lorem sit amet libero pretium vulputate vel ut purus. Suspendisse leo arcu, -mattis et imperdiet luctus, pulvinar vitae mi. Quisque fermentum sollicitudin feugiat. Mauris nec leo -ligula. Vestibulum tristique odio ut risus ultricies a hendrerit quam iaculis. Duis tempor elit sit amet -ligula vehicula et iaculis sem placerat. Fusce dictum, metus at volutpat lacinia, elit massa auctor risus, -id auctor arcu enim eu augue. Donec ultrices turpis in mi imperdiet ac venenatis sapien sodales. In -consequat imperdiet nunc quis bibendum. Nulla semper, erat quis ornare tristique, lectus massa posuere +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque vel diam purus. Curabitur ut nisi lacus. +Nam id nisl quam. Donec a lorem sit amet libero pretium vulputate vel ut purus. Suspendisse leo arcu, +mattis et imperdiet luctus, pulvinar vitae mi. Quisque fermentum sollicitudin feugiat. Mauris nec leo +ligula. Vestibulum tristique odio ut risus ultricies a hendrerit quam iaculis. Duis tempor elit sit amet +ligula vehicula et iaculis sem placerat. Fusce dictum, metus at volutpat lacinia, elit massa auctor risus, +id auctor arcu enim eu augue. Donec ultrices turpis in mi imperdiet ac venenatis sapien sodales. In +consequat imperdiet nunc quis bibendum. Nulla semper, erat quis ornare tristique, lectus massa posuere libero, ut vehicula lectus nunc ut lorem. Aliquam erat volutpat. </p> @@ -120,7 +120,7 @@ libero, ut vehicula lectus nunc ut lorem. Aliquam erat volutpat. <div class="container"> <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> + at <span>2016-11-27</span> </p> <p> <b>Disclaimer</b> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/816057e5/api.html ---------------------------------------------------------------------- diff --git a/api.html b/api.html index b976aea..c8b4087 100644 --- a/api.html +++ b/api.html @@ -97,14 +97,14 @@ <h1></h1> </div> - <p><em>2016-11-02</em></p> + <p><em>2016-11-19</em></p> <p><div class="sect1"> <h2 id="CoreDesign">Apache Tamaya: API</h2> <div class="sectionbody"> <div class="paragraph"> <p>Though Tamaya is a very powerful and flexible solution there are basically only a few simple core concepts required -that build the base of all the other mechanisms. As a starting point we recommend you read the corresponding +that are the base of all the other mechanisms. As a starting point we recommend you read the corresponding l<a href="HighLevelDesign.html">High Level Design Documentation</a></p> </div> </div> @@ -183,14 +183,20 @@ singleton.</p> <p>PropertyFilter, which allows filtering of property values prior getting returned to the caller.</p> </li> <li> -<p>ConfigurationContext, which provides the container that contains the property sources and filters that form a -configuration.</p> -</li> -<li> <p>PropertyValueCombinationPolicy optionally can be registered to change the way how different key/value pairs are combined to build up the final Configuration passed over to the filters registered.</p> </li> <li> +<p>ConfigurationContext, which provides a container for all the artifacts needed to build up a Configuration. +For example a context contains the property sources, property filters, converters and combination policy used. +Also the ordering of the property sources is defined by the context. A context instance given a +Configuration can be created by calling ConfigurationProvider.createConfiguration(context);.</p> +</li> +<li> +<p>Similarly a ConfigurationContext can be created using a ConfigurationContextBuilder. This builder can be +obtained calling ConfigurationProvider.getConfigurationContextBuilder();.</p> +</li> +<li> <p>ServiceContext, which provides access to the components loaded, depending on the current runtime stack.</p> </li> <li> @@ -405,7 +411,7 @@ be included.</p> </div> </div> <div class="sect3"> -<h4 id="PropertyConverter">Property Converters</h4> +<h4 id="PropertyConverter">Property Type Conversion</h4> <div class="paragraph"> <p>As illustrated in the previous section, Configuration also to access non String types. Nevertheless internally all properties are strictly modelled as pure Strings only, so non String types must be derived by converting the @@ -571,8 +577,9 @@ property sources with additional combination/aggregation rules in place.</p> <p>PropertySources are by default registered using the Java ServiceLoader or the mechanism provided by the current active ServiceContext.</p> </div> -<div class="sect3"> -<h4 id="PropertySourceProvider">Interface PropertySourceProvider</h4> +</div> +<div class="sect2"> +<h3 id="PropertySourceProvider">Interface PropertySourceProvider</h3> <div class="paragraph"> <p>Instances of this type can be used to register multiple instances of PropertySource.</p> </div> @@ -594,8 +601,8 @@ refer also to <a id="ConfigurationContext"></a>.</p> current active ServiceContext.</p> </div> </div> -<div class="sect3"> -<h4 id="PropertyFilter">Interface PropertyFilter</h4> +<div class="sect2"> +<h3 id="PropertyFilter">Interface PropertyFilter</h3> <div class="paragraph"> <p>Also PropertyFilters can be added to a Configuration. They are evaluated before a Configuration instance is passed to the user. Filters can hereby used for multiple purposes, such as</p> @@ -653,7 +660,6 @@ To prevent possible endless loops after a defined number of loops evaluation is <div class="paragraph"> <p>This method is called each time a single entry is accessed, and for each property in a full properties result.</p> </div> -</div> <div class="sect3"> <h4 id="PropertyValueCombinationPolicy">Interface PropertyValueCombinationPolicy</h4> <div class="paragraph"> @@ -690,7 +696,7 @@ public interface PropertyValueCombinationPolicy{ <div class="sect3"> <h4 id="ConfigurationContext">The Configuration Context</h4> <div class="paragraph"> -<p>A Configuration is basically based on a so called ConfigurationContext, which is +<p>A Configuration is created from a ConfigurationContext, which is accessible from Configuration.getContext():</p> </div> <div class="listingblock"> @@ -700,7 +706,8 @@ accessible from Configuration.getContext():</p> </div> </div> <div class="paragraph"> -<p>The ConfigurationContext provides access to the internal building blocks that determine the final Configuration:</p> +<p>The ConfigurationContext provides access to the internal artifacts that determine the final Configuration and +also defines the ordering of the property sources, filters and converters contained:</p> </div> <div class="ulist"> <ul> @@ -723,8 +730,8 @@ combined to the final property value returned to the client.</p> <div class="sect3"> <h4 id="Mutability">Changing the current Configuration Context</h4> <div class="paragraph"> -<p>By default the ConfigurationContext is not mutable once it is created. In many cases mutability is also not needed -or even not wanted. Nevertheless there are use cases where the current ConfigurationContext (and +<p>A ConfigurationContext is not mutable once it is created. In many cases mutability is also not needed. Nevertheless +there are use cases where the current ConfigurationContext (and consequently Configuration) must be adapted:</p> </div> <div class="ulist"> @@ -746,7 +753,7 @@ tests executed.</p> </ul> </div> <div class="paragraph"> -<p>In such cases the ConfigurationContext must be mutable, meaning it must be possible:</p> +<p>In such cases the ConfigurationContext must be changed, meaning it must be possible:</p> </div> <div class="ulist"> <ul> @@ -771,11 +778,11 @@ accessed either</p> <div class="ulist"> <ul> <li> -<p>from the current ConfigurationContext, hereby returning a builder instance preinitialized with the values from the -current ConfigurationContext</p> +<p>calling ConfigurationContext.toBuilder(), hereby returning a builder instance preinitialized with the values from the +current ConfigurationContext.</p> </li> <li> -<p>from the current ConfigurationProvider singleton.</p> +<p>calling ConfigurationProvider.getConfigurationContextBuilder().</p> </li> </ul> </div> @@ -792,10 +799,43 @@ ConfigurationContextBuilder emptyContextBuilder = ConfigurationProvider.getConfi <div class="listingblock"> <div class="title">Creating and applying a new ConfigurationContext</div> <div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">ConfigurationContextBuilder preinitializedContextBuilder = ConfigurationProvider.getConfiguration().getContext() - .toBuilder(); -ConfigurationContext context = preinitializedContextBuilder.addPropertySources(new MyPropertySource()) - .addPropertyFilter(new MyFilter()).build(); +<pre class="prettyprint highlight"><code class="language-java" data-lang="java">ConfigurationContext context = ConfigurationProvider.getConfiguration().getContext() + .toBuilder(); + .addPropertySources(new MyPropertySource()) + .addPropertyFilter(new MyFilter()) + .build();</code></pre> +</div> +</div> +<div class="paragraph"> +<p>Hereby the builder provides several methods for adding, removing of property sources and also operations +for programmatically change the property sourcepriorities, e.g.</p> +</div> +<div class="listingblock"> +<div class="title">Chain manipulation using ConfigurationContextBuilder</div> +<div class="content"> +<pre class="prettyprint highlight"><code class="language-java" data-lang="java">PropertySource propertySource = builder.getPropertySource("sourceId"); + +// changing the priority of a property source. The ordinal value hereby is not considered. +// Instead the position of the property source within the chain is changed. +builder.decreasePriority(propertySource); + +// Alternately a comparator expression can be passed to establish the defined ordering... +builder.sortPropertyFilters(MyFilterComparator::compare);</code></pre> +</div> +</div> +<div class="paragraph"> +<p>Finally if the new context is ready a new configuration can be created, or the context is applied to the +current configuration.</p> +</div> +<div class="listingblock"> +<div class="title">Creating and applying a new ConfigurationContext</div> +<div class="content"> +<pre class="prettyprint highlight"><code class="language-java" data-lang="java">ConfigurationContext context = builder.build(); + +// Creates a new matching Configuration instance +Configuration newConfig = ConfigurationProvider.createConfiguration(context); + +// Apply the new context to replace the current configuration: ConfigurationProvider.setConfigurationContext(context);</code></pre> </div> </div> @@ -827,6 +867,68 @@ ConfigurationProvider singleton. Implementing this class allows</p> </ul> </div> </div> +</div> +</div> +</div> +<h1 id="_interface_configurationcontextbuilder" class="sect0">Interface ConfigurationContextBuilder</h1> +<div class="paragraph"> +<p>Unresolved directive in <stdin> - include::temp-properties-files-for-site/attributes.adoc[]</p> +</div> +<div class="sect1"> +<h2 id="BuilderCore">Interface ConfigurationContextBuilder</h2> +<div class="sectionbody"> +<div class="sect2"> +<h3 id="_overview">Overview</h3> +<div class="paragraph"> +<p>The Tamaya builder module provides a generic (one time) builder for creating Configuration instances, +e.g. as follows:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="prettyprint highlight"><code class="language-java" data-lang="java">ConfigurationBuilder builder = new ConfigurationBuilder(); +// do something +Configuration config = builder.build();</code></pre> +</div> +</div> +<div class="paragraph"> +<p>Basically the builder allows to create configuration instances completely independent of the current configuration +setup. This gives you full control on the Configuration setup.</p> +</div> +</div> +<div class="sect2"> +<h3 id="_supported_functionality">Supported Functionality</h3> +<div class="paragraph"> +<p>The builder allows you to add PropertySource instances:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="prettyprint highlight"><code class="language-java" data-lang="java">ConfigurationContextBuilder builder = ConfigurationProvider.getConfigurationContextBuilder(); +builder.addPropertySources(sourceOne, sourceTwo, sourceThree +Configuration config = ConfigurationProvider.createConfiguration(builder.build());</code></pre> +</div> +</div> +<div class="paragraph"> +<p>Hereby the ordering of the propertysources is not changed, regardless of the ordinals provided +by the property sources. This allows alternate ordering policies easily being implemented because +creating a configuration based on a configuration context is already implemented and provided by the core +API.</p> +</div> +<div class="paragraph"> +<p>Similarly you can add filters:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="prettyprint highlight"><code class="language-java" data-lang="java">builder.addPropertyFilters(new MyConfigFilter());</code></pre> +</div> +</div> +<div class="paragraph"> +<p>…​or PropertySourceProvider instances:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="prettyprint highlight"><code class="language-java" data-lang="java">builder.addPropertySourceProvider(new MyPropertySourceProvider());</code></pre> +</div> +</div> <div class="sect3"> <h4 id="ServiceContext">The ServiceContext</h4> <div class="paragraph"> @@ -983,7 +1085,7 @@ further details.</p> <div class="container"> <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> + at <span>2016-11-27</span> </p> <p> <b>Disclaimer</b> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/816057e5/archive.html ---------------------------------------------------------------------- diff --git a/archive.html b/archive.html index b9b73a0..81c8623 100644 --- a/archive.html +++ b/archive.html @@ -97,9 +97,9 @@ </div> - <h3>Oktober 2013</h3> + <h3>November 2016</h3> - <h4>17 - <a href="blog/2013/fourth-post.html">Fourth Post</a></h4> + <h4>04 - <a href="blog/2016/first-post.html">Hello world</a></h4> @@ -113,13 +113,6 @@ <h3>September 2013</h3> - <h4>26 - <a href="blog/2013/third-post.html">Third Post</a></h4> - - - - - <h3>September 2013</h3> - <h4>26 - <a href="blog/2016/third-post.html">Third Post</a></h4> @@ -127,31 +120,10 @@ <h3>August 2013</h3> - <h4>25 - <a href="blog/2013/second-post.html">Second Post</a></h4> - - - - - <h3>August 2013</h3> - <h4>25 - <a href="blog/2016/second-post.html">Second Post</a></h4> - - <h3>Juli 2013</h3> - - <h4>24 - <a href="blog/2013/first-post.html">First Post</a></h4> - - - - - <h3>Juli 2013</h3> - - <h4>24 - <a href="blog/2016/first-post.html">First Post</a></h4> - - - </div> </div> @@ -162,7 +134,7 @@ <div class="container"> <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> + at <span>2016-11-27</span> </p> <p> <b>Disclaimer</b> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/816057e5/blog/2016/first-post.html ---------------------------------------------------------------------- diff --git a/blog/2016/first-post.html b/blog/2016/first-post.html index 8bdbdba..d24439f 100644 --- a/blog/2016/first-post.html +++ b/blog/2016/first-post.html @@ -3,7 +3,7 @@ <html xmlns="http://www.w3.org/1999/xhtml";> <head> <meta charset="utf-8"/> - <title>First Post</title> + <title>Hello world</title> <meta name="viewport" content="width=device-width, initial-scale=1.0"/> <meta name="description" content=""/> <meta name="author" content=""/> @@ -94,13 +94,15 @@ <div class="container"> <div class="page-header"> - <h1>First Post</h1> + <h1>Hello world</h1> </div> - <p><em>2013-07-24</em></p> + <p><em>2016-11-04</em></p> <p> -<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque vel diam purus. Curabitur ut nisi lacus.</p> +<p> +This page contains the newly baked and generated homepage for tamaya :-) +</p> <ul> <li><a href="http://example.org";>http://example.org</a></li> @@ -139,7 +141,7 @@ libero, ut vehicula lectus nunc ut lorem. Aliquam erat volutpat.</p> <div class="container"> <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> + at <span>2016-11-27</span> </p> <p> <b>Disclaimer</b> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/816057e5/blog/2016/fourth-post.html ---------------------------------------------------------------------- diff --git a/blog/2016/fourth-post.html b/blog/2016/fourth-post.html index 3234a8d..d210fcf 100644 --- a/blog/2016/fourth-post.html +++ b/blog/2016/fourth-post.html @@ -132,7 +132,7 @@ libero, ut vehicula lectus nunc ut lorem. Aliquam erat volutpat.</p> <div class="container"> <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> + at <span>2016-11-27</span> </p> <p> <b>Disclaimer</b> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/816057e5/blog/2016/second-post.html ---------------------------------------------------------------------- diff --git a/blog/2016/second-post.html b/blog/2016/second-post.html index 4cedb36..5d125a1 100644 --- a/blog/2016/second-post.html +++ b/blog/2016/second-post.html @@ -116,7 +116,7 @@ <div class="container"> <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> + at <span>2016-11-27</span> </p> <p> <b>Disclaimer</b> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/816057e5/blog/2016/third-post.html ---------------------------------------------------------------------- diff --git a/blog/2016/third-post.html b/blog/2016/third-post.html index 023cfb7..b3629af 100644 --- a/blog/2016/third-post.html +++ b/blog/2016/third-post.html @@ -132,7 +132,7 @@ libero, ut vehicula lectus nunc ut lorem. Aliquam erat volutpat.</p> <div class="container"> <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> + at <span>2016-11-27</span> </p> <p> <b>Disclaimer</b> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/816057e5/community.html ---------------------------------------------------------------------- diff --git a/community.html b/community.html index 7c42f5f..1f975ce 100644 --- a/community.html +++ b/community.html @@ -97,7 +97,7 @@ <h1>Apache Tamaya: Community</h1> </div> - <p><em>2016-11-02</em></p> + <p><em>2016-11-19</em></p> <p><div class="sect1"> <h2 id="_users">1. Users</h2> @@ -118,7 +118,7 @@ bug or if there is an ongoing discussion in case of a feature.</p> </div> <div class="paragraph"> <p>You are very welcome to follow our twitter account -<a href="http://twitter.com/tamayaconf"; target="_blank">@tamayaconf</a> and spread the word +<a href="https://twitter.com/TBD_tamaya"; target="_blank">@TBD_tamaya</a> and spread the word of Tamaya with tweets, blog entries,…​</p> </div> </div> @@ -128,8 +128,8 @@ of Tamaya with tweets, blog entries,…​</p> <div class="sectionbody"> <div class="paragraph"> <p>Everybody is welcome to get involved with our community. You can find general -information at <a href="http://apache.org/foundation/getinvolved.html"; class="bare">http://apache.org/foundation/getinvolved.html</a> and -<a href="http://apache.org/foundation/how-it-works.html"; class="bare">http://apache.org/foundation/how-it-works.html</a>. +information at <a href="https://apache.org/foundation/getinvolved.html"; class="bare">https://apache.org/foundation/getinvolved.html</a> and +<a href="https://apache.org/foundation/how-it-works.html"; class="bare">https://apache.org/foundation/how-it-works.html</a>. The following sections provides some details about the different levels of getting involved.</p> </div> <div class="paragraph"> @@ -144,8 +144,8 @@ that addresses how to contribute, render and publish it.</p> <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 <a href="http://www.apache.org/licenses/icla.txt"; target="_blank">Individual Contributor License Agreement (ICLA)</a> -or <a href="http://www.apache.org/licenses/cla-corporate.txt"; target="_blank">Software Grant and Corporate Contributor License Agreement (CCLA)</a> +a <a href="https://www.apache.org/licenses/icla.txt"; target="_blank">Individual Contributor License Agreement (ICLA)</a> +or <a href="https://www.apache.org/licenses/cla-corporate.txt"; target="_blank">Software Grant and Corporate Contributor License Agreement (CCLA)</a> and send it to secretary at apache dot org (or fax it) as early as possible.</p> </div> <div class="paragraph"> @@ -172,7 +172,7 @@ start contributing and help users.</p> Furthermore, you can check our <a href="community.html#mailing-lists">mail-archives</a>.</p> </div> <div class="paragraph"> -<p>Further details are available at <a href="http://www.apache.org/dev/"; target="_blank">http://www.apache.org/dev/</a>.</p> +<p>Further details are available at <a href="https://www.apache.org/dev/"; target="_blank">https://www.apache.org/dev/</a>.</p> </div> </div> <div class="sect2"> @@ -228,8 +228,8 @@ If you have any question, you can ask us <h3 id="_spread_the_word">2.5. Spread the word</h3> <div class="paragraph"> <p>You are very welcome e.g. to write blog entries, mention our twitter handle - @tamayaconf if you tweet about the project or just follow our twitter -account <a href="http://twitter.com/tamayaconf"; target="_blank">@tamayaconf</a></p> + @TBD_tamaya if you tweet about the project or just follow our twitter +account <a href="https://twitter.com/TBD_tamaya"; target="_blank">@TBD_tamaya</a></p> </div> </div> <div class="sect2"> @@ -261,7 +261,7 @@ $ irssi <div class="container"> <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> + at <span>2016-11-27</span> </p> <p> <b>Disclaimer</b> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/816057e5/core.html ---------------------------------------------------------------------- diff --git a/core.html b/core.html index 642c161..ede125e 100644 --- a/core.html +++ b/core.html @@ -97,7 +97,7 @@ <h1></h1> </div> - <p><em>2016-11-02</em></p> + <p><em>2016-11-19</em></p> <p><div class="sect1"> <h2 id="Core">Tamaya Core Implementation</h2> @@ -132,7 +132,8 @@ hereby providing type conversion for all important types.</p> registers them in the global ConfigurationContext</p> </li> <li> -<p>It provides a ConfigurationContextBuilder and allows changing the current ConfigurationContext.</p> +<p>It provides a ConfigurationContextBuilder implementation (class DefaultConfigurationContextBuilder) and allows +changing the current ConfigurationContext.</p> </li> </ul> </div> @@ -351,6 +352,19 @@ still defined and predictable in almost all scenarios.</p> </li> </ul> </div> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<div class="title">Note</div> +</td> +<td class="content"> +Sorting the property sources based on their ordinal value is only the default ordering principle applied. By implementing + your own implementation of ConfigurationProviderSpi you can apply a different logic: +</td> +</tr> +</table> +</div> </div> <div class="sect2"> <h3 id="RegisteringPropertySources">Registering Property Sources</h3> @@ -527,7 +541,7 @@ Loading extensions hereby is trivial: you only are required to add the correspon <div class="container"> <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> + at <span>2016-11-27</span> </p> <p> <b>Disclaimer</b> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/816057e5/devguide.html ---------------------------------------------------------------------- diff --git a/devguide.html b/devguide.html index 347f3bb..3980a3d 100644 --- a/devguide.html +++ b/devguide.html @@ -97,7 +97,7 @@ <h1>Apache Tamaya: Development Guide</h1> </div> - <p><em>2016-11-02</em></p> + <p><em>2016-11-19</em></p> <p><div class="sect1"> <h2 id="_suggested_git_workflows">1. Suggested Git Workflows</h2> @@ -353,7 +353,7 @@ $ git branch -d TAMAYA-XXX</pre> <div class="container"> <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> + at <span>2016-11-27</span> </p> <p> <b>Disclaimer</b> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/816057e5/download.html ---------------------------------------------------------------------- diff --git a/download.html b/download.html index 8458ed6..eac9c44 100644 --- a/download.html +++ b/download.html @@ -97,12 +97,12 @@ <h1>Apache Tamaya: Download</h1> </div> - <p><em>2016-11-02</em></p> + <p><em>2016-11-19</em></p> <p><div id="preamble"> <div class="sectionbody"> <div class="paragraph"> -<p>The latest release is Apache Tamaya {tamaya_version_released}. +<p>The latest release is Apache Tamaya 0.2. You can download it it from the <a href="http://www.apache.org/dist/incubator/tamaya"; target="_blank">Apache Software Foundation Distribution Directory</a>.</p> </div> @@ -138,12 +138,12 @@ can be found at the <a href="history.html">release history page</a>.</p> <pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> <groupId>org.apache.tamaya</groupId> <artifactId>tamaya-api</artifactId> - <version>{tamaya_version_released}</version> + <version>0.2</version> </dependency> <dependency> <groupId>org.apache.tamaya</groupId> <artifactId>tamaya-core</artifactId> - <version>{tamaya_version_released}</version> + <version>0.2</version> </dependency></code></pre> </div> </div> @@ -154,7 +154,7 @@ can be found at the <a href="history.html">release history page</a>.</p> <div class="sectionbody"> <div class="paragraph"> <p>All previous releases can also be found at the -<a href="http://www.apache.org/dist/incubator/tamaya/"; target="_blank">Apache Software Foundation Distribution Directory</a>. +<a href="https://www.apache.org/dist/incubator/tamaya/"; target="_blank">Apache Software Foundation Distribution Directory</a>. In our <a href="history.html">release history overview</a> you can find all previous releases of Tamaya.</p> </div> </div> @@ -166,16 +166,16 @@ In our <a href="history.html">release history overview</a> you can find all prev <p>It is essential that you verify the integrity of any downloaded files using the PGP or MD5 signatures. For more information on signing artifacts and why we do it, check out the -<a href="http://www.apache.org/dev/release-signing.html"; target="_blank">Release Signing FAQ</a>.</p> +<a href="https://www.apache.org/dev/release-signing.html"; target="_blank">Release Signing FAQ</a>.</p> </div> <div class="paragraph"> <p>The PGP signatures can be verified using PGP or GPG. First download the -<a href="http://www.apache.org/dist/incubator/tamaya/KEYS"; target="_blank">KEYS file</a> +<a href="https://www.apache.org/dist/incubator/tamaya/KEYS"; target="_blank">KEYS file</a> as well as the asc signature file for the artifact. Make sure you get these files from the -<a href="http://www.apache.org/dist/incubator/tamaya/"; target="_blank">main distribution directory</a> +<a href="https://www.apache.org/dist/incubator/tamaya/"; target="_blank">main distribution directory</a> rather than from a -<a href="http://www.apache.org/dyn/closer.cgi/tamaya/"; target="_blank">mirror</a>. +<a href="https://www.apache.org/dyn/closer.cgi/tamaya/"; target="_blank">mirror</a>. Then verify the signatures using e.g.:</p> </div> <div class="listingblock"> @@ -215,7 +215,7 @@ $ gpg --verify tamaya-project-1.2.0-source-release.zip.asc</code></pre> <div class="container"> <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> + at <span>2016-11-27</span> </p> <p> <b>Disclaimer</b> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/816057e5/examples.html ---------------------------------------------------------------------- diff --git a/examples.html b/examples.html index 79d1a48..a4fd2a6 100644 --- a/examples.html +++ b/examples.html @@ -97,7 +97,7 @@ <h1>Apache Tamaya: Examples</h1> </div> - <p><em>2016-11-02</em></p> + <p><em>2016-11-19</em></p> <p><div id="preamble"> <div class="sectionbody"> @@ -181,7 +181,7 @@ adapted.</p> <div class="container"> <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> + at <span>2016-11-27</span> </p> <p> <b>Disclaimer</b> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/816057e5/extensions.html ---------------------------------------------------------------------- diff --git a/extensions.html b/extensions.html index 553f6e3..dddd42d 100644 --- a/extensions.html +++ b/extensions.html @@ -97,7 +97,7 @@ <h1></h1> </div> - <p><em>2016-11-02</em></p> + <p><em>2016-11-19</em></p> <p><div class="sect1"> <h2 id="_apache_tamaya_extension_modules">Apache Tamaya: Extension Modules</h2> @@ -153,47 +153,6 @@ <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_resolver.html">Documentation</a></p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-spi-support</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Tamaya support module for SPI implementation.</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_spi-support.html">Documentation</a></p></td> -</tr> -</tbody> -</table> -</div> -<div class="sect2"> -<h3 id="_extensions">Extensions</h3> -<div class="paragraph"> -<p>Extensions in <em>draft state</em> are tested well and normally should have rather stable APIs. Nevertheless API changes may -still occurr, but we try to prevent such changes if possible.</p> -</div> -<div class="paragraph"> -<p>NOTE All extensions currently run on Java 7 as well as on Java 8.</p> -</div> -<table class="tableblock frame-1 grid-all spread"> -<colgroup> -<col style="width: 33.3333%;"> -<col style="width: 33.3333%;"> -<col style="width: 33.3334%;"> -</colgroup> -<thead> -<tr> -<th class="tableblock halign-left valign-top"><em>Artifact</em></th> -<th class="tableblock halign-left valign-top"><em>Description</em></th> -<th class="tableblock halign-left valign-top"><em>Links</em></th> -</tr> -</thead> -<tbody> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-builder</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Provides a fluent-style builder for configurations</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_builder.html">Documentation</a></p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-classloader-support</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Manages Tamaya configuration and services considering classloading hierarchies.</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_classloader_support.html">Documentation</a></p></td> -</tr> -<tr> <td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-events</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Provides support for publishing configuration changes</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_events.html">Documentation</a></p></td> @@ -204,19 +163,24 @@ still occurr, but we try to prevent such changes if possible.</p> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_filter.html">Documentation</a></p></td> </tr> <tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-injection-api</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Provides Tamaya’s injection annotations API.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_injection.html">Documentation</a></p></td> +</tr> +<tr> <td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-injection</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Provides configuration injection services and congiruation template support.</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_injection.html">Documentation</a></p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-management</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Provides JMX support for inspecting configuration.</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_management.html">Documentation</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-injection-cdi</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Java EE/standalone compliant CDI integration using CDI for injection.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_cdi.html">Documentation</a></p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-model</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Provides support documenting ang validating configuration during runtime.</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_model.html">Documentation</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-injection-cdi-se</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Java EE/standalone compliant CDI integration using Tamaya SE injection mechanism.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_cdi.html">Documentation</a></p></td> </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-mutable-config</p></td> @@ -224,9 +188,9 @@ still occurr, but we try to prevent such changes if possible.</p> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_mutable_config.html">Documentation</a></p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-remote</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Provides remote configuration support.</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_remote.html">Documentation</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-spi-support</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Tamaya support module for SPI implementation.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_spi-support.html">Documentation</a></p></td> </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-resources</p></td> @@ -234,11 +198,6 @@ still occurr, but we try to prevent such changes if possible.</p> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_resources.html">Documentation</a></p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-server</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Lets a Tamaya configuration instance provide scoped configuration as a REST service.</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_server.html">Documentation</a></p></td> -</tr> -<tr> <td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-yaml</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Support for using yaml as a configuration format.</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_yaml.html">Documentation</a></p></td> @@ -248,14 +207,32 @@ still occurr, but we try to prevent such changes if possible.</p> <td class="tableblock halign-left valign-top"><p class="tableblock">Collections support.</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_collections.html">Documentation</a></p></td> </tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-spring</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Integration for Spring / Spring Boot.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_spring.html">Documentation</a></p></td> +</tr> </tbody> </table> </div> <div class="sect2"> -<h3 id="_integrations">Integrations</h3> +<h3 id="_extensions_sandbox">Extensions Sandbox</h3> <div class="paragraph"> -<p>These extensions integrate/bridge Tamayas functionality with other frameworks turning their configuration capabilities -from a sledgehammer to a scalpell:</p> +<p>Extensions in <em>draft state</em> rather experimental or not yet very mature. API changes may occurr at any time +and the may also have severe issues. So use at your own risk or join and help us getting them stable and +well tested!</p> +</div> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<div class="title">Note</div> +</td> +<td class="content"> +All extensions currently run on Java 7 as well as on Java 8. +</td> +</tr> +</table> </div> <table class="tableblock frame-1 grid-all spread"> <colgroup> @@ -272,9 +249,39 @@ from a sledgehammer to a scalpell:</p> </thead> <tbody> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-cdi</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Java EE/standalone compliant CDI integration</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_cdi.html">Documentation</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-commons</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Combines Tamaya’s Format Abstraction with Apache Commons.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-jodatime</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Provides support for JodaTime.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_jodatime.html">Documentation</a></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-classloader-support</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Manages Tamaya configuration and services considering classloading hierarchies.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_classloader_support.html">Documentation</a></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-management</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Provides JMX support for inspecting configuration.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_management.html">Documentation</a></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-metamodel</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Provides support defining configuration using XML based meta-configuration.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_metamodel.html">Documentation</a></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-validation</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Provides support for XML based meta-configuration allowing to validate configuration read.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_validation.html">Documentation</a></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-usagetracker</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Provides support tracking of configuration usage and the consumer locations consuming configuration.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_usagetracker.html">Documentation</a></p></td> </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-camel</p></td> @@ -282,11 +289,6 @@ from a sledgehammer to a scalpell:</p> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_camel.html">Documentation</a></p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-spring</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Integration for Spring / Spring Boot.</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_spring.html">Documentation</a></p></td> -</tr> -<tr> <td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-osgi</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Integration for OSGI containers.</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_osgi.html">Documentation</a></p></td> @@ -301,66 +303,25 @@ from a sledgehammer to a scalpell:</p> <td class="tableblock halign-left valign-top"><p class="tableblock">Integration with etcd clusters.</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_etcd.html">Documentation</a></p></td> </tr> -</tbody> -</table> -</div> -<div class="sect2"> -<h3 id="_extensions_in_experimental_stage">Extensions in Experimental Stage</h3> -<div class="paragraph"> -<p>Extensions in <em>experimental mode</em> may still be under discussions. API changes may still happen, so use them -very carefully and especially give us feedback, so we can improve them before progressing to <em>draft</em> state.</p> -</div> -<table class="tableblock frame-1 grid-all spread"> -<colgroup> -<col style="width: 33.3333%;"> -<col style="width: 33.3333%;"> -<col style="width: 33.3334%;"> -</colgroup> -<thead> -<tr> -<th class="tableblock halign-left valign-top"><em>Artifact</em></th> -<th class="tableblock halign-left valign-top"><em>Description</em></th> -<th class="tableblock halign-left valign-top"><em>Links</em></th> -</tr> -</thead> -<tbody> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-jodatime</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Provides support for JodaTime.</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_jodatime.html">Documentation</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-configured-sysprops</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Allows Tamaya to integrate with System.getProperties().</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_sysprops.html">Documentation</a></p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-staged</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Simple configuration extension to add staged config.</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_metamodel-staged.html">Documentation</a></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-remote</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Provides remote configuration support.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_remote.html">Documentation</a></p></td> </tr> -</tbody> -</table> -</div> -<div class="sect2"> -<h3 id="_integrations_in_experimental_stage">Integrations in Experimental Stage</h3> -<div class="paragraph"> -<p>Integrations in <em>experimental mode</em> may still be under discussions, or may even not compile ! API changes may still happen, so use them -very carefully and especially give us feedback, so we can improve them before progressing to <em>draft</em> state.</p> -</div> -<table class="tableblock frame-1 grid-all spread"> -<colgroup> -<col style="width: 33.3333%;"> -<col style="width: 33.3333%;"> -<col style="width: 33.3334%;"> -</colgroup> -<thead> <tr> -<th class="tableblock halign-left valign-top"><em>Artifact</em></th> -<th class="tableblock halign-left valign-top"><em>Description</em></th> -<th class="tableblock halign-left valign-top"><em>Links</em></th> +<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-server</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Lets a Tamaya configuration instance provide scoped configuration as a REST service.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_server.html">Documentation</a></p></td> </tr> -</thead> -<tbody> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-commons</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Integration with Apache Commons Configuration.</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">org.apache.tamaya.ext:tamaya-ui</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Provides a web UI for a VM running Tamaya.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="extensions/mod_ui.html">Documentation</a></p></td> </tr> </tbody> </table> @@ -378,7 +339,7 @@ very carefully and especially give us feedback, so we can improve them before pr <div class="container"> <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> + at <span>2016-11-27</span> </p> <p> <b>Disclaimer</b> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/816057e5/extensions/mod_builder.html ---------------------------------------------------------------------- diff --git a/extensions/mod_builder.html b/extensions/mod_builder.html index 9aa89a0..7ca4c55 100644 --- a/extensions/mod_builder.html +++ b/extensions/mod_builder.html @@ -203,7 +203,7 @@ builder.enableProvidedPropertySources();</code></pre> <div class="container"> <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> + at <span>2016-11-27</span> </p> <p> <b>Disclaimer</b> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/816057e5/extensions/mod_camel.html ---------------------------------------------------------------------- diff --git a/extensions/mod_camel.html b/extensions/mod_camel.html index 6b2fc9e..aab4068 100644 --- a/extensions/mod_camel.html +++ b/extensions/mod_camel.html @@ -97,7 +97,7 @@ <h1>Apache Tamaya&#8201;&#8212;&#8201;Extension: Integration with Apache Camel</h1> </div> - <p><em>2016-11-02</em></p> + <p><em>2016-11-19</em></p> <p><div id="preamble"> <div class="sectionbody"> @@ -130,7 +130,7 @@ configuration with Apache Camel.</p> <pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-camel</artifactId> - <version>{tamayaVersion}</version> + <version>{tamaya_version}</version> </dependency></code></pre> </div> </div> @@ -255,7 +255,7 @@ again use Tamaya as the main configuration solutions only using Camel’s de <div class="container"> <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> + at <span>2016-11-27</span> </p> <p> <b>Disclaimer</b> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/816057e5/extensions/mod_cdi.html ---------------------------------------------------------------------- diff --git a/extensions/mod_cdi.html b/extensions/mod_cdi.html index 13b2d71..8ff66c0 100644 --- a/extensions/mod_cdi.html +++ b/extensions/mod_cdi.html @@ -97,7 +97,7 @@ <h1>Apache Tamaya&#8201;&#8212;&#8201;Extension: Classloader Isolation Support</h1> </div> - <p><em>2016-11-02</em></p> + <p><em>2016-11-19</em></p> <p><div id="preamble"> <div class="sectionbody"> @@ -154,7 +154,7 @@ components will be compatible regardless if deployed in a pure SE, a Java EE (CD <pre><dependency> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-injection-api</artifactId> - <version>{tamaya-version}</version> + <version>{tamaya_version}</version> </dependency></pre> </div> </div> @@ -162,7 +162,7 @@ components will be compatible regardless if deployed in a pure SE, a Java EE (CD <div class="sect2"> <h3 id="_compatibility">Compatibility</h3> <div class="paragraph"> -<p>Both modules are based on Java 7, so they will only run on Java 7 and beyond.</p> +<p>Both modules are based on Java 7, so they will not run on Java 7 and beyond.</p> </div> </div> <div class="sect2"> @@ -177,7 +177,7 @@ you never have installed both CDI extensions at the same time because this may b <pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-cdi-ee</artifactId> - <version>{tamaya-version}</version> + <version>{tamaya_version}</version> </dependency></code></pre> </div> </div> @@ -187,7 +187,7 @@ you never have installed both CDI extensions at the same time because this may b <pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-cdi-se</artifactId> - <version>{tamaya-version}</version> + <version>{tamaya_version}</version> </dependency></code></pre> </div> </div> @@ -388,7 +388,7 @@ default section parts.</p> <div class="container"> <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> + at <span>2016-11-27</span> </p> <p> <b>Disclaimer</b> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/816057e5/extensions/mod_classloader_support.html ---------------------------------------------------------------------- diff --git a/extensions/mod_classloader_support.html b/extensions/mod_classloader_support.html index b16d996..35b6a61 100644 --- a/extensions/mod_classloader_support.html +++ b/extensions/mod_classloader_support.html @@ -97,7 +97,7 @@ <h1>Apache Tamaya&#8201;&#8212;&#8201;Extension: Classloader Isolation Support</h1> </div> - <p><em>2016-11-02</em></p> + <p><em>2016-11-19</em></p> <p><div id="preamble"> <div class="sectionbody"> @@ -130,7 +130,7 @@ of classloaders, hereby preventing multiple loading of components within a class <pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-classloader-support</artifactId> - <version>{tamayaVersion}</version> + <version>{tamaya_version}</version> </dependency></code></pre> </div> </div> @@ -141,7 +141,7 @@ a priority of 10.</p> </div> </div> <div class="sect2"> -<h3 id="_how_it_works">How it Works</h3> +<h3 id="_how_it_works">How it works</h3> <div class="paragraph"> <p>Basically the component manages a Map of all classloaders encountered. When services are accessed, the component will evaluate the services as follows:</p> @@ -224,7 +224,7 @@ hierarchies:</p> <div class="container"> <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> + at <span>2016-11-27</span> </p> <p> <b>Disclaimer</b> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/816057e5/extensions/mod_collections.html ---------------------------------------------------------------------- diff --git a/extensions/mod_collections.html b/extensions/mod_collections.html index e048ed2..0ff8511 100644 --- a/extensions/mod_collections.html +++ b/extensions/mod_collections.html @@ -97,7 +97,7 @@ <h1>Apache Tamaya&#8201;&#8212;&#8201;Extension: Collection Support</h1> </div> - <p><em>2016-11-02</em></p> + <p><em>2016-11-19</em></p> <p><div id="preamble"> <div class="sectionbody"> @@ -131,7 +131,7 @@ Collections extension adds this functionality to the Tamaya eco-system.</p> <pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-collections</artifactId> - <version>{tamayaVersion}</version> + <version>{tamaya_version}</version> </dependency></code></pre> </div> </div> @@ -411,7 +411,7 @@ _redefined-map.item-separator=|</code></pre> <div class="container"> <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> + at <span>2016-11-27</span> </p> <p> <b>Disclaimer</b> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/816057e5/extensions/mod_consul.html ---------------------------------------------------------------------- diff --git a/extensions/mod_consul.html b/extensions/mod_consul.html index 9c92a21..f4698a9 100644 --- a/extensions/mod_consul.html +++ b/extensions/mod_consul.html @@ -97,7 +97,7 @@ <h1>Apache Tamaya&#8201;&#8212;&#8201;Extension: Integration with consul (Hashicorp)</h1> </div> - <p><em>2016-11-02</em></p> + <p><em>2016-11-19</em></p> <p><div id="preamble"> <div class="sectionbody"> @@ -131,7 +131,7 @@ as a support for MutableConfiguration as defined by the tamaya-mutable-config ex <pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-consul</artifactId> - <version>{tamayaVersion}</version> + <version>{tamaya_version}</version> </dependency></code></pre> </div> </div> @@ -190,7 +190,7 @@ set to cluster-config. a consul key of host:known/all is mapped to cluster-confi <div class="container"> <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> + at <span>2016-11-27</span> </p> <p> <b>Disclaimer</b> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/816057e5/extensions/mod_environment.html ---------------------------------------------------------------------- diff --git a/extensions/mod_environment.html b/extensions/mod_environment.html index c84b5b3..02c1ac2 100644 --- a/extensions/mod_environment.html +++ b/extensions/mod_environment.html @@ -97,7 +97,7 @@ <h1>Apache Tamaya&#8201;&#8212;&#8201;Extension: Classloader Isolation Support</h1> </div> - <p><em>2016-11-02</em></p> + <p><em>2016-11-19</em></p> <p><div id="preamble"> <div class="sectionbody"> @@ -130,7 +130,7 @@ combines them in the given order into an (optional) root context within the syst <pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-envionment</artifactId> - <version>{tamayaVersion}</version> + <version>{tamaya_version}</version> </dependency></code></pre> </div> </div> @@ -160,7 +160,7 @@ combines them in the given order into an (optional) root context within the syst <div class="container"> <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> + at <span>2016-11-27</span> </p> <p> <b>Disclaimer</b> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/816057e5/extensions/mod_etcd.html ---------------------------------------------------------------------- diff --git a/extensions/mod_etcd.html b/extensions/mod_etcd.html index 3e104cc..0d8604d 100644 --- a/extensions/mod_etcd.html +++ b/extensions/mod_etcd.html @@ -97,7 +97,7 @@ <h1>Apache Tamaya&#8201;&#8212;&#8201;Extension: Integration with etcd (Core OS)</h1> </div> - <p><em>2016-11-02</em></p> + <p><em>2016-11-19</em></p> <p><div id="preamble"> <div class="sectionbody"> @@ -131,7 +131,7 @@ as a support for MutableConfiguration as defined by the tamaya-mutable-config ex <pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-etcd</artifactId> - <version>{tamayaVersion}</version> + <version>{tamaya_version}</version> </dependency></code></pre> </div> </div> @@ -326,7 +326,7 @@ set to cluster-config. a etcd key of host:known/all is mapped to cluster-config. <div class="container"> <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> + at <span>2016-11-27</span> </p> <p> <b>Disclaimer</b> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/816057e5/extensions/mod_events.html ---------------------------------------------------------------------- diff --git a/extensions/mod_events.html b/extensions/mod_events.html index 354a995..dc8cf03 100644 --- a/extensions/mod_events.html +++ b/extensions/mod_events.html @@ -97,7 +97,7 @@ <h1>Apache Tamaya&#8201;&#8212;&#8201;Extension: Events</h1> </div> - <p><em>2016-11-02</em></p> + <p><em>2016-11-19</em></p> <p><div id="preamble"> <div class="sectionbody"> @@ -114,7 +114,7 @@ about modules.</p> </div> <div class="paragraph"> -<p>Tamaya Events provides an abstraction for events like change events, when configuration has bee changed.</p> +<p>Tamaya Events provides an abstraction for events like change events, when configuration has been changed.</p> </div> </div> <div class="sect2"> @@ -133,7 +133,7 @@ about modules.</p> <pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-events</artifactId> - <version>{tamayaVersion}</version> + <version>{tamaya_version}</version> </dependency></code></pre> </div> </div> @@ -164,10 +164,9 @@ public interface ConfigEventListener { </div> </div> <div class="paragraph"> -<p>This mechanism can now be used to propagate configuration changes to all interested stakeholders. Hereby the payloed +<p>This mechanism can now be used to propagate configuration changes to all interested stakeholders. Hereby the payload can be basically arbitrary as long as it implements the ConfigEvent interface. The next sections -give more details on the the provided event implementations and abstractions that are used to implement such -features.</p> +give more details on the the provided event types and their usage.</p> </div> </div> <div class="sect2"> @@ -190,19 +189,7 @@ be</p> </ul> </div> <div class="paragraph"> -<p>This is also reflected in the ChangeType enum</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">public enum ChangeType { - NEW, - DELETED, - UPDATED, -}</code></pre> -</div> -</div> -<div class="paragraph"> -<p>This enum type is used within the ConfigurationChange class, which implements the event sent for a changed +<p>The most important event modelled is the ConfigurationChange class, which implements the event sent for a changed Configuration:</p> </div> <div class="listingblock"> @@ -219,8 +206,6 @@ Configuration:</p> public String getVersion(); @Override public long getTimestamp(); - @Override - public long getTimestamp(); // Event specific methods @@ -239,7 +224,7 @@ Configuration:</p> </div> </div> <div class="paragraph"> -<p>New instances of this class hereby are created using a fluent builder:</p> +<p>New instances of this class hereby can be created using a fluent builder:</p> </div> <div class="listingblock"> <div class="content"> @@ -250,8 +235,8 @@ ConfigurationChange change = ConfigurationChangeBuilder.of(config) </div> </div> <div class="paragraph"> -<p>Also it is possible to directly compare 2 instances of configurations to create a matching ConfigurationChange -instance:</p> +<p>Also it is possible to directly compare 2 instances of configurations to create ConfigurationChange that +reflect the differences between the two configurations:</p> </div> <div class="listingblock"> <div class="content"> @@ -267,8 +252,8 @@ ConfigurationChange change = ConfigurationChangeBuilder.of(config) <div class="paragraph"> <p>So a ConfigurationChange allows you to evaluate the changes on a configuration. This allows you to listen to changes and react in your client code as useful, once you encounter changes that are relevant to you, e.g. by reconfiguring -your component. Of course, your code has to register itself to listen for appropriate changes by implementing -a ConfigEventListener:</p> +your component. For listening to configuration changes you must implement the +ConfigEventListener functional interface:</p> </div> <div class="listingblock"> <div class="title">Implementing a ConfigChangeListener</div> @@ -306,56 +291,31 @@ META-INF/services/org.apache.tamaya.events.ConfigEventListener</p> <div class="sect2"> <h3 id="_modelling_propertysource_changes">Modelling PropertySource Changes</h3> <div class="paragraph"> -<p>Beside that a whole configuration changes, also PropertySource instance can change, e.g. by a configuration file +<p>Beside that a whole configuration changes, also PropertySource instances can change, e.g. by a configuration file edited on the fly. This is similarly to a ConfigurationChange reflected by the classes PropertySourceChange, PropertySourceChangeBuilder.</p> </div> </div> <div class="sect2"> -<h3 id="_modelling_configuration_context_changes">Modelling Configuration Context Changes</h3> -<div class="paragraph"> -<p>The ConfigurationContext models the container that manages all subcomponents that are used to define and -evalaute a Configuration. In the case where configuration is dynamically loaded, e.g. by observing changes on a -file folder, the ConfigurationContext may change, so a corresponding ConfigurationContextChange event is -defined:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">public final class ConfigurationContextChange implements ConfigEvent<ConfigurationContext>, Serializable{ - - public static ConfigurationContextChange emptyChangeSet(); - - @Override - public ConfigurationContext getResource(); - @Override - public Class<ConfigurationContext> getResourceType(); - @Override - public String getVersion(); - @Override - public long getTimestamp(); - - // specific methods - public Collection<PropertySourceChange> getPropertySourceChanges(); - public Collection<PropertySourceChange> getPropertySourceUpdates(); - public Collection<PropertySource> getRemovedPropertySources(); - public Collection<PropertySource> getAddedPropertySources(); - public Collection<PropertySource> getUpdatedPropertySources(); - public boolean isAffected(PropertySource propertySource); - public boolean isEmpty(); -}</code></pre> -</div> -</div> -<div class="paragraph"> -<p>Similar to the ConfigurationChange class you also must use a ConfigurationContextChangeBuilder to create instances -of ConfigurationContextChange.</p> -</div> -</div> -<div class="sect2"> <h3 id="_the_configeventmanager_singleton">The ConfigEventManager Singleton</h3> <div class="paragraph"> <p>Main entry point of the events module is the ConfigEventManager singleton class, which provides static accessor methods to the extension’s functionality:</p> </div> +<div class="ulist"> +<ul> +<li> +<p>Adding/removing of ConfigChangeListener instances, either globally or per event type.</p> +</li> +<li> +<p>Firing configuration events synchronously or asyncronously (mostly called by framework code).</p> +</li> +<li> +<p>Configuring the monitor that periodically checks for changes on the global Configuration provided +by ConfigurationProvider.getConfiguration().</p> +</li> +</ul> +</div> <div class="listingblock"> <div class="content"> <pre class="prettyprint highlight"><code class="language-java" data-lang="java">public final class ConfigEventManager { @@ -382,30 +342,14 @@ methods to the extension’s functionality:</p> }</code></pre> </div> </div> -<div class="paragraph"> -<p>Looking at the methods listed above you see that there is more functionality worth to be mentioned:</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>ConfigCHangeListeners can be registered either <em>globally</em> or for a certain <em>event type</em> only.</p> -</li> -<li> -<p>ConfigEvents can be published within the same thread, or asynchronously.</p> -</li> -</ul> -</div> <div class="sect3"> <h4 id="_monitoring_of_configuration_changes">Monitoring of configuration changes</h4> <div class="paragraph"> <p>The ConfigEventManager also supports active monitoring of the current configuration to trigger corresponding change -events to listeners registered. This feature is activated by default, but can be deactivated optionally. Nevertheless -this feature is quite handy, since regularly polling your local Configuration for any kind of changes is much -more simpler than implementing change management on the PropertySource level. With this feature you can easily -implement also remote property source, which can deliver different configuration based on any changes done remotedly -on another node in your system. If such a change happened Tamaya identifies it and triggers corresponding -+ConfigurationChange" events automatically. Similarly changes in a configuration tree, can actively identified and -broadcasted to the targeting nodes automatically.</p> +events to listeners registered. This feature is deactivated by default, but can be enabled by calling +ConfigEventManager.enableChangeMonitoring(true);. This feature avoids regularly polling your local Configuration for +any kind of changes. If a change has been encountered Tamaya identifies it and triggers corresponding +ConfigurationChange events automatically.</p> </div> </div> </div> @@ -413,8 +357,8 @@ broadcasted to the targeting nodes automatically.</p> <h3 id="_freezing_configurations_and_propertysources">Freezing Configurations and PropertySources</h3> <div class="paragraph"> <p>Configuration instances as well as PropertySources are explicitly not required to be serializable. To enable easy -serialization of these types as well as to fix a current state (e.g. for later comparison with a newly loaded instance) -Tamaya allows to <strong>freeze</strong> instances of these types. Freezing hereby means</p> +serialization of these types a Configuration's <strong>current state can be frozen</strong> (e.g. for later comparison with a newly +loaded version). Freezing hereby means</p> </div> <div class="ulist"> <ul> @@ -422,18 +366,23 @@ Tamaya allows to <strong>freeze</strong> instances of these types. Freezing here <p>all key/values are read-out by calling the getProperties() method.</p> </li> <li> -<p>a meta data entry is added of the form [meta]frozenAt=223273777652325677, whichdefines the UTC timestamp in +<p>a meta data entry is added of the form _frozenAt=223273777652325677, whichdefines the UTC timestamp in milliseconds when this instance was frozen.</p> </li> +<li> +<p>if not already defined an _id property will be added to the Configuration containing the +identifier of the configuration.</p> +</li> </ul> </div> <div class="paragraph"> -<p>In code this is done easily as follows:</p> +<p>In code freezing is a no-brainer:</p> </div> <div class="listingblock"> <div class="title">Freezing the current Configuration</div> <div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">Configuration frozenConfig = FrozenConfiguration.of(ConfigurationProvider.getConfiguration());</code></pre> +<pre class="prettyprint highlight"><code class="language-java" data-lang="java">Configuration config = ConfigurationProvider.getConfiguration(); +Configuration frozenConfig = FrozenConfiguration.of(config);</code></pre> </div> </div> <div class="olist lowerroman"> @@ -446,83 +395,17 @@ milliseconds when this instance was frozen.</p> <div class="listingblock"> <div class="title">Freezing the current Configuration</div> <div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">PropertySource frozenSource = FrozenPropertySource.of(ConfigurationProvider.getConfiguration());</code></pre> +<pre class="prettyprint highlight"><code class="language-java" data-lang="java">PropertySource propertySource = ...; +PropertySource frozenSource = FrozenPropertySource.of(propertySource);</code></pre> </div> </div> </div> <div class="sect2"> -<h3 id="_modelling_of_an_observing_propertysourceprovider">Modelling of an observing PropertySourceProvider.</h3> -<div class="paragraph"> -<p>In Tamaya configuration data is provided by instances of PropertySource, which in case of a configuration directory -may be provided by an implementation of PropertySourceProvider, which produces one PropertySource (at least) per -file detected. The events module provides a base provider implementation that</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>observes all changes in a Path</p> -</li> -<li> -<p>tries to reevaluate corresponding resources based on the ConfigurationFormats supported.</p> -</li> -<li> -<p>it creates an instance of ConfigurationContextChange reflecting the changed ConfigurationContext and triggers -this event by calling ConfigEventManager.fireEvent(contextChange);.</p> -</li> -</ul> -</div> -<div class="paragraph"> -<p>Additionally this module registers an instance of ConfigEventListener<ConfigurationContextChange>+, which listenes to -these events. If such an event is triggered the listener tries to apply the changes by</p> -</div> -<div class="olist arabic"> -<ol class="arabic"> -<li> -<p>accessing the current Configuration and its ConfigurationContext</p> -</li> -<li> -<p>checking if the event is affecting the current ConfigurationContext.</p> -</li> -<li> -<p>in the case the current context is affected, based on the current ConfigurationContext a new context is created, -whereas</p> -<div class="olist loweralpha"> -<ol class="loweralpha" type="a"> -<li> -<p>all PropertySources provided by this provider implementation type are removed.</p> -</li> -<li> -<p>the new PropertySources loaded are added.</p> -</li> -</ol> -</div> -</li> -<li> -<p>Finally the listener tries to apply the new ConfigurationContext by calling the corresponding API methods of the -ConfigurationProvider:</p> -</li> -</ol> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">try { - ConfigurationProvider.setConfigurationContext(newContext); -} catch (Exception e) { - LOG.log(Level.INFO, "Failed to update the current ConfigurationContext due to config model changes", e); -}</code></pre> -</div> -</div> -<div class="paragraph"> -<p>So if the current ConfigurationProvider supports reloading of the current ConfigurationContext this will apply the -changes to the current Configuration. Otherwise the change is logged, but no further actions are taken.</p> -</div> -</div> -<div class="sect2"> <h3 id="_spis">SPIs</h3> <div class="paragraph"> <p>This component also defines an additional SPI, which allows to adapt the implementation of the main ConfigEventManager singleton. This enables, for example, using external eventing systems, such as CDI, instead of the default provided -simple SE based implementation. As normal, implementation mus be registered using the current ServiceContext +simple SE based implementation. As normal, implementation must be registered using the current ServiceContext active, by default using the Java ServiceLoader mechanism.</p> </div> <div class="listingblock"> @@ -547,6 +430,11 @@ active, by default using the Java ServiceLoader mechanism.</p> }</code></pre> </div> </div> +<div class="paragraph"> +<p>Summarizing with the events module you can easily observe configuration changes, record the +state of any configuration and compare configuration states to create and publish related +change events.</p> +</div> </div> </div> </div></p> @@ -561,7 +449,7 @@ active, by default using the Java ServiceLoader mechanism.</p> <div class="container"> <p class="muted credit">© 2014-2016 Apache Software Foundation | Mixed with <a href="http://getbootstrap.com/";>Bootstrap v3.1.1</a> | Baked with <a href="http://jbake.org";>JBake <span>v2.5.0</span></a> - at <span>2016-11-02</span> + at <span>2016-11-27</span> </p> <p> <b>Disclaimer</b>
