tamaya-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From anat...@apache.org
Subject incubator-tamaya-site git commit: Improved docs.
Date Fri, 10 Feb 2017 20:58:23 GMT
Repository: incubator-tamaya-site
Updated Branches:
  refs/heads/master 1e0c1c8f7 -> 9d5fb59c8


Improved docs.


Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/commit/9d5fb59c
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/tree/9d5fb59c
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/diff/9d5fb59c

Branch: refs/heads/master
Commit: 9d5fb59c87b1e8ed141f48e349fce7a6060b3bfe
Parents: 1e0c1c8
Author: anatole <anatole@apache.org>
Authored: Fri Feb 10 21:58:05 2017 +0100
Committer: anatole <anatole@apache.org>
Committed: Fri Feb 10 21:58:18 2017 +0100

----------------------------------------------------------------------
 content/documentation/extensions.adoc           |  45 +++----
 content/documentation/extensions/mod_camel.adoc |   2 +-
 content/documentation/extensions/mod_cdi.adoc   | 116 +++++++++++--------
 .../extensions/mod_classloader_support.adoc     |   7 +-
 .../extensions/mod_collections.adoc             |  33 ++++--
 .../documentation/extensions/mod_consul.adoc    |  24 ++--
 .../extensions/mod_environment.adoc             |  45 -------
 content/documentation/extensions/mod_etcd.adoc  |  37 +++---
 8 files changed, 152 insertions(+), 157 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/9d5fb59c/content/documentation/extensions.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions.adoc b/content/documentation/extensions.adoc
index fb5a144..31af83e 100644
--- a/content/documentation/extensions.adoc
+++ b/content/documentation/extensions.adoc
@@ -11,8 +11,8 @@ Mature extensions have a stable API and SPI, similar to the API and Implementati
 
 [width="100%",frame="1",options="header",grid="all"]
 |=======
-|_Artifact_                                 |_Description_                              
 |_Links_
-|                                           | N/A: currently no extensions have reached that
maturity level.  | -
+|_Artifact_                                   |_Description_                            
   |_Links_
+|                                             | N/A: currently no extensions have reached
that maturity level.  | -
 |+org.apache.tamaya.ext:tamaya-formats+       |Provides an abstract model for configuration
formats   |link:extensions/mod_formats.html[Documentation]
 |+org.apache.tamaya.ext:tamaya-functions+     |Provides several functional extension points.
         |link:extensions/mod_functions.html[Documentation]
 |+org.apache.tamaya.ext:tamaya-json+          |Provides format support for JSON based configuration.
 |link:extensions/mod_json.html[Documentation]
@@ -29,36 +29,37 @@ Mature extensions have a stable API and SPI, similar to the API and Implementati
 |+org.apache.tamaya.ext:tamaya-resources+     |Provides ant-style resource path resolution
 |link:extensions/mod_resources.html[Documentation]
 |+org.apache.tamaya.ext:tamaya-yaml+          |Support for using yaml as a configuration
format.      |link:extensions/mod_yaml.html[Documentation]
 |+org.apache.tamaya.ext:tamaya-collections+   |Collections support.                     
             |link:extensions/mod_collections.html[Documentation]
-|+org.apache.tamaya.ext:tamaya-spring+      | Integration for Spring / Spring Boot.     
  | link:extensions/mod_spring.html[Documentation]
+|+org.apache.tamaya.ext:tamaya-spring+        | Integration for Spring / Spring Boot.   
    | link:extensions/mod_spring.html[Documentation]
 |=======
 
 NOTE: The former Tamaya _Builder_ extension module has been removed. The corresponding methods
were integrated into
-Tamaya's main API's +ConfigurationContextBuilder+ API.
+Tamaya's main API's +ConfigurationContextBuilder+ interface.
 
 === Extensions Sandbox
 
 Extensions in _draft state_ rather experimental or not yet very mature. API changes may occurr
at any time
-and the may also have severe issues. So use at your own risk or join and help us getting
them stable and
-well tested!
+and the may also have severe issues or even not work at all. So use at your own risk or join
and help
+us getting them stable and well tested!
 
 NOTE: All extensions currently run on Java 7 as well as on Java 8.
 
 [width="100%",frame="1",options="header",grid="all"]
 |=======
-|_Artifact_                                 |_Description_                              
           |_Links_
-|+org.apache.tamaya.ext:tamaya-commons+     |Combines Tamaya's Format Abstraction with Apache
Commons.  | -
-|+org.apache.tamaya.ext:tamaya-jodatime+    |Provides support for JodaTime.             
           | link:extensions/mod_jodatime.html[Documentation]
-|+org.apache.tamaya.ext:tamaya-classloader-support+  |Manages Tamaya configuration and services
considering classloading hierarchies.  |link:extensions/mod_classloader_support.html[Documentation]
-|+org.apache.tamaya.ext:tamaya-management+  |Provides JMX support for inspecting configuration.
    |link:extensions/mod_management.html[Documentation]
-|+org.apache.tamaya.ext:tamaya-metamodel+   |Provides support defining configuration using
XML based meta-configuration.  |link:extensions/mod_metamodel-staged.html[Documentation]
-|+org.apache.tamaya.ext:tamaya-validation+  |Provides support for XML based meta-configuration
allowing to validate configuration read.  |link:extensions/mod_validation.html[Documentation]
-|+org.apache.tamaya.ext:tamaya-usagetracker+  |Provides support tracking of configuration
usage and the consumer locations consuming configuration.  |link:extensions/mod_usagetracker.html[Documentation]
-|+org.apache.tamaya.ext:tamaya-camel+       | Integration for Apache Camel.             
  | link:extensions/mod_camel.html[Documentation]
-|+org.apache.tamaya.ext:tamaya-osgi+        | Integration for OSGI containers.          
  | link:extensions/mod_osgi.html[Documentation]
-|+org.apache.tamaya.ext:tamaya-consul+      | Integration with consul clusters.         
  | link:extensions/mod_consul.html[Documentation]
-|+org.apache.tamaya.ext:tamaya-etcd+        | Integration with etcd clusters.           
  | link:extensions/mod_etcd.html[Documentation]
-|????+org.apache.tamaya.ext:tamaya-configured-sysprops+        | Allows Tamaya to integrate
with +System.getProperties()+.   | link:extensions/mod_sysprops.html[Documentation]
-|+org.apache.tamaya.ext:tamaya-remote+      |Provides remote configuration support.     
           |link:extensions/mod_remote.html[Documentation]
-|+org.apache.tamaya.ext:tamaya-server+      |Lets a Tamaya configuration instance provide
scoped configuration as a REST service.     |link:extensions/mod_server.html[Documentation]
-||????+org.apache.tamaya.ext:tamaya-ui+          |Provides a web UI for a VM running Tamaya.
   |link:extensions/mod_ui.html[Documentation]
+|_Artifact_                                 |_Description_                              
          |_Links_
+|+org.apache.tamaya.ext:tamaya-commons+     |Integration Support for Apache Commons.    
          | -
+|+org.apache.tamaya.ext:tamaya-jodatime+    |Provides support for JodaTime.             
          | link:extensions/mod_jodatime.html[Documentation]
+|+org.apache.tamaya.ext:tamaya-classloader-support+  |Configuration services considering
classloaderas. |link:extensions/mod_classloader_support.html[Documentation]
+|+org.apache.tamaya.ext:tamaya-management+  |Provides JMX support for inspecting configuration.
   |link:extensions/mod_management.html[Documentation]
+|+org.apache.tamaya.ext:tamaya-metamodel+   |Provides an XML API for building configuration.
      |link:extensions/mod_metamodel-staged.html[Documentation]
+|+org.apache.tamaya.ext:tamaya-validation+  |Provides an XML API for validating configuration.
    |link:extensions/mod_validation.html[Documentation]
+|+org.apache.tamaya.ext:tamaya-usagetracker+ |Allows tracking of configuration usage.   
          |link:extensions/mod_usagetracker.html[Documentation]
+|+org.apache.tamaya.ext:tamaya-camel+       |Integration with Apache Camel.             
          | link:extensions/mod_camel.html[Documentation]
+|+org.apache.tamaya.ext:tamaya-osgi+        |Integration with OSGI containers.          
          | link:extensions/mod_osgi.html[Documentation]
+|+org.apache.tamaya.ext:tamaya-consul+      |Integration with consul clusters.          
          | link:extensions/mod_consul.html[Documentation]
+|+org.apache.tamaya.ext:tamaya-etcd+        |Integration with etcd clusters.            
          | link:extensions/mod_etcd.html[Documentation]
+|+org.apache.tamaya.ext:tamaya-hazelcast+   |Integration with Hazelcast datagrids.      
          | link:extensions/mod_hazelcast.html[Documentation]
+|+org.apache.tamaya.ext:tamaya-configured-sysprops+  | Tamaya configuration to be provided
as +System.getProperties()+.  | link:extensions/mod_sysprops.html[Documentation]
+|+org.apache.tamaya.ext:tamaya-remote+      |Remote configuration support using the server
API.    |link:extensions/mod_remote.html[Documentation]
+|+org.apache.tamaya.ext:tamaya-server+      |Publishes configuration as a REST service. 
          |link:extensions/mod_server.html[Documentation]
+|+org.apache.tamaya.ext:tamaya-ui+          |Provides a web UI for a VM running Tamaya. 
          |link:extensions/mod_ui.html[Documentation]
 |=======

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/9d5fb59c/content/documentation/extensions/mod_camel.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_camel.adoc b/content/documentation/extensions/mod_camel.adoc
index 9255430..18a937a 100644
--- a/content/documentation/extensions/mod_camel.adoc
+++ b/content/documentation/extensions/mod_camel.adoc
@@ -36,7 +36,7 @@ To benefit from configuration builder support you only must add the correspondin
 -----------------------------------------------
 
 
-=== The Extensions Provided
+=== The Functionality Provided
 
 Camel integration comes basically with three artifacts:
 

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/9d5fb59c/content/documentation/extensions/mod_cdi.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_cdi.adoc b/content/documentation/extensions/mod_cdi.adoc
index ac9553f..b980642 100644
--- a/content/documentation/extensions/mod_cdi.adoc
+++ b/content/documentation/extensions/mod_cdi.adoc
@@ -1,7 +1,7 @@
 :jbake-type: page
 :jbake-status: published
 
-= Apache Tamaya -- Extension: Classloader Isolation Support
+= Apache Tamaya -- Extension: CDI Support
 
 toc::[]
 
@@ -11,6 +11,7 @@ toc::[]
 
 Tamaya _CDI_ is an extension module. Refer to the link:../extensions.html[extensions documentation]
for further details.
 
+
 === What functionality this module provides ?
 
 Apache Tamaya currently provides two implementations for integration with CDI extensions
implementing similar
@@ -18,6 +19,7 @@ functionality as described in this document:
 
 * Loading of CDI managed SPI components as configuration extensions such as +PropertySources,
PropertySourceProviders,
   PropertyFilters, etc+. This also includes SPI defined by any Tamaya submodules.
+  This is useful when Tamaya is used as an application module managed by the CDI implementation.
 * Implement and enable Tamaya's configuration injection services with CDI.
 
 Hereby there are two implementations provided:
@@ -32,7 +34,7 @@ Hereby there are two implementations provided:
 
 The annotations used for all injection functionality in Tamaya is defined as a separate module.
This allows you to
 code against the injection API without dependency on the concrete injection implementation.
As a consequence your
-components will be compatible regardless if deployed in a pure SE, a Java EE (CDI) or OSGI
or Spring environment:
+components will be compatible regardless if deployed in a pure SE or as Java EE (CDI) or
Spring environment:
 
 -----------------------------------------------
 <dependency>
@@ -45,7 +47,7 @@ components will be compatible regardless if deployed in a pure SE, a Java
EE (CD
 
 === Compatibility
 
-Both modules are based on Java 7, so they will not run on Java 7 and beyond.
+All modules are based on Java 7, so they will not run on Java 7 and beyond.
 
 
 === Installation
@@ -53,7 +55,7 @@ Both modules are based on Java 7, so they will not run on Java 7 and beyond.
 To benefit from Tamaya CDI integration you only must one of the following dependencies to
your module. Ensure that
 you never have installed both CDI extensions at the same time because this may be lead to
unforseen side-effects.
 
-.CDI Pure Application Configuration
+.CDI Java EE Application Configuration
 [source, xml]
 -----------------------------------------------
 <dependency>
@@ -63,7 +65,7 @@ you never have installed both CDI extensions at the same time because this
may b
 </dependency>
 -----------------------------------------------
 
-.CDI enhanced with Tamaya SE Application Configuration
+.CDI injection based on Tamaya SE Application Configuration
 [source, xml]
 -----------------------------------------------
 <dependency>
@@ -79,6 +81,61 @@ register CDI extensions that implement Configuration injection as described
befo
 IMPORTANT: Never install Tamaya's +tamaya-cdi-se+ and +tamaya-cdi-ee+ on the same system,
since unpredictable side
            effects could occur.
 
+
+For working with a pure non Java EE environment have a look at the link:mod_injection.html[tamaya-injection
module].
+
+Additionally you have to register Tamaya's CDI extension modules into your `beans-xml`:
+
+Contents of `META-INF/services/javax.enterprise.inject.spi.Extension`:
+[source, properties]
+-----------------------------------------------
+# Register Tamaya to perform injection
+org.apache.tamaya.integration.cdi.ConfigurationExtension
+-----------------------------------------------
+
+
+
+=== Annotating your Classes
+
+Basically annotating your classes is stright forward. +@Config+ defines an additional CDI
qualifier that is, depending
+on the module deployed, handled by a CDI producer (+tamaya-cdi-ee+) or the Tamaya SE injection
mechanism $
+(+tamaya-cdi-se+). All types injected by this module are injected using _dependent scope_.
+
+
+[source, java]
+--------------------------------------------------------
+@RequestScoped
+public class ConfiguredClass{
+
+    @Config
+    private String testProperty;
+
+    @Config({"a.b.c.key1","a.b.c.key2","a.b.c.key3"})
+    @ConfigDefault("The current \\${JAVA_HOME} env property is ${env:JAVA_HOME}.")
+    String value1;
+
+    @Config({"foo","a.b.c.key2"})
+    private String value2;
+
+    @Config
+    @ConfigDefault("N/A")
+    private String runtimeVersion;
+
+    @Config
+    @ConfigDefault("${sys:java.version}")
+    private String javaVersion2;
+
+    @Config
+    @ConfigDefault("5")
+    private Integer int1;
+
+    ...
+
+}
+--------------------------------------------------------
+
+
+
 === Registering CDI managed components into the Application's ConfigurationContext
 
 As mentioned both modules allow to provide Tamaya SPI extensions modules as ordinary CDI
managed beans. By default
@@ -126,49 +183,16 @@ public class TestPropertySource implements PropertySource{
 }
 --------------------------------------------------------
 
-Note that for many SPI's there is a priority mechanism using +@Priority+ annotations in place.
-The +ServiceContext+ implementation combines the components registered with the ones loaded
from the +ServiceLoader+
-mechanism hereby considering classloaser hierarchies.
-
-
-=== Annotating your Classes
-
-Basically annotating your classes is stright forward. +@Config+ defines an additional CDI
qualifier that is, depending
-on the module deployed, handled by a CDI producer (+tamaya-cdi-ee+) or the Tamaya SE injection
mechanism $
-(+tamaya-cdi-se+). All types injected by this module are injected using _dependent scope_.
+To enable this (optional) feature you must replace Tamaya's +ServiceContext+ with the
+CDI aware implementation:
 
+Contents of `META-INF/services/org.apache.tamaya.spi.ServiceContext`:
+[source, properties]
+-----------------------------------------------
+# Registering a CDI aware service context
+org.apache.tamaya.integration.cdi.CDIAwareServiceContext
+-----------------------------------------------
 
-[source, java]
---------------------------------------------------------
-@RequestScoped
-public class ConfiguredClass{
-
-    @Config
-    private String testProperty;
-
-    @Config({"a.b.c.key1","a.b.c.key2","a.b.c.key3"})
-    @ConfigDefault("The current \\${JAVA_HOME} env property is ${env:JAVA_HOME}.")
-    String value1;
-
-    @Config({"foo","a.b.c.key2"})
-    private String value2;
-
-    @Config
-    @ConfigDefault("N/A")
-    private String runtimeVersion;
-
-    @Config
-    @ConfigDefault("${sys:java.version}")
-    private String javaVersion2;
-
-    @Config
-    @ConfigDefault("5")
-    private Integer int1;
-
-    ...
-
-}
---------------------------------------------------------
 
 === Advanced Use Cases
 

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/9d5fb59c/content/documentation/extensions/mod_classloader_support.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_classloader_support.adoc b/content/documentation/extensions/mod_classloader_support.adoc
index c254405..d2a84f1 100644
--- a/content/documentation/extensions/mod_classloader_support.adoc
+++ b/content/documentation/extensions/mod_classloader_support.adoc
@@ -34,9 +34,10 @@ To benefit from configuration server support you only must add the corresponding
 </dependency>
 -----------------------------------------------
 
-The component will auto.register its components and override the default +ServicceContext+
in use by default
-with an instance of type +org.apache.tamaya.clsupport.internal.CLAwareServiceContext+. This
implementation returns
-a priority of +10+.
+The component will auto.register its components and override the default +ServiceContext+
in use by default
+with an instance of type +org.apache.tamaya.clsupport.internal.CLAwareServiceContext+ with
a precendence value
+(component priority) of +10+.
+
 
 === How it works
 

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/9d5fb59c/content/documentation/extensions/mod_collections.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_collections.adoc b/content/documentation/extensions/mod_collections.adoc
index 5360bab..cd00871 100644
--- a/content/documentation/extensions/mod_collections.adoc
+++ b/content/documentation/extensions/mod_collections.adoc
@@ -10,12 +10,14 @@ toc::[]
 
 Tamaya _Collections_ is an extension module. Refer to the link:../extensions.html[extensions
documentation] for further details.
 
+
 === What functionality this module provides ?
 
 All configuration in Tamaya is expressed as simple key, value pairs. Nevertheless this concept
allows similarly
 the modelling of collection typed values such as lists, sets, maps or simple collections
of things. The Tamaya
 Collections extension adds this functionality to the Tamaya eco-system.
 
+
 === Compatibility
 
 The module is based on Java 7, so it will not run on Java 7 and beyond.
@@ -38,7 +40,7 @@ To use Tamaya collection support you only must add the corresponding dependency
 === Overview
 
 Tamaya Collections adds +PropertyConverter+ implementations that are able to access configuration
data
-as lists, maps or sets. By default this works out of the box as easy as accessing any other
type of
+as _lists, maps_ or _sets_. By default this works out of the box as easy as accessing any
other type of
 configuration data, e.g.
 
 [source, java]
@@ -63,14 +65,14 @@ Additionally the module allows adding additional meta-entries, which allows
to t
 inner-workings, e.g.
 
 * using your own +PropertyConverter+ implementation for parsing entries.
-* specifying a custom separator String to be used to split the items (default is {{','}}.
-* specifying a custom separator String to be used to split key/value paris when parsing map
entries.
-* specifying the implementation type of the collection instance to be returned.
-* specifying if the resulting collection should be returned as a modifiable collection.
+* specifying a custom separator to split the items (default is {{','}}.
+* specifying a custom separator to split key/value pairs when parsing map entries.
+* specifying the implementation type of the collection item to be returned.
+* specifying the implementation type of the collection to be returned.
 
 === Supported Types
 
-This module supports the following types:
+This module currently supports the following types:
 
 * +java.util.Collection+
 * +java.util.List+
@@ -85,13 +87,19 @@ This module supports the following types:
 * +java.util.HashMap+
 * +java.util.TreeMap+
 
-Hereby the type is determined primarly by the parameter type accessed, e.g.
+Hereby the collection type is determined by the parameter type accessed, e.g.
 +config.get("mylist", ArrayList.class)+ will always return an +ArrayList+
 as result.
 
+NOTE: This means that depending on your use case you can access different
+collection types based on the same configuration values, as long as their is
+a +PropertyConverter+ that can convert the _raw configuration value_ to the
+required target type.
+
+
 ==== Configuring the target implementation type
 
-Tamaya Collections allows you to configure the target collection type by adding the
+Tamaya Collections allows you to configure the _default_ target collection type by adding
the
 following meta-configuration entry (shown for the +mylist+ entry). Hereby the package part
+java.util.+
 can be ommitted:
 
@@ -116,9 +124,9 @@ the most significant configuration entry is used. In case of collections
(and ma
 overriding is not always the mechanism of choice. E.g. when you want to have all entries
added to your
 configuration to be *combined* to a new entry containing all values provided by any property
sources.
 
-Therefore Tamaya Collections also provides a more sophistiated +CombinationPolicy+ (automatically
configured)
+Therefore _Tamaya Collections_ also provides a more sophistiated +CombinationPolicy+ (automatically
configured)
 that allows to adapt the way how configuration entries are combined. All you must do is declaring
-the mechanism to be applied by an according meta-configuration parameter, e.g. for +my.list+
your config may
+the mechanism to be applied by an according _meta-configuration_ parameter, e.g. for +my.list+
your config may
 look as follows:
 
 [source, properties]
@@ -126,7 +134,7 @@ look as follows:
 # from PropertSource 1
 my.list=1,2,3
 
-# from PropertSource 2
+# from PropertSource 2, with higher precedence
 my.list=4,5,6
 
 # without any additional meta-info these entries would be combined to
@@ -140,7 +148,7 @@ With Tamaya Collections you can now configure the combination policy as
follows:
 # use one of the default policies: override / collect
 _my.list.combination-policy=collect
 
-# use an custom CombinationPolicy to combine the values
+# or use your own custom CombinationPolicy to combine the values
 _my.list.combination-policy=com.mycomp.app.MyCombincationPolicy
 -----------------------------------------------
 
@@ -176,6 +184,7 @@ list=1,2,3,4,5,6
 map=a::b, c::d
 -----------------------------------------------
 
+
 ==== Trimming of entries
 
 By default all tokens parsed are trimmed _before_ adding them to the final collection. In
case of map entries this is

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/9d5fb59c/content/documentation/extensions/mod_consul.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_consul.adoc b/content/documentation/extensions/mod_consul.adoc
index 0463124..3119075 100644
--- a/content/documentation/extensions/mod_consul.adoc
+++ b/content/documentation/extensions/mod_consul.adoc
@@ -13,9 +13,11 @@ Tamaya _Consul_ is an extension module. Refer to the link:../extensions.html[ext
 
 === What functionality this module provides ?
 
-Tamaya _Consul_ provides different artifacts which allows integration of Apachae Tamaya
-configuration with consul. Basically the module supports read-only integration (as a +ConsulPropertySource+
as well
-as a support for +MutableConfiguration+ as defined by the +tamaya-mutable-config+ extension
module.
+Tamaya _Consul_ provides different artifacts which allows use of
+link:http://www.consul.io[Consul from Hashicorp] as configuration backend. Basically the
+module supports read-only integration (as a +ConsulPropertySource+ as well
+as a writing configuration changes back (based on Tamaya's +MutableConfiguration+ API
+defined by the link:mod_mutable_config.html[tamaya-mutable-config] extension module.
 
 
 === Compatibility
@@ -25,7 +27,7 @@ The module is based on Java 7, so it will not run on Java 7 and beyond.
 
 === Installation
 
-To benefit from configuration builder support you only must add the corresponding dependency
to your module:
+To use _tamaya-consul_ you only must add the corresponding dependency to your module:
 
 [source, xml]
 -----------------------------------------------
@@ -41,11 +43,13 @@ To benefit from configuration builder support you only must add the correspondin
 
 Consul integration comes basically with 2 artifacts:
 
-* The +org.apache.tamaya.etcd.ConsulPropertySource+ is a +PropertySource+ with a default
ordinal of 100 and the name
-  'consul', which is automatically registered.
+* The +org.apache.tamaya.etcd.ConsulPropertySource+ is a +PropertySource+ with a default
+  ordinal of 100 and the name 'consul', which is automatically registered.
 * If the +tamaya-mutable-config+ module is loaded it is possible to write property values
back into the consul cluster,
   by accessing a +MutableConfiguration+ using the URI +config:consul+.
 
+Access of consul key/value pairs is through the normal Tamaya API.
+
 
 === The ConsulPropertySource
 
@@ -53,10 +57,10 @@ The +ConsulPropertySource+ is automatically registered and allows the
consul ser
 enables to use e.g. in Docker environments the docker environment configuration mechanisms
to configure Tamaya running
 in microservice containers to connect with the according consul cluster:
 
-* The property source reads the +tamaya.consul.urls+ system and environment property to evaluate
possible etcd servers
-  (comma separated), which can be connected to. On error the API just performs a Round-Robin
through the list of
+* The property source reads the +tamaya.consul.urls+ system and environment property to evaluate
possible consul servers
+  (comma separated), which can be connected to. On failure the API just performs a Round-Robin
through the list of
   configured servers. Without any configuration +http://127.0.0.1:2400+ is used. If no connection
to any consul
   server can be established a warning will be logged, but deployment will not fail.
 * The +ConsulPropertySource+ finally also allows the values read from the consul cluster
to be mapped to prefixed
-  context. This can be activated by setting the +-Dtamaya.consul.prefix=<PREFIX>+ system
property. E.g. when the prefix is
-  set to +cluster-config.+ a consul key of +host:known/all+ is mapped to +cluster-config.host:known/all+.
+  context. This can be activated by setting the `-Dtamaya.consul.prefix=<PREFIX>` system
property. E.g. when the prefix is
+  set to `cluster-config.` a consul key of `host:known/all` is mapped to `cluster-config.host:known/all`.

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/9d5fb59c/content/documentation/extensions/mod_environment.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_environment.adoc b/content/documentation/extensions/mod_environment.adoc
deleted file mode 100644
index 01cc49e..0000000
--- a/content/documentation/extensions/mod_environment.adoc
+++ /dev/null
@@ -1,45 +0,0 @@
-:jbake-type: page
-:jbake-status: published
-
-= Apache Tamaya -- Extension: Classloader Isolation Support
-
-toc::[]
-
-
-[[Environment]]
-== Tamaya Environment Model (Extension Module)
-
-Tamaya _Environment_ is an extension module. Refer to the link:../extensions.html[extensions
documentation] for further details.
-
-=== What functionality this module provides ?
-
-The Tamaya _Environment_ extension adds a simple PropertySourceProvider that evaluates a
List of environment context and
-combines them in the given order into an (optional) root context within the system's configuration.
-
-
-=== Compatibility
-
-The module is based on Java 7, so it will not run on Java 7 and beyond.
-
-
-=== Installation
-
-To benefit from Tamaya Environment Model you only must add the corresponding dependency to
your module:
-
-[source, xml]
------------------------------------------------
-<dependency>
-  <groupId>org.apache.tamaya.ext</groupId>
-  <artifactId>tamaya-envionment</artifactId>
-  <version>{tamaya_version}</version>
-</dependency>
------------------------------------------------
-
-
-=== How it Works
-
-tbd
-
-=== Reusable Base Classes
-
-tbd

http://git-wip-us.apache.org/repos/asf/incubator-tamaya-site/blob/9d5fb59c/content/documentation/extensions/mod_etcd.adoc
----------------------------------------------------------------------
diff --git a/content/documentation/extensions/mod_etcd.adoc b/content/documentation/extensions/mod_etcd.adoc
index ee77177..8e8a914 100644
--- a/content/documentation/extensions/mod_etcd.adoc
+++ b/content/documentation/extensions/mod_etcd.adoc
@@ -12,9 +12,10 @@ Tamaya _Etcd_ is an extension module. Refer to the link:../extensions.html[exten
 
 === What functionality this module provides ?
 
-Tamaya _Etcd_ provides different artifacts which allows integration of Apachae Tamaya
-configuration with etcd. Basically the module supports read-only integration (as a +EtcdPropertySource+
as well
-as a support for +MutableConfiguration+ as defined by the +tamaya-mutable-config+ extension
module.
+Tamaya _Etcd_ provides different artifacts which allows using link:https://github.com/coreos/etcd[etcd]
as a
+configuration backend. Basically the module adds a read-only property source (+EtcdPropertySource+).
If
+the _tamaya-mutable-config_ extension is loaded it is alos possible to write configuration
+changes to _etcd_ using +MutableConfiguration+.
 
 
 === Compatibility
@@ -24,7 +25,8 @@ The module is based on Java 7, so it will not run on Java 7 and beyond.
 
 === Installation
 
-To benefit from configuration builder support you only must add the corresponding dependency
to your module:
+To use _etcd_ as a configuration backend you only must add the corresponding dependency to
+your module:
 
 [source, xml]
 -----------------------------------------------
@@ -38,11 +40,11 @@ To benefit from configuration builder support you only must add the correspondin
 
 === The Extensions Provided
 
-ETcd integration comes basically with 2 artifacts:
+Tamaya's _etcd_ integration provides basically the following artifacts:
 
-* The +org.apache.tamaya.etcd.EtcdAccessor+ can be configured with a an url targeting an
etcd server's REST endpoint root.
-  (+org.apache.tamaya.etcd.EtcdAccessor+). The accessor basically provides a simple Java
API for communicating
-  with etcd server. The accessor hereby allows reading of single properties, or whole subtrees.
Also the basic non
+* The +org.apache.tamaya.etcd.EtcdAccessor+ can be configured with a an url targeting an
etcd server's REST endpoint
+  root. The accessor basically provides a simple Java API for communicating with the _etcd_
server. The
+  accessor hereby allows reading of single properties, or whole subtrees. Also the basic
non
   atomic write methods are implemented.
 * The +org.apache.tamaya.etcd.EtcdPropertySource+ is a +PropertySource+ with a default ordinal
of 100 and the name
   'etcd', which is automatically registered.
@@ -51,10 +53,10 @@ ETcd integration comes basically with 2 artifacts:
 
 === The EtcdAccessor
 
-The accessor mentioned implements the basic read and write API for communicating with an
etcd configuration cluster.
-Hereby the accessor also provides etcd specific data such as +createdIndex, modifiedIndex,
ttl+ in the +Map+
-returned. Hereby the concept of etcd is used where keys starting with an '_' will be hidden
from the overall
-properties map, being only directly/explicitly accessible:
+The accessor implements the basic read and write API for communicating with an _etcd_ server.
+Hereby the accessor also provides _etcd_ specific data such as +createdIndex, modifiedIndex,
ttl+ in the +Map+
+returned. Hereby the concept of _etcd_ is used where keys starting with an '_' represent
meta-configuration
+that will be hidden from the overall properties map, being only directly/explicitly accessible:
 
 [source, java]
 -----------------------------------------------
@@ -175,7 +177,7 @@ public class EtcdAccessor {
 
 === The EtcdPropertySource
 
-The +EtcdPropertySource+ is automatically registered and allows to configure the etcd servers
to be used. This
+The +EtcdPropertySource+ is automatically registered and allows to configure the _etcd_ servers
to be used. This
 enables to use e.g. in Docker environments the docker environment configuration mechanisms
to configure Tamaya running
 in microservice containers to connect with the according etcd cluster:
 
@@ -183,9 +185,8 @@ in microservice containers to connect with the according etcd cluster:
   (comma separated), which can be connected to. On error the API just performs a Round-Robin
through the list of
   configured servers. Without any configuration +http://127.0.0.1:4001+ is used. If no connection
to any etcd
   server can be established a warning will be logged, but deployment will not fail.
-* Additinoally also the
-  accessor allows to configure the socket/connection timeouts by setting +tamaya.etcd.timeout+
in seconds either as
-  system or environment property.
-* The +EtcdPropertySource+ finally also allows the values read from the etcd cluster to be
mapped to prefixed
+* Additionally also the accessor allows to configure the socket/connection timeouts by setting
+  +tamaya.etcd.timeout+ in seconds either as system or environment property.
+* The +EtcdPropertySource+ finally also allows the values read from the _etcd_ cluster to
be mapped to prefixed
   context. This can be activated by setting the +-Dtamaya.etcd.prefix=<PREFIX>+ system
property. E.g. when the prefix is
-  set to +cluster-config.+ a etcd key of +host:known/all+ is mapped to +cluster-config.host:known/all+.
+  set to `cluster-config.` a etcd key of `host:known/all` is mapped to `cluster-config.host:known/all`.


Mime
View raw message