http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/cddd52a8/documentation-new/extensions/mod_camel.html ---------------------------------------------------------------------- diff --git a/documentation-new/extensions/mod_camel.html b/documentation-new/extensions/mod_camel.html index 245b0b6..80b7d8f 100644 --- a/documentation-new/extensions/mod_camel.html +++ b/documentation-new/extensions/mod_camel.html @@ -125,84 +125,76 @@ <h1>Apache Tamaya - Extension: Integration with Apache Camel</h1> </div> - <p><em>2018-04-26</em></p> + <p><em>2018-05-17</em></p> - <p><div id="preamble"> -<div class="sectionbody"> -<!-- toc disabled --> -</div> -</div> -<div class="sect1"> -<h2 id="Camel">Integration with Apache Camel (Extension Module)</h2> -<div class="sectionbody"> -<div class="paragraph"> -<p>Tamaya <em>Camel</em> is an extension module. Refer to the <a href="../extensions.html">extensions documentation</a> for further details.</p> -</div> -<div class="sect2"> -<h3 id="_what_functionality_this_module_provides">What functionality this module provides ?</h3> -<div class="paragraph"> -<p>The Tamaya <em>Camel</em> module provides different artifacts which allows integration of Apachae Tamaya -configuration with Apache Camel.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_compatibility">Compatibility</h3> -<div class="paragraph"> -<p>The module is based on Java 8, so it will not run on Java 8 and beyond.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_installation">Installation</h3> -<div class="paragraph"> -<p>To benefit from configuration builder support you only must add the corresponding dependency to your module:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> + <p><div id="preamble"> + <div class="sectionbody"> + <!-- toc disabled --> + </div> +</div> +<div class="sect1"> + <h2 id="Camel">Integration with Apache Camel (Extension Module)</h2> + <div class="sectionbody"> + <div class="paragraph"> + <p>Tamaya <em>Camel</em> is an extension module. Refer to the <a href="../extensions.html">extensions documentation</a> for further details.</p> + </div> + <div class="sect2"> + <h3 id="_what_functionality_this_module_provides">What functionality this module provides ?</h3> + <div class="paragraph"> + <p>The Tamaya <em>Camel</em> module provides different artifacts which allows integration of Apachae Tamaya configuration with Apache Camel.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_compatibility">Compatibility</h3> + <div class="paragraph"> + <p>The module is based on Java 8, so it will not run on Java 8 and beyond.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_installation">Installation</h3> + <div class="paragraph"> + <p>To benefit from configuration builder support you only must add the corresponding dependency to your module:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-camel</artifactId> <version>{tamaya_version}</version> -</dependency></code></pre> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="_the_functionality_provided">The Functionality Provided</h3> -<div class="paragraph"> -<p>Tamaya Camel comes basically with three artifacts:</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>A Camel ResolverFunction implementation adding explicit property resolution -(org.apache.tamaya.camel.TamayaPropertyResolver).</p> -</li> -<li> -<p>A Camel PropertiesComponent implementation, which allows implicitly preconfigures the resolvers from above and -additionally allows using Tamaya configuration as Camel <em>overrides</em> -(org.apache.tamaya.camel.TamayaPropertiesComponent).</p> -</li> -</ul> -</div> -</div> -<div class="sect2"> -<h3 id="_configuring_using_camel_java_dsl">Configuring using Camel Java DSL</h3> -<div class="paragraph"> -<p>Camel integration using Java DSL is basically simple:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">import org.apache.tamaya.camel.TamayaPropertiesComponent; +</dependency></code></pre> + </div> + </div> + </div> + <div class="sect2"> + <h3 id="_the_functionality_provided">The Functionality Provided</h3> + <div class="paragraph"> + <p>Tamaya Camel comes basically with three artifacts:</p> + </div> + <div class="ulist"> + <ul> + <li> <p>A Camel ResolverFunction implementation adding explicit property resolution (org.apache.tamaya.camel.TamayaPropertyResolver).</p> </li> + <li> <p>A Camel PropertiesComponent implementation, which allows implicitly preconfigures the resolvers from above and additionally allows using Tamaya configuration as Camel <em>overrides</em> (org.apache.tamaya.camel.TamayaPropertiesComponent).</p> </li> + </ul> + </div> + </div> + <div class="sect2"> + <h3 id="_configuring_using_camel_java_dsl">Configuring using Camel Java DSL</h3> + <div class="paragraph"> + <p>Camel integration using Java DSL is basically simple:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">import org.apache.tamaya.camel.TamayaPropertiesComponent; -camelContext.addComponent("properties", new TamayaPropertiesComponent());</code></pre> -</div> -</div> -<div class="paragraph"> -<p>Given so you can then use cfg or tamaya as prefix for resolving entries with Tamaya as follows:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">RouteBuilder builder = new RouteBuilder() { +camelContext.addComponent("properties", new TamayaPropertiesComponent());</code></pre> + </div> + </div> + <div class="paragraph"> + <p>Given so you can then use cfg or tamaya as prefix for resolving entries with Tamaya as follows:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">RouteBuilder builder = new RouteBuilder() { public void configure() { from("direct:hello1").transform().simple("{{cfg:message}}"); } @@ -213,31 +205,27 @@ builder = new RouteBuilder() { from("direct:hello2").transform().simple("{{tamaya:message}}"); } }; -camelContext.addRoutes(builder);</code></pre> -</div> -</div> -<div class="paragraph"> -<p>Optionally you can also configure TamayaPropertiesComponent that all currently known Tamaya properties are used -as Camel overrides, meaning they are evaluated prior to all other available resolver functions in the Camel -PropertiesComponent:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">TamayaPropertiesComponent props = new TamayaPropertiesComponent(); -props.setTamayaOverrides(true);</code></pre> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="_configuring_using_camel_xml_dsl">Configuring using Camel XML DSL</h3> -<div class="paragraph"> -<p>Camel integration using XML DSL is basically very similar. You just have to add the properties component as bean -as well. All other configuration parameters (e.g. file URIs are similar supported). In the example code below we -again use Tamaya as the main configuration solutions only using Camel’s default behaviour as a fallback:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><beans xmlns="http://www.springframework.org/schema/beans"; +camelContext.addRoutes(builder);</code></pre> + </div> + </div> + <div class="paragraph"> + <p>Optionally you can also configure TamayaPropertiesComponent that all currently known Tamaya properties are used as Camel overrides, meaning they are evaluated prior to all other available resolver functions in the Camel PropertiesComponent:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">TamayaPropertiesComponent props = new TamayaPropertiesComponent(); +props.setTamayaOverrides(true);</code></pre> + </div> + </div> + </div> + <div class="sect2"> + <h3 id="_configuring_using_camel_xml_dsl">Configuring using Camel XML DSL</h3> + <div class="paragraph"> + <p>Camel integration using XML DSL is basically very similar. You just have to add the properties component as bean as well. All other configuration parameters (e.g. file URIs are similar supported). In the example code below we again use Tamaya as the main configuration solutions only using Camelâs default behaviour as a fallback:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><beans xmlns="http://www.springframework.org/schema/beans"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd @@ -269,11 +257,11 @@ again use Tamaya as the main configuration solutions only using Camel’s de <property name="tamayaOverrides" value="true"/> </bean> -</beans></code></pre> -</div> -</div> -</div> -</div> +</beans></code></pre> + </div> + </div> + </div> + </div> </div></p> <hr /> @@ -285,8 +273,8 @@ again use Tamaya as the main configuration solutions only using Camel’s de <div id="footer"> <div class="container"> <p class="muted credit">© 2014-<span>2018</span> 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.1</span></a> - at <span>2018-05-03</span> | + | Baked with <a href="http://jbake.org";>JBake <span>v2.6.1</span></a> + at <span>2018-05-17</span> | <a class="twitter-follow-button" data-show-count="false" href="https://twitter.com/tamayaconf";>Follow @tamayaconf</a><script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script> </p> <p>
http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/cddd52a8/documentation-new/extensions/mod_cdi.html ---------------------------------------------------------------------- diff --git a/documentation-new/extensions/mod_cdi.html b/documentation-new/extensions/mod_cdi.html index 0f35e09..f197cb8 100644 --- a/documentation-new/extensions/mod_cdi.html +++ b/documentation-new/extensions/mod_cdi.html @@ -125,66 +125,46 @@ <h1>Apache Tamaya - Extension: CDI Support</h1> </div> - <p><em>2018-04-26</em></p> + <p><em>2018-05-17</em></p> - <p><div id="preamble"> -<div class="sectionbody"> -<!-- toc disabled --> -</div> -</div> -<div class="sect1"> -<h2 id="CDI">Tamaya CDI Integration (Extension Modules)</h2> -<div class="sectionbody"> -<div class="paragraph"> -<p>Tamaya <em>CDI</em> is an extension module. Refer to the <a href="../extensions.html">extensions documentation</a> for further details.</p> -</div> -<div class="sect2"> -<h3 id="_what_functionality_this_module_provides">What functionality this module provides ?</h3> -<div class="paragraph"> -<p>Apache <em>CDI</em> provides integration with CDI:</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>Loading of CDI managed SPI components as configuration extensions such as ConfigSources, ConfigSourceProviders, -Converters, Filters, etc. This also includes SPI defined by any Tamaya submodules. -This is useful when Tamaya is used as an application module managed by the CDI implementation.</p> -</li> -<li> -<p>Implement and enable Tamaya’s configuration injection services (either using CDI injection or -Tamaya’s standalone injection module.</p> -</li> -</ul> -</div> -<div class="paragraph"> -<p>Hereby there are two implementations provided:</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>tamaya-injection-cdi implements injection by using CDI’s injection mechanism to inject configuration values into the -beans managed by the CDI systems.</p> -</li> -<li> -<p>tamaya-injection-standalone implements injection by integrating the tamaya-injection SE based injection module (also used -for Spring and OSGI injection) with CDI. Injection hereby is performed by the Tamaya SE module, whereas -beans and injection control overall are still managed by CDI.</p> -</li> -<li> -<p>One difference, of course, is that tamaya-injection-standalone also provides an SE compatible API (ConfigurationInjection, -ConfigurationInjector), which is not available, when using the purely CDI based variant.</p> -</li> -</ul> -</div> -<div class="paragraph"> -<p>Most annotations used are defined as part of the Config JSR API, whereas Tamaya adds additional features not available -in the JSR as separate modules. This allows you to code against the injection API without dependency on the concrete -injection implementation. As a consequence your components will be compatible regardless if deployed in a pure SE or as -Java EE (CDI) or Spring environment:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre><dependency> + <p><div id="preamble"> + <div class="sectionbody"> + <!-- toc disabled --> + </div> +</div> +<div class="sect1"> + <h2 id="CDI">Tamaya CDI Integration (Extension Modules)</h2> + <div class="sectionbody"> + <div class="paragraph"> + <p>Tamaya <em>CDI</em> is an extension module. Refer to the <a href="../extensions.html">extensions documentation</a> for further details.</p> + </div> + <div class="sect2"> + <h3 id="_what_functionality_this_module_provides">What functionality this module provides ?</h3> + <div class="paragraph"> + <p>Apache <em>CDI</em> provides integration with CDI:</p> + </div> + <div class="ulist"> + <ul> + <li> <p>Loading of CDI managed SPI components as configuration extensions such as ConfigSources, ConfigSourceProviders, Converters, Filters, etc. This also includes SPI defined by any Tamaya submodules. This is useful when Tamaya is used as an application module managed by the CDI implementation.</p> </li> + <li> <p>Implement and enable Tamayaâs configuration injection services (either using CDI injection or Tamayaâs standalone injection module.</p> </li> + </ul> + </div> + <div class="paragraph"> + <p>Hereby there are two implementations provided:</p> + </div> + <div class="ulist"> + <ul> + <li> <p>tamaya-injection-cdi implements injection by using CDIâs injection mechanism to inject configuration values into the beans managed by the CDI systems.</p> </li> + <li> <p>tamaya-injection-standalone implements injection by integrating the tamaya-injection SE based injection module (also used for Spring and OSGI injection) with CDI. Injection hereby is performed by the Tamaya SE module, whereas beans and injection control overall are still managed by CDI.</p> </li> + <li> <p>One difference, of course, is that tamaya-injection-standalone also provides an SE compatible API (ConfigurationInjection, ConfigurationInjector), which is not available, when using the purely CDI based variant.</p> </li> + </ul> + </div> + <div class="paragraph"> + <p>Most annotations used are defined as part of the Config JSR API, whereas Tamaya adds additional features not available in the JSR as separate modules. This allows you to code against the injection API without dependency on the concrete injection implementation. As a consequence your components will be compatible regardless if deployed in a pure SE or as Java EE (CDI) or Spring environment:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre><dependency> <groupId>javax.config</groupId> <artifactId>config-api</artifactId> <version>{config_api_version}</version> @@ -193,90 +173,87 @@ Java EE (CDI) or Spring environment:</p> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-injection-api</artifactId> <version>{tamaya_version}</version> -</dependency></pre> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="_compatibility">Compatibility</h3> -<div class="paragraph"> -<p>All modules are based on Java 8, so they will not run on Java 8 and beyond.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_installation">Installation</h3> -<div class="paragraph"> -<p>To benefit from Tamaya CDI integration you only must one of the following dependencies to your module. Ensure that -you never have installed both CDI extensions at the same time because this may be lead to unforseen side-effects.</p> -</div> -<div class="listingblock"> -<div class="title">CDI Java EE Application Configuration</div> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> +</dependency></pre> + </div> + </div> + </div> + <div class="sect2"> + <h3 id="_compatibility">Compatibility</h3> + <div class="paragraph"> + <p>All modules are based on Java 8, so they will not run on Java 8 and beyond.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_installation">Installation</h3> + <div class="paragraph"> + <p>To benefit from Tamaya CDI integration you only must one of the following dependencies to your module. Ensure that you never have installed both CDI extensions at the same time because this may be lead to unforseen side-effects.</p> + </div> + <div class="listingblock"> + <div class="title"> + CDI Java EE Application Configuration + </div> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-cdi</artifactId> <version>{tamaya_version}</version> -</dependency></code></pre> -</div> -</div> -<div class="paragraph"> -<div class="title">To use Tamaya’s <em>standalone injection support</em>, you additionally should add the</div> -<p>following dependency. If this dependency is missing injection is purely based on -CDI injection features.</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> +</dependency></code></pre> + </div> + </div> + <div class="paragraph"> + <div class="title"> + To use Tamayaâs + <em>standalone injection support</em>, you additionally should add the + </div> + <p>following dependency. If this dependency is missing injection is purely based on CDI injection features.</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-injection-standalone</artifactId> <version>{tamaya_version}</version> -</dependency></code></pre> -</div> -</div> -<div class="paragraph"> -<p>Both components will auto-register its components and override the default ServicceContext in use. Additionally they -register CDI extensions that implement Configuration injection as described before.</p> -</div> -<div class="paragraph"> -<p>For working with a pure non Java EE environment have a look at the <a href="mod_injection-standalone.html">tamaya-injection-standalone module</a>.</p> -</div> -<div class="paragraph"> -<p>Additionally you have to register Tamaya’s CDI extension modules into your <code>beans-xml</code>:</p> -</div> -<div class="paragraph"> -<p>Contents of <code>META-INF/services/javax.enterprise.inject.spi.Extension</code>:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-properties" data-lang="properties"># Register Tamaya to perform injection +</dependency></code></pre> + </div> + </div> + <div class="paragraph"> + <p>Both components will auto-register its components and override the default ServicceContext in use. Additionally they register CDI extensions that implement Configuration injection as described before.</p> + </div> + <div class="paragraph"> + <p>For working with a pure non Java EE environment have a look at the <a href="mod_injection-standalone.html">tamaya-injection-standalone module</a>.</p> + </div> + <div class="paragraph"> + <p>Additionally you have to register Tamayaâs CDI extension modules into your <code>beans-xml</code>:</p> + </div> + <div class="paragraph"> + <p>Contents of <code>META-INF/services/javax.enterprise.inject.spi.Extension</code>:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-properties" data-lang="properties"># Register Tamaya to perform injection # org.apache.tamaya.cdi.TamayaCDIInjectionExtension # org.apache.tamaya.cdi.TamayaSEInjectionExtension -org.apache.tamaya.cdi.TamayaCDIAccessor</code></pre> -</div> -</div> -<div class="paragraph"> -<p>If you want to use CDI standard injection (using @Inject @Config), activate -org.apache.tamaya.cdi.TamayaCDIInjectionExtension as a CDI extension.</p> -</div> -<div class="paragraph"> -<p>If you want to use SE based injection (using @Config <strong>without</strong> @Inject), -activate org.apache.tamaya.cdi.TamayaSEInjectionExtension instead of.</p> -</div> -<div class="paragraph"> -<p>Though not recommended, it is possible to activate both extension at the same time.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_annotating_your_classes">Annotating your Classes</h3> -<div class="paragraph"> -<p>Basically annotating your classes is stright forward. Depending -on the module deployed, your annotations are handled by a CDI producer (tamaya-cdi-ee) or the -Tamaya SE injection mechanism (tamaya-cdi-se). All types injected by this module are injected -using <em>dependent scope</em>.</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">@RequestScoped +org.apache.tamaya.cdi.TamayaCDIAccessor</code></pre> + </div> + </div> + <div class="paragraph"> + <p>If you want to use CDI standard injection (using @Inject @Config), activate org.apache.tamaya.cdi.TamayaCDIInjectionExtension as a CDI extension.</p> + </div> + <div class="paragraph"> + <p>If you want to use SE based injection (using @Config <strong>without</strong> @Inject), activate org.apache.tamaya.cdi.TamayaSEInjectionExtension instead of.</p> + </div> + <div class="paragraph"> + <p>Though not recommended, it is possible to activate both extension at the same time.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_annotating_your_classes">Annotating your Classes</h3> + <div class="paragraph"> + <p>Basically annotating your classes is stright forward. Depending on the module deployed, your annotations are handled by a CDI producer (tamaya-cdi-ee) or the Tamaya SE injection mechanism (tamaya-cdi-se). All types injected by this module are injected using <em>dependent scope</em>.</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">@RequestScoped public class ConfiguredClass{ @Config @@ -300,21 +277,18 @@ public class ConfiguredClass{ ... -}</code></pre> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="_registering_cdi_managed_components_into_the_application_s_configurationcontext">Registering CDI managed components into the Application’s ConfigurationContext</h3> -<div class="paragraph"> -<p>As mentioned both modules allow to provide Tamaya SPI extensions modules as ordinary CDI managed beans. By default -extensions should be registered using @Singleton or @ApplicationScoped scope annotations. So you can define/deploy -additional application specific PropertySources and other artifacts simply by defining a CDI managed bean implementing -the required SPI interface:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">@Singleton +}</code></pre> + </div> + </div> + </div> + <div class="sect2"> + <h3 id="_registering_cdi_managed_components_into_the_application_s_configurationcontext">Registering CDI managed components into the Applicationâs ConfigurationContext</h3> + <div class="paragraph"> + <p>As mentioned both modules allow to provide Tamaya SPI extensions modules as ordinary CDI managed beans. By default extensions should be registered using @Singleton or @ApplicationScoped scope annotations. So you can define/deploy additional application specific PropertySources and other artifacts simply by defining a CDI managed bean implementing the required SPI interface:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">@Singleton public class TestConfigSource implements ConfigSource{ final Map<String,String> config = new HashMap<>(); @@ -345,83 +319,71 @@ public class TestConfigSource implements ConfigSource{ return config; } -}</code></pre> -</div> -</div> -<div class="paragraph"> -<p>To enable this (optional) feature you must replace Tamaya’s ServiceContext with the -CDI aware implementation:</p> -</div> -<div class="paragraph"> -<p>Contents of <code>META-INF/services/org.apache.tamaya.spi.ServiceContext</code>:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-properties" data-lang="properties"># Registering a CDI aware service context -org.apache.tamaya.cdi.CDIAwareServiceContext</code></pre> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="_advanced_use_cases">Advanced Use Cases</h3> -<div class="paragraph"> -<p>Beside basic configuration Tamaya also covers additional requirements:</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>_Reading multiple keys, where the first successful one is determining the value of the configuration, is -simply possible, by defining additional keys with @ConfigFallbackKeys annotation. -E.g. for trying first a.b and then new.b you would configure it as follows:</p> -</li> -</ul> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">@Config(key="a.b") +}</code></pre> + </div> + </div> + <div class="paragraph"> + <p>To enable this (optional) feature you must replace Tamayaâs ServiceContext with the CDI aware implementation:</p> + </div> + <div class="paragraph"> + <p>Contents of <code>META-INF/services/org.apache.tamaya.spi.ServiceContext</code>:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-properties" data-lang="properties"># Registering a CDI aware service context +org.apache.tamaya.cdi.CDIAwareServiceContext</code></pre> + </div> + </div> + </div> + <div class="sect2"> + <h3 id="_advanced_use_cases">Advanced Use Cases</h3> + <div class="paragraph"> + <p>Beside basic configuration Tamaya also covers additional requirements:</p> + </div> + <div class="ulist"> + <ul> + <li> <p>_Reading multiple keys, where the first successful one is determining the value of the configuration, is simply possible, by defining additional keys with @ConfigFallbackKeys annotation. E.g. for trying first a.b and then new.b you would configure it as follows:</p> </li> + </ul> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">@Config(key="a.b") @ConfigFallbackKeys({"new.b"}) -private String value;</code></pre> -</div> -</div> -<div class="ulist"> -<ul> -<li> -<p>When you must apply a some special conversion, or you use a type that is not registered -for conversion, you can configure a custom converter to be applied as follows:</p> -</li> -</ul> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">@Config(key="a.b") +private String value;</code></pre> + </div> + </div> + <div class="ulist"> + <ul> + <li> <p>When you must apply a some special conversion, or you use a type that is not registered for conversion, you can configure a custom converter to be applied as follows:</p> </li> + </ul> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">@Config(key="a.b") @WithConverter(MyConverter.class) -private MySpecialFooType value;</code></pre> -</div> -</div> -<div class="ulist"> -<ul> -<li> -<p>Often multiple keys in a class belong to the same root section. So instead of copying this to -every entry you can define the most common root sections in the type’s header:</p> -</li> -</ul> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">@ConfigDefaultSections({"aaaa", "new"}); +private MySpecialFooType value;</code></pre> + </div> + </div> + <div class="ulist"> + <ul> + <li> <p>Often multiple keys in a class belong to the same root section. So instead of copying this to every entry you can define the most common root sections in the typeâs header:</p> </li> + </ul> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">@ConfigDefaultSections({"aaaa", "new"}); public class MyType{ @Config(key="b"} @ConfigFallbackKeys({"[legacy.bKey]"}) // lookups: "aaaa.b", "new.b", legacy.bKey -private String value;</code></pre> -</div> -</div> -<div class="paragraph"> -<p>In the example above legacy.bKey defines an absolute key, which is not combined with any defined -default section parts.</p> -</div> -</div> -</div> +private String value;</code></pre> + </div> + </div> + <div class="paragraph"> + <p>In the example above legacy.bKey defines an absolute key, which is not combined with any defined default section parts.</p> + </div> + </div> + </div> </div></p> <hr /> @@ -433,8 +395,8 @@ default section parts.</p> <div id="footer"> <div class="container"> <p class="muted credit">© 2014-<span>2018</span> 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.1</span></a> - at <span>2018-05-03</span> | + | Baked with <a href="http://jbake.org";>JBake <span>v2.6.1</span></a> + at <span>2018-05-17</span> | <a class="twitter-follow-button" data-show-count="false" href="https://twitter.com/tamayaconf";>Follow @tamayaconf</a><script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script> </p> <p> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/cddd52a8/documentation-new/extensions/mod_classloader_support.html ---------------------------------------------------------------------- diff --git a/documentation-new/extensions/mod_classloader_support.html b/documentation-new/extensions/mod_classloader_support.html index 930dfa4..5b8828b 100644 --- a/documentation-new/extensions/mod_classloader_support.html +++ b/documentation-new/extensions/mod_classloader_support.html @@ -125,124 +125,92 @@ <h1>Apache Tamaya - Extension: Classloader Isolation Support</h1> </div> - <p><em>2018-04-26</em></p> + <p><em>2018-05-17</em></p> - <p><div id="preamble"> -<div class="sectionbody"> -<!-- toc disabled --> -</div> -</div> -<div class="sect1"> -<h2 id="Classloader">Tamaya Classloader Aware ServiceContext (Extension Module)</h2> -<div class="sectionbody"> -<div class="paragraph"> -<p>Tamaya <em>Classloader</em> is an extension module. Refer to the <a href="../extensions.html">extensions documentation</a> for further details.</p> -</div> -<div class="sect2"> -<h3 id="_what_functionality_this_module_provides">What functionality this module provides ?</h3> -<div class="paragraph"> -<p>The Tamaya <em>Classloader</em> support provides an alternative implementation of java.util.ServiceLoader, which is aware -of classloaders, hereby preventing multiple loading of components within a classloader hierarchy.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_compatibility">Compatibility</h3> -<div class="paragraph"> -<p>The module is based on Java 8, so it will not run on Java 8 and beyond.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_installation">Installation</h3> -<div class="paragraph"> -<p>To benefit from configuration server support you only must add the corresponding dependency to your module:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> + <p><div id="preamble"> + <div class="sectionbody"> + <!-- toc disabled --> + </div> +</div> +<div class="sect1"> + <h2 id="Classloader">Tamaya Classloader Aware ServiceContext (Extension Module)</h2> + <div class="sectionbody"> + <div class="paragraph"> + <p>Tamaya <em>Classloader</em> is an extension module. Refer to the <a href="../extensions.html">extensions documentation</a> for further details.</p> + </div> + <div class="sect2"> + <h3 id="_what_functionality_this_module_provides">What functionality this module provides ?</h3> + <div class="paragraph"> + <p>The Tamaya <em>Classloader</em> support provides an alternative implementation of java.util.ServiceLoader, which is aware of classloaders, hereby preventing multiple loading of components within a classloader hierarchy.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_compatibility">Compatibility</h3> + <div class="paragraph"> + <p>The module is based on Java 8, so it will not run on Java 8 and beyond.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_installation">Installation</h3> + <div class="paragraph"> + <p>To benefit from configuration server support you only must add the corresponding dependency to your module:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-classloader-support</artifactId> <version>{tamaya_version}</version> -</dependency></code></pre> -</div> -</div> -<div class="paragraph"> -<p>The component will auto.register its components and override the default ServiceContext in use by default -with an instance of type org.apache.tamaya.clsupport.internal.CLAwareServiceContext with a precendence value -(component priority) of 10.</p> -</div> -</div> -<div class="sect2"> -<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> -</div> -<div class="ulist"> -<ul> -<li> -<p>the component walks up the class loader hierarchy.</p> -</li> -<li> -<p>in a next step the hierarchy is traversed down from the parent to the current classloader. Hereby it is checked -if the service list for the required type has been loaded already. If not the service configuration files are -evaluated.</p> -</li> -<li> -<p>This configuration file evaluation will ignore all resources already loaded by any of the already traversed parent -classloaders.</p> -</li> -<li> -<p>For each configuration file newly visible to the classloader currently traversed, the corresponding services are -loaded unleyy, the same service class already has been loaded by one its parent classloaders or another file -loaded with this classloader.</p> -</li> -<li> -<p>Finally all services found are returned as the full collection of services valid for the given context (classloader).</p> -</li> -</ul> -</div> -<div class="paragraph"> -<p>This ensures no service is loaded multiple times, even when it is referenced multiple times in several service -configurations. Additionally every service is loaded on the classloader where it is also declared the first time.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_control_logging">Control Logging</h3> -<div class="paragraph"> -<p>The service component by default only logs errors. But it is possible to change this by reconfiguring the logging -levels on the following logging names/path: org.apache.tamaya.clsupport.internal.CLAwareServiceContext</p> -</div> -<div class="ulist"> -<ul> -<li> -<p><em>INFO</em> logs additional info on the services accessed.</p> -</li> -<li> -<p><em>FINEST</em> logs additional info on the services scanned and selected.</p> -</li> -</ul> -</div> -</div> -<div class="sect2"> -<h3 id="_classloader_aware_configuration">Classloader Aware Configuration</h3> -<div class="paragraph"> -<p>The mechanism above is used to provide a classloader aware implementation of ConfigurationContext -(org.apache.tamaya.clsupport.internal.CLAwareConfigurationContext). Similarly to the service variants -this class provides a context implementation that manages the core configuration aspects considering classloading -hierarchies:</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>PropertySource, PropertySourceProviders</p> -</li> -<li> -<p>PropertyFilters, PropertyCombinationPolicy</p> -</li> -</ul> -</div> -</div> -</div> +</dependency></code></pre> + </div> + </div> + <div class="paragraph"> + <p>The component will auto.register its components and override the default ServiceContext in use by default with an instance of type org.apache.tamaya.clsupport.internal.CLAwareServiceContext with a precendence value (component priority) of 10.</p> + </div> + </div> + <div class="sect2"> + <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> + </div> + <div class="ulist"> + <ul> + <li> <p>the component walks up the class loader hierarchy.</p> </li> + <li> <p>in a next step the hierarchy is traversed down from the parent to the current classloader. Hereby it is checked if the service list for the required type has been loaded already. If not the service configuration files are evaluated.</p> </li> + <li> <p>This configuration file evaluation will ignore all resources already loaded by any of the already traversed parent classloaders.</p> </li> + <li> <p>For each configuration file newly visible to the classloader currently traversed, the corresponding services are loaded unleyy, the same service class already has been loaded by one its parent classloaders or another file loaded with this classloader.</p> </li> + <li> <p>Finally all services found are returned as the full collection of services valid for the given context (classloader).</p> </li> + </ul> + </div> + <div class="paragraph"> + <p>This ensures no service is loaded multiple times, even when it is referenced multiple times in several service configurations. Additionally every service is loaded on the classloader where it is also declared the first time.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_control_logging">Control Logging</h3> + <div class="paragraph"> + <p>The service component by default only logs errors. But it is possible to change this by reconfiguring the logging levels on the following logging names/path: org.apache.tamaya.clsupport.internal.CLAwareServiceContext</p> + </div> + <div class="ulist"> + <ul> + <li> <p><em>INFO</em> logs additional info on the services accessed.</p> </li> + <li> <p><em>FINEST</em> logs additional info on the services scanned and selected.</p> </li> + </ul> + </div> + </div> + <div class="sect2"> + <h3 id="_classloader_aware_configuration">Classloader Aware Configuration</h3> + <div class="paragraph"> + <p>The mechanism above is used to provide a classloader aware implementation of ConfigurationContext (org.apache.tamaya.clsupport.internal.CLAwareConfigurationContext). Similarly to the service variants this class provides a context implementation that manages the core configuration aspects considering classloading hierarchies:</p> + </div> + <div class="ulist"> + <ul> + <li> <p>PropertySource, PropertySourceProviders</p> </li> + <li> <p>PropertyFilters, PropertyCombinationPolicy</p> </li> + </ul> + </div> + </div> + </div> </div></p> <hr /> @@ -254,8 +222,8 @@ hierarchies:</p> <div id="footer"> <div class="container"> <p class="muted credit">© 2014-<span>2018</span> 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.1</span></a> - at <span>2018-05-03</span> | + | Baked with <a href="http://jbake.org";>JBake <span>v2.6.1</span></a> + at <span>2018-05-17</span> | <a class="twitter-follow-button" data-show-count="false" href="https://twitter.com/tamayaconf";>Follow @tamayaconf</a><script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script> </p> <p> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/cddd52a8/documentation-new/extensions/mod_collections.html ---------------------------------------------------------------------- diff --git a/documentation-new/extensions/mod_collections.html b/documentation-new/extensions/mod_collections.html index 50ed8a3..4fc3bc5 100644 --- a/documentation-new/extensions/mod_collections.html +++ b/documentation-new/extensions/mod_collections.html @@ -125,326 +125,263 @@ <h1>Apache Tamaya - Extension: Collection Support</h1> </div> - <p><em>2018-04-26</em></p> + <p><em>2018-05-17</em></p> - <p><div id="preamble"> -<div class="sectionbody"> -<!-- toc disabled --> -</div> -</div> -<div class="sect1"> -<h2 id="Collections">Tamaya Collections Support (Extension Module)</h2> -<div class="sectionbody"> -<div class="paragraph"> -<p>Tamaya <em>Collections</em> is an extension module. Refer to the <a href="../extensions.html">extensions documentation</a> for further details.</p> -</div> -<div class="sect2"> -<h3 id="_what_functionality_this_module_provides">What functionality this module provides ?</h3> -<div class="paragraph"> -<p>All configuration in Tamaya is expressed as simple key, value pairs. Nevertheless this concept allows similarly -the modelling of collection typed values such as lists, sets, maps or simple collections of things. The Tamaya -Collections extension adds this functionality to the Tamaya eco-system.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_compatibility">Compatibility</h3> -<div class="paragraph"> -<p>The module is based on Java 8, so it will not run on Java 8 and beyond.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_installation">Installation</h3> -<div class="paragraph"> -<p>To use Tamaya collection support you only must add the corresponding dependency to your module:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> + <p><div id="preamble"> + <div class="sectionbody"> + <!-- toc disabled --> + </div> +</div> +<div class="sect1"> + <h2 id="Collections">Tamaya Collections Support (Extension Module)</h2> + <div class="sectionbody"> + <div class="paragraph"> + <p>Tamaya <em>Collections</em> is an extension module. Refer to the <a href="../extensions.html">extensions documentation</a> for further details.</p> + </div> + <div class="sect2"> + <h3 id="_what_functionality_this_module_provides">What functionality this module provides ?</h3> + <div class="paragraph"> + <p>All configuration in Tamaya is expressed as simple key, value pairs. Nevertheless this concept allows similarly the modelling of collection typed values such as lists, sets, maps or simple collections of things. The Tamaya Collections extension adds this functionality to the Tamaya eco-system.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_compatibility">Compatibility</h3> + <div class="paragraph"> + <p>The module is based on Java 8, so it will not run on Java 8 and beyond.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_installation">Installation</h3> + <div class="paragraph"> + <p>To use Tamaya collection support you only must add the corresponding dependency to your module:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-collections</artifactId> <version>{tamaya_version}</version> -</dependency></code></pre> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="_overview">Overview</h3> -<div class="paragraph"> -<p>Tamaya Collections adds PropertyConverter implementations that are able to access configuration data -as <em>lists, maps</em> or <em>sets</em>. By default this works out of the box as easy as accessing any other type of -configuration data, e.g.</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">Configuration config = ConfigurationProvider.getConfiguration(); +</dependency></code></pre> + </div> + </div> + </div> + <div class="sect2"> + <h3 id="_overview">Overview</h3> + <div class="paragraph"> + <p>Tamaya Collections adds PropertyConverter implementations that are able to access configuration data as <em>lists, maps</em> or <em>sets</em>. By default this works out of the box as easy as accessing any other type of configuration data, e.g.</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">Configuration config = ConfigurationProvider.getConfiguration(); // Without any content specification, a list of String is returned. List<String> simpleList = config.get("my.list.config.entry", List.class); // Using a TypeLiteral allows to use every convertible sub type supported by the system. -List<Integer> intList = config.get("my.list.config.entry", new TypeLiteral<List<Integer>>(){});</code></pre> -</div> -</div> -<div class="paragraph"> -<p>Configuration in that case, by default, is a simple comma-separated list of entries, e.g.</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-properties" data-lang="properties">my.list.config.entry=1,34454,23,344545,3445</code></pre> -</div> -</div> -<div class="paragraph"> -<p>Additionally the module allows adding additional meta-entries, which allows to tweak some of the -inner-workings, e.g.</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>using your own PropertyConverter implementation for parsing entries.</p> -</li> -<li> -<p>specifying a custom separator to split the items (default is {{','}}.</p> -</li> -<li> -<p>specifying a custom separator to split key/value pairs when parsing map entries.</p> -</li> -<li> -<p>specifying the implementation type of the collection item to be returned.</p> -</li> -<li> -<p>specifying the implementation type of the collection to be returned.</p> -</li> -</ul> -</div> -</div> -<div class="sect2"> -<h3 id="_supported_types">Supported Types</h3> -<div class="paragraph"> -<p>This module currently supports the following types:</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>java.util.Collection</p> -</li> -<li> -<p>java.util.List</p> -</li> -<li> -<p>java.util.ArrayList</p> -</li> -<li> -<p>java.util.LinkedList</p> -</li> -<li> -<p>java.util.Set</p> -</li> -<li> -<p>java.util.SortedSet</p> -</li> -<li> -<p>java.util.TreeSet</p> -</li> -<li> -<p>java.util.HashSet</p> -</li> -<li> -<p>java.util.Map</p> -</li> -<li> -<p>java.util.SortedMap</p> -</li> -<li> -<p>java.util.HashMap</p> -</li> -<li> -<p>java.util.TreeMap</p> -</li> -</ul> -</div> -<div class="paragraph"> -<p>Hereby the collection type is determined by the parameter type accessed, e.g. -config.get("mylist", ArrayList.class) will always return an ArrayList -as result.</p> -</div> -<div class="admonitionblock note"> -<table> -<tr> -<td class="icon"> -<div class="title">Note</div> -</td> -<td class="content"> -This means that depending on your use case you can access different -collection types based on the same configuration values, as long as their is -a PropertyConverter that can convert the <em>raw configuration value</em> to the -required target type. -</td> -</tr> -</table> -</div> -<div class="sect3"> -<h4 id="_configuring_the_target_implementation_type">Configuring the target implementation type</h4> -<div class="paragraph"> -<p>Tamaya Collections allows you to configure the <em>default</em> target collection type by adding the -following meta-configuration entry (shown for the mylist entry). Hereby the package part -java.util. can be ommitted:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-properties" data-lang="properties">mylist=a,b,c -_mylist.collection-type=LinkedList</code></pre> -</div> -</div> -<div class="paragraph"> -<p>When calling config.get("mylist", ArrayList.class) this parameter does not have any effect, -so you will still get an ArrayList as a result. However when you call config.get("mylist", -List.class) you will get a LinkedList as implementation type.</p> -</div> -<div class="paragraph"> -<p>This mechanism similarly applies to all kind of collections, so you can use it similarly to define the implementation -type returned when accessing List, Map or Collection.</p> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="_collecting_configuration_entries_instead_of_overriding">Collecting Configuration Entries instead of Overriding</h3> -<div class="paragraph"> -<p>By default Tamaya applies always an overriding CombinationPolicy, where only the configuration entry for -the most significant configuration entry is used. In case of collections (and maybe also other use cases), -overriding is not always the mechanism of choice. E.g. when you want to have all entries added to your -configuration to be <strong>combined</strong> to a new entry containing all values provided by any property sources.</p> -</div> -<div class="paragraph"> -<p>Therefore <em>Tamaya Collections</em> also provides a more sophistiated CombinationPolicy (automatically configured) -that allows to adapt the way how configuration entries are combined. All you must do is declaring -the mechanism to be applied by an according <em>meta-configuration</em> parameter, e.g. for my.list your config may -look as follows:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-properties" data-lang="properties"># from PropertSource 1 +List<Integer> intList = config.get("my.list.config.entry", new TypeLiteral<List<Integer>>(){});</code></pre> + </div> + </div> + <div class="paragraph"> + <p>Configuration in that case, by default, is a simple comma-separated list of entries, e.g.</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-properties" data-lang="properties">my.list.config.entry=1,34454,23,344545,3445</code></pre> + </div> + </div> + <div class="paragraph"> + <p>Additionally the module allows adding additional meta-entries, which allows to tweak some of the inner-workings, e.g.</p> + </div> + <div class="ulist"> + <ul> + <li> <p>using your own PropertyConverter implementation for parsing entries.</p> </li> + <li> <p>specifying a custom separator to split the items (default is {{','}}.</p> </li> + <li> <p>specifying a custom separator to split key/value pairs when parsing map entries.</p> </li> + <li> <p>specifying the implementation type of the collection item to be returned.</p> </li> + <li> <p>specifying the implementation type of the collection to be returned.</p> </li> + </ul> + </div> + </div> + <div class="sect2"> + <h3 id="_supported_types">Supported Types</h3> + <div class="paragraph"> + <p>This module currently supports the following types:</p> + </div> + <div class="ulist"> + <ul> + <li> <p>java.util.Collection</p> </li> + <li> <p>java.util.List</p> </li> + <li> <p>java.util.ArrayList</p> </li> + <li> <p>java.util.LinkedList</p> </li> + <li> <p>java.util.Set</p> </li> + <li> <p>java.util.SortedSet</p> </li> + <li> <p>java.util.TreeSet</p> </li> + <li> <p>java.util.HashSet</p> </li> + <li> <p>java.util.Map</p> </li> + <li> <p>java.util.SortedMap</p> </li> + <li> <p>java.util.HashMap</p> </li> + <li> <p>java.util.TreeMap</p> </li> + </ul> + </div> + <div class="paragraph"> + <p>Hereby the collection type is determined by the parameter type accessed, e.g. config.get("mylist", ArrayList.class) will always return an ArrayList as result.</p> + </div> + <div class="admonitionblock note"> + <table> + <tbody> + <tr> + <td class="icon"> + <div class="title"> + Note + </div> </td> + <td class="content"> This means that depending on your use case you can access different collection types based on the same configuration values, as long as their is a PropertyConverter that can convert the <em>raw configuration value</em> to the required target type. </td> + </tr> + </tbody> + </table> + </div> + <div class="sect3"> + <h4 id="_configuring_the_target_implementation_type">Configuring the target implementation type</h4> + <div class="paragraph"> + <p>Tamaya Collections allows you to configure the <em>default</em> target collection type by adding the following meta-configuration entry (shown for the mylist entry). Hereby the package part java.util. can be ommitted:</p> + </div> + <div class="paragraph"> + <p>[ source, properties]</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre>mylist=a,b,c +_mylist.collection-type=LinkedList</pre> + </div> + </div> + <div class="paragraph"> + <p>When calling config.get("mylist", ArrayList.class) this parameter does not have any effect, so you will still get an ArrayList as a result. However when you call config.get("mylist", List.class) you will get a LinkedList as implementation type.</p> + </div> + <div class="paragraph"> + <p>This mechanism similarly applies to all kind of collections, so you can use it similarly to define the implementation type returned when accessing List, Map or Collection.</p> + </div> + </div> + </div> + <div class="sect2"> + <h3 id="_collecting_configuration_entries_instead_of_overriding">Collecting Configuration Entries instead of Overriding</h3> + <div class="paragraph"> + <p>By default Tamaya applies always an overriding CombinationPolicy, where only the configuration entry for the most significant configuration entry is used. In case of collections (and maybe also other use cases), overriding is not always the mechanism of choice. E.g. when you want to have all entries added to your configuration to be <strong>combined</strong> to a new entry containing all values provided by any property sources.</p> + </div> + <div class="paragraph"> + <p>Therefore <em>Tamaya Collections</em> also provides a more sophistiated CombinationPolicy (automatically configured) that allows to adapt the way how configuration entries are combined. All you must do is declaring the mechanism to be applied by an according <em>meta-configuration</em> parameter, e.g. for my.list your config may look as follows:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-properties" data-lang="properties"># from PropertSource 1 my.list=1,2,3 # from PropertSource 2, with higher precedence my.list=4,5,6 # without any additional meta-info these entries would be combined to -my.list=4,5,6</code></pre> -</div> -</div> -<div class="paragraph"> -<p>With Tamaya Collections you can now configure the combination policy as follows:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-properties" data-lang="properties"># use one of the default policies: override / collect +my.list=4,5,6</code></pre> + </div> + </div> + <div class="paragraph"> + <p>With Tamaya Collections you can now configure the combination policy as follows:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-properties" data-lang="properties"># use one of the default policies: override / collect _my.list.combination-policy=collect # or use your own custom CombinationPolicy to combine the values -_my.list.combination-policy=com.mycomp.app.MyCombincationPolicy</code></pre> -</div> -</div> -<div class="paragraph"> -<p>So declaring the collect policy the resulting raw output of the entry looks as follows:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-properties" data-lang="properties"># result when applying the collect policy: -my.list=1,2,3,4,5,6</code></pre> -</div> -</div> -<div class="paragraph"> -<p>The customizable policy mechanism of Tamaya Collections also honors the item-separator meta-configuration -parameter explained later in this document.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_format_of_collection_configuration">Format of Collection Configuration</h3> -<div class="paragraph"> -<p>By default collections are modelled as simple String values, that are tokenized into individual parts using a -defined item-separator (by default ','). So a given configuration entry of 1,2,3 is mapped to "1","2","3". -If the target context type is something different than String the smae conversion logic is used as when mapping -configuration parameters directly to non-String target types (implemented as +PropertyConverter classes, manahed -within the current ConfigurationContext. The procedure is identical for all collection types, including Map types, -with the difference that each token in the list is parsed once more for separating it into a key and a value. -The default separator for map entries hereby is "::". Map keys, as of now, are always of type String, whereas -for values the same logic is applied as for non-map collection types.</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-properties" data-lang="properties"># a list, using the default format +_my.list.combination-policy=com.mycomp.app.MyCombincationPolicy</code></pre> + </div> + </div> + <div class="paragraph"> + <p>So declaring the collect policy the resulting raw output of the entry looks as follows:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-properties" data-lang="properties"># result when applying the collect policy: +my.list=1,2,3,4,5,6</code></pre> + </div> + </div> + <div class="paragraph"> + <p>The customizable policy mechanism of Tamaya Collections also honors the item-separator meta-configuration parameter explained later in this document.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_format_of_collection_configuration">Format of Collection Configuration</h3> + <div class="paragraph"> + <p>By default collections are modelled as simple String values, that are tokenized into individual parts using a defined item-separator (by default ','). So a given configuration entry of 1,2,3 is mapped to "1","2","3". If the target context type is something different than String the smae conversion logic is used as when mapping configuration parameters directly to non-String target types (implemented as +PropertyConverter classes, manahed within the current ConfigurationContext. The procedure is identical for all collection types, including Map types, with the difference that each token in the list is parsed once more for separating it into a key and a value. The default separator for map entries hereby is "::". Map keys, as of now, are always of type String, whereas for values the same logic is applied as for non-map collection types.</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-properties" data-lang="properties"># a list, using the default format list=1,2,3,4,5,6 # a map, using the default format -map=a::b, c::d</code></pre> -</div> -</div> -<div class="sect3"> -<h4 id="_trimming_of_entries">Trimming of entries</h4> -<div class="paragraph"> -<p>By default all tokens parsed are trimmed <em>before</em> adding them to the final collection. In case of map entries this is -also the case for key/value entries. So the following configuration results in the identical values for -list1,list2 and map1,map2:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-properties" data-lang="properties"># a list, using the default format +map=a::b, c::d</code></pre> + </div> + </div> + <div class="sect3"> + <h4 id="_trimming_of_entries">Trimming of entries</h4> + <div class="paragraph"> + <p>By default all tokens parsed are trimmed <em>before</em> adding them to the final collection. In case of map entries this is also the case for key/value entries. So the following configuration results in the identical values for list1,list2 and map1,map2:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-properties" data-lang="properties"># a list, using the default format list1=1,2,3,4,5,6 list2=1, 2, 3, 4, 5, 6 # a map, using the default format map1=a::b, c::d -map2=a :: b, c :: d</code></pre> -</div> -</div> -<div class="paragraph"> -<p>Nevertheless truncation can be controlled by the usage of brackets, e.g. the last list or map entry will have a single -space character as value:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-properties" data-lang="properties"># a list, with a ' ' value at the end +map2=a :: b, c :: d</code></pre> + </div> + </div> + <div class="paragraph"> + <p>Nevertheless truncation can be controlled by the usage of brackets, e.g. the last list or map entry will have a single space character as value:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-properties" data-lang="properties"># a list, with a ' ' value at the end list3=1, 2, 3, 4, 5, [ ] # a map, with a ' ' value for key '0' -map3=1 :: a, 2 :: b, 0::[ ]</code></pre> -</div> -</div> -<div class="paragraph"> -<p>Hereby \[ escapes the sequence.</p> -</div> -</div> -<div class="sect3"> -<h4 id="_customizing_the_format">Customizing the format</h4> -<div class="paragraph"> -<p>The item and entry separators (by default ',' and "::") can be customized by setting corresponding meta-data -entries as follows, resulting in the same values as in the prevoius listing:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-properties" data-lang="properties"># a list, with a ' ' value at the end +map3=1 :: a, 2 :: b, 0::[ ]</code></pre> + </div> + </div> + <div class="paragraph"> + <p>Hereby \[ escapes the sequence.</p> + </div> + </div> + <div class="sect3"> + <h4 id="_customizing_the_format">Customizing the format</h4> + <div class="paragraph"> + <p>The item and entry separators (by default ',' and "::") can be customized by setting corresponding meta-data entries as follows, resulting in the same values as in the prevoius listing:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-properties" data-lang="properties"># a list, with a ' ' value at the end list3=1__2__3__ 4__ 5__[ ] _list3.item-separator=__ # a map, with a ' ' value for key '0' map3=1->a, 2->b, 0->[ ] -_map3.map-entry-separator=-></code></pre> -</div> -</div> -<div class="paragraph"> -<p>Of course these settings also can be combined:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-properties" data-lang="properties"># a reformatted map +_map3.map-entry-separator=-></code></pre> + </div> + </div> + <div class="paragraph"> + <p>Of course these settings also can be combined:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-properties" data-lang="properties"># a reformatted map redefined-map=0==none | 1==single | 2==any _redefined-map.map-entry-separator=== -_redefined-map.item-separator=|</code></pre> -</div> -</div> -</div> -</div> -</div> +_redefined-map.item-separator=|</code></pre> + </div> + </div> + </div> + </div> + </div> </div></p> <hr /> @@ -456,8 +393,8 @@ _redefined-map.item-separator=|</code></pre> <div id="footer"> <div class="container"> <p class="muted credit">© 2014-<span>2018</span> 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.1</span></a> - at <span>2018-05-03</span> | + | Baked with <a href="http://jbake.org";>JBake <span>v2.6.1</span></a> + at <span>2018-05-17</span> | <a class="twitter-follow-button" data-show-count="false" href="https://twitter.com/tamayaconf";>Follow @tamayaconf</a><script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script> </p> <p> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/cddd52a8/documentation-new/extensions/mod_consul.html ---------------------------------------------------------------------- diff --git a/documentation-new/extensions/mod_consul.html b/documentation-new/extensions/mod_consul.html index 4000a0b..e784644 100644 --- a/documentation-new/extensions/mod_consul.html +++ b/documentation-new/extensions/mod_consul.html @@ -125,95 +125,74 @@ <h1>Apache Tamaya - Extension: Integration with consul (Hashicorp)</h1> </div> - <p><em>2018-04-26</em></p> + <p><em>2018-05-17</em></p> - <p><div id="preamble"> -<div class="sectionbody"> -<!-- toc disabled --> -</div> -</div> -<div class="sect1"> -<h2 id="Consul">Integration with consul (Extension Module)</h2> -<div class="sectionbody"> -<div class="paragraph"> -<p>Tamaya <em>Consul</em> is an extension module. Refer to the <a href="../extensions.html">extensions documentation</a> for further details.</p> -</div> -<div class="sect2"> -<h3 id="_what_functionality_this_module_provides">What functionality this module provides ?</h3> -<div class="paragraph"> -<p>Tamaya <em>Consul</em> provides different artifacts which allows use of -<a href="http://www.consul.io";>Consul from Hashicorp</a> as configuration backend. Basically the -module supports read-only integration (as a ConsulonfigSource as well -as a writing configuration changes back (based on Tamaya’s MutableConfiguration API -defined by the <a href="mod_mutable_config.html">tamaya-mutable-config</a> extension module.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_compatibility">Compatibility</h3> -<div class="paragraph"> -<p>The module is based on Java 8, so it will not run on Java 8 and beyond.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_installation">Installation</h3> -<div class="paragraph"> -<p>To use <em>tamaya-consul</em> you only must add the corresponding dependency to your module:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> + <p><div id="preamble"> + <div class="sectionbody"> + <!-- toc disabled --> + </div> +</div> +<div class="sect1"> + <h2 id="Consul">Integration with consul (Extension Module)</h2> + <div class="sectionbody"> + <div class="paragraph"> + <p>Tamaya <em>Consul</em> is an extension module. Refer to the <a href="../extensions.html">extensions documentation</a> for further details.</p> + </div> + <div class="sect2"> + <h3 id="_what_functionality_this_module_provides">What functionality this module provides ?</h3> + <div class="paragraph"> + <p>Tamaya <em>Consul</em> provides different artifacts which allows use of <a href="http://www.consul.io";>Consul from Hashicorp</a> as configuration backend. Basically the module supports read-only integration (as a ConsulonfigSource as well as a writing configuration changes back (based on Tamayaâs MutableConfiguration API defined by the <a href="mod_mutable_config.html">tamaya-mutable-config</a> extension module.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_compatibility">Compatibility</h3> + <div class="paragraph"> + <p>The module is based on Java 8, so it will not run on Java 8 and beyond.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_installation">Installation</h3> + <div class="paragraph"> + <p>To use <em>tamaya-consul</em> you only must add the corresponding dependency to your module:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-consul</artifactId> <version>{tamaya_version}</version> -</dependency></code></pre> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="_the_extensions_provided">The Extensions Provided</h3> -<div class="paragraph"> -<p>Consul integration comes basically with 2 artifacts:</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>The org.apache.tamaya.etcd.ConsulConfigSource is a ConfigSource with a default -ordinal of 100 and the name 'consul', which is automatically registered.</p> -</li> -<li> -<p>If the tamaya-mutable-config module is loaded it is possible to write property values back into the consul cluster, -by accessing a MutableConfiguration using the URI config:consul.</p> -</li> -</ul> -</div> -<div class="paragraph"> -<p>Access of consul key/value pairs is through the normal Tamaya API.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_the_consulconfigsource">The ConsulConfigSource</h3> -<div class="paragraph"> -<p>The ConsulConfigSource is automatically registered and allows the consul servers to be used to be configured. This -enables to use e.g. in Docker environments the docker environment configuration mechanisms to configure Tamaya running -in microservice containers to connect with the according consul cluster:</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>The config source reads the tamaya.consul.urls system and environment property to evaluate possible consul servers -(comma separated), which can be connected to. On failure the API just performs a Round-Robin through the list of -configured servers. Without any configuration http://127.0.0.1:2400 is used. If no connection to any consul -server can be established a warning will be logged, but deployment will not fail.</p> -</li> -<li> -<p>The ConsulConfigSource finally also allows the values read from the consul cluster to be mapped to prefixed -context. This can be activated by setting the <code>-Dtamaya.consul.prefix=<PREFIX></code> system property. E.g. when the prefix is -set to <code>cluster-config.</code> a consul key of <code>host:known/all</code> is mapped to <code>cluster-config.host:known/all</code>.</p> -</li> -</ul> -</div> -</div> -</div> +</dependency></code></pre> + </div> + </div> + </div> + <div class="sect2"> + <h3 id="_the_extensions_provided">The Extensions Provided</h3> + <div class="paragraph"> + <p>Consul integration comes basically with 2 artifacts:</p> + </div> + <div class="ulist"> + <ul> + <li> <p>The org.apache.tamaya.etcd.ConsulConfigSource is a ConfigSource with a default ordinal of 100 and the name 'consul', which is automatically registered.</p> </li> + <li> <p>If the tamaya-mutable-config module is loaded it is possible to write property values back into the consul cluster, by accessing a MutableConfiguration using the URI config:consul.</p> </li> + </ul> + </div> + <div class="paragraph"> + <p>Access of consul key/value pairs is through the normal Tamaya API.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_the_consulconfigsource">The ConsulConfigSource</h3> + <div class="paragraph"> + <p>The ConsulConfigSource is automatically registered and allows the consul servers to be used to be configured. This enables to use e.g. in Docker environments the docker environment configuration mechanisms to configure Tamaya running in microservice containers to connect with the according consul cluster:</p> + </div> + <div class="ulist"> + <ul> + <li> <p>The config source reads the tamaya.consul.urls system and environment property to evaluate possible consul servers (comma separated), which can be connected to. On failure the API just performs a Round-Robin through the list of configured servers. Without any configuration http://127.0.0.1:2400 is used. If no connection to any consul server can be established a warning will be logged, but deployment will not fail.</p> </li> + <li> <p>The ConsulConfigSource finally also allows the values read from the consul cluster to be mapped to prefixed context. This can be activated by setting the <code>-Dtamaya.consul.prefix=<PREFIX></code> system property. E.g. when the prefix is set to <code>cluster-config.</code> a consul key of <code>host:known/all</code> is mapped to <code>cluster-config.host:known/all</code>.</p> </li> + </ul> + </div> + </div> + </div> </div></p> <hr /> @@ -225,8 +204,8 @@ set to <code>cluster-config.</code> a consul key of <code>host:known/all</code> <div id="footer"> <div class="container"> <p class="muted credit">© 2014-<span>2018</span> 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.1</span></a> - at <span>2018-05-03</span> | + | Baked with <a href="http://jbake.org";>JBake <span>v2.6.1</span></a> + at <span>2018-05-17</span> | <a class="twitter-follow-button" data-show-count="false" href="https://twitter.com/tamayaconf";>Follow @tamayaconf</a><script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script> </p> <p> http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/cddd52a8/documentation-new/extensions/mod_etcd.html ---------------------------------------------------------------------- diff --git a/documentation-new/extensions/mod_etcd.html b/documentation-new/extensions/mod_etcd.html index 36b8c83..746d092 100644 --- a/documentation-new/extensions/mod_etcd.html +++ b/documentation-new/extensions/mod_etcd.html @@ -125,85 +125,67 @@ <h1>Apache Tamaya - Extension: Integration with etcd (Core OS)</h1> </div> - <p><em>2018-04-26</em></p> + <p><em>2018-05-17</em></p> - <p><div id="preamble"> -<div class="sectionbody"> -<!-- toc disabled --> -</div> -</div> -<div class="sect1"> -<h2 id="Etcd">Integration with etcd (Extension Module)</h2> -<div class="sectionbody"> -<div class="paragraph"> -<p>Tamaya <em>Etcd</em> is an extension module. Refer to the <a href="../extensions.html">extensions documentation</a> for further details.</p> -</div> -<div class="sect2"> -<h3 id="_what_functionality_this_module_provides">What functionality this module provides ?</h3> -<div class="paragraph"> -<p>Tamaya <em>Etcd</em> provides different artifacts which allows using <a href="https://github.com/coreos/etcd";>etcd</a> as a -configuration backend. Basically the module adds a read-only property source (EtcdConfigSource). If -the <em>tamaya-mutable-config</em> extension is loaded it is alos possible to write configuration -changes to <em>etcd</em> using MutableConfiguration.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_compatibility">Compatibility</h3> -<div class="paragraph"> -<p>The module is based on Java 8, so it will not run on Java 8 and beyond.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_installation">Installation</h3> -<div class="paragraph"> -<p>To use <em>etcd</em> as a configuration backend you only must add the corresponding dependency to -your module:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> + <p><div id="preamble"> + <div class="sectionbody"> + <!-- toc disabled --> + </div> +</div> +<div class="sect1"> + <h2 id="Etcd">Integration with etcd (Extension Module)</h2> + <div class="sectionbody"> + <div class="paragraph"> + <p>Tamaya <em>Etcd</em> is an extension module. Refer to the <a href="../extensions.html">extensions documentation</a> for further details.</p> + </div> + <div class="sect2"> + <h3 id="_what_functionality_this_module_provides">What functionality this module provides ?</h3> + <div class="paragraph"> + <p>Tamaya <em>Etcd</em> provides different artifacts which allows using <a href="https://github.com/coreos/etcd";>etcd</a> as a configuration backend. Basically the module adds a read-only property source (EtcdConfigSource). If the <em>tamaya-mutable-config</em> extension is loaded it is alos possible to write configuration changes to <em>etcd</em> using MutableConfiguration.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_compatibility">Compatibility</h3> + <div class="paragraph"> + <p>The module is based on Java 8, so it will not run on Java 8 and beyond.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_installation">Installation</h3> + <div class="paragraph"> + <p>To use <em>etcd</em> as a configuration backend you only must add the corresponding dependency to your module:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><dependency> <groupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-etcd</artifactId> <version>{tamaya_version}</version> -</dependency></code></pre> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="_the_extensions_provided">The Extensions Provided</h3> -<div class="paragraph"> -<p>Tamaya’s <em>etcd</em> integration provides basically the following artifacts:</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>The org.apache.tamaya.etcd.EtcdAccessor can be configured with a an url targeting an etcd server’s REST endpoint -root. The accessor basically provides a simple Java API for communicating with the <em>etcd</em> server. The -accessor hereby allows reading of single properties, or whole subtrees. Also the basic non -atomic write methods are implemented.</p> -</li> -<li> -<p>The org.apache.tamaya.etcd.EtcdConfigSource is a ConfigSource with a default ordinal of 100 and the name -'etcd', which is automatically registered.</p> -</li> -<li> -<p>If the tamaya-mutable-config module is loaded it is possible to write property values back into the etcd cluster, -by accessing a MutableConfiguration using the URI config:etcd.</p> -</li> -</ul> -</div> -</div> -<div class="sect2"> -<h3 id="_the_etcdaccessor">The EtcdAccessor</h3> -<div class="paragraph"> -<p>The accessor implements the basic read and write API for communicating with an <em>etcd</em> server. -Hereby the accessor also provides <em>etcd</em> specific data such as createdIndex, modifiedIndex, ttl in the Map -returned. Hereby the concept of <em>etcd</em> is used where keys starting with an '_' represent meta-configuration -that will be hidden from the overall properties map, being only directly/explicitly accessible:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">public class EtcdAccessor { +</dependency></code></pre> + </div> + </div> + </div> + <div class="sect2"> + <h3 id="_the_extensions_provided">The Extensions Provided</h3> + <div class="paragraph"> + <p>Tamayaâs <em>etcd</em> integration provides basically the following artifacts:</p> + </div> + <div class="ulist"> + <ul> + <li> <p>The org.apache.tamaya.etcd.EtcdAccessor can be configured with a an url targeting an etcd serverâs REST endpoint root. The accessor basically provides a simple Java API for communicating with the <em>etcd</em> server. The accessor hereby allows reading of single properties, or whole subtrees. Also the basic non atomic write methods are implemented.</p> </li> + <li> <p>The org.apache.tamaya.etcd.EtcdConfigSource is a ConfigSource with a default ordinal of 100 and the name 'etcd', which is automatically registered.</p> </li> + <li> <p>If the tamaya-mutable-config module is loaded it is possible to write property values back into the etcd cluster, by accessing a MutableConfiguration using the URI config:etcd.</p> </li> + </ul> + </div> + </div> + <div class="sect2"> + <h3 id="_the_etcdaccessor">The EtcdAccessor</h3> + <div class="paragraph"> + <p>The accessor implements the basic read and write API for communicating with an <em>etcd</em> server. Hereby the accessor also provides <em>etcd</em> specific data such as createdIndex, modifiedIndex, ttl in the Map returned. Hereby the concept of <em>etcd</em> is used where keys starting with an '_' represent meta-configuration that will be hidden from the overall properties map, being only directly/explicitly accessible:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">public class EtcdAccessor { /** * Creates a new instance with the basic access url. @@ -314,38 +296,24 @@ that will be hidden from the overall properties map, being only directly/explici */ public Map<String,String> getProperties(String directory, boolean recursive); -}</code></pre> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="_the_etcdconfigsource">The EtcdConfigSource</h3> -<div class="paragraph"> -<p>The EtcdConfigSource is automatically registered and allows to configure the <em>etcd</em> servers to be used. This -enables to use e.g. in Docker environments the docker environment configuration mechanisms to configure Tamaya running -in microservice containers to connect with the according etcd cluster:</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>The property source reads the tamaya.etcd.server.urls system and environment property to evaluate possible etcd servers -(comma separated), which can be connected to. On error the API just performs a Round-Robin through the list of -configured servers. Without any configuration http://127.0.0.1:4001 is used. If no connection to any etcd -server can be established a warning will be logged, but deployment will not fail.</p> -</li> -<li> -<p>Additionally also the accessor allows to configure the socket/connection timeouts by setting -tamaya.etcd.timeout in seconds either as system or environment property.</p> -</li> -<li> -<p>The EtcdConfigSource finally also allows the values read from the <em>etcd</em> cluster to be mapped to prefixed -context. This can be activated by setting the -Dtamaya.etcd.prefix=<PREFIX> system property. E.g. when the prefix is -set to <code>cluster-config.</code> a etcd key of <code>host:known/all</code> is mapped to <code>cluster-config.host:known/all</code>.</p> -</li> -</ul> -</div> -</div> -</div> +}</code></pre> + </div> + </div> + </div> + <div class="sect2"> + <h3 id="_the_etcdconfigsource">The EtcdConfigSource</h3> + <div class="paragraph"> + <p>The EtcdConfigSource is automatically registered and allows to configure the <em>etcd</em> servers to be used. This enables to use e.g. in Docker environments the docker environment configuration mechanisms to configure Tamaya running in microservice containers to connect with the according etcd cluster:</p> + </div> + <div class="ulist"> + <ul> + <li> <p>The property source reads the tamaya.etcd.server.urls system and environment property to evaluate possible etcd servers (comma separated), which can be connected to. On error the API just performs a Round-Robin through the list of configured servers. Without any configuration http://127.0.0.1:4001 is used. If no connection to any etcd server can be established a warning will be logged, but deployment will not fail.</p> </li> + <li> <p>Additionally also the accessor allows to configure the socket/connection timeouts by setting tamaya.etcd.timeout in seconds either as system or environment property.</p> </li> + <li> <p>The EtcdConfigSource finally also allows the values read from the <em>etcd</em> cluster to be mapped to prefixed context. This can be activated by setting the -Dtamaya.etcd.prefix=<PREFIX> system property. E.g. when the prefix is set to <code>cluster-config.</code> a etcd key of <code>host:known/all</code> is mapped to <code>cluster-config.host:known/all</code>.</p> </li> + </ul> + </div> + </div> + </div> </div></p> <hr /> @@ -357,8 +325,8 @@ set to <code>cluster-config.</code> a etcd key of <code>host:known/all</code> is <div id="footer"> <div class="container"> <p class="muted credit">© 2014-<span>2018</span> 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.1</span></a> - at <span>2018-05-03</span> | + | Baked with <a href="http://jbake.org";>JBake <span>v2.6.1</span></a> + at <span>2018-05-17</span> | <a class="twitter-follow-button" data-show-count="false" href="https://twitter.com/tamayaconf";>Follow @tamayaconf</a><script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script> </p> <p>
