http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/cddd52a8/documentation/extensions/mod_resources.html ---------------------------------------------------------------------- diff --git a/documentation/extensions/mod_resources.html b/documentation/extensions/mod_resources.html index 4c47c76..58087b2 100644 --- a/documentation/extensions/mod_resources.html +++ b/documentation/extensions/mod_resources.html @@ -125,94 +125,83 @@ <h1>Apache Tamaya - Extension: Resources</h1> </div> - <p><em>2018-04-26</em></p> + <p><em>2018-05-17</em></p> - <p><div class="sect1"> -<h2 id="Resources">Tamaya Resources (Extension Module)</h2> -<div class="sectionbody"> -<div class="paragraph"> -<p>Tamaya <em>Resources</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>Resources</em> defines some additional tools to locate resources in your classpath or file system based on -descriptive ant-styled resource patterns.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_compatibility">Compatibility</h3> -<div class="paragraph"> -<p>The module is based on Java 7, so it can be used with Java 7 and beyond.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_installation">Installation</h3> -<div class="paragraph"> -<p>To use this module add the following dependency:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-listing" data-lang="listing"><dependency> + <p><div class="sect1"> + <h2 id="Resources">Tamaya Resources (Extension Module)</h2> + <div class="sectionbody"> + <div class="paragraph"> + <p>Tamaya <em>Resources</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>Resources</em> defines some additional tools to locate resources in your classpath or file system based on descriptive ant-styled resource patterns.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_compatibility">Compatibility</h3> + <div class="paragraph"> + <p>The module is based on Java 7, so it can be used with Java 7 and beyond.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_installation">Installation</h3> + <div class="paragraph"> + <p>To use this module add the following dependency:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-listing" data-lang="listing"><dependency> <grooupId>org.apache.tamaya.ext</groupId> <artifactId>tamaya-resources</artifactId> <version>0.4-incubating-SNAPSHOT</version> -</dependency></code></pre> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="_usage">Usage</h3> -<div class="paragraph"> -<p>The module’s main entry point is the singleton class org.apache.tamaya.resource.ConfigResources. This class -provides access to a ResourceResolver instance:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">ResourceResolver resolver = ConfigResources.getResourceResolver();</code></pre> -</div> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">public interface ResourceResolver { +</dependency></code></pre> + </div> + </div> + </div> + <div class="sect2"> + <h3 id="_usage">Usage</h3> + <div class="paragraph"> + <p>The moduleâs main entry point is the singleton class org.apache.tamaya.resource.ConfigResources. This class provides access to a ResourceResolver instance:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">ResourceResolver resolver = ConfigResources.getResourceResolver();</code></pre> + </div> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">public interface ResourceResolver { Collection<URL> getResources(Collection<String> expressions) {...} Collection<URL> getResources(String... expressions) {...} Collection<URL> getResources(ClassLoader classLoader, String... expressions){...} Collection<URL> getResources(ClassLoader classLoader, Collection<String> expressions); -}</code></pre> -</div> -</div> -<div class="paragraph"> -<p>Hereby the methods allow to resolve expressions to a collection of URLs. In case the expression is also targeting the -current classpath the target ClassLoader to be used can be passed additionally.</p> -</div> -<div class="paragraph"> -<p>The default implementation provides resource resolution mechanism similar to the functionality offered by Spring. -So by default resources can be looked up</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>from files</p> -</li> -<li> -<p>from the classpath</p> -</li> -<li> -<p>optionally ant-styled expressions can be used.</p> -</li> -</ul> -</div> -</div> -<div class="sect2"> -<h3 id="_examples">Examples</h3> -<div class="paragraph"> -<p>There are numerous ways how a resource pattern can be defined. Following the most important variants -are listed:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-listing" data-lang="listing">// explicitly searching the file system +}</code></pre> + </div> + </div> + <div class="paragraph"> + <p>Hereby the methods allow to resolve expressions to a collection of URLs. In case the expression is also targeting the current classpath the target ClassLoader to be used can be passed additionally.</p> + </div> + <div class="paragraph"> + <p>The default implementation provides resource resolution mechanism similar to the functionality offered by Spring. So by default resources can be looked up</p> + </div> + <div class="ulist"> + <ul> + <li> <p>from files</p> </li> + <li> <p>from the classpath</p> </li> + <li> <p>optionally ant-styled expressions can be used.</p> </li> + </ul> + </div> + </div> + <div class="sect2"> + <h3 id="_examples">Examples</h3> + <div class="paragraph"> + <p>There are numerous ways how a resource pattern can be defined. Following the most important variants are listed:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-listing" data-lang="listing">// explicitly searching the file system file:myroot/aa?a/*.file file:myroot/b*/b?/*.file file:myroot/**/*.file @@ -233,24 +222,21 @@ javax/annotation/R?so*.class META-INF/maven/org.apache.geronimo.specs/**/* myroot/**/*.file myroot/aa?a/*.file -myroot/b*/b?/*.file</code></pre> -</div> -</div> -<div class="paragraph"> -<p>Summarizing the resources module provides useful functionality that helps to locate resources on the file system and -in the classpath. This can be used to implement PropertySourceProvider implementations that are based on -corresponding resource path patterns instead of concrete files.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_overall_usage_example">Overall Usage Example</h3> -<div class="paragraph"> -<p>Given the functionality we can easily implement a PropertySourceProvider that reads all files from a classpath -location, hereby traversing down all folders:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">public class PathBasedPropertySourceProvider implements PropertySourceProvider { +myroot/b*/b?/*.file</code></pre> + </div> + </div> + <div class="paragraph"> + <p>Summarizing the resources module provides useful functionality that helps to locate resources on the file system and in the classpath. This can be used to implement PropertySourceProvider implementations that are based on corresponding resource path patterns instead of concrete files.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_overall_usage_example">Overall Usage Example</h3> + <div class="paragraph"> + <p>Given the functionality we can easily implement a PropertySourceProvider that reads all files from a classpath location, hereby traversing down all folders:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">public class PathBasedPropertySourceProvider implements PropertySourceProvider { @Override public Collection<PropertySource> getPropertySources() { @@ -294,23 +280,20 @@ location, hereby traversing down all folders:</p> return properties; } } -}</code></pre> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="_spi">SPI</h3> -<div class="paragraph"> -<p>The ResourceResolver that is returned by the ConfigResources singleton is determined by the -current ServiceContext, by default you can replace the default implementation by registering an -alternate implementation with an overriding @Priority annotation added using the ServiceLoader.</p> -</div> -<div class="paragraph"> -<p>Additionally a BaseResourceResolver class can be used to reduce the amount of code to be written -on your own.</p> -</div> -</div> -</div> +}</code></pre> + </div> + </div> + </div> + <div class="sect2"> + <h3 id="_spi">SPI</h3> + <div class="paragraph"> + <p>The ResourceResolver that is returned by the ConfigResources singleton is determined by the current ServiceContext, by default you can replace the default implementation by registering an alternate implementation with an overriding @Priority annotation added using the ServiceLoader.</p> + </div> + <div class="paragraph"> + <p>Additionally a BaseResourceResolver class can be used to reduce the amount of code to be written on your own.</p> + </div> + </div> + </div> </div></p> <hr /> @@ -322,8 +305,8 @@ on your own.</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/extensions/mod_server.html ---------------------------------------------------------------------- diff --git a/documentation/extensions/mod_server.html b/documentation/extensions/mod_server.html index 7e0ee55..991e2cc 100644 --- a/documentation/extensions/mod_server.html +++ b/documentation/extensions/mod_server.html @@ -125,131 +125,114 @@ <h1>Apache Tamaya - Extension: Configuration Server</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="Server">Tamaya Configuration Server (Extension Module)</h2> -<div class="sectionbody"> -<div class="paragraph"> -<p>Tamaya <em>Server</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>Server</em> module provides support for providing scoped configuration using a http server serving JSON formatted -configuration properties.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_compatibility">Compatibility</h3> -<div class="paragraph"> -<p>The module is based on Java 7, so it will not run on Java 7 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="Server">Tamaya Configuration Server (Extension Module)</h2> + <div class="sectionbody"> + <div class="paragraph"> + <p>Tamaya <em>Server</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>Server</em> module provides support for providing scoped configuration using a http server serving JSON formatted configuration properties.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_compatibility">Compatibility</h3> + <div class="paragraph"> + <p>The module is based on Java 7, so it will not run on Java 7 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-server</artifactId> <version>{tamaya_version}</version> -</dependency></code></pre> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="_providing_configuration_using_the_tamaya_built_in_configuration_server">Providing configuration using the Tamaya Built-in Configuration Server</h3> -<div class="paragraph"> -<p>The most simple way for providing configuration is to start the internal server:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">// using context path: '/', port 8085 +</dependency></code></pre> + </div> + </div> + </div> + <div class="sect2"> + <h3 id="_providing_configuration_using_the_tamaya_built_in_configuration_server">Providing configuration using the Tamaya Built-in Configuration Server</h3> + <div class="paragraph"> + <p>The most simple way for providing configuration is to start the internal server:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">// using context path: '/', port 8085 org.apache.tamaya.server.Server.start(); // optionally pass the root context path and/or port: // org.apache.tamaya.server.Server.start(8088); -// org.apache.tamaya.server.Server.start("/appconf", 7787);</code></pre> -</div> -</div> -<div class="paragraph"> -<p>This will start a simple server instance that serves the following URL patterns:</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>GET ${CONTEXT}/config provides access to the full configuration tree.</p> -</li> -<li> -<p>GET ${CONTEXT}/config/filtered/${path} let you filter the configuration returned using regular expression (comma separated). -E.g. ${CONTEXT}/config/filtered/java,sun will return all configuration entries starting with <em>java</em> and <em>sun</em>.</p> -</li> -</ul> -</div> -<div class="paragraph"> -<p>Additionally the server module has the following options implemented, which can be passed as additional, optional -parameters:</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>format allows to define the target format. By default the ACCEPT header of the http request is checked, but this -setting can be explicitly controlled by passing this parameter explicitly. The value is the expected MIME type to be -returned. By default the service supports the following types:</p> -<div class="ulist"> -<ul> -<li> -<p>text/html</p> -</li> -<li> -<p>text/plain</p> -</li> -<li> -<p>application/xml</p> -</li> -<li> -<p>application/json</p> -</li> -</ul> -</div> -</li> -</ul> -</div> -</div> -<div class="sect2"> -<h3 id="_using_the_configuration_servlets">Using the Configuration Servlets</h3> -<div class="paragraph"> -<p>You can also register a servlet, e.g. as follows;</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre><servlet> +// org.apache.tamaya.server.Server.start("/appconf", 7787);</code></pre> + </div> + </div> + <div class="paragraph"> + <p>This will start a simple server instance that serves the following URL patterns:</p> + </div> + <div class="ulist"> + <ul> + <li> <p>GET ${CONTEXT}/config provides access to the full configuration tree.</p> </li> + <li> <p>GET ${CONTEXT}/config/filtered/${path} let you filter the configuration returned using regular expression (comma separated). E.g. ${CONTEXT}/config/filtered/java,sun will return all configuration entries starting with <em>java</em> and <em>sun</em>.</p> </li> + </ul> + </div> + <div class="paragraph"> + <p>Additionally the server module has the following options implemented, which can be passed as additional, optional parameters:</p> + </div> + <div class="ulist"> + <ul> + <li> <p>format allows to define the target format. By default the ACCEPT header of the http request is checked, but this setting can be explicitly controlled by passing this parameter explicitly. The value is the expected MIME type to be returned. By default the service supports the following types:</p> + <div class="ulist"> + <ul> + <li> <p>text/html</p> </li> + <li> <p>text/plain</p> </li> + <li> <p>application/xml</p> </li> + <li> <p>application/json</p> </li> + </ul> + </div> </li> + </ul> + </div> + </div> + <div class="sect2"> + <h3 id="_using_the_configuration_servlets">Using the Configuration Servlets</h3> + <div class="paragraph"> + <p>You can also register a servlet, e.g. as follows;</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre><servlet> <servlet-name>config-servlet</servlet-name> <servlet-class>org.apache.cxf.jaxrs.servlet.CXFNonSpringJaxrsServlet</servlet-class> <init-params> <init-param key="javax.ws.rs.Application">org.apache.tamaya.server.Server$ResourceLoader</init-param> </init-params> -</servlet></pre> -</div> -</div> -<div class="sect3"> -<h4 id="_formatting_used_by_default">Formatting used by Default</h4> -<div class="paragraph"> -<p>The server module formats the configuration returned by default in the following variants:</p> -</div> -<div class="listingblock"> -<div class="title">Formatting for text/json</div> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-json" data-lang="json">{ +</servlet></pre> + </div> + </div> + <div class="sect3"> + <h4 id="_formatting_used_by_default">Formatting used by Default</h4> + <div class="paragraph"> + <p>The server module formats the configuration returned by default in the following variants:</p> + </div> + <div class="listingblock"> + <div class="title"> + Formatting for text/json + </div> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-json" data-lang="json">{ "java.vendor.url": "http://java.oracle.com/";, "java.vendor.url.bug": "http://bugreport.sun.com/bugreport/";, "java.vm.info": "mixed mode", @@ -277,13 +260,15 @@ returned. By default the service supports the following types:</p> "_info.timestamp": "1441463200571", "_timestamp": "1441463200571", "_type": "Configuration" -}</code></pre> -</div> -</div> -<div class="listingblock"> -<div class="title">Formatting for application/xml</div> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><configuration> +}</code></pre> + </div> + </div> + <div class="listingblock"> + <div class="title"> + Formatting for application/xml + </div> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><configuration> <entry key="java.vendor.url">http://java.oracle.com/</entry> <entry key="java.vendor.url.bug">http://bugreport.sun.com/bugreport/</entry> <entry key="java.vm.info">mixed mode</entry> @@ -311,13 +296,15 @@ returned. By default the service supports the following types:</p> <entry key="_info.timestamp">1441463383687</entry> <entry key="_timestamp">1441463383687</entry> <entry key="_type">Configuration</entry> -</configuration></code></pre> -</div> -</div> -<div class="listingblock"> -<div class="title">Formatting for text/plain</div> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-text" data-lang="text">Configuration: +</configuration></code></pre> + </div> + </div> + <div class="listingblock"> + <div class="title"> + Formatting for text/plain + </div> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-text" data-lang="text">Configuration: java.vendor.url: http://java.oracle.com/, java.vendor.url.bug: http://bugreport.sun.com/bugreport/, java.vm.info: mixed mode, @@ -344,13 +331,15 @@ returned. By default the service supports the following types:</p> _info.format: text/plain, _info.timestamp: 1441463082020, _timestamp: 1441463082021, - _type: Configuration</code></pre> -</div> -</div> -<div class="listingblock"> -<div class="title">Formatting for application/html</div> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-html" data-lang="html"><html> + _type: Configuration</code></pre> + </div> + </div> + <div class="listingblock"> + <div class="title"> + Formatting for application/html + </div> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-html" data-lang="html"><html> <head><title>System Configuration</title></head> <body> <h1>Sysem Configuration</h1> @@ -385,12 +374,12 @@ Configuration: _type: Configuration </pre> </body> -</html></code></pre> -</div> -</div> -</div> -</div> -</div> +</html></code></pre> + </div> + </div> + </div> + </div> + </div> </div></p> <hr /> @@ -402,8 +391,8 @@ Configuration: <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/extensions/mod_spring.html ---------------------------------------------------------------------- diff --git a/documentation/extensions/mod_spring.html b/documentation/extensions/mod_spring.html index f71d5fa..d50e54a 100644 --- a/documentation/extensions/mod_spring.html +++ b/documentation/extensions/mod_spring.html @@ -125,75 +125,62 @@ <h1>Apache Tamaya - Extension: Spring Integration</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="Spring">Tamaya Spring Integration (Extension Module)</h2> -<div class="sectionbody"> -<div class="paragraph"> -<p>Tamaya <em>Spring</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>Spring</em> currently provides full integration with Spring and Spring Boot:</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>A Spring @Configuration implementation that also provides a Tamaya based version of -org.springframework.context.support.PropertySourcesPlaceholderConfigurer.</p> -</li> -<li> -<p>org.apache.tamaya.integration.spring.TamayaEnvironment is the Tamaya based implementation of the Spring -Environment interface.</p> -</li> -<li> -<p>TamayaSpringPropertySource implements an additional Spring PropertySource.</p> -</li> -<li> -<p>Finally org.apache.tamaya.integration.spring.SpringConfigInjectionPostProcessor implements a Bean PostProcessor, -which adds all the fully fledged Tamaya configuration capabilities to Spring.</p> -</li> -</ul> -</div> -</div> -<div class="sect2"> -<h3 id="_compatibility">Compatibility</h3> -<div class="paragraph"> -<p>Both modules are based on Java 8, so they will run on Java 8 and beyond. The extension shown here works in -Spring Framework as well as Spring Boot.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_installation">Installation</h3> -<div class="paragraph"> -<p>To benefit from Tamaya Spring integration add the following dependencies 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="Spring">Tamaya Spring Integration (Extension Module)</h2> + <div class="sectionbody"> + <div class="paragraph"> + <p>Tamaya <em>Spring</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>Spring</em> currently provides full integration with Spring and Spring Boot:</p> + </div> + <div class="ulist"> + <ul> + <li> <p>A Spring @Configuration implementation that also provides a Tamaya based version of org.springframework.context.support.PropertySourcesPlaceholderConfigurer.</p> </li> + <li> <p>org.apache.tamaya.integration.spring.TamayaEnvironment is the Tamaya based implementation of the Spring Environment interface.</p> </li> + <li> <p>TamayaSpringPropertySource implements an additional Spring PropertySource.</p> </li> + <li> <p>Finally org.apache.tamaya.integration.spring.SpringConfigInjectionPostProcessor implements a Bean PostProcessor, which adds all the fully fledged Tamaya configuration capabilities to Spring.</p> </li> + </ul> + </div> + </div> + <div class="sect2"> + <h3 id="_compatibility">Compatibility</h3> + <div class="paragraph"> + <p>Both modules are based on Java 8, so they will run on Java 8 and beyond. The extension shown here works in Spring Framework as well as Spring Boot.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_installation">Installation</h3> + <div class="paragraph"> + <p>To benefit from Tamaya Spring integration add the following dependencies 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-spring</artifactId> <version>{tamaya_version}</version> -</dependency></code></pre> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="_registering_tamaya_spring_configuration">Registering Tamaya Spring Configuration</h3> -<div class="paragraph"> -<p>Basically to activate the Tamaya Spring support the most simple thing is to a enable the Tamaya package for being -scanned for Spring components, e.g. using by annotation:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">@SpringBootApplication +</dependency></code></pre> + </div> + </div> + </div> + <div class="sect2"> + <h3 id="_registering_tamaya_spring_configuration">Registering Tamaya Spring Configuration</h3> + <div class="paragraph"> + <p>Basically to activate the Tamaya Spring support the most simple thing is to a enable the Tamaya package for being scanned for Spring components, e.g. using by annotation:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">@SpringBootApplication @ComponentScan({"org.apache.tamaya.integration.spring"}) public class SampleWebFreeMarkerApplication { @@ -201,15 +188,15 @@ public class SampleWebFreeMarkerApplication { SpringApplication.run(SampleWebFreeMarkerApplication.class, args); } -}</code></pre> -</div> -</div> -<div class="paragraph"> -<p>Of course, you can still use Spring’s XML configuration in a similar way:</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"; +}</code></pre> + </div> + </div> + <div class="paragraph"> + <p>Of course, you can still use Springâs XML configuration in a similar way:</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"; xmlns:context="http://www.springframework.org/schema/context"; xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd"> @@ -219,42 +206,40 @@ public class SampleWebFreeMarkerApplication { ... -</beans></code></pre> -</div> -</div> -<div class="paragraph"> -<p>Though not recommended you can explicitly register the Tamaya related beans in your context configuration by hand: -files:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><bean id="tamayaInjectionProcessor" name="tamayaInjectionProcessor" class="org.apache.tamaya.integration.spring.SpringConfigInjectionPostProcessor"/> -<bean id="tamayaConfigProvider" name="tamayaConfigProvider" class="org.apache.tamaya.integration.spring.TamayaSpringConfig"/></code></pre> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="_configuring_your_context">Configuring your Context</h3> -<div class="paragraph"> -<p>After activation you can use Tamaya as a backend for property resolution, e.g. propertyValue -is resolved from the current Tamaya configuration. See example below:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><bean id="configuredBean" name="configuredBean" class="org.apache.tamaya.integration.spring.ConfiguredSpringBean"> +</beans></code></pre> + </div> + </div> + <div class="paragraph"> + <p>Though not recommended you can explicitly register the Tamaya related beans in your context configuration by hand: files:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><bean id="tamayaInjectionProcessor" name="tamayaInjectionProcessor" class="org.apache.tamaya.integration.spring.SpringConfigInjectionPostProcessor"/> +<bean id="tamayaConfigProvider" name="tamayaConfigProvider" class="org.apache.tamaya.integration.spring.TamayaSpringConfig"/></code></pre> + </div> + </div> + </div> + <div class="sect2"> + <h3 id="_configuring_your_context">Configuring your Context</h3> + <div class="paragraph"> + <p>After activation you can use Tamaya as a backend for property resolution, e.g. propertyValue is resolved from the current Tamaya configuration. See example below:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><bean id="configuredBean" name="configuredBean" class="org.apache.tamaya.integration.spring.ConfiguredSpringBean"> <property name="message" value="${propertyValue}"/> -</bean></code></pre> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="_configuring_your_beans">Configuring your Beans</h3> -<div class="paragraph"> -<p>Similarly you can inject any kind of configuration as supported by Tamaya into your Spring managed beans:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">@ConfigDefaultSections("app.root") // optional <b class="conum">(1)</b> +</bean></code></pre> + </div> + </div> + </div> + <div class="sect2"> + <h3 id="_configuring_your_beans">Configuring your Beans</h3> + <div class="paragraph"> + <p>Similarly you can inject any kind of configuration as supported by Tamaya into your Spring managed beans:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">@ConfigDefaultSections("app.root") // optional <b class="conum">(1)</b> @Component public class ConfiguredSpringBean { @@ -274,80 +259,59 @@ public class ConfiguredSpringBean { private int testNumber; ... -}</code></pre> -</div> -</div> -<div class="colist arabic"> -<ol> -<li> -<p>You can configure default section prefixes. This is an optional feature.</p> -</li> -<li> -<p>Tamaya does not require you to change your code. You can still work with -Spring injection for your configuration, but Tamaya will override Spring -configuration by default.</p> -</li> -<li> -<p>You can also define entries as optional, which allows you to perform -default inialization using Java idoms.</p> -</li> -<li> -<p>Tamaya allows you to define an ordered list of key candidates, which are -combined with the section prefix, if present, to the full keys. Keys added -in brackets ([]) are interpreted as absolute keys, so the example above -the key candidate list evaluates to app.root.number", "app.root.testNum", -"notavailable".</p> -</li> -<li> -<p>You can configure default values used, if no other value can be evaluated -for the given keyset.</p> -</li> -</ol> -</div> -<div class="paragraph"> -<p>Summarizing you get all the nice features of Tamaya out of the box running -with your Spring code.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_working_with_dynamic_values">Working with Dynamic Values</h3> -<div class="paragraph"> -<p>Integration into Spring also includes for support for <em>dynamic values</em>:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">@Config(value = "foreground.color", required = false, defaultValue = "#DDDDDD") -private DynamicValue<Color> foregroundColor;</code></pre> -</div> -</div> -<div class="paragraph"> -<p>Dynamic values are a very flexible mechanism for managing configuration changes. -You can even use an update policy to define how you want to handle configuration -changes for your configuration parameter:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">foregroundColor.setUpdatePolicy(UpdatePolicy.IMMEDEATE); +}</code></pre> + </div> + </div> + <div class="colist arabic"> + <ol> + <li> <p>You can configure default section prefixes. This is an optional feature.</p> </li> + <li> <p>Tamaya does not require you to change your code. You can still work with Spring injection for your configuration, but Tamaya will override Spring configuration by default.</p> </li> + <li> <p>You can also define entries as optional, which allows you to perform default inialization using Java idoms.</p> </li> + <li> <p>Tamaya allows you to define an ordered list of key candidates, which are combined with the section prefix, if present, to the full keys. Keys added in brackets ([]) are interpreted as absolute keys, so the example above the key candidate list evaluates to app.root.number", "app.root.testNum", "notavailable".</p> </li> + <li> <p>You can configure default values used, if no other value can be evaluated for the given keyset.</p> </li> + </ol> + </div> + <div class="paragraph"> + <p>Summarizing you get all the nice features of Tamaya out of the box running with your Spring code.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_working_with_dynamic_values">Working with Dynamic Values</h3> + <div class="paragraph"> + <p>Integration into Spring also includes for support for <em>dynamic values</em>:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">@Config(value = "foreground.color", required = false, defaultValue = "#DDDDDD") +private DynamicValue<Color> foregroundColor;</code></pre> + </div> + </div> + <div class="paragraph"> + <p>Dynamic values are a very flexible mechanism for managing configuration changes. You can even use an update policy to define how you want to handle configuration changes for your configuration parameter:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">foregroundColor.setUpdatePolicy(UpdatePolicy.IMMEDEATE); foregroundColor.addPropertyChangeListener(() -> { System.out.println("New forground color: " + foregroundColor.get(); -});</code></pre> -</div> -</div> -<div class="admonitionblock important"> -<table> -<tr> -<td class="icon"> -<div class="title">Important</div> -</td> -<td class="content"> -For a full description of Tamaya’s injection API please - refer to the <a href="extensions/mod_injection.html">corresponding documentation</a>. -</td> -</tr> -</table> -</div> -</div> -</div> +});</code></pre> + </div> + </div> + <div class="admonitionblock important"> + <table> + <tbody> + <tr> + <td class="icon"> + <div class="title"> + Important + </div> </td> + <td class="content"> For a full description of Tamayaâs injection API please refer to the <a href="extensions/mod_injection.html">corresponding documentation</a>. </td> + </tr> + </tbody> + </table> + </div> + </div> + </div> </div></p> <hr /> @@ -359,8 +323,8 @@ For a full description of Tamaya’s injection API please <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/extensions/mod_usagetracker.html ---------------------------------------------------------------------- diff --git a/documentation/extensions/mod_usagetracker.html b/documentation/extensions/mod_usagetracker.html index d28db46..ef49400 100644 --- a/documentation/extensions/mod_usagetracker.html +++ b/documentation/extensions/mod_usagetracker.html @@ -125,86 +125,69 @@ <h1>Apache Tamaya - Extension: Usage Tracking</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="UsageTracker">Tamaya Usage Tracking (Extension Module)</h2> -<div class="sectionbody"> -<div class="paragraph"> -<p>Tamaya <em>UsageTracker</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>UsageTracker</em> allows to record and count the configuration access and consumer locations in your local -VM.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_compatibility">Compatibility</h3> -<div class="paragraph"> -<p>The module is based on Java 7, so it can be used with Java 7 and beyond.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_installation">Installation</h3> -<div class="paragraph"> -<p>To use Tamaya <em>usagetracker</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="UsageTracker">Tamaya Usage Tracking (Extension Module)</h2> + <div class="sectionbody"> + <div class="paragraph"> + <p>Tamaya <em>UsageTracker</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>UsageTracker</em> allows to record and count the configuration access and consumer locations in your local VM.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_compatibility">Compatibility</h3> + <div class="paragraph"> + <p>The module is based on Java 7, so it can be used with Java 7 and beyond.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_installation">Installation</h3> + <div class="paragraph"> + <p>To use Tamaya <em>usagetracker</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-usagetracker</artifactId> <version>{tamaya_version}</version> -</dependency></code></pre> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="_tracking_configuration_access">Tracking Configuration Access</h3> -<div class="paragraph"> -<p>The model module also allows tracking which code accesses configuration properties or configuration parameters. -It checks the stacktrace to evaluate the calling code location, hereby any unwanted packages can be implicitly -ommitted from the stacktrace. Also the maximal length of the stacktrace retained can be constraint in length. -The usages are recorded as Usage instances. Hereby for each parameter accessed a corresponding Usage -instance is created. It can be accessed by calling Usage ConfigUsageStats.getUsage(String key). Usage -statistics for calling Configuration.getProperties() can be obtained calling Usage getUsageAllProps();.</p> -</div> -<div class="paragraph"> -<p>Usage tracking is disabled by default. It can be enabled by calling ConfigUsageStats.enableUsageTracking(true);. -ConfigUsageStats.isUsageTrackingEnabled() returns the current tracking status.</p> -</div> -<div class="paragraph"> -<p>The Usage class itself provides access to further fainer grained usage data (AccessDetail) containing:</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>the access point (fqn.ClassName#method(line: xxx)).</p> -</li> -<li> -<p>the number of accesses</p> -</li> -<li> -<p>the first an last access</p> -</li> -<li> -<p>the values read</p> -</li> -<li> -<p>the access stacktrace (filtered by ignored packages).</p> -</li> -</ul> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">public final class Usage { +</dependency></code></pre> + </div> + </div> + </div> + <div class="sect2"> + <h3 id="_tracking_configuration_access">Tracking Configuration Access</h3> + <div class="paragraph"> + <p>The model module also allows tracking which code accesses configuration properties or configuration parameters. It checks the stacktrace to evaluate the calling code location, hereby any unwanted packages can be implicitly ommitted from the stacktrace. Also the maximal length of the stacktrace retained can be constraint in length. The usages are recorded as Usage instances. Hereby for each parameter accessed a corresponding Usage instance is created. It can be accessed by calling Usage ConfigUsageStats.getUsage(String key). Usage statistics for calling Configuration.getProperties() can be obtained calling Usage getUsageAllProps();.</p> + </div> + <div class="paragraph"> + <p>Usage tracking is disabled by default. It can be enabled by calling ConfigUsageStats.enableUsageTracking(true);. ConfigUsageStats.isUsageTrackingEnabled() returns the current tracking status.</p> + </div> + <div class="paragraph"> + <p>The Usage class itself provides access to further fainer grained usage data (AccessDetail) containing:</p> + </div> + <div class="ulist"> + <ul> + <li> <p>the access point (fqn.ClassName#method(line: xxx)).</p> </li> + <li> <p>the number of accesses</p> </li> + <li> <p>the first an last access</p> </li> + <li> <p>the values read</p> </li> + <li> <p>the access stacktrace (filtered by ignored packages).</p> </li> + </ul> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">public final class Usage { [...] public String getKey(); public void clearMetrics(); @@ -230,16 +213,15 @@ ConfigUsageStats.isUsageTrackingEnabled() returns the current tracking status.</ public Map<Long, String> getTrackedValues(); } -}</code></pre> -</div> -</div> -<div class="paragraph"> -<p>With ConfigUsageStats.clearUsageStats() the collected statistics can be reset at any time. Summarizing the main -singleton for configuration statistics is defined as follows:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">public final class ConfigUsageStats{ +}</code></pre> + </div> + </div> + <div class="paragraph"> + <p>With ConfigUsageStats.clearUsageStats() the collected statistics can be reset at any time. Summarizing the main singleton for configuration statistics is defined as follows:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">public final class ConfigUsageStats{ public static Set<String> getIgnoredUsagePackages(); public static void addIgnoredUsagePackages(String... packageName); public static void enableUsageTracking(boolean enabled); @@ -249,47 +231,36 @@ singleton for configuration statistics is defined as follows:</p> public static Usage getUsageAllProperties(); public static boolean isUsageTrackingEnabled(); public static String getUsageInfo(); -}</code></pre> -</div> -</div> -<div class="sect3"> -<h4 id="_customizing_the_stacktrace_for_usage_reporting">Customizing the Stacktrace for Usage Reporting</h4> -<div class="paragraph"> -<p>The stacktrace tracked by the system can be customized in several ways:</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>ConfigUsageStats.addIgnoredPackageNames(String...) allows to add additional ignored package names.</p> -</li> -<li> -<p>With Usage.setMaxTraceLength(int) the maximal size of the stacktraces logged can be set. Setting a -negative value will disable stacktrace logging completelely.</p> -</li> -</ul> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="_accessing_usage_statistics">Accessing Usage Statistics</h3> -<div class="paragraph"> -<p>Bascially usage statistics are available in two forms:</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>The Usage/AccessDetail object tree can be accessed programmatically from the ConfigUsageStats -singleton.</p> -</li> -<li> -<p>With ConfigUsageStats.getUsageInfo() also a textual representation of the usage statistics -can be obtained, as illustrated below (a snipped from the current test output):</p> -</li> -</ul> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-listing" data-lang="listing">Apache Tamaya Configuration Usage Metrics +}</code></pre> + </div> + </div> + <div class="sect3"> + <h4 id="_customizing_the_stacktrace_for_usage_reporting">Customizing the Stacktrace for Usage Reporting</h4> + <div class="paragraph"> + <p>The stacktrace tracked by the system can be customized in several ways:</p> + </div> + <div class="ulist"> + <ul> + <li> <p>ConfigUsageStats.addIgnoredPackageNames(String...) allows to add additional ignored package names.</p> </li> + <li> <p>With Usage.setMaxTraceLength(int) the maximal size of the stacktraces logged can be set. Setting a negative value will disable stacktrace logging completelely.</p> </li> + </ul> + </div> + </div> + </div> + <div class="sect2"> + <h3 id="_accessing_usage_statistics">Accessing Usage Statistics</h3> + <div class="paragraph"> + <p>Bascially usage statistics are available in two forms:</p> + </div> + <div class="ulist"> + <ul> + <li> <p>The Usage/AccessDetail object tree can be accessed programmatically from the ConfigUsageStats singleton.</p> </li> + <li> <p>With ConfigUsageStats.getUsageInfo() also a textual representation of the usage statistics can be obtained, as illustrated below (a snipped from the current test output):</p> </li> + </ul> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-listing" data-lang="listing">Apache Tamaya Configuration Usage Metrics ========================================= DATE: Sat Apr 30 21:51:09 CEST 2016 @@ -297,37 +268,28 @@ DATE: Sat Apr 30 21:51:09 CEST 2016 - 220 <unknown/filtered/internal> , first=Sat Apr 30 21:51:09 CEST 2016, last=Sat Apr 30 21:51:09 CEST 2016 3 java.version: - 2 test.model.TestConfigAccessor#readProperty(line:43), first=Sat Apr 30 21:51:09 CEST 2016, last=Sat Apr 30 21:51:09 CEST 2016 - - 1 <unknown/filtered/internal> , first=Sat Apr 30 21:51:09 CEST 2016, last=Sat Apr 30 21:51:09 CEST 2016</code></pre> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="_auto_documentation_of_classes_with_configuration_injection">Auto-Documentation of Classes with Configuration Injection</h3> -<div class="paragraph"> -<p>A special feature of this module is that it observes ConfigEvent published through Tamaya’as event channel -(tamaya-events module). If no metaconfiguration model is found the model manager by default automatically creates -models for all injected instances on the fly. In the case of CDI integration this happens typically during deployment -time, since CDI initializes during deployment time. Other runtime platforms, such as OSGI, may have rather different -behaviour. Nevertheless this means that after your system has been started you should have access to a complete -set of ConfigModel instances that automatically document all the classes in your system that consume configuration -(through injection).</p> -</div> -</div> -</div> -</div> -<div class="sect1"> -<h2 id="_usagetracker_module_spi">UsageTracker Module SPI</h2> -<div class="sectionbody"> -<div class="sect2"> -<h3 id="_the_configusagestatsspi">The ConfigUsageStatsSpi</h3> -<div class="paragraph"> -<p>The methods for managing and tracking of configuration changes are similarly delegated to an -implementation of the org.apache.tamaya.model.spi.ConfigUsageStatsSpi SPI. -By implementing this SPI and registerting it with the ServiceContext the usage tracking -logic can be adapted or replaced.</p> -</div> -</div> -</div> + - 1 <unknown/filtered/internal> , first=Sat Apr 30 21:51:09 CEST 2016, last=Sat Apr 30 21:51:09 CEST 2016</code></pre> + </div> + </div> + </div> + <div class="sect2"> + <h3 id="_auto_documentation_of_classes_with_configuration_injection">Auto-Documentation of Classes with Configuration Injection</h3> + <div class="paragraph"> + <p>A special feature of this module is that it observes ConfigEvent published through Tamayaâas event channel (tamaya-events module). If no metaconfiguration model is found the model manager by default automatically creates models for all injected instances on the fly. In the case of CDI integration this happens typically during deployment time, since CDI initializes during deployment time. Other runtime platforms, such as OSGI, may have rather different behaviour. Nevertheless this means that after your system has been started you should have access to a complete set of ConfigModel instances that automatically document all the classes in your system that consume configuration (through injection).</p> + </div> + </div> + </div> +</div> +<div class="sect1"> + <h2 id="_usagetracker_module_spi">UsageTracker Module SPI</h2> + <div class="sectionbody"> + <div class="sect2"> + <h3 id="_the_configusagestatsspi">The ConfigUsageStatsSpi</h3> + <div class="paragraph"> + <p>The methods for managing and tracking of configuration changes are similarly delegated to an implementation of the org.apache.tamaya.model.spi.ConfigUsageStatsSpi SPI. By implementing this SPI and registerting it with the ServiceContext the usage tracking logic can be adapted or replaced.</p> + </div> + </div> + </div> </div></p> <hr /> @@ -339,8 +301,8 @@ logic can be adapted or replaced.</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/extensions/mod_validation.html ---------------------------------------------------------------------- diff --git a/documentation/extensions/mod_validation.html b/documentation/extensions/mod_validation.html index 8c57c36..aa719e4 100644 --- a/documentation/extensions/mod_validation.html +++ b/documentation/extensions/mod_validation.html @@ -125,73 +125,70 @@ <h1>Apache Tamaya - Extension: Configuration Validation</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="Validation">Tamaya Validation: Validating Configuration (Extension Module)</h2> -<div class="sectionbody"> -<div class="paragraph"> -<p>Tamaya <em>Validation</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="_overview">Overview</h3> -<div class="paragraph"> -<p>Tamaya <em>Validation</em> adds support to validate a configuration against a set of rules -defined in a Tamaya Metaconfiguration XML file.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_compatibility">Compatibility</h3> -<div class="paragraph"> -<p>The module is based on Java 7, so it will run on Java 7 and beyond.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_installation">Installation</h3> -<div class="paragraph"> -<p>To activate configuration <em>validation</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="Validation">Tamaya Validation: Validating Configuration (Extension Module)</h2> + <div class="sectionbody"> + <div class="paragraph"> + <p>Tamaya <em>Validation</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="_overview">Overview</h3> + <div class="paragraph"> + <p>Tamaya <em>Validation</em> adds support to validate a configuration against a set of rules defined in a Tamaya Metaconfiguration XML file.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_compatibility">Compatibility</h3> + <div class="paragraph"> + <p>The module is based on Java 7, so it will run on Java 7 and beyond.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_installation">Installation</h3> + <div class="paragraph"> + <p>To activate configuration <em>validation</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-validation</artifactId> <version>{tamaya_version}</version> -</dependency></code></pre> -</div> -</div> -<div class="paragraph"> -<p>The component will extend Tamaya’s tamaya-metamodel module and adds an additional meta provider ruleset -so validation rules can also be added to the default meta configuration XML file as separate sections.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_usage">Usage</h3> -<div class="paragraph"> -<p>This module expects meta-configuration to be located at the following locations. Hereby multiple files -are supported:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-text" data-lang="text">-Dtamaya-validation=<an URL> // any resolvable URL +</dependency></code></pre> + </div> + </div> + <div class="paragraph"> + <p>The component will extend Tamayaâs tamaya-metamodel module and adds an additional meta provider ruleset so validation rules can also be added to the default meta configuration XML file as separate sections.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_usage">Usage</h3> + <div class="paragraph"> + <p>This module expects meta-configuration to be located at the following locations. Hereby multiple files are supported:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-text" data-lang="text">-Dtamaya-validation=<an URL> // any resolvable URL ./tamaya-validation-*.xml // file -META-INF/tamaya-validation-*.xml // classpath (multiple entries-possible)</code></pre> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="_the_validation_xml_format">The Validation XML Format</h3> -<div class="paragraph"> -<p>The configuration validation is defined by simple configuration meta-data entries.</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><configuration-validation> +META-INF/tamaya-validation-*.xml // classpath (multiple entries-possible)</code></pre> + </div> + </div> + </div> + <div class="sect2"> + <h3 id="_the_validation_xml_format">The Validation XML Format</h3> + <div class="paragraph"> + <p>The configuration validation is defined by simple configuration meta-data entries.</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-xml" data-lang="xml"><configuration-validation> ... <provider>The Validation Provider</provider> <!-- optional --> <section name="org.mycompany"> @@ -211,58 +208,37 @@ META-INF/tamaya-validation-*.xml // classpath (multiple entries-possible)</code </section> </section> <validator class="a,b,c,MyGlobalValidator"/> -</configuration-validation></code></pre> -</div> -</div> -<div class="sect3"> -<h4 id="_the_example_explained">The Example Explained</h4> -<div class="ulist"> -<ul> -<li> -<p>The <strong>provider</strong> entry is used for generating validation message, when a validation fails.</p> -</li> -<li> -<p>Section itself can be recursively defined, where each level can have it’s own validations.</p> -</li> -<li> -<p>Sections added, but without validation rules are <em>defined</em> section. Configuration outside of -defined sections can be flagged out using WARNING messages.</p> -</li> -<li> -<p>Sections can be <em>reuired</em> and additionally also <em>validated</em>.</p> -</li> -<li> -<p>There is also the possibility to register global validators, which are called by the validation -logic once a configuration has been completely loaded.</p> -</li> -</ul> -</div> -<div class="paragraph"> -<p>Similar to sections also parameters can be validated:</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>they can be marked as <em>required</em></p> -</li> -<li> -<p>they can have a certain type, meaning they must be convertible to the given type</p> -</li> -<li> -<p>they can have an additional custom validator.</p> -</li> -<li> -<p>they can have an optional description for error analysis and error output.</p> -</li> -</ul> -</div> -<div class="paragraph"> -<p>Similar to section parameters that are not defined, but encountered may be flagged out with -a WARNING message.</p> -</div> -</div> -</div> -</div> +</configuration-validation></code></pre> + </div> + </div> + <div class="sect3"> + <h4 id="_the_example_explained">The Example Explained</h4> + <div class="ulist"> + <ul> + <li> <p>The <strong>provider</strong> entry is used for generating validation message, when a validation fails.</p> </li> + <li> <p>Section itself can be recursively defined, where each level can have itâs own validations.</p> </li> + <li> <p>Sections added, but without validation rules are <em>defined</em> section. Configuration outside of defined sections can be flagged out using WARNING messages.</p> </li> + <li> <p>Sections can be <em>reuired</em> and additionally also <em>validated</em>.</p> </li> + <li> <p>There is also the possibility to register global validators, which are called by the validation logic once a configuration has been completely loaded.</p> </li> + </ul> + </div> + <div class="paragraph"> + <p>Similar to sections also parameters can be validated:</p> + </div> + <div class="ulist"> + <ul> + <li> <p>they can be marked as <em>required</em></p> </li> + <li> <p>they can have a certain type, meaning they must be convertible to the given type</p> </li> + <li> <p>they can have an additional custom validator.</p> </li> + <li> <p>they can have an optional description for error analysis and error output.</p> </li> + </ul> + </div> + <div class="paragraph"> + <p>Similar to section parameters that are not defined, but encountered may be flagged out with a WARNING message.</p> + </div> + </div> + </div> + </div> </div></p> <hr /> @@ -274,8 +250,8 @@ a WARNING message.</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/extensions/mod_vertx.html ---------------------------------------------------------------------- diff --git a/documentation/extensions/mod_vertx.html b/documentation/extensions/mod_vertx.html index 061a364..68c0bfb 100644 --- a/documentation/extensions/mod_vertx.html +++ b/documentation/extensions/mod_vertx.html @@ -125,82 +125,75 @@ <h1>Apache Tamaya - Extension: Integration for Vertx</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="JNDI">Integration with Vertx (Extension Module)</h2> -<div class="sectionbody"> -<div class="paragraph"> -<p>Tamaya <em>JNDI</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>Vertx</em> provides configuration services that can be used in a Vertx environment:</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>AbstractConfiguredVerticle defines a subclass extending AbstractVerticle, which allows you to -use Tamaya Injection API.</p> -</li> -<li> -<p>Additionally you deply a ConfigVerticle, which registers services to access configuration -using asynchronous event bus.</p> -</li> -</ul> -</div> -</div> -<div class="sect2"> -<h3 id="_compatibility">Compatibility</h3> -<div class="paragraph"> -<p>The module requires Java 8, so it will not run on Java 7.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_installation">Installation</h3> -<div class="paragraph"> -<p>To use Tamaya’s <em>Vertx</em> 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="JNDI">Integration with Vertx (Extension Module)</h2> + <div class="sectionbody"> + <div class="paragraph"> + <p>Tamaya <em>JNDI</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>Vertx</em> provides configuration services that can be used in a Vertx environment:</p> + </div> + <div class="ulist"> + <ul> + <li> <p>AbstractConfiguredVerticle defines a subclass extending AbstractVerticle, which allows you to use Tamaya Injection API.</p> </li> + <li> <p>Additionally you deply a ConfigVerticle, which registers services to access configuration using asynchronous event bus.</p> </li> + </ul> + </div> + </div> + <div class="sect2"> + <h3 id="_compatibility">Compatibility</h3> + <div class="paragraph"> + <p>The module requires Java 8, so it will not run on Java 7.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_installation">Installation</h3> + <div class="paragraph"> + <p>To use Tamayaâs <em>Vertx</em> 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-vertx-alpha</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="admonitionblock note"> -<table> -<tr> -<td class="icon"> -<div class="title">Note</div> -</td> -<td class="content"> -This module is in alpha state. Please give feedback via our JIRA, so we can improve it. -</td> -</tr> -</table> -</div> -<div class="sect3"> -<h4 id="_extending_abstractconfiguredverticle">Extending AbstractConfiguredVerticle</h4> -<div class="paragraph"> -<p>Main artifact is the AbstractConfiguredVerticle class, which implements a -base verticle class for Vertx:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">public abstract class AbstractConfiguredVerticle extends AbstractVerticle{ +</dependency></code></pre> + </div> + </div> + </div> + <div class="sect2"> + <h3 id="_the_functionality_provided">The Functionality Provided</h3> + <div class="admonitionblock note"> + <table> + <tbody> + <tr> + <td class="icon"> + <div class="title"> + Note + </div> </td> + <td class="content"> This module is in alpha state. Please give feedback via our JIRA, so we can improve it. </td> + </tr> + </tbody> + </table> + </div> + <div class="sect3"> + <h4 id="_extending_abstractconfiguredverticle">Extending AbstractConfiguredVerticle</h4> + <div class="paragraph"> + <p>Main artifact is the AbstractConfiguredVerticle class, which implements a base verticle class for Vertx:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">public abstract class AbstractConfiguredVerticle extends AbstractVerticle{ private Configuration configuration; @@ -228,28 +221,24 @@ base verticle class for Vertx:</p> protected final String getConfigPropertyOrDefault(String key, String defaultValue); protected final <T> T getConfigProperty(String key, Class<T> type); protected final <T> T getConfigPropertyOrDefault(String key, Class<T> type, T defaultValue); -}</code></pre> -</div> -</div> -<div class="paragraph"> -<p>Using this verticle as a superclass, provides you</p> -</div> -<div class="ulist"> -<ul> -<li> -<p>embedded convenience methods for programmatic configuration access (getConfigProperty* methods).</p> -</li> -<li> -<p>support for configuration injection based on <a href="../mod_injection.html">Tamaya’s injection API</a>.</p> -</li> -</ul> -</div> -<div class="paragraph"> -<p>The following code snippet gives you an example, what you can do with this functionality:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">public cllass MyVerticle extends AbstractConfiguredVerticle{ +}</code></pre> + </div> + </div> + <div class="paragraph"> + <p>Using this verticle as a superclass, provides you</p> + </div> + <div class="ulist"> + <ul> + <li> <p>embedded convenience methods for programmatic configuration access (getConfigProperty* methods).</p> </li> + <li> <p>support for configuration injection based on <a href="../mod_injection.html">Tamayaâs injection API</a>.</p> </li> + </ul> + </div> + <div class="paragraph"> + <p>The following code snippet gives you an example, what you can do with this functionality:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">public cllass MyVerticle extends AbstractConfiguredVerticle{ @Override public void start(){ @@ -258,15 +247,15 @@ base verticle class for Vertx:</p> BigDecimal bd = getConfigureddPropertyOrDefault("MyNum", BigDecimal.ZERO); [...] } -}</code></pre> -</div> -</div> -<div class="paragraph"> -<p>As menioned you can also use the injection API:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">public cllass MyVerticle extends AbstractConfiguredVerticle{ +}</code></pre> + </div> + </div> + <div class="paragraph"> + <p>As menioned you can also use the injection API:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">public cllass MyVerticle extends AbstractConfiguredVerticle{ @Config("myKey") private String configuredValue; @@ -279,18 +268,18 @@ base verticle class for Vertx:</p> public void start(){ [...] } -}</code></pre> -</div> -</div> -</div> -<div class="sect3"> -<h4 id="_accessing_configuration_using_the_vertx_event_bus">Accessing Configuration using the Vertx event bus</h4> -<div class="paragraph"> -<p>Additionally the extension allows to access configuration values from the event bus:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">@Override +}</code></pre> + </div> + </div> + </div> + <div class="sect3"> + <h4 id="_accessing_configuration_using_the_vertx_event_bus">Accessing Configuration using the Vertx event bus</h4> + <div class="paragraph"> + <p>Additionally the extension allows to access configuration values from the event bus:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">@Override public void start(){ // the selector allows to apply a regex on the configuration key to select a // a configuration sub set. @@ -308,15 +297,15 @@ public void start(){ // do something with the config // ... } - });</code></pre> -</div> -</div> -<div class="paragraph"> -<p>Similar only single values can be accessed:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">@Override + });</code></pre> + </div> + </div> + <div class="paragraph"> + <p>Similar only single values can be accessed:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">@Override public void start(){ vertx().eventBus().send( "CONFIG-VAL", // event bus address @@ -328,25 +317,24 @@ public void start(){ // do something with the config value // ... } - });</code></pre> -</div> -</div> -<div class="paragraph"> -<p>Finally the event bus targets to be used can be configured using Tamaya configuration, -see the code snippet from the implementation:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">@Config(value = "tamaya.vertx.config.map", defaultValue = "CONFIG-MAP") + });</code></pre> + </div> + </div> + <div class="paragraph"> + <p>Finally the event bus targets to be used can be configured using Tamaya configuration, see the code snippet from the implementation:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">@Config(value = "tamaya.vertx.config.map", defaultValue = "CONFIG-MAP") private String mapBusTarget; @Config(value = "tamaya.vertx.config.value", defaultValue = "CONFIG-VAL") -private String valBusTarget;</code></pre> -</div> -</div> -</div> -</div> -</div> +private String valBusTarget;</code></pre> + </div> + </div> + </div> + </div> + </div> </div></p> <hr /> @@ -358,8 +346,8 @@ private String valBusTarget;</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/extensions/mod_yaml.html ---------------------------------------------------------------------- diff --git a/documentation/extensions/mod_yaml.html b/documentation/extensions/mod_yaml.html index 041f669..2bbd058 100644 --- a/documentation/extensions/mod_yaml.html +++ b/documentation/extensions/mod_yaml.html @@ -125,71 +125,69 @@ <h1>Apache Tamaya - Extension: Builder</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="YAML">Tamaya YAML (Extension Module)</h2> -<div class="sectionbody"> -<div class="paragraph"> -<p>Tamaya <em>YAML</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="_overview">Overview</h3> -<div class="paragraph"> -<p>Tamaya <em>YAML</em> provides support for reading configuration using the YAML format (yaml.org). YAML hereby -use intendation for expressing hierarchy, which makes yaml configuration files very easily readable and compact.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_compatibility">Compatibility</h3> -<div class="paragraph"> -<p>The YAML module is based on Java 7, so it will run on Java 7 and beyond.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_installation">Installation</h3> -<div class="paragraph"> -<p>To use YAML as configuration format you 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="YAML">Tamaya YAML (Extension Module)</h2> + <div class="sectionbody"> + <div class="paragraph"> + <p>Tamaya <em>YAML</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="_overview">Overview</h3> + <div class="paragraph"> + <p>Tamaya <em>YAML</em> provides support for reading configuration using the YAML format (yaml.org). YAML hereby use intendation for expressing hierarchy, which makes yaml configuration files very easily readable and compact.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_compatibility">Compatibility</h3> + <div class="paragraph"> + <p>The YAML module is based on Java 7, so it will run on Java 7 and beyond.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_installation">Installation</h3> + <div class="paragraph"> + <p>To use YAML as configuration format you 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-yaml</artifactId> <version>{tamaya_version}</version> -</dependency></code></pre> -</div> -</div> -<div class="paragraph"> -<p>This extension also transitively requires the tamaya.formats module.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_reading_configuration_in_yaml">Reading configuration in YAML</h3> -<div class="paragraph"> -<p>For reading YAML based onfiguration most easily a YAMLFormat can be provided:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-java" data-lang="java">PropertySource ps = ConfigurationFormats.createPropertySource( - getClassLoader().getResource("myFileConfig.yaml"), new YAMLFormat()));</code></pre> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="_examples">Examples</h3> -<div class="paragraph"> -<p>The YAML module adds instances of ConfigurationFormat so YAML configuration can be read and mapped to the -according property values. E.g. the following file is a simple and correct YAML configuration:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-yaml" data-lang="yaml">invoice: 34843 +</dependency></code></pre> + </div> + </div> + <div class="paragraph"> + <p>This extension also transitively requires the tamaya.formats module.</p> + </div> + </div> + <div class="sect2"> + <h3 id="_reading_configuration_in_yaml">Reading configuration in YAML</h3> + <div class="paragraph"> + <p>For reading YAML based onfiguration most easily a YAMLFormat can be provided:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-java" data-lang="java">PropertySource ps = ConfigurationFormats.createPropertySource( + getClassLoader().getResource("myFileConfig.yaml"), new YAMLFormat()));</code></pre> + </div> + </div> + </div> + <div class="sect2"> + <h3 id="_examples">Examples</h3> + <div class="paragraph"> + <p>The YAML module adds instances of ConfigurationFormat so YAML configuration can be read and mapped to the according property values. E.g. the following file is a simple and correct YAML configuration:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-yaml" data-lang="yaml">invoice: 34843 date : 2001-01-23 bill-to: &id001 given : Chris @@ -216,15 +214,15 @@ total: 4443.52 comments: Late afternoon is best. Backup contact is Nancy - Billsmer @ 338-4338.</code></pre> -</div> -</div> -<div class="paragraph"> -<p>Hereby the above file, by default is mapped as follows into Map<String,String> typed properties:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="prettyprint highlight"><code class="language-listing" data-lang="listing">invoice -> 34843 + Billsmer @ 338-4338.</code></pre> + </div> + </div> + <div class="paragraph"> + <p>Hereby the above file, by default is mapped as follows into Map<String,String> typed properties:</p> + </div> + <div class="listingblock"> + <div class="content"> + <pre class="prettyprint highlight"><code class="language-listing" data-lang="listing">invoice -> 34843 date -> Tue Jan 23 01:00:00 CET 2001 bill-to.family -> Dumars bill-to.given -> Chris @@ -247,11 +245,11 @@ _product.collection-type -> List tax -> 251.42 total -> 4443.52 -comments -> Late afternoon is best. Backup contact is Nancy Billsmer @ 338-4338.</code></pre> -</div> -</div> -</div> -</div> +comments -> Late afternoon is best. Backup contact is Nancy Billsmer @ 338-4338.</code></pre> + </div> + </div> + </div> + </div> </div></p> <hr /> @@ -263,8 +261,8 @@ comments -> Late afternoon is best. Backup contact is Nancy Billsmer @ 338-43 <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>
