You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tamaya.apache.org by po...@apache.org on 2016/12/19 21:38:56 UTC
[4/4] incubator-tamaya git commit: TAMAYA-209: Remove old stuff from
main repo.
TAMAYA-209: Remove old stuff from main repo.
* Contents is migrated to tamaya-site repo.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/commit/63124d1f
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/tree/63124d1f
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tamaya/diff/63124d1f
Branch: refs/heads/master
Commit: 63124d1faf06f0a45ba60a22b9e05a774c678906
Parents: f6cce93
Author: Phil Ottlinger <po...@apache.org>
Authored: Mon Dec 19 22:38:19 2016 +0100
Committer: Phil Ottlinger <po...@apache.org>
Committed: Mon Dec 19 22:38:19 2016 +0100
----------------------------------------------------------------------
docs/pom.xml | 193 -----
docs/src/main/asciidoc/README | 3 -
docs/src/main/assembly/documentation.xml | 37 -
docs/src/main/images/CoreDesign.png | Bin 43759 -> 0 bytes
docs/src/main/resources/attributes.adoc | 27 -
pom.xml | 15 -
src/site/asciidoc/API.adoc | 704 -------------------
src/site/asciidoc/Core.adoc | 231 ------
src/site/asciidoc/HighLevelDesign.adoc | 165 -----
src/site/asciidoc/community.adoc | 142 ----
src/site/asciidoc/devguide.adoc | 211 ------
src/site/asciidoc/download.adoc | 110 ---
src/site/asciidoc/examples.adoc | 69 --
src/site/asciidoc/extensions.adoc | 79 ---
src/site/asciidoc/extensions/mod_camel.adoc | 143 ----
src/site/asciidoc/extensions/mod_cdi.adoc | 231 ------
.../extensions/mod_classloader_support.adoc | 90 ---
.../asciidoc/extensions/mod_collections.adoc | 246 -------
src/site/asciidoc/extensions/mod_consul.adoc | 73 --
.../asciidoc/extensions/mod_environment.adoc | 57 --
src/site/asciidoc/extensions/mod_etcd.adoc | 203 ------
src/site/asciidoc/extensions/mod_events.adoc | 294 --------
src/site/asciidoc/extensions/mod_filter.adoc | 134 ----
src/site/asciidoc/extensions/mod_formats.adoc | 222 ------
src/site/asciidoc/extensions/mod_functions.adoc | 123 ----
src/site/asciidoc/extensions/mod_injection.adoc | 447 ------------
src/site/asciidoc/extensions/mod_jodatime.adoc | 65 --
src/site/asciidoc/extensions/mod_json.adoc | 78 --
.../asciidoc/extensions/mod_management.adoc | 106 ---
.../asciidoc/extensions/mod_mutable_config.adoc | 283 --------
src/site/asciidoc/extensions/mod_optional.adoc | 69 --
src/site/asciidoc/extensions/mod_osgi.adoc | 130 ----
src/site/asciidoc/extensions/mod_remote.adoc | 129 ----
src/site/asciidoc/extensions/mod_resolver.adoc | 143 ----
src/site/asciidoc/extensions/mod_resources.adoc | 172 -----
src/site/asciidoc/extensions/mod_server.adoc | 382 ----------
.../asciidoc/extensions/mod_spi-support.adoc | 72 --
src/site/asciidoc/extensions/mod_spring.adoc | 148 ----
.../asciidoc/extensions/mod_usagetracker.adoc | 169 -----
.../asciidoc/extensions/mod_validation.adoc | 111 ---
src/site/asciidoc/extensions/mod_yaml.adoc | 127 ----
src/site/asciidoc/history.adoc | 49 --
src/site/asciidoc/images/CoreDesign.png | Bin 43759 -> 0 bytes
.../asciidoc/misc/PossibleContributions.adoc | 260 -------
src/site/asciidoc/quickstart.adoc | 206 ------
src/site/asciidoc/release-guide.adoc | 274 --------
src/site/asciidoc/source.adoc | 39 -
src/site/asciidoc/usecasesAndReqs.adoc | 505 -------------
src/site/markdown/index.md.vm | 54 --
src/site/resources/css/site.css | 57 --
src/site/resources/logos/egg-logo2.png | Bin 7241 -> 0 bytes
src/site/site.xml | 122 ----
52 files changed, 7999 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/63124d1f/docs/pom.xml
----------------------------------------------------------------------
diff --git a/docs/pom.xml b/docs/pom.xml
deleted file mode 100644
index df60971..0000000
--- a/docs/pom.xml
+++ /dev/null
@@ -1,193 +0,0 @@
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
--->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
- <modelVersion>4.0.0</modelVersion>
-
- <parent>
- <groupId>org.apache.tamaya</groupId>
- <artifactId>tamaya-all</artifactId>
- <version>0.3-incubating-SNAPSHOT</version>
- <relativePath>..</relativePath>
- </parent>
-
- <artifactId>tamaya-docs</artifactId>
- <name>Apache Tamaya Documentation</name>
- <description>The Documentation projects keeps together the documentation files in asciidoc and other formats
- for the Apache Tamaya project.
- </description>
-
- <dependencies>
- <dependency>
- <groupId>rubygems</groupId>
- <artifactId>asciidoctor-diagram</artifactId>
- <type>gem</type>
- <scope>provided</scope>
- <exclusions>
- <exclusion>
- <groupId>rubygems</groupId>
- <artifactId>asciidoctor</artifactId>
- </exclusion>
- </exclusions>
- </dependency>
- </dependencies>
-
- <scm>
- <connection>
- scm:git://git.apache.org/incubator-tamaya.git
- </connection>
- <developerConnection>
- scm:git://git.apache.org/incubator-tamaya.git
- </developerConnection>
- <url>
- https://git-wip-us.apache.org/repos/asf?p=incubator-tamaya.git
- </url>
- <tag>vote02-tamaya-0.2-incubating</tag>
- </scm>
-
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-clean-plugin</artifactId>
- <configuration>
- <filesets>
- <fileset>
- <!--
- ! This directory is to store Maven properties exported to a file
- ! which will be included by various Asciidoctor documents
- ! to share global properties/attributes.
- !
- ! see https://github.com/asciidoctor/asciidoctor-maven-plugin/issues/170
- !-->
- <directory>${project.basedir}/temp-properties-files-for-site</directory>
- </fileset>
- </filesets>
- </configuration>
- </plugin>
- <plugin>
- <artifactId>maven-resources-plugin</artifactId>
- <executions>
- <execution>
- <id>bal</id>
- <phase>generate-resources</phase>
- <goals>
- <goal>copy-resources</goal>
- </goals>
- <inherited>false</inherited>
- <configuration>
- <outputDirectory>${project.basedir}/../src/site/asciidoc/temp-properties-files-for-site</outputDirectory>
- <resources>
- <resource>
- <directory>${project.basedir}/src/main/resources</directory>
- <filtering>true</filtering>
- </resource>
- </resources>
- </configuration>
- </execution>
- </executions>
- </plugin>
- <plugin>
- <groupId>de.saumya.mojo</groupId>
- <artifactId>gem-maven-plugin</artifactId>
- <configuration>
- <jrubyVersion>${jruby.version}</jrubyVersion>
- <gemHome>${project.build.directory}/gems</gemHome>
- <gemPath>${project.build.directory}/gems</gemPath>
- </configuration>
- <executions>
- <execution>
- <goals>
- <goal>initialize</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
- <plugin>
- <groupId>org.asciidoctor</groupId>
- <artifactId>asciidoctor-maven-plugin</artifactId>
- <configuration>
- <eruby>erubis</eruby>
- <!-- The gem-maven-plugin appends the scope (e.g., provided) to the gemPath defined in the plugin configuration -->
- <gemPath>${project.build.directory}/gems-provided</gemPath>
- <requires>
- <require>asciidoctor-diagram</require>
- </requires>
- </configuration>
- <executions>
- <execution>
- <id>output-html-design</id>
- <phase>generate-resources</phase>
- <goals>
- <goal>process-asciidoc</goal>
- </goals>
- <configuration>
- <imagesDir>${project.basedir}/../src/site/asciidoc/images</imagesDir>
- <sourceDirectory>${project.basedir}/../src/site/asciidoc</sourceDirectory>
- <attributes>
- <tamayaVersion>${project.version}</tamayaVersion>
- </attributes>
- <projectDirectory>${project.basedir}/../src/site/asciidoc</projectDirectory>
- <!--<imagesDir>${project.basedir}/../src/site/asciidoc/</imagesDir>-->
- <outputDirectory>${project.build.directory}/adocs</outputDirectory>
- <sourceHighlighter>coderay</sourceHighlighter>
- <backend>html</backend>
- <embedAssets>true</embedAssets>
- <preserveDirectories>true</preserveDirectories>
- </configuration>
- </execution>
- </executions>
- </plugin>
-
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-assembly-plugin</artifactId>
- <executions>
- <execution>
- <id>attach-distribution</id>
- <phase>package</phase>
- <goals>
- <goal>single</goal>
- </goals>
- <configuration>
- <runOnlyAtExecutionRoot>false</runOnlyAtExecutionRoot>
- <finalName>apache-tamaya-docs-${project.version}</finalName>
- <descriptor>src/main/assembly/documentation.xml</descriptor>
- </configuration>
- </execution>
- </executions>
- </plugin>
-
- </plugins>
- </build>
-
- <repositories>
- <repository>
- <id>rubygems-proxy-releases</id>
- <name>RubyGems.org Proxy (Releases)</name>
- <url>http://rubygems-proxy.torquebox.org/releases</url>
- <releases>
- <enabled>true</enabled>
- </releases>
- <snapshots>
- <enabled>false</enabled>
- </snapshots>
- </repository>
- </repositories>
-
-</project>
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/63124d1f/docs/src/main/asciidoc/README
----------------------------------------------------------------------
diff --git a/docs/src/main/asciidoc/README b/docs/src/main/asciidoc/README
deleted file mode 100644
index fe43f44..0000000
--- a/docs/src/main/asciidoc/README
+++ /dev/null
@@ -1,3 +0,0 @@
-This file is only a placeholder:
-
-The asciidoc files used to generate the contents of this module are located under TAMAYA_ROOT/src/site/asciidoc.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/63124d1f/docs/src/main/assembly/documentation.xml
----------------------------------------------------------------------
diff --git a/docs/src/main/assembly/documentation.xml b/docs/src/main/assembly/documentation.xml
deleted file mode 100644
index a264485..0000000
--- a/docs/src/main/assembly/documentation.xml
+++ /dev/null
@@ -1,37 +0,0 @@
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
--->
-<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3
- http://maven.apache.org/xsd/assembly-1.1.3.xsd">
-
- <id>documentation</id>
- <formats>
- <format>zip</format>
- <format>tar.gz</format>
- <format>dir</format>
- </formats>
-
- <fileSets>
- <fileSet>
- <directory>${project.build.directory}/adocs</directory>
- <outputDirectory>docs</outputDirectory>
- </fileSet>
- </fileSets>
-</assembly>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/63124d1f/docs/src/main/images/CoreDesign.png
----------------------------------------------------------------------
diff --git a/docs/src/main/images/CoreDesign.png b/docs/src/main/images/CoreDesign.png
deleted file mode 100644
index a84d8a6..0000000
Binary files a/docs/src/main/images/CoreDesign.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/63124d1f/docs/src/main/resources/attributes.adoc
----------------------------------------------------------------------
diff --git a/docs/src/main/resources/attributes.adoc b/docs/src/main/resources/attributes.adoc
deleted file mode 100644
index fb97680..0000000
--- a/docs/src/main/resources/attributes.adoc
+++ /dev/null
@@ -1,27 +0,0 @@
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements. See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership. The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License. You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied. See the License for the
-// specific language governing permissions and limitations
-// under the License.
-
-//
-// This file is used to export Maven properties to a file
-// which will be included by various Asciidoctor documents
-// to share global properties/attributes.
-//
-// see https://github.com/asciidoctor/asciidoctor-maven-plugin/issues/170
-//
-:tamaya_version_current: ${project.version}
-:tamaya_mvn_group_id: ${project.groupId}
-
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/63124d1f/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index 2cc4d6b..db489a9 100644
--- a/pom.xml
+++ b/pom.xml
@@ -211,7 +211,6 @@ under the License.
<modules>
<module>buildconfigurations</module>
<module>code</module>
- <module>docs</module>
<module>examples</module>
<module>distribution</module>
</modules>
@@ -765,20 +764,6 @@ under the License.
</build>
</profile>
- <!-- Generate all documents -->
- <profile>
- <id>generateDocuments</id>
- <activation>
- <property>
- <name>generateDocuments</name>
- </property>
- </activation>
-
- <modules>
- <module>docs</module>
- </modules>
- </profile>
-
<!-- Do a fast build by skipping all code analysis tools -->
<profile>
<id>fast</id>
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/63124d1f/src/site/asciidoc/API.adoc
----------------------------------------------------------------------
diff --git a/src/site/asciidoc/API.adoc b/src/site/asciidoc/API.adoc
deleted file mode 100644
index 6aac2da..0000000
--- a/src/site/asciidoc/API.adoc
+++ /dev/null
@@ -1,704 +0,0 @@
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements. See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership. The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License. You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied. See the License for the
-// specific language governing permissions and limitations
-// under the License.
-'''
-
-include::temp-properties-files-for-site/attributes.adoc[]
-
-[[CoreDesign]]
-== Apache Tamaya: API
-
-Though Tamaya is a very powerful and flexible solution there are basically only a few simple core concepts required
-that are the base of all the other mechanisms. As a starting point we recommend you read the corresponding
-llink:HighLevelDesign.html[High Level Design Documentation]
-
-[[API]]
-== The Tamaya API
-The API provides the artifacts as described in the link:HighLevelDesign.html[High Level Design Documentation], which are:
-
-* A simple but complete SE *API* for accessing key/value based _Configuration_:
- ** +Configuration+ hereby models configuration, the main interface of Tamaya. +Configuration+ provides
- *** access to literal key/value pairs.
- *** functional extension points (+with, query+) using a unary +ConfigOperator+ or
- a function +ConfigurationQuery<T>+.
- ** +ConfigurationProvider+ provides with +getConfiguration()+ the static entry point for accessing configuration.
- ** +ConfigException+ defines a runtime exception for usage by the configuration system.
- ** +TypeLiteral+ provides a possibility to type safely define the target type to be returned by a registered
- +PropertyProvider+.
- ** +PropertyConverter+, which defines conversion of configuration values (String) into any required target type.
-
-* Additionally the *SPI* provides:
- ** _PropertySource:_ is the the SPI for adding configuration data. A +PropertySource+ hereby
- *** is designed as a minimalistic interface that be implemented by any kind of data provider (local or remote)
- *** provides single access for key/value pairs in raw format as String key/values only (+getPropertyValue+).
- *** can optionally support scanning of its provided values, implementing +getProperties()+.
- ** _PropertySourceProvider:_ allows to register multiple property sources dynamically, e.g. all config files found in
- file system folder..
- ** +ConfigurationProviderSpi+ defines the SPI that is used as a backing bean for the +ConfigurationProvider+
- singleton.
- ** +PropertyFilter+, which allows filtering of property values prior getting returned to the caller.
- ** +PropertyValueCombinationPolicy+ optionally can be registered to change the way how different key/value
- pairs are combined to build up the final +Configuration+ passed over to the filters registered.
- ** +ConfigurationContext+, which provides a container for all the artifacts needed to build up a +Configuration+.
- For example a context contains the property sources, property filters, converters and combination policy used.
- Also the ordering of the property sources is defined by the context. A context instance given a
- +Configuration+ can be created by calling +ConfigurationProvider.createConfiguration(context);+.
- ** Similarly a +ConfigurationContext+ can be created using a +ConfigurationContextBuilder+. This builder can be
- obtained calling +ConfigurationProvider.getConfigurationContextBuilder();+.
- ** +ServiceContext+, which provides access to the components loaded, depending on the current runtime stack.
- ** +ServiceContextManager+ provides static access to the +ServiceContext+ loaded.
-
-This is also reflected in the main packages of the API:
-
-* +org.apache.tamaya+ contains the main API abstractions used by users.
-* +org.apache.tamaya.spi+ contains the SPI interfaces to be implemented by implementations and the +ServiceContext+
- mechanism.
-
-
-
-[[APIKeyValues]]
-=== Key/Value Pairs
-
-Basically configuration is a very generic concept. Therefore it should be modelled in a generic way. The most simple
-and most commonly used approach are simple literal key/value pairs. So the core building block of {name} are key/value pairs.
-You can think of a common +.properties+ file, e.g.
-
-[source,properties]
-.A simple properties file
---------------------------------------------
-a.b.c=cVal
-a.b.c.1=cVal1
-a.b.c.2=cVal2
-a=aVal
-a.b=abVal
-a.b2=abVal
---------------------------------------------
-
-Now you can use +java.util.Properties+ to read this file and access the corresponding properties, e.g.
-
-[source,properties]
---------------------------------------------
-Properties props = new Properties();
-props.readProperties(...);
-String val = props.getProperty("a.b.c");
-val = props.getProperty("a.b.c.1");
-...
---------------------------------------------
-
-
-==== Why Using Strings Only
-
-There are good reason to keep of non String-values as core storage representation of configuration. Mostly
-there are several huge advantages:
-
-* Strings are simple to understand
-* Strings are human readable and therefore easy to prove for correctness
-* Strings can easily be used within different language, different VMs, files or network communications.
-* Strings can easily be compared and manipulated
-* Strings can easily be searched, indexed and cached
-* It is very easy to provide Strings as configuration, which gives much flexibility for providing configuration in
- production as well in testing.
-* and more...
-
-On the other side there are also disadvantages:
-
-* Strings are inherently not type safe, they do not provide validation out of the box for special types, such as
-numbers, dates etc.
-* In many cases you want to access configuration in a typesafe way avoiding conversion to the target types explicitly
- throughout your code.
-* Strings are neither hierarchical nor multi-valued, so mapping hierarchical and collection structures requires some
- extra efforts.
-
-Nevertheless most of these advantages can be mitigated easily, hereby still keeping all the benefits from above:
-
-* Adding type safe adapters on top of String allow to add any type easily, that can be directly mapped out of Strings.
- This includes all common base types such as numbers, dates, time, but also timezones, formatting patterns and more.
-* Also multi-valued, complex and collection types can be defined as a corresponding +PropertyAdapter+ knows how to
- parse and create the target instance required.
-* String s also can be used as references pointing to other locations and formats, where configuration is
- accessible.
-
-
-[[API Configuration]]
-=== Configuration
-
-+Configuration+ is the main API provided by Tamaya. It allows reading of single property values or the whole
-property map, but also supports type safe access:
-
-[source,java]
-.Interface Configuration
---------------------------------------------
-public interface Configuration{
- String get(String key);
- String getOrDefault(String key, String value);
- <T> T get(String key, Class<T> type);
- <T> T getOrDefault(String key, Class<T> type, T defaultValue);
- <T> T get(String key, TypeLiteral<T> type);
- <T> T getOrDefault(String key, TypeLiteral<T> type, T defaultValue);
- Map<String,String> getProperties();
-
- // extension points
- Configuration with(ConfigOperator operator);
- <T> T query(ConfigQuery<T> query);
-
- ConfigurationContext getContext();
-}
---------------------------------------------
-
-Hereby
-
-* +<T> T get(String, Class<T>)+ provides type safe accessors for all basic wrapper types of the JDK.
-* +with, query+ provide the extension points for adding additional functionality.
-* +getProperties()+ provides access to all key/values, whereas entries from non scannable property sources may not
- be included.
-* +getOrDefault+ allows to pass default values as needed, returned if the requested value evaluated to +null+.
-
-The class +TypeLiteral+ is basically similar to the same class provided with CDI:
-
-[source,java]
---------------------------------------------
-public class TypeLiteral<T> implements Serializable {
-
- [...]
-
- protected TypeLiteral(Type type) {
- this.type = type;
- }
-
- protected TypeLiteral() { }
-
- public static <L> TypeLiteral<L> of(Type type){...}
- public static <L> TypeLiteral<L> of(Class<L> type){...}
-
- public final Type getType() {...}
- public final Class<T> getRawType() {...}
-
- public static Type getGenericInterfaceTypeParameter(Class<?> clazz, Class<?> interfaceType){...}
- public static Type getTypeParameter(Class<?> clazz, Class<?> interfaceType){...}
-
- [...]
-}
---------------------------------------------
-
-Instances of +Configuration+ can be accessed from the +ConfigurationProvider+ singleton:
-
-[source,java]
-.Accessing Configuration
---------------------------------------------
-Configuration config = ConfigurationProvider.getConfiguration();
---------------------------------------------
-
-Hereby the singleton is backed up by an instance of +ConfigurationProviderSpi+.
-
-
-[[PropertyConverter]]
-==== Property Type Conversion
-
-As illustrated in the previous section, +Configuration+ also to access non String types. Nevertheless internally
-all properties are strictly modelled as pure Strings only, so non String types must be derived by converting the
-configured String values into the required target type. This is achieved with the help of +PropertyConverters+:
-
-[source,java]
---------------------------------------------
-public interface PropertyConverter<T>{
- T convert(String value, ConversionContext context);
- //X TODO Collection<String> getSupportedFormats();
-}
---------------------------------------------
-
-The +ConversionContext+ contains additional meta-information for the accessed key, inclusing the key'a name and
-additional metadata.
-
-+PropertyConverter+ instances can be implemented and registered by default using the +ServiceLoader+. Hereby
-a configuration String value is passed to all registered converters for a type in order of their annotated +@Priority+
-value. The first non-null result of a converter is then returned as the current configuration value.
-
-Access to converters is provided by the current +ConfigurationContext+, which is accessible from
-the +ConfigurationProvider+ singleton.
-
-
-[[ExtensionPoints]]
-=== Extension Points
-
-We are well aware of the fact that this library will not be able to cover all kinds of use cases. Therefore
-we have added functional extension mechanisms to +Configuration+ that were used in other areas of the Java eco-system
-as well:
-
-* +with(ConfigOperator operator)+ allows to pass arbitrary unary functions that take and return instances of
- +Configuration+. Operators can be used to cover use cases such as filtering, configuration views, security
- interception and more.
-* +query(ConfigQuery query)+ allows to apply a function returning any kind of result based on a
- +Configuration+ instance. Queries are used for accessing/deriving any kind of data based on of a +Configuration+
- instance, e.g. accessing a +Set<String>+ of root keys present.
-
-Both interfaces hereby are functional interfaces. Because of backward compatibility with Java 7 we did not use
-+UnaryOperator+ and +Function+ from the +java.util.function+ package. Nevertheless usage is similar, so you can
-use Lambdas and method references in Java 8:
-
-[source,java]
-.Applying a +ConfigurationQuery+ using a method reference
---------------------------------------------
-ConfigSecurity securityContext = ConfigurationProvider.getConfiguration().query(ConfigSecurity::targetSecurityContext);
---------------------------------------------
-
-NOTE: +ConfigSecurity+ is an arbitrary class only for demonstration purposes.
-
-
-Operator calls basically look similar:
-
-[source,java]
-.Applying a +ConfigurationOperator+ using a lambda expression:
---------------------------------------------
-Configuration secured = ConfigurationProvider.getConfiguration()
- .with((config) ->
- config.get("foo")!=null?;
- FooFilter.apply(config):
- config);
---------------------------------------------
-
-
-[[ConfigException]]
-=== ConfigException
-
-The class +ConfigException+ models the base *runtime* exception used by the configuration system.
-
-
-[[SPI]]
-== SPI
-
-[[PropertySource]]
-=== Interface PropertySource
-
-We have seen that constraining configuration aspects to simple literal key/value pairs provides us with an easy to
-understand, generic, flexible, yet expendable mechanism. Looking at the Java language features a +java.util.Map<String,
-String>+ and +java.util.Properties+ basically model these aspects out of the box.
-
-Though there are advantages in using these types as a model, there are some severe drawbacks, notably implementation
-of these types is far not trivial and the collection API offers additional functionality not useful when aiming
-for modelling simple property sources.
-
-To render an implementation of a custom +PropertySource+ as convenient as possible only the following methods were
-identified to be necessary:
-
-[source,java]
---------------------------------------------
-public interface PropertySource{
- int getOrdinal();
- String getName();
- String get(String key);
- boolean isScannable();
- Map<String, String> getProperties();
-}
---------------------------------------------
-
-Hereby
-
-* +get+ looks similar to the methods on +Map+. It may return +null+ in case no such entry is available.
-* +getProperties+ allows to extract all property data to a +Map<String,String>+. Other methods like +containsKey,
- keySet+ as well as streaming operations then can be applied on the returned +Map+ instance.
-* But not in all scenarios a property source may be scannable, e.g. when looking up keys is very inefficient, it
- may not make sense to iterator over all keys to collect the corresponding properties.
- This can be evaluated by calling +isScannable()+. If a +PropertySource+ is defined as non scannable accesses to
- +getProperties()+ may not return all key/value pairs that would be available when accessed directly using the
- +String get(String)+ method.
-* +getOrdinal()+ defines the ordinal of the +PropertySource+. Property sources are managed in an ordered chain, where
- property sources with higher ordinals override the ones with lower ordinals. If ordinal are the same, the natural
- ordering of the fulloy qualified class names of the property source implementations are used. The reason for
- not using +@Priority+ annotations is that property sources can define dynamically their ordinals, e.g. based on
- a property contained with the configuration itself.
-* Finally +getName()+ returns a (unique) name that identifies the +PropertySource+ within the current
- +ConfigurationContext+.
-
-This interface can be implemented by any kind of logic. It could be a simple in memory map, a distributed configuration
-provided by a data grid, a database, the JNDI tree or other resources. Or it can be a combination of multiple
-property sources with additional combination/aggregation rules in place.
-
-+PropertySources+ are by default registered using the Java +ServiceLoader+ or the mechanism provided by the current
- active +ServiceContext+.
-
-
-[[PropertySourceProvider]]
-=== Interface PropertySourceProvider
-
-Instances of this type can be used to register multiple instances of +PropertySource+.
-
-[source,java]
---------------------------------------------
-// @FunctionalInterface in Java 8
-public interface PropertySourceProvider{
- Collection<PropertySource> getPropertySources();
-}
---------------------------------------------
-
-This allows to evaluate the property sources to be read/that are available dynamically. All property sources
-are read out and added to the current chain of +PropertySource+ instances within the current +ConfigurationContext+,
-refer also to [[ConfigurationContext]].
-
-+PropertySourceProviders+ are by default registered using the Java +ServiceLoader+ or the mechanism provided by the
-current active +ServiceContext+.
-
-
-[[PropertyFilter]]
-=== Interface PropertyFilter
-
-Also +PropertyFilters+ can be added to a +Configuration+. They are evaluated before a +Configuration+ instance is
-passed to the user. Filters can hereby used for multiple purposes, such as
-
-* resolving placeholders
-* masking sensitive entries, such as passwords
-* constraining visibility based on the current active user
-* ...
-
-+PropertyFilters+ are by default registered using the Java +ServiceLoader+ or the mechanism provided by the current
-active +ServiceContext+. Similar to property sources they are managed in an ordered filter chain, based on the
-applied +@Priority+ annotations.
-
-A +PropertyFilter+ is defined as follows:
-
-[source,java]
---------------------------------------------
-// Functional Interface
-public interface PropertyFilter{
- String filterProperty(String value, FilterContext context);
-}
---------------------------------------------
-
-Hereby:
-
-* returning +null+ will remove the key from the final result
-* non null values are used as the current value of the key. Nevertheless for resolving multi-step dependencies
- filter evaluation has to be continued as long as filters are still changing some of the values to be returned.
- To prevent possible endless loops after a defined number of loops evaluation is stopped.
-* +FilterContext+ provides additional metdata, inclusing the key accessed, which is useful in many use cases.
-
-This method is called each time a single entry is accessed, and for each property in a full properties result.
-
-
-[[PropertyValueCombinationPolicy]]
-==== Interface PropertyValueCombinationPolicy
-
-This interface can be implemented optional. It can be used to adapt the way how property key/value pairs are combined to
-build up the final Configuration to be passed over to the +PropertyFilters+. The default implementation is just
-overriding all values read before with the new value read. Nevertheless for collections and other use cases it is
-often useful to have alternate combination policies in place, e.g. for combining values from previous sources with the
-new value. Finally looking at the method's signature it may be surprising to find a +Map+ for the value. The basic
-value hereby is defined by +currentValue.get(key)+. Nevertheless the +Map+ may also contain additional meta entries,
-which may be considered by the policy implementation.
-
-[source,java]
---------------------------------------------
-// FunctionalInterface
-public interface PropertyValueCombinationPolicy{
-
- PropertyValueCombinationPolicy DEFAULT_OVERRIDING_COLLECTOR =
- new PropertyValueCombinationPolicy(){
- @Override
- public Map<String,String> collect(Map<String,String> currentValue, String key,
- PropertySource propertySource) {
- PropertyValue value = propertySource.get(key);
- return value!=null?value.getConfigEntries():currentValue;
- }
- };
-
- String collect(Map<String,String> currentValue currentValue, String key,
- PropertySource propertySource);
-
-}
---------------------------------------------
-
-
-[[ConfigurationContext]]
-==== The Configuration Context
-
-A +Configuration+ is created from a +ConfigurationContext+, which is
-accessible from +Configuration.getContext()+:
-
-[source,java]
-.Accessing the current +ConfigurationContext+
---------------------------------------------
-ConfigurationContext context = ConfigurationProvider.getConfiguration().getContext();
---------------------------------------------
-
-The +ConfigurationContext+ provides access to the internal artifacts that determine the final +Configuration+ and
-also defines the ordering of the property sources, filters and converters contained:
-
-* +PropertySources+ registered (including the PropertySources provided from +PropertySourceProvider+ instances).
-* +PropertyFilters+ registered, which filter values before they are returned to the client
-* +PropertyConverter+ instances that provide conversion functionality for converting String values to any other types.
-* the current +PropertyValueCombinationPolicy+ that determines how property values from different PropertySources are
- combined to the final property value returned to the client.
-
-
-[[Mutability]]
-==== Changing the current Configuration Context
-
-A +ConfigurationContext+ is not mutable once it is created. In many cases mutability is also not needed. Nevertheless
-there are use cases where the current +ConfigurationContext+ (and
-consequently +Configuration+) must be adapted:
-
-* New configuration files where detected in a folder observed by Tamaya.
-* Remote configuration, e.g. stored in a database or alternate ways has been updated and the current system must
- be adapted to these changes.
-* The overall configuration context is manually setup by the application logic.
-* Within unit testing alternate configuration setup should be setup to meet the configuration requirements of the
- tests executed.
-
-In such cases the +ConfigurationContext+ must be changed, meaning it must be possible:
-
-* to add or remove +PropertySource+ instances
-* to add or remove +PropertyFilter+ instances
-* to add or remove +PropertyConverter+ instances
-* to redefine the current +PropertyValueCombinationPolicy+ instances.
-
-This can be achieved by obtaining an instance of +ConfigurationContextBuilder+. Instances of this builder can be
-accessed either
-
-* calling +ConfigurationContext.toBuilder()+, hereby returning a builder instance preinitialized with the values from the
- current +ConfigurationContext+.
-* calling +ConfigurationProvider.getConfigurationContextBuilder()+.
-
-[source,java]
-.Accessing a +ConfigurationContextBuilder+
---------------------------------------------
-ConfigurationContextBuilder preinitializedContextBuilder = ConfigurationProvider.getConfiguration().getContext().toBuilder();
-ConfigurationContextBuilder emptyContextBuilder = ConfigurationProvider.getConfigurationContextBuilder();
---------------------------------------------
-
-With such a builder a new +ConfigurationContext+ can be created and then applied:
-
-[source,java]
-.Creating and applying a new +ConfigurationContext+
---------------------------------------------
-ConfigurationContext context = ConfigurationProvider.getConfiguration().getContext()
- .toBuilder();
- .addPropertySources(new MyPropertySource())
- .addPropertyFilter(new MyFilter())
- .build();
---------------------------------------------
-
-Hereby the builder provides several methods for adding, removing of property sources and also operations
-for programmatically change the property sourcepriorities, e.g.
-
-[source,java]
-.Chain manipulation using +ConfigurationContextBuilder+
---------------------------------------------
-PropertySource propertySource = builder.getPropertySource("sourceId");
-
-// changing the priority of a property source. The ordinal value hereby is not considered.
-// Instead the position of the property source within the chain is changed.
-builder.decreasePriority(propertySource);
-
-// Alternately a comparator expression can be passed to establish the defined ordering...
-builder.sortPropertyFilters(MyFilterComparator::compare);
---------------------------------------------
-
-Finally if the new context is ready a new configuration can be created, or the context is applied to the
-current configuration.
-
-[source,java]
-.Creating and applying a new +ConfigurationContext+
---------------------------------------------
-ConfigurationContext context = builder.build();
-
-// Creates a new matching Configuration instance
-Configuration newConfig = ConfigurationProvider.createConfiguration(context);
-
-// Apply the new context to replace the current configuration:
-ConfigurationProvider.setConfigurationContext(context);
---------------------------------------------
-
-Hereby +ConfigurationProvider.setConfigurationContext(context)+ can throw an +UnsupportedOperationException+.
-This can be checked by calling the method +boolean ConfigurationProvider.isConfigurationContextSettable()+.
-
-
-[[ConfigurationProviderSpi]]
-==== Implementing and Managing Configuration
-
-One of the most important SPI in Tamaya if the +ConfigurationProviderSpi+ interface, which is backing up the
-+ConfigurationProvider+ singleton. Implementing this class allows
-
-* to fully determine the implementation class for +Configuration+
-* to manage the current +ConfigurationContext+ in the scope and granularity required.
-* to provide access to the right +Configuration/ConfigurationContext+ based on the current runtime context.
-* Performing changes as set with the current +ConfigurationContextBuilder+.
-
-= Interface ConfigurationContextBuilder
-
-include::temp-properties-files-for-site/attributes.adoc[]
-
-[[BuilderCore]]
-== Interface ConfigurationContextBuilder
-=== Overview
-
-The Tamaya builder module provides a generic (one time) builder for creating +Configuration+ instances,
-e.g. as follows:
-
-[source,java]
----------------------------------------------------------------
-ConfigurationBuilder builder = new ConfigurationBuilder();
-// do something
-Configuration config = builder.build();
----------------------------------------------------------------
-
-Basically the builder allows to create configuration instances completely independent of the current configuration
-setup. This gives you full control on the +Configuration+ setup.
-
-
-=== Supported Functionality
-
-The builder allows you to add +PropertySource+ instances:
-
-[source,java]
-----------------------------------------------------------------
-ConfigurationContextBuilder builder = ConfigurationProvider.getConfigurationContextBuilder();
-builder.addPropertySources(sourceOne, sourceTwo, sourceThree
-Configuration config = ConfigurationProvider.createConfiguration(builder.build());
-----------------------------------------------------------------
-
-Hereby the ordering of the propertysources is not changed, regardless of the ordinals provided
-by the property sources. This allows alternate ordering policies easily being implemented because
-creating a configuration based on a configuration context is already implemented and provided by the core
-API.
-
-Similarly you can add filters:
-
-[source,java]
-----------------------------------------------------------------
-builder.addPropertyFilters(new MyConfigFilter());
-----------------------------------------------------------------
-
-...or +PropertySourceProvider+ instances:
-
-[source,java]
-----------------------------------------------------------------
-builder.addPropertySourceProvider(new MyPropertySourceProvider());
-----------------------------------------------------------------
-
-
-
-[[ServiceContext]]
-==== The ServiceContext
-
-The +ServiceContext+ is also a very important SPI, which allows to define how components are loaded in Tamaya.
-The +ServiceContext+ hereby defines access methods to obtain components, whereas itself it is available from the
-+ServiceContextManager+ singleton:
-
-[source,java]
-.Accessing the +ServiceContext+
---------------------------------------------
-ServiceContext serviceContext = ServiceContextManager.getServiceContext();
-
-public interface ServiceContext{
- int ordinal();
- <T> T getService(Class<T> serviceType);
- <T> List<T> getServices(Class<T> serviceType);
-}
---------------------------------------------
-
-With the +ServiceContext+ a component can be accessed in two different ways:
-
-. access as as a single property. Hereby the registered instances (if multiple) are sorted by priority and then finally
- the most significant instance is returned only.
-. access all items given its type. This will return (by default) all instances loadedable from the current
- runtime context, ordered by priority, hereby the most significant components added first.
-
-
-## Examples
-### Accessing Configuration
-
-_Configuration_ is obtained from the ConfigurationProvider singleton:
-
-[source,java]
-.Accessing +Configuration+
---------------------------------------------
-Configuration config = ConfigurationProvider.getConfiguration();
---------------------------------------------
-
-Many users in a SE context will probably only work with _Configuration_, since it offers all functionality
-needed for basic configuration with a very lean memory and runtime footprint. In Java 7 access to the keys is
-very similar to *Map<String,String>*, whereas in Java 8 additionally usage of _Optional_ is supported:
-
-[source,java]
---------------------------------------------
-Configuration config = ConfigurationProvider.getConfiguration();
-String myKey = config.get("myKey"); // may return null
-int myLimit = config.get("all.size.limit", int.class);
---------------------------------------------
-
-
-### Environment and System Properties
-
-By default environment and system properties are included into the _Configuration_. So we can access the current
-_PROMPT_ environment variable as follows:
-
-[source,java]
---------------------------------------------
-String prompt = ConfigurationProvider.getConfiguration().get("PROMPT");
---------------------------------------------
-
-Similary the system properties are directly applied to the _Configuration_. So if we pass the following system
-property to our JVM:
-
-[source,java]
---------------------------------------------
-java ... -Duse.my.system.answer=yes
---------------------------------------------
-
-we can access it as follows:
-
-[source,java]
---------------------------------------------
-boolean useMySystem = ConfigurationProvider.getConfiguration().get("use.my.system.answer", boolean.class);
---------------------------------------------
-
-
-### Adding a Custom Configuration
-
-Adding a classpath based configuration is simply as well: just implement an according _PropertySource_. With the
-_tamaya-spi-support_ module you just have to perform a few steps:
-
-. Define a PropertySource as follows:
-
-[source,java]
---------------------------------------------
- public class MyPropertySource extends PropertiesResourcePropertySource{
-
- public MyPropertySource(){
- super(ClassLoader.getSystemClassLoader().getResource("META-INF/cfg/myconfig.properties"), DEFAULT_ORDINAL);
- }
- }
---------------------------------------------
-
-Then register +MyPropertySource+ using the +ServiceLoader+ by adding the following file:
-
-[source,listing]
---------------------------------------------
-META-INF/services/org.apache.tamaya.spi.PropertySource
---------------------------------------------
-
-...containing the following line:
-
-[source,listing]
---------------------------------------------
-com.mypackage.MyPropertySource
---------------------------------------------
-
-
-[[APIImpl]]
-== API Implementation
-
-The API is implemented by the Tamaya _Core_module. Refer to the link:Core.html[Core documentation] for
-further details.
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/63124d1f/src/site/asciidoc/Core.adoc
----------------------------------------------------------------------
diff --git a/src/site/asciidoc/Core.adoc b/src/site/asciidoc/Core.adoc
deleted file mode 100644
index 927004b..0000000
--- a/src/site/asciidoc/Core.adoc
+++ /dev/null
@@ -1,231 +0,0 @@
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements. See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership. The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License. You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied. See the License for the
-// specific language governing permissions and limitations
-// under the License.
-'''
-
-include::temp-properties-files-for-site/attributes.adoc[]
-
-[[Core]]
-== Tamaya Core Implementation
-=== Overview
-
-Tamaya Core provides an implementation of the link:API.html[Tamaya Configuration API] and adds additional functionality
-and building blocks for supporting SPI implementations.
-
-Tamaya Core contains the following artifacts:
-
-* Implementations of +Configuration, ConfigurationContext, ConfigurationContextBuilder+ ConfigurationProviderSpi+
-* A +java.util.ServiceLoader+ based +ServiceContext+ implementation. Hereby it implements component priorization based
- on the +@Priority+ annotations.
-* A PropertyConverterManager+ that loads and stores references to all the preconfigured +PropertyConverter+ instances
-hereby providing type conversion for all important types.
-* A simple default configuration setup using the current classpath and an optional staging variable.
-* It collects all +PropertySource+ and +PropertySourceProvider+ instances registered with the +ServiceLoader+ and
- registers them in the global +ConfigurationContext+
-* It provides a +ConfigurationContextBuilder+ implementation (class +DefaultConfigurationContextBuilder+) and allows
- changing the current +ConfigurationContext+.
-
-The overall size of the library is very small. All required components are implemented and registered, so basically the
-Core module is a complete configuration solution. Nevertheless it is also very minimalistic, but fortunately is flexible
-enough to be extended/accommodated with additional features as needed, such as
-
-* placeholder and resolution mechanisms
-* dynamic resource path lookup, e.g. with ant styled patterns
-* configuration injection and configuration templates
-* abstraction for reusable formats
-* integration with other existing solutions
-* configuration and configuration isolation targeting Java EE
-* dynamic configuration and configuration updates
-* Configuration management extensions
-* remote configuration
-* and more
-
-For details about the extension modules available and their functionality refer to the link:modules.html[extension user guide].
-
-
-[[CorePropertyConverters]]
-=== Default PropertyConverters in Core
-
-As mentioned the Core module delivers several default +PropertyConverter+ instances out of the box. Find below the
-listing of converters automatically registered with the Core module:
-
-[width="100%",frame="1",options="header",grid="all"]
-|=======
-|_Target Type_ |_Class Name_ |_Supported Formats_
-|java.math.BigDecimal |BigDecimalConverter |1.2345, 0xFF
-|java.math.BigInteger |BigIntegerConverter |0xFF, 1234
-|java.ui.lang.Boolean |BooleanConverter |true, false, T, F, 1 ,0
-|java.ui.lang.Byte |ByteConverter |0xFF, MIN_VALUE, MAX_VALUE, 123
-|java.ui.lang.Character |CharConverter |0xFF, 'a', 'H', 123
-|java.ui.lang.Class |ClassConverter |<fully qualified class name>
-|java.util.Currency |CurrencyConverter |CHF, 123
-|java.ui.lang.Double |DoubleConverter |1, 0xFF, 1.2334, NaN, NEGATIVE_INFITIY, POSITIVE_INFINITY, MIN_VALUE, MAX_VALUE
-|_Enums_ |EnumConverter |<Enum item name>
-|java.ui.lang.Float |FloatConverter |1, 0xFF, 1.2334, NaN, NEGATIVE_INFITIY, POSITIVE_INFINITY, MIN_VALUE, MAX_VALUE
-|java.ui.lang.Integer |IntegerConverter |1, 0xD3, MIN_VALUE, MAX_VALUE
-|LocalDate |LocalDateConverter |<Date as defined by LocalDate.parse(String)
-|LocalTime |LocalTimeConverter |<Time as defined by LocalTime.parse(String)
-|LocalDateTime |LocalDateTimeConverter |<LocalDateTime as defined by LocalDateTime.parse(String)>
-|java.ui.lang.Long |LongConverter |1, 0xD3, MIN_VALUE, MAX_VALUE
-|java.ui.lang.Number |NumberConverter |1, 0xFF, 1.2334, NaN, NEGATIVE_INFITIY, POSITIVE_INFINITY
-|java.ui.lang.Short |ShortConverter |1, 0xD3, MIN_VALUE, MAX_VALUE
-|java.net.URI |URIConverter |http://localhost:2020/testresource?api=true
-|java.net.URL |URLConverter |http://localhost:2020/testresource?api=true
-|ZoneId |ZoneIdConverter |Europe/Zurich
-|=======
-
-
-=== Registering PropertyConverters
-
-Additional +PropertyConverters+ can be implemented easily. It is recommended to register then using the +java.util.ServiceLoader+,
-meaning you add a file under +META-INF/service/org.apache.tamaya.spi.PropertyConverter+ containing the fully qualified
-class names of the converters to be registered (one line per each).
-
-Alternatively you can also use a +ConfigurationContextBuilder+ to add additional converters programmatically.
-
-NOTE: API Implementations can be read-only thus not allowing adding additional converters programmatically.
-
-
-[[ComponentLoadingAndPriorization]]
-=== Component Loading and Priorization
-
-Tamaya Core in general loads all components using the +java.util.ServiceLoader+ mechanism. This means that new components
-must be registered by adding a file under +META-INF/service/<myInterfaceName>+ containing the fully qualified
-implementation class names of the components to be registered (one line per each).
-The +ServiceLoader+ itself does not provide any functionality for overriding or ordering of components. Tamaya
-core adds this functionality by the possibility to add +@Priority+ annotations to the components registered.
-By default, and if no annotation is added +0+ is used as priority. Hereby higher values preceed lower values, meaning
-
-* if a singleton component is accessed from the current +ServiceContext+ the component with the higher value
- effectively _overrides/replaces_ any component with lower values.
-* if a collection of components is obtained from the +ServiceContext+ the components are ordered in order, where the
- ones with higher priority are before components with lower priority.
-* if priorities match Tamaya Core additionally sorts them using the simple class name. This ensures that ordering is
- still defined and predictable in almost all scenarios.
-
-NOTE: Sorting the property sources based on their ordinal value is only the default ordering principle applied. By implementing
- your own implementation of +ConfigurationProviderSpi+ you can apply a different logic:
-
-
-[[RegisteringPropertySources]]
-=== Registering Property Sources
-
-PropertySources that provide configuration properties are registered as ordinary components as described in the previous
-section. Nevertheless the priority is not managed based on +@Priority+ annotations, but based on an explicit
-+int getOrdinal()+ method. This allows to define the ordinal/priority of a +PropertySource+ explicitly. This is useful
-due to several reasons:
-
-* it allows to define the ordinal as part of the configuration, thus allowing new overriding property sources being
- added easily.
-* it allows to define the ordinal dynamically, e.g. based on the configuration location, the time of loading or
- whatever may be appropriate.
-
-
-[[CorePropertySources]]
-== Configuration Setup in Core
-
-Tamaya Core provides a minimal configuration setting, that allows you to configure SE
-applications already easily. Basically configuration is built up by default as follows:
-
-. Read environment properties and add them prefixed with +env.+
-. Read all files found at +META-INF/javaconfiguration.properties+
- and +META-INF/javaconfiguration.xml+
-
-
-=== Overview of Registered Default Property Sources and Providers
-
-The Tamaya Core implementation provides a couple of default +PropertySource+ implementations, which are automatically
-registered. They are all in the package +org.apache.tamaya.core.propertysource+ and
-+org.apache.tamaya.core.provider+:
-
-[width="100%",frame="1",options="header",grid="all"]
-|=======
-|_Type_ |_Class Name_ |_Ordinal Used_
-|META-INF/javaconfiguration.properties |JavaConfigurationProvider |0
-|META-INF/javaconfiguration.xml |JavaConfigurationProvider |0
-|Environment Properties |EnvironmentPropertySource |300
-|System Properties |SystemPropertySource |400
-|=======
-
-
-=== Abstract Class PropertiesFilePropertySource
-
-The abstract class +PropertiesFilePropertySource+ can be used for implementing a +PropertySource+ based on a +URL+
-instance that points to a +.properites+ file. It requires a +URL+ to be passed on the constructor:
-
-[source,java]
---------------------------------------------
-PropertiesFilePropertySource(URL url);
---------------------------------------------
-
-
-==== Abstract Class PropertiesPropertySource
-
-The abstract class +PropertiesPropertySource+ can be used for implementing a +PropertySource+ based on a +Properties+
-instance. It requires a +PropertySource+ to be passed on the constructor:
-
-[source,java]
---------------------------------------------
-PropertiesPropertySource(Properties properties);
---------------------------------------------
-
-
-==== Abstract Class BasePropertySource
-
-The abstract class +BasePropertySource+ can be used for implementing custom +PropertySource+ classes. It requires only
-one method to implemented:
-
-[source,java]
-.Implementing a PropertySource using BasePropertySource
---------------------------------------------
-public class MyPropertySource extends BasePropertySource{
-
- public String getName(){
- // return a unique name for the property source, e.g. based on the underlying resource. This name also
- // allows to access the property source later
- }
-
- public Map<String, String> getProperties(){
- // Get a map with all properties provided by this property source
- // If the property source is not scannable, the map returned may be empty.
- // In the ladder case the +boolean isScannale()+ must be overridden, since
- // by default property sources are assumed to be scannable.
- }
-
-}
---------------------------------------------
-
-By default the ordinal of the property sources will be 1000, unless the key +tamaya.ordinal+ asdefined in
-+PropertySource.TAMAYA_ORDINAL+ is present in the current +PropertySource+. Of course it is also possible to override
-the inherited +protected void initializeOrdinal(final int defaultOrdinal)+, or directly +int getOrdinal()+.
-
-
-[[CorePropertySourceProviders]]
-=== Default PropertySourceProvider in Core
-
-With +org.apache.tamaya.core.provider.JavaConfigurationProvider+ there is also a default +PropertySourceProvider+
-present that loads all .properties files found at +META-INF/javaconfiguration.properties+
-and +META-INF/javaconfiguration.xml+.
-
-
-[[Extensions]]
-== Adding Extensions
-
-The Core module only implements the link:API.html[API]. Many users require/wish additional functionality from a
-configuration system. Fortunately there are numerous extensions available that add further functionality.
-Loading extensions hereby is trivial: you only are required to add the corresponding dependency to the classpath.
-
-For detailed information on the extensions available refer to the link:extensions.html[extensions documentation].
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/63124d1f/src/site/asciidoc/HighLevelDesign.adoc
----------------------------------------------------------------------
diff --git a/src/site/asciidoc/HighLevelDesign.adoc b/src/site/asciidoc/HighLevelDesign.adoc
deleted file mode 100644
index b3a3539..0000000
--- a/src/site/asciidoc/HighLevelDesign.adoc
+++ /dev/null
@@ -1,165 +0,0 @@
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements. See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership. The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License. You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied. See the License for the
-// specific language governing permissions and limitations
-// under the License.
-
-include::temp-properties-files-for-site/attributes.adoc[]
-
-
-== The Tamaya High Level Design
-
-Though Tamaya is a very powerful and flexible solution there are basically only a few simple core concepts required
-that build the base of all the other mechanisms:
-
-The *API* (package +org.apache.tamaya+) provides
-
-* A simple but complete SE *API* for accessing key/value based _Configuration_:
- ** +Configuration+ hereby models configuration, the main interface of Tamaya, providing key/value pairs as raw
- (String-based) key/value pairs, allowing also access to typed values.
- ** +ConfigurationProvider+ provides the static entry point for accessing configuration.
-
-The *SPI* (package +org.apache.tamaya.spi+) provides:
- ** A simple minimalistic model for configuration data, called _PropertySource_.
- ** Several extension points for adding additional configuration property sources or adapting the internal workings
- of the overall system.
- ** A +ServiceContext / ServiceContextManager+ that controls the loading of the components in Tamaya. This allows to
- adapt the behaviour depending on the runtime environment in use, e.g. a Java standalone application, an OSGI
- container or a Java EE application server.
-
-Tamaya *Modules* finally allow to add additional functionality to customize your configuration solution with the
-functionality you want. E.g. modules are providing features such as
-
-* Configuration _injection_
-* _Dynamic placeholders_ and resolution mechanism for configuration values
-* Abstractions for reusable _configuration formats_
-* Dynamic configuration updates and change events
-* Support for OSGI/Java EE Classloading
-* A configuration server/client
-* and more...
-
-
-== How Tamaya organizes Configuration
-=== Overview
-
-All the mentioned artifacts are used to organize configuration in a higly flexible and extendable way. Hereby the
-+PropertySource+ is the key artifact. In general Tamaya organizes Configuration as follows:
-
-image::../images/CoreDesign.png[]
-
-Key abstraction hereby is the +ConfigurationContext+, which basically
-
-* an ordered chain of +PropertySource+ instances. This chain is used to evaluate raw configuration values.
-* a set of +PropertyFilter+ instances that filter the raw values evaluated from the property source chain.
-* a set of +PropertyConverter+ that convert String values into typed values when needed.
-
-In most standalone use cases only one +ConfigurationContext+ will be active at a time. But in more complex scenarios,
-such as Java EE also multiple contexts could be active that are active depending on the current runtime context
-(e.g. attached to the corresponding classloader(s)). These aspects are basically handled by the
-+ConfigurationProvider+ and its corresponding SPIs.
-
-=== Loading the current _ConfigurationContext_
-
-The +ConfigurationContext+ is the core of Tamaya. It manages all configuration sources and additional components
-required to evaluate a concrete configuration value:
-
-* Tamaya loads all available +PropertySource+ instances. Hereby +PropertySource+ instances can be
- ** Directly registered (using the mechanism defined by the current +ServiceContext+ implementation, by default
- the Java +ServiceLoader+.
- ** Provided by a registered instance of +PropertySourceProvider+.
-* All loaded property sources are _ordered based on each ordinal_, returned from +PropertySource.getOrdinal()+ as
- an ordered chain of PropertySources, building up the ordered chain of +PropertySource+ instances used for raw
- configuration value evaluation.
-* Tamaya loads all available +PropertyFilter+ instances. Hereby +PropertyFilter+ instances can be registered
- by default using the Java +ServiceLoader+ API. The +PropertyFilter+ instances loaded are ordered based on the
- +@Priority+ annotations found on each filter. If no priority annotation is present, +0+ is assumed.
-* Tamaya loads all available +PropertyConverter+ instances. Hereby +PropertyConverter+ instances can be registered
- by default using the Java +ServiceLoader+ API. The +PropertyConverter+ instances loaded are ordered based on the
- +@Priority+ annotations found on each filter. If no priority annotation is present, +0+ is assumed. It is
- possible to register multiple converters for the same target type.
-
-=== Evaluating raw property values
-When evaluating a concrete configuration value for a given key, Tamaya iterates through this chain of registered
-PropertySources. Hereby the final value, by default, is determined by the last non-null value returned from a
-+PropertySource+.
-
-Since the ladder may not always be appropriate, e.g. when values should be combined instead of overridden, a
-instance of +PropertyValueCombinationPolicy+ can be registered, which allows to add more detailed behaviour how values
-are combined.
-
-Access to the complete configuration +Map+ is performing the same resolution and combination algorithm, but for all
-key/value pairs available.
-
-=== Filtering the raw properties:
-Each raw configuration value evaluated is filtered by the ordered filter chain, as long as there are any changes
-applied by any of the filters called. This ensures that also transitive replacements by filters are possible.
-If, after a configurable number of evaluation loops still values are changes during each loop, the filtering
-process is aborted, since a non-resolvable circular filter issue is assumed.
-
-The output is the final configuration value as type +String+.
-
-=== Applying type conversion:
-Finally, if the required target type, does not match +Java.ui.lang.String+, all registered +PropertyConverter+
-instances targeting the corresponding target type are asked to convert the given (String-based) configuration
-entry to the required (non String) target type.
-
-Hereby the first _non-null_ value returned by a +PropertyConverter+ is used as the final typed configuration value and
-returned to the caller.
-
-=== Advanced Features
-Basically the bahaviour of Tamaya can be customized using the following mechanisms. Basically configuration can be
-provided using the following mechanism:
-
-* Registering additional (default) +PropertySource+ instances. Depending on their _ordinal value_ they
- will override or extend existing configuration.
-* Registering additional (default) +PropertySourceProvider+ instances.that can provide multiple +PropertySource+
- instances.
-
-Additionally Tamaya provides hooks for further adapting the internal workings:
-
-* Adapting the way how multiple entries with the same key are combined (+PropertyValueCombinationPolicy+). This
- may be useful, if overriding is not the way how entries of the same key should be combined. An example, where
- such an alternate scenario is useful are list entries, that combine all entries encountered to a collecting
- list entry.
-* Adding additional support for new target types configurable by registering additional +PropertyConverter+
- instances. This can be used for adding support for new types as well as for adding support for additional
- formats.
-* Complex extensions may adapt the complete +ConfigurationContext+, using the +ConfigurationContextBuilder+ and
- reapply the changed instance using +ConfigurationProvider.setConfigurationContext(ConfigurationContext)+.
- This is one example how to react on dynamic changes detected on configuration files read.
-* Registering additional +PropertyFilter+ instances, that filter the configuration values extracted.
-* Registering an alternate +ServiceContext+ to support alternate runtime containers, e.g. a CDI container.
-* A combination of all above.
-
-Additionally instances of +ConfigOperator, ConfigQuery+ can be provided that provide additional functionality
-that should not be globally visible. It is recommended to provide them from a singleton accessor, hereby hiding
-the effective implementation classes.
-
-== Component Loading
-
-As mentioned the component loading of Tamaya can be adapted. By default the JDK +ServiceLoader+ API is used to determine
-a +ServiceContext+ implementation that should control
-Tamaya's overall component loading. If not found, a default implementation is registered, which relies on the
-Java +hava.util.ServiceLoader+ mechanism. This behaviour can be changed by implementing your own version
-of the +ServiceContext+ interface, annotating it with a +@Priority+ annotation and registering it using the
-+java.util.ServiceLoader+ mechanism.
-
-== Compatibility
-
-The Tamaya API is compatible with Java 7 and beyond.
-
-== Further Documentation
-
-Being here we recommend to have a look at the more detailed documentation of Tamaya's link:API.html[API and SPI],
-and of its current available link:extensions.html[modules].
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/63124d1f/src/site/asciidoc/community.adoc
----------------------------------------------------------------------
diff --git a/src/site/asciidoc/community.adoc b/src/site/asciidoc/community.adoc
deleted file mode 100644
index 3101614..0000000
--- a/src/site/asciidoc/community.adoc
+++ /dev/null
@@ -1,142 +0,0 @@
-//
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements. See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership. The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License. You may obtain a copy of the License at
-// .
-// http://www.apache.org/licenses/LICENSE-2.0
-// .
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied. See the License for the
-// specific language governing permissions and limitations
-// under the License.
-//
-
-include::temp-properties-files-for-site/attributes.adoc[]
-
-= Apache Tamaya: Community
-
-:sectnums:
-
-// Document properties
-:twitterhandle: tamayaconf
-
-== Users
-
-If you are a new user and you would like to participate in Tamaya
-(would be great!), you can have a look at the current
-project documentation. Apache Tamaya currently does
-not yet have a users mailing list. If you want discuss your use cases
-we encourage you to mailto:dev-subscribe@tamaya.incubator.apache.org[subscribe]
-to our mailto:dev@tamaya.incubator.apache.org[mailing list for developers].
-Furthermore, you can check our xref:a_mailing_lists[mail-archives].
-
-Before you file a ticket in our https://issues.apache.org/jira/browse/TAMAYA[Jira^]
-please ask on the mailing list if it's a known issue in case of a
-bug or if there is an ongoing discussion in case of a feature.
-
-You are very welcome to follow our twitter account
-http://twitter.com/{twitterhandle}[@{twitterhandle}^] and spread the word
-of Tamaya with tweets, blog entries,...
-
-== Getting Involved
-
-Everybody is welcome to get involved with our community. You can find general
-information at http://apache.org/foundation/getinvolved.html and
-http://apache.org/foundation/how-it-works.html.
-The following sections provides some details about the different levels of getting involved.
-
-If you want to contribute to the
-documentation of Apache Tamaya, please
-read the instructions about the Documentation
-that addresses how to contribute, render and publish it.
-
-
-=== Contributors
-
-Before you get a committer you have to contribute to our effort.
-E.g. you can help users, participate in discussions on the dev list,
-submit patches,... . Therefore, it's essential to file
-a http://www.apache.org/licenses/icla.txt[Individual Contributor License Agreement (ICLA)^]
-or http://www.apache.org/licenses/cla-corporate.txt[Software Grant and Corporate Contributor License Agreement (CCLA)^]
-and send it to secretary at apache dot org (or fax it) as early as possible.
-
-If you would like to submit a patch through Jira, you can have a look at the
-link:devguide.html[suggested Git approach].
-
-The lists of current contributors and committers can be found
-on the link:team-list.html[team and contributers page^].
-
-
-=== Committers
-
-Before you read this section, please ensure that you have read
-the contributor section. All of you are welcome to join our development effort.
-mailto:dev-subscribe@tamaya.incubator.apache.org[Subscribe] to our
-mailto:dev@tamaya.incubator.apache.org[mailing list for developers] and
-start contributing and help users.
-
-// todo Fix the link when finishing the new homepage, Oliver B. Fischer, 2015-09-12
-Optionally mailto:commits-subscribe@tamaya.incubator.apache.org[subscribe] to our
-mailto:commits@tamaya.incubator.apache.org[mailing list for commits].
-Furthermore, you can check our link:community.html#mailing-lists[mail-archives].
-
-Further details are available at http://www.apache.org/dev/[http://www.apache.org/dev/^].
-
-=== Mailing lists
-
-The table below lists all mailings used by the Tamaya project.
-
-[width="70"]
-[cols="5*.<", options="header"]
-|===
-| List
-| Subscribe
-| Unsubscribe
-| Archive
-| Mirrors
-//-- next row
-| Developer List
-| mailto:dev-subscribe@tamaya.incubator.apache.org[Subscribe]
-| mailto:dev-unsubscribe@tamaya.incubator.apache.org[Unsubscribe]
-| http://mail-archives.apache.org/mod_mbox/incubator-tamaya-dev/[Archive^]
-|
-//-- next row
-| Committer List
-| mailto:commits-subscribe@tamaya.incubator.apache.org[Subscribe]
-| mailto:commits-unsubscribe@tamaya.incubator.apache.org[Unsubscribe]
-| http://mail-archives.apache.org/mod_mbox/incubator-tamaya-commits/[Archive^]
-|
-|===
-
-=== JIRA
-
-Any kind of issue has to be filed in our
-https://issues.apache.org/jira/browse/TAMAYA[issue tracker^].
-If you have any question, you can ask us
-(e.g. via the mailing list for developers).
-
-=== Spread the word
-
-You are very welcome e.g. to write blog entries, mention our twitter handle
- @{twitterhandle} if you tweet about the project or just follow our twitter
-account http://twitter.com/{twitterhandle}[@{twitterhandle}^]
-
-=== IRC
-
-Usually discussions happen on the mailing list. Some informal discussions take
-place in our IRC-Channel irc://irc.freenode.net/apache-tamaya.
-
-----
-// with the irssi command-line client:
-$ irssi
-
-> /connect irc.freenode.net
-> /join #apache-tamaya
-----
-
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/63124d1f/src/site/asciidoc/devguide.adoc
----------------------------------------------------------------------
diff --git a/src/site/asciidoc/devguide.adoc b/src/site/asciidoc/devguide.adoc
deleted file mode 100644
index 5753e90..0000000
--- a/src/site/asciidoc/devguide.adoc
+++ /dev/null
@@ -1,211 +0,0 @@
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements. See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership. The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License. You may obtain a copy of the License at
-// .
-// http://www.apache.org/licenses/LICENSE-2.0
-// .
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied. See the License for the
-// specific language governing permissions and limitations
-// under the License.
-
-include::temp-properties-files-for-site/attributes.adoc[]
-
-:sectnums: yes
-
-= Apache Tamaya: Development Guide
-
-== Suggested Git Workflows
-
-=== Avoid git pull!
-
-`git pull` should never get invoked if you have dirty files lying around
-or if your branch is ahead of master. This will always lead to
-some dirty artifacts in the commit history:
-
-----
-Merge branch 'master' of http://git-wip-us.apache.org/tamaya into master
-----
-
-=== Use git pull --rebase
-
-An easy version for getting rid of the auto-merges is using
-
-----
-$ git pull --rebase
-----
-
-Please note that this sometimes trashes your working tree if there
-are unmergeable files around. Cleaning this up with a forced manual
-rebase is not something we would recommend for a git beginner.
-
-=== Working in an own branch
-
-This is actually the suggested way to prevent auto-merges. Create an own
-branch where you do your feature work. Either do all your work in one
-branch or create one branch per feature you are working on.
-
-----
-$ git branch mybranch
-----
-
-After you finished your feature, first add (`git add`) and commit (`git commit`) your work.
-Check with `git status` that you don't have any dirty files and uncommitted
-changes around. You can use `git stash` to 'backup' unfinished work.
-
-Then switch back to the master branch and pull changes
-done by other committers in the meantime.
-
-----
-$ git checkout master
-$ git pull --rebase
-----
-
-You should now get all the changes done by other committers and
-the will get applied to your local master branch. Now go back to
-your private branch and rebase your locally performed work to the HEAD of master.
-
-----
-$ git checkout mybranch
-$ git rebase master
-----
-
-If you got conflicts, you will get lines with ">>>>" added to those
-files. Resolve those conflicts manually, add them and finish the rebase.
-
-Check with `git-status` and `gitk` if the merge went well and the history now contains your changes.
-If all is well, go back to the master branch and merge your changes in.
-
-----
-$ git pull --rebase // (just for safety, you should see no changes)
-$ git checkout master
-$ git merge mybranch
-----
-
-Finally you can push your changes to the ASF git repo
-
-----
-$ git push
-----
-
-[[contributing-workflow]]
-== Contribution workflow
-
-=== Creating patches
-
-You should use the following workflow, if you plan to contribute
-patches or new features to Tamaya.
-
-First update you local copy of the repository:
-
-----
-$ git checkout master
-$ git pull --rebase
-----
-
-Then create a new local branch for your work. It's good practice to name
-it after the corresponding JIRA issue.
-
-----
-$ git checkout -b TAMAYA-XXX
-----
-
-Now you can start to work on your patch. When you are finished, commit your changes. But don't forget to **add the name
-of the JIRA issue to the commit message**.
-
-----
-$ git add -am "TAMAYA-XXX: Fixed some issue"
-----
-
-For small patches we recommend to do a single commit containing your changes. For larger contributions you should try
-to group your work into separate sub-tasks that you can commit one by one.
-
-Before you create your patch you should make sure that your local repository is up to date with the master repository.
-This is very important especially if you work on your branch for a long time. Use the following commands to pull the
-latest changes from the upstream repository and rebase your branch against the current master.
-
-
-----
-$ git checkout master
-$ git pull --rebase
-$ git checkout TAMAYA-XXX
-$ git rebase master
-----
-
-Now you are ready to create your patch:
-
-----
-$ git checkout TAMAYA-XXX
-$ git format-patch --stdout master > ../TAMAYA-XXX.patch
-----
-
-Please attach the resulting patch file to the correspoding JIRA issue.
-
-=== Applying patches
-
-If you are a committer and want to apply a patch you should do so in a separate branch.
-
-----
-$ git checkout -b TAMAYA-XXX
-----
-
-Then apply the patch using `git am` and rebase it against the master branch.
-
-----
-$ git am < ../TAMAYA-XXX.patch
-$ git rebase master
-----
-
-After reviewing the changes and testing the code, the changes are ready to
-be merged into the master branch:
-
-----
-$ git checkout master
-$ git merge TAMAYA-XXX
-$ git branch -d TAMAYA-XXX
-----
-
-=== Discussion workflow (optional)
-
-All discussions which lead to a decision take place on the mailing list.
-Sometimes it's required to show-case an idea esp. if the solution is
-more than few lines. As shown above it makes sense to use local branches
-for developing new parts. Git allows to push such local branches to a
-public repository. So it's easier to share it with the community
-for discussing it. The following listings show an example in combination
-with GitHub - for sure it works with any hosting platform like BitBucket,
-Google-Code,... The only important part here is that such branches
-*NEVER* get pushed to the main Apache repository to keep the commit history
-as clean as possible.
-
-=== Initial setup
-
-----
-$ git clone https://git-wip-us.apache.org/repos/asf/incubator-tamaya.git
-$ git remote add discuss https://[username]@github.com/[username]/[repo-name].git
-$ git push -u discuss master
-----
-
-=== Branches for discussions
-
-----
-$ git checkout -b TAMAYA-XXX # 1-n commits
-$ git push discuss TAMAYA-XXX # share the link to the branch for the discussions
-----
-
-*If the community agrees on the suggested change, the implementation will be applied to the origin master. A committer
-has to follow the steps described above for the basic workflow to keep the commit history simple, clean and straight.
-A contributor has to follow the steps described above for creating a patch.*
-
-=== Delete the branch again
-
-----
-$ git push discuss :TAMAYA-XXX
-$ git branch -d TAMAYA-XXX
-----
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/63124d1f/src/site/asciidoc/download.adoc
----------------------------------------------------------------------
diff --git a/src/site/asciidoc/download.adoc b/src/site/asciidoc/download.adoc
deleted file mode 100644
index 941fb7f..0000000
--- a/src/site/asciidoc/download.adoc
+++ /dev/null
@@ -1,110 +0,0 @@
-// Licensed to the Apache Software Foundation (ASF) under one
-// or more contributor license agreements. See the NOTICE file
-// distributed with this work for additional information
-// regarding copyright ownership. The ASF licenses this file
-// to you under the Apache License, Version 2.0 (the
-// "License"); you may not use this file except in compliance
-// with the License. You may obtain a copy of the License at
-// .
-// http://www.apache.org/licenses/LICENSE-2.0
-// .
-// Unless required by applicable law or agreed to in writing,
-// software distributed under the License is distributed on an
-// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-// KIND, either express or implied. See the License for the
-// specific language governing permissions and limitations
-// under the License.
-
-//:source-highlighter: coderay
-
-include::temp-properties-files-for-site/attributes.adoc[]
-
-:sectnums: yes
-:linkattrs: true
-
-= Apache Tamaya: Download
-
-The latest release is Apache Tamaya {tamaya_version_released}.
-You can download it it from the
-http://www.apache.org/dist/incubator/tamaya[Apache Software Foundation Distribution Directory^].
-
-The release notes for each release of Apache Tamaya
-can be found at the link:history.html[release history page].
-
-== Current Source Code
-
-Downloading of the the current state of the project can be done by
-
-* cloning the https://github.com/apache/incubator-tamaya[GitHub mirror^]
-* Github also provides an easy way to dowload the current project source as zip archive.
-// @todo * Cloning the Apache source tree, see link:3[source section]. source.html
-
-
-== Maven Dependencies
-
-// @todo
-// @todo Details are available <a href="documentation/#_project_configuration_without_maven">here</a>.
-
-
-// @todo Source highlighting does not work currently.
-//
-[source,xml,subs="verbatim,attributes"]
-----
-<dependency>
- <groupId>{tamaya_mvn_group_id}</groupId>
- <artifactId>tamaya-api</artifactId>
- <version>{tamaya_version_released}</version>
-</dependency>
-<dependency>
- <groupId>{tamaya_mvn_group_id}</groupId>
- <artifactId>tamaya-core</artifactId>
- <version>{tamaya_version_released}</version>
-</dependency>
-----
-
-
-== Previous Releases
-
-All previous releases can also be found at the
-http://www.apache.org/dist/incubator/tamaya/[Apache Software Foundation Distribution Directory^].
-In our link:history.html[release history overview] you can find all previous releases of Tamaya.
-
-== Verifying Releases
-
-It is essential that you verify the integrity of any downloaded files using
-the PGP or MD5 signatures. For more information on signing artifacts and
-why we do it, check out the
-http://www.apache.org/dev/release-signing.html[Release Signing FAQ^].
-
-The PGP signatures can be verified using PGP or GPG. First download the
-http://www.apache.org/dist/incubator/tamaya/KEYS[KEYS file^]
-as well as the asc signature file for the artifact. Make sure you get
-these files from the
-http://www.apache.org/dist/incubator/tamaya/[main distribution directory^]
-rather than from a
-http://www.apache.org/dyn/closer.cgi/tamaya/[mirror^].
-Then verify the signatures using e.g.:
-
-[source,shell]
-----
-$ pgpk -a KEYS
-$ pgpv tamaya-project-1.2.0-source-release.zip.asc
-----
-
-or
-[source,shell]
-----
-$ pgp -ka KEYS
-$ pgp tamaya-project-1.2.0-source-release.zip.asc
-----
-
-or
-
-[source,shell]
-----
-$ gpg --import KEYS
-$ gpg --verify tamaya-project-1.2.0-source-release.zip.asc
-----
-
-
-