You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tamaya.apache.org by bu...@apache.org on 2015/03/03 12:42:22 UTC
svn commit: r942129 - in /websites/staging/tamaya/trunk/content: ./
documentation.html modules.html quickstart.html
Author: buildbot
Date: Tue Mar 3 11:42:22 2015
New Revision: 942129
Log:
Staging update by buildbot for tamaya
Modified:
websites/staging/tamaya/trunk/content/ (props changed)
websites/staging/tamaya/trunk/content/documentation.html
websites/staging/tamaya/trunk/content/modules.html
websites/staging/tamaya/trunk/content/quickstart.html
Propchange: websites/staging/tamaya/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Mar 3 11:42:22 2015
@@ -1 +1 @@
-1663641
+1663674
Modified: websites/staging/tamaya/trunk/content/documentation.html
==============================================================================
--- websites/staging/tamaya/trunk/content/documentation.html (original)
+++ websites/staging/tamaya/trunk/content/documentation.html Tue Mar 3 11:42:22 2015
@@ -82,30 +82,40 @@
</div>
<div class="toc">
<ul>
-<li><a href="#sources">Sources</a></li>
-<li><a href="#format">Format</a></li>
+<li><a href="#available-documentation">Available Documentation</a></li>
+<li><a href="#enhancing-documentation">Enhancing Documentation</a><ul>
+<li><a href="#documentation-sources">Documentation Sources</a></li>
+<li><a href="#documentation-format">Documentation Format</a></li>
<li><a href="#rendering-documentation-as-html">Rendering documentation as HTML</a></li>
<li><a href="#contribute">Contribute</a></li>
<li><a href="#publish-procedure-for-committers-only">Publish procedure (for committers only)</a></li>
</ul>
+</li>
+</ul>
</div>
<hr />
-<h1 id="sources">Sources</h1>
-<p><a href="/documentation/">Tamaya Documentation</a> is available with <a href="documentation/source.html">Tamaya Source</a>.</p>
-<h1 id="format">Format</h1>
-<p>The format used for Tamaya documentation is <a href="http://www.methods.co.nz/asciidoc/">ASCIIDOC</a> because it's easily exportable to PDF, HTML, and it's also easy to contribute. It can be used to export also to epub and also be used to write books</p>
-<h1 id="rendering-documentation-as-html">Rendering documentation as HTML</h1>
+<h1 id="available-documentation">Available Documentation</h1>
+<p>The current project documentation can be found <a href="documentation/index.html">here</a>.</p>
+<h1 id="enhancing-documentation">Enhancing Documentation</h1>
+<h2 id="documentation-sources">Documentation Sources</h2>
+<p>The documentation is managed as part of the <a href="source.html">Tamaya Source</a></p>
+<h2 id="documentation-format">Documentation Format</h2>
+<p>The format used for Tamaya documentation is <a href="http://www.methods.co.nz/asciidoc/">ASCIIDOC</a> because it's easily
+exportable to PDF, HTML, and it's also easy to contribute. It can be used to export also to epub and also be used to
+write books</p>
+<h2 id="rendering-documentation-as-html">Rendering documentation as HTML</h2>
<p><em>Requirenment:</em> Have <a href="http://maven.apache.org/">Maven</a> installed.</p>
<p>If you cloned the source repository and want to render the documentation as HTML, you just need to run the following command:</p>
-<div class="codehilite"><pre>$ <span class="n">cd</span> <span class="n">REPO_ROOT</span><span class="o">/</span><span class="n">documentation</span>
+<div class="codehilite"><pre>$ <span class="n">cd</span> <span class="n">REPO_ROOT</span><span class="o">/</span><span class="n">docs</span>
$ <span class="n">mvn</span> <span class="n">site</span>
</pre></div>
-<p>The generate documentation will be available at <code>REPO_ROOT/documentation/target/site</code></p>
-<h1 id="contribute">Contribute</h1>
-<p>If you would like to submit a documentation patch through Jira, you can have a look at the <a href="suggested-git-workflows.html">suggested approach</a>.</p>
-<h1 id="publish-procedure-for-committers-only">Publish procedure (for committers only)</h1>
+<p>The generate documentation will be available at <code>REPO_ROOT/docs/target/site</code></p>
+<h2 id="contribute">Contribute</h2>
+<p>If you would like to submit a documentation patch through Jira, you can have a look at the
+<a href="suggested-git-workflows.html">suggested approach</a>.</p>
+<h2 id="publish-procedure-for-committers-only">Publish procedure (for committers only)</h2>
<p>If you're a committer and want to publish the documentation at <a href="http://tamaya.incubator.apache.org/documentation/">Tamaya Site</a>
you have do the following steps:</p>
<ol>
Modified: websites/staging/tamaya/trunk/content/modules.html
==============================================================================
--- websites/staging/tamaya/trunk/content/modules.html (original)
+++ websites/staging/tamaya/trunk/content/modules.html Tue Mar 3 11:42:22 2015
@@ -108,45 +108,47 @@
<h1 id="overview">Overview</h1>
<p>Tamaya has a modular design comprising the following parts:</p>
<ul>
-<li>Tamaya contains a complete <strong>API</strong> with interfaces for <em>Configuration, ConfigurationProvider,
- ConfigOperator, ConfigQuery, PropertyConverter, TypeLiteral, ConfigException</em></li>
+<li>Tamaya contains a <strong>API</strong> with artifacts such as <strong>Configuration, ConfigurationProvider,
+ ConfigOperator, ConfigQuery, PropertyConverter, TypeLiteral, ConfigException</strong></li>
<li>Besides the API Tamaya defines an <strong>SPI</strong>, which provides powerful extension mechanisms with artifacts such as
<strong>ConfigurationContext, ConfigurationContextBuilder, ConfigurationProviderSpi, PropertyFilter, PropertySource,
PropertySourceProvider, PropertyValueCombinationPolicy, ServiceContext, ServiceContextManager</strong>.</li>
-<li>The <strong>Core</strong> contains a small and minimal implementation of the API that contains everything needed for SE based use cases.</li>
-<li>
-<p>The <strong>Modules</strong> are planned to contain extensions (based on the API, no dependencies to Core) to
- <strong> provide injection mechanism for configuration (injection)
- </strong> provide support for dynamic placeholders and custom resolvers (resolver)
- <strong> provide mechanism to declaratively lookup resources in the filesystem and the classpath (resources)
- </strong> event mechanism for modelling and propagating configuration changes (events)
- <strong> define a common model for decoupling formatting from building up concrete property sources (formats)
- </strong> enrich Tamaya with an extendible environment model (environment)
- <strong> provide more complex met-configuration schemes, e.g. for OSGI, Java EE and other runtime container technologies.
- </strong> integrate Tamaya with other frameworks such as Apache Commons Configuration, Spring and Java EE, CDI.
- ** and possibly more...</p>
-</li>
-<li>
-<p>The <strong>Documentation</strong> module contains overall documentations in <em>asciidoc</em> .</p>
-</li>
+<li>The <strong>Core</strong> contains a small and minimal implementation of the API that contains everything needed for SE based use
+ cases.</li>
+<li>The <strong>Modules</strong> are extensions (based on the API) providing different functionality such as
+ <strong> a configuration injection mechanism, including an injection SPI (</strong>tamaya-injection<strong>).
+ </strong> support for dynamic placeholders and resolvers, including a resolver API (<strong>tamaya-resolver</strong>).
+ <strong> a mechanism to declaratively lookup resources on the filesystem and the classpath (</strong>tamaya-resources<strong>)
+ </strong> an event mechanism for modelling and propagating configuration changes (<strong>tamaya-events</strong>)
+ <strong> a common model for decoupling formatting from building up concrete property sources (</strong>tamaya-formats<strong>)
+ </strong> an extendible environment model (tamaya-environment)
+ <strong> preconfigured more complex configuration schemes, e.g. for OSGI, Java EE and other runtime container technologies.
+ </strong> integrate of Tamaya with other frameworks such as Apache Commons Configuration, Spring and Java EE, CDI.
+ ** and more...</li>
+</ul>
+<p>NOTE: This modules are published based on the individual maturity. Check the release notes, which modules are part
+of a <em>Tamaya</em> release and which not.</p>
+<ul>
+<li>Finally the dhe <strong>Documentation</strong> module contains overall documentations in <em>asciidoc</em> .</li>
</ul>
<h1 id="api">API</h1>
-<p>The <em>API</em> models a complete Java SE API for configuration. It is possible to implement an application completely
-against this API. Nevertheless the API is minimalistic and many users will add additional extensions for additional
-comfort. The API is available from Maven central as</p>
-<div class="codehilite"><pre><span class="nt"><dependency></span>
- <span class="nt"><artifactId></span>org.apache.tamaya<span class="nt"></id></span>
- <span class="nt"><artifactId></span>tamaya-api<span class="nt"></artifactId></span>
- <span class="nt"><version><CURRENT_VERSION></version></span>
-<span class="nt"></dependency></span>
+<p>The <strong>API</strong> models a complete Java SE API for configuration. It is possible to implement an application completely
+against this API only. The API takes about 20k of disk space (Java 8) and is available from Maven central as</p>
+<div class="codehilite"><pre> <span class="nt"><dependency></span>
+ <span class="nt"><artifactId></span>org.apache.tamaya<span class="nt"></id></span>
+ <span class="nt"><artifactId></span>tamaya-api<span class="nt"></artifactId></span>
+ <span class="nt"><version><CURRENT_VERSION></version></span>
+ <span class="nt"></dependency></span>
</pre></div>
+<p>Nevertheless the API is also minimalistic and many users will wish more functionality available. This is where
+so called <em>Tamaya</em> extensions come into the place (see later).</p>
<h1 id="core">Core</h1>
<p>The Core module implements the API based on Java SE and provides additional features as useful.
-The Core part hereby does <em>not have any external dependencies</em>, beside the API. So it can be directly
-accessed and consumed as artifact:</p>
-<p>Put the following information in your pom.xml file</p>
+The Core part hereby does <em>not have any external dependencies</em>, beside the API and also only takes about 70k of space.
+So with the API less than 100k of space is needed for configuring your application.
+Put the following information in your pom.xml file</p>
<div class="codehilite"><pre><span class="nt"><dependency></span>
<span class="nt"><artifactId></span>org.apache.tamaya<span class="nt"></id></span>
<span class="nt"><artifactId></span>tamaya-core<span class="nt"></artifactId></span>
@@ -155,7 +157,7 @@ accessed and consumed as artifact:</p>
</pre></div>
-<p>The core modules out of the box supports _.properties files
+<p>The core modules out of the box supports <em>.properties</em> files
as valid input formats. It is capable of reading configuration resources from</p>
<ul>
<li>the classpath</li>
@@ -179,17 +181,17 @@ companies:</p>
<li>Configuration Context (in relation to the current <em>Environment</em>)</li>
<li>... (and more)</li>
</ul>
-<p>By default <em>Tamaya</em> implicitly registers and loads a <strong>simple</strong> meta-model by default, which is as follows
-(first sources have lower priority):</p>
+<p>Nevertheless, by default, <em>Tamaya</em> registers and loads a <strong>simple</strong> configuration meta-model by default, which is as
+follows (first sources have lower priority):</p>
<ul>
<li><strong>Default entries:</strong> META-INF/cfg/default-config.properties</li>
<li><strong>Explicit entries:</strong> META-INF/cfg/config.properties</li>
<li><strong>System Properties</strong></li>
-<li><strong>Environment Properties</strong>, mapped to <em>env.*</em></li>
+<li><strong>Environment Properties</strong>, mapped to <em>env.*</em>
+The_.properties_ format hereby is as defined by <em>java.util.Properties</em>.</li>
</ul>
-<p>By default <em>.properties</em> and <em>.xml</em> (properties) formats as defined by <em>java.util.Properties</em> are supported.</p>
<h1 id="modules">Modules</h1>
-<p>Tamaya ships with several extension modules that provide additional APIs or integration functionality. The
+<p>Tamaya ships with several extension modules that provide additional APIs, SPIs or integration functionality. The
most important ones are shortly listed in this section.</p>
<h2 id="configuration-injection">Configuration Injection</h2>
<p>Now with JSR 299/330 we all are aware of inversion of control and dependency injection as a very elegant way to resolve
@@ -247,17 +249,7 @@ annotations on your template and let <em
<p>Integrations adapt <em>Tamaya</em> for being interoperable with other solutions, or on the other way round
existing configuration solutions can transparently hooked into <em>Tamaya</em>.</p>
<h3 id="cdi-integration">CDI Integration</h3>
-<p>When using CDI configuration injection can be provided by simply adding the following library
-to your classpath:</p>
-<div class="codehilite"><pre><span class="nt"><dependency></span>
- <span class="nt"><artifactId></span>org.apache.tamaya.integration<span class="nt"></id></span>
- <span class="nt"><artifactId></span>tamaya-cdi<span class="nt"></artifactId></span>
- <span class="nt"><version><CURRENT_VERSION></version></span>
-<span class="nt"></dependency></span>
-</pre></div>
-
-
-<p>Additionally <em>Configuration</em> and also other artifacts are known by CDI and can be injected.</p>
+<p>Planned for the future.</p>
<h3 id="spring-integration">Spring Integration</h3>
<p>Planned for the future.</p>
<h3 id="apache-commons-configuration-integration">Apache Commons Configuration Integration</h3>
@@ -298,7 +290,7 @@ counterpart:</p>
<h3 id="java-ee-base-meta-model">Java EE Base Meta-Model</h3>
<p>Planned for the future.</p>
<h2 id="environment-module">Environment Module</h2>
-<p>There is an experimaental <em>Environment</em> available, but not yet as a mature module ready to use.</p>
+<p>Planned for the future.</p>
</div>
</div>
Modified: websites/staging/tamaya/trunk/content/quickstart.html
==============================================================================
--- websites/staging/tamaya/trunk/content/quickstart.html (original)
+++ websites/staging/tamaya/trunk/content/quickstart.html Tue Mar 3 11:42:22 2015
@@ -119,7 +119,7 @@ following configuration model (most sign
<h1 id="adding-additional-features">Adding additional features</h1>
-<p>Depenending on your likingy you may add additional extensions such as:</p>
+<p>Depenending on your liking you may add additional extensions such as:</p>
<h2 id="dynamic-resolution-and-value-placeholders">Dynamic Resolution and Value Placeholders</h2>
<div class="codehilite"><pre><span class="nt"><dependency></span>
<span class="nt"><artifactId></span>org.apache.tamaya.ext<span class="nt"></id></span>
@@ -130,7 +130,13 @@ following configuration model (most sign
<p>With that it is possible to define values with Unix styled placeholders that are resolved on configuration access,
-e.g. <em>mykey=my${dynamicValue}</em>. For further details refer to the module documentation.</p>
+e.g. <em>mykey=my${dynamicValue}</em>. For further details refer to the module documentation. This module also provides
+a <em>Resolver</em> singleton:</p>
+<div class="codehilite"><pre><span class="n">String</span> <span class="n">myExpression</span> <span class="p">=</span> <span class="p">...;</span>
+<span class="n">String</span> <span class="n">resolved</span> <span class="p">=</span> <span class="n">Resolver</span><span class="p">.</span><span class="n">evaluateExpression</span><span class="p">(</span><span class="n">myExpression</span><span class="p">);</span>
+</pre></div>
+
+
<h2 id="ant-styled-path-resolution-of-resources">Ant-styled Path Resolution of Resources</h2>
<div class="codehilite"><pre><span class="nt"><dependency></span>
<span class="nt"><artifactId></span>org.apache.tamaya.ext<span class="nt"></id></span>
@@ -140,7 +146,7 @@ e.g. <em>mykey=my${dynamicValue}</em>. F
</pre></div>
-<p>This module provides a <em>ResourceResolver</em> service that allows to resolve configuration resources using a ant-styled
+<p>This module provides a <em>Resolver</em> singleton that allows to resolve configuration resources using a ant-styled
resource description, e.g.</p>
<div class="codehilite"><pre><span class="n">Collection</span><span class="o"><</span><span class="n">URL</span><span class="o">></span> <span class="n">urls</span> <span class="p">=</span> <span class="n">ResourceResolver</span><span class="p">.</span><span class="n">getResources</span><span class="p">(</span>"<span class="n">META</span><span class="o">-</span><span class="n">INF</span><span class="o">/</span><span class="n">cfg</span><span class="o">/**/*</span><span class="p">.</span><span class="k">properties</span>"<span class="p">);</span>
</pre></div>
@@ -171,7 +177,7 @@ corresponding configuration:</p>
<p>}</p>
<p>MyType type = new MyType();
- ConfigurationInjector.injectConfiguration(type);</p>
+ ConfigurationInjector.configure(type);</p>
<p>Or the same as template:</p>
<p>public interface MyTypeTemplate{</p>
<div class="codehilite"><pre> <span class="p">@</span><span class="n">ConfiguredProperty</span><span class="p">(</span>"<span class="n">name</span>"<span class="p">)</span>