http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/examples.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/examples.adoc b/src/site/asciidoc/examples.adoc new file mode 100644 index 0000000..9f4892a --- /dev/null +++ b/src/site/asciidoc/examples.adoc @@ -0,0 +1,69 @@ +// 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 -- Examples + +toc::[] + +== Tamaya Examples + +=== Minimal + +This example shows the basic functionality that is available when Tamaya is used without any further extensions. +It shows how configuration can be added to the classpath and how it can be accessed. + +=== Simple PropertySource + +This example shows how to write and register an additional +PropertySource+ and +PropertySourceProvider+, which is +the SPI to add your own configuration data and locations. For a more advanced example you may also have a look at +the provided default metamodels, e.g. the simple metamodel (currently in the experimental part and not shipped with +the current release). + +=== Resources + +This example shows how resources can be located using ANT-styled paths and this feature can help you to implement ++PropertySourceProvider+ instances that provide configuration for a set of files/folders at a certain (searchable) +location, as provided by the resource extension_. + +=== Resolver + +The resolver example defines a configuration file that illustrates the usage of placeholders that are resolved on +configuration access, as provided by the _resolver extension_. + +=== Injection + +The injection sample shows how to inject configuration into a created object instance, or how to instantiate a proxied +configuration template, which provides a type-safe configuration access mechanism. This functionality is provided +by the _injection extension_. Hereby neither JSR 330 nor 299 are used, so it is pure and minimal SE based +implementation. + +=== FileObserver + +This example shows how the +event extension+ can be used to automatically adapt the current configuration when +the underlying configuration data is changing, e.g. when new configuration is added to a file folder, or removed or +adapted. + +=== Builder + +This example shows how to build a +Configuration+ using a simple pure SE builder API as provided by the +_builder extension_. + +=== Remote + +THe remote example shows a simple setup where parts of the +Configuration+ are read remotedly.
http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions.adoc b/src/site/asciidoc/extensions.adoc new file mode 100644 index 0000000..ec72f29 --- /dev/null +++ b/src/site/asciidoc/extensions.adoc @@ -0,0 +1,105 @@ +// 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 -- Extension Modules + +toc::[] + +=== Mature Extensions + +Mature extensions have a stable API and SPI, similar to the API and Implementations provided. + +[width="100%",frame="1",options="header",grid="all"] +|======= +|_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] +|+org.apache.tamaya.ext:tamaya-optional+ |Lets a Tamaya configuration to be used as an optional project extension only. |link:extensions/mod_optional.html[Documentation] +|+org.apache.tamaya.ext:tamaya-resolver+ |Provides placeholder and dynamic resolution functionality for configuration values. |link:extensions/mod_resolver.html[Documentation] +|+org.apache.tamaya.ext:tamaya-spi-support+ |Tamaya support module for SPI implementation. |link:extensions/mod_spi-support.html[Documentation] +|======= + + +=== Extensions + +Extensions in _draft state_ are tested well and normally should have rather stable APIs. Nevertheless API changes may +still occurr, but we try to prevent such changes if possible. + +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-builder+ |Provides a fluent-style builder for configurations | link:extensions/mod_builder.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-events+ |Provides support for publishing configuration changes |link:extensions/mod_events.html[Documentation] +|+org.apache.tamaya.ext:tamaya-filter+ |Provides a programmatic filter for config entries. | link:extensions/mod_filter.html[Documentation] +|+org.apache.tamaya.ext:tamaya-injection+ |Provides configuration injection services and congiruation template support. |link:extensions/mod_injection.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-model+ |Provides support documenting ang validating configuration during runtime. |link:extensions/mod_model.html[Documentation] +|+org.apache.tamaya.ext:tamaya-mutable-config+|Provides API/SPI for writing configuration |link:extensions/mod_mutable_config.html[Documentation] +|+org.apache.tamaya.ext:tamaya-remote+ |Provides remote configuration support. |link:extensions/mod_remote.html[Documentation] +|+org.apache.tamaya.ext:tamaya-resources+ |Provides ant-style resource path resolution |link:extensions/mod_resources.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-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] +|======= + +=== Integrations + +These extensions integrate/bridge Tamayas functionality with other frameworks turning their configuration capabilities +from a sledgehammer to a scalpell: + +[width="100%",frame="1",options="header",grid="all"] +|======= +|_Artifact_ |_Description_ |_Links_ +|+org.apache.tamaya.ext:tamaya-cdi+ | Java EE/standalone compliant CDI integration | link:extensions/mod_cdi.html[Documentation] +|+org.apache.tamaya.ext:tamaya-camel+ | Integration for Apache Camel. | link:extensions/mod_camel.html[Documentation] +|+org.apache.tamaya.ext:tamaya-spring+ | Integration for Spring / Spring Boot. | link:extensions/mod_spring.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] +|======= + + +=== Extensions in Experimental Stage + +Extensions in _experimental mode_ may still be under discussions. API changes may still happen, so use them +very carefully and especially give us feedback, so we can improve them before progressing to _draft_ state. + +[width="100%",frame="1",options="header",grid="all"] +|======= +|_Artifact_ |_Description_ |_Links_ +|+org.apache.tamaya.ext:tamaya-jodatime+ |Provides support for JodaTime. | link:extensions/mod_jodatime.html[Documentation] +|+org.apache.tamaya.ext:tamaya-staged+ |Simple configuration extension to add staged config. | link:extensions/mod_metamodel-staged.html[Documentation] +|======= + + +=== Integrations in Experimental Stage + +Integrations in _experimental mode_ may still be under discussions, or may even not compile ! API changes may still happen, so use them +very carefully and especially give us feedback, so we can improve them before progressing to _draft_ state. + +[width="100%",frame="1",options="header",grid="all"] +|======= +|_Artifact_ |_Description_ |_Links_ +|+org.apache.tamaya.ext:tamaya-commons+ |Integration with Apache Commons Configuration. | - +|======= http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/index.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/index.adoc b/src/site/asciidoc/extensions/index.adoc deleted file mode 100644 index 2aab46b..0000000 --- a/src/site/asciidoc/extensions/index.adoc +++ /dev/null @@ -1,124 +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. - -Apache Tamaya -- Extension Modules -================================== -:name: Tamaya -:rootpackage: org.apache.tamaya -:title: Apache Tamaya Extension Modules -:revnumber: {tamayaVersion} -:revremark: Incubator -:revdate: March 2015 -:longversion: {revnumber} ({revremark}) {revdate} -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: -toc::[] - -== Mature Extensions - -Mature extensions have a stable API and SPI, similar to the API and Implementations provided. - -[width="100%",frame="1",options="header",grid="all"] -|======= -|_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:mod_formats.html[Documentation] -|+org.apache.tamaya.ext:tamaya-functions+ |Provides several functional extension points. |link:mod_functions.html[Documentation] -|+org.apache.tamaya.ext:tamaya-json+ |Provides format support for JSON based configuration. |link:mod_json.html[Documentation] -|+org.apache.tamaya.ext:tamaya-optional+ |Lets a Tamaya configuration to be used as an optional project extension only. |link:mod_optional.html[Documentation] -|+org.apache.tamaya.ext:tamaya-resolver+ |Provides placeholder and dynamic resolution functionality for configuration values. |link:mod_resolver.html[Documentation] -|+org.apache.tamaya.ext:tamaya-spi-support+ |Tamaya support module for SPI implementation. |link:mod_spi-support.html[Documentation] -|======= - - -== Extensions - -Extensions in _draft state_ are tested well and normally should have rather stable APIs. Nevertheless API changes may -still occurr, but we try to prevent such changes if possible. - -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-builder+ |Provides a fluent-style builder for configurations | link:mod_builder.html[Documentation] -|+org.apache.tamaya.ext:tamaya-classloader-support+ |Manages Tamaya configuration and services considering classloading hierarchies. |link:mod_classloader_support.html[Documentation] -|+org.apache.tamaya.ext:tamaya-events+ |Provides support for publishing configuration changes |link:mod_events.html[Documentation] -|+org.apache.tamaya.ext:tamaya-filter+ |Provides a programmatic filter for config entries. | link:mod_filter.html[Documentation] -|+org.apache.tamaya.ext:tamaya-injection+ |Provides configuration injection services and congiruation template support. |link:mod_injection.html[Documentation] -|+org.apache.tamaya.ext:tamaya-management+ |Provides JMX support for inspecting configuration. |link:mod_management.html[Documentation] -|+org.apache.tamaya.ext:tamaya-model+ |Provides support documenting ang validating configuration during runtime. |link:mod_model.html[Documentation] -|+org.apache.tamaya.ext:tamaya-mutable-config+|Provides API/SPI for writing configuration |link:mod_mutable_config.html[Documentation] -|+org.apache.tamaya.ext:tamaya-remote+ |Provides remote configuration support. |link:mod_remote.html[Documentation] -|+org.apache.tamaya.ext:tamaya-resources+ |Provides ant-style resource path resolution |link:mod_resources.html[Documentation] -|+org.apache.tamaya.ext:tamaya-server+ |Lets a Tamaya configuration instance provide scoped configuration as a REST service. |link:mod_server.html[Documentation] -|+org.apache.tamaya.ext:tamaya-yaml+ |Support for using yaml as a configuration format. |link:mod_yaml.html[Documentation] -|======= - -== Integrations - -These extensions integrate/bridge Tamayas functionality with other frameworks turning their configuration capabilities -from a sledgehammer to a scalpell: - -[width="100%",frame="1",options="header",grid="all"] -|======= -|_Artifact_ |_Description_ |_Links_ -|+org.apache.tamaya.ext:tamaya-cdi+ | Java EE/standalone compliant CDI integration | link:mod_cdi.html[Documentation] -|+org.apache.tamaya.ext:tamaya-camel+ | Integration for Apache Camel. | link:mod_camel.html[Documentation] -|+org.apache.tamaya.ext:tamaya-spring+ | Integration for Spring / Spring Boot. | link:mod_spring.html[Documentation] -|+org.apache.tamaya.ext:tamaya-osgi+ | Integration for OSGI containers. | link:mod_osgi.html[Documentation] -|+org.apache.tamaya.ext:tamaya-consul+ | Integration with consul clusters. | link:mod_consul.html[Documentation] -|+org.apache.tamaya.ext:tamaya-etcd+ | Integration with etcd clusters. | link:mod_etcd.html[Documentation] -|======= - - -== Extensions in Experimental Stage - -Extensions in _experimental mode_ may still be under discussions. API changes may still happen, so use them -very carefully and especially give us feedback, so we can improve them before progressing to _draft_ state. - -[width="100%",frame="1",options="header",grid="all"] -|======= -|_Artifact_ |_Description_ |_Links_ -|+org.apache.tamaya.ext:tamaya-jodatime+ |Provides support for JodaTime. | link:mod_jodatime.html[Documentation] -|+org.apache.tamaya.ext:tamaya-staged+ |Simple configuration extension to add staged config. | link:mod_metamodel-staged.html[Documentation] -|+org.apache.tamaya.ext:tamaya-collections+ |Collections support. | link:mod_collections.html[Documentation] -|+org.apache.tamaya.ext:tamaya-ui+ |UI for Managing Configuration. | - -|======= - - -== Integrations in Experimental Stage - -Integrations in _experimental mode_ may still be under discussions, or may even not compile ! API changes may still happen, so use them -very carefully and especially give us feedback, so we can improve them before progressing to _draft_ state. - -[width="100%",frame="1",options="header",grid="all"] -|======= -|_Artifact_ |_Description_ |_Links_ -|+org.apache.tamaya.ext:tamaya-store+ |SPI for writing configuration. | - -|+org.apache.tamaya.ext:tamaya-store-file+ |Store SPI implementation using file storage. | - -|+org.apache.tamaya.ext:tamaya-store-hazelcast+ |Store SPI implementation using a Hazelcast Datagrid. | - -|+org.apache.tamaya.ext:tamaya-store-ignite+ |Store SPI implementation using Apache Ignite. | - -|+org.apache.tamaya.ext:tamaya-commons+ |Integration with Apache Commons Configuration. | - -|======= http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_builder.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_builder.adoc b/src/site/asciidoc/extensions/mod_builder.adoc index 2a22217..34472a8 100644 --- a/src/site/asciidoc/extensions/mod_builder.adoc +++ b/src/site/asciidoc/extensions/mod_builder.adoc @@ -19,20 +19,6 @@ include::temp-properties-files-for-site/attributes.adoc[] -:name: Tamaya -:rootpackage: org.apache.tamaya.builder -:title: Apache Tamaya Extension: Builder -:revnumber: 0.1.1 -:revremark: Incubator -:revdate: March 2015 -:longversion: {revnumber} ({revremark}) {revdate} -:authorinitials: OBF -:author: Oliver B. Fischer -:email: <ple...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:encoding: UTF-8 -:numbered: [[BuilderCore]] == Tamaya Builder (Extension Module) http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_camel.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_camel.adoc b/src/site/asciidoc/extensions/mod_camel.adoc index 41e97c8..abb5199 100644 --- a/src/site/asciidoc/extensions/mod_camel.adoc +++ b/src/site/asciidoc/extensions/mod_camel.adoc @@ -17,29 +17,9 @@ = Apache Tamaya -- Extension: Integration with Apache Camel -:name: Tamaya -:rootpackage: org.apache.tamaya.integration.camel -:title: Apache Tamaya Extension: Integration with Apache Camel -:revdate: December 2015 -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: - -''' - -<<< - toc::[] -<<< -:numbered!: -<<< + [[Optional]] == Integration with Apache Camel (Extension Module) === Overview http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_cdi.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_cdi.adoc b/src/site/asciidoc/extensions/mod_cdi.adoc index 40cf835..e5fe95e 100644 --- a/src/site/asciidoc/extensions/mod_cdi.adoc +++ b/src/site/asciidoc/extensions/mod_cdi.adoc @@ -17,29 +17,9 @@ = Apache Tamaya -- Extension: Classloader Isolation Support -:name: Tamaya -:rootpackage: org.apache.tamaya.integration.cdi -:title: Apache Tamaya Extension: CDI Integration of tamaya-injection (SE) -:revdate: September 2015 -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: - -''' - -<<< - toc::[] -<<< -:numbered!: -<<< + [[Remote]] == Tamaya CDI Integration (Extension Modules) === Overview http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_classloader_support.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_classloader_support.adoc b/src/site/asciidoc/extensions/mod_classloader_support.adoc index aa3e42a..f8bf529 100644 --- a/src/site/asciidoc/extensions/mod_classloader_support.adoc +++ b/src/site/asciidoc/extensions/mod_classloader_support.adoc @@ -17,29 +17,8 @@ = Apache Tamaya -- Extension: Classloader Isolation Support -:name: Tamaya -:rootpackage: org.apache.tamaya.clsupport -:title: Apache Tamaya Extension: Classloader Isolation Support -:revdate: September 2015 -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: - -''' - -<<< - toc::[] -<<< -:numbered!: -<<< [[Remote]] == Tamaya Classloader Aware ServiceContext (Extension Module) === Overview http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_collections.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_collections.adoc b/src/site/asciidoc/extensions/mod_collections.adoc index 02a1c5e..835a20c 100644 --- a/src/site/asciidoc/extensions/mod_collections.adoc +++ b/src/site/asciidoc/extensions/mod_collections.adoc @@ -17,29 +17,8 @@ = Apache Tamaya -- Extension: Collection Support -:name: Tamaya -:rootpackage: org.apache.tamaya.collection -:title: Apache Tamaya Extension: Collection Support -:revdate: February 2016 -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: - -''' - -<<< - toc::[] -<<< -:numbered!: -<<< [[Optional]] == Tamaya Collection Support (Extension Module) === Overview http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_consul.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_consul.adoc b/src/site/asciidoc/extensions/mod_consul.adoc index 497da89..5aa3055 100644 --- a/src/site/asciidoc/extensions/mod_consul.adoc +++ b/src/site/asciidoc/extensions/mod_consul.adoc @@ -17,29 +17,9 @@ = Apache Tamaya -- Extension: Integration with consul (Hashicorp) -:name: Tamaya -:rootpackage: org.apache.tamaya.integration.consul -:title: Apache Tamaya Extension: Integration with consul service -:revdate: February 2016 -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: - -''' - -<<< - toc::[] -<<< -:numbered!: -<<< + [[Optional]] == Integration with consul (Extension Module) === Overview http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_environment.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_environment.adoc b/src/site/asciidoc/extensions/mod_environment.adoc index 39f9665..2e5921f 100644 --- a/src/site/asciidoc/extensions/mod_environment.adoc +++ b/src/site/asciidoc/extensions/mod_environment.adoc @@ -17,29 +17,9 @@ = Apache Tamaya -- Extension: Classloader Isolation Support -:name: Tamaya -:rootpackage: org.apache.tamaya.environment -:title: Apache Tamaya Extension: Environment -:revdate: September 2015 -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: - -''' - -<<< - toc::[] -<<< -:numbered!: -<<< + [[Remote]] == Tamaya Environment Model (Extension Module) === Overview http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_etcd.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_etcd.adoc b/src/site/asciidoc/extensions/mod_etcd.adoc index d7fc70f..bfb4b30 100644 --- a/src/site/asciidoc/extensions/mod_etcd.adoc +++ b/src/site/asciidoc/extensions/mod_etcd.adoc @@ -17,29 +17,9 @@ = Apache Tamaya -- Extension: Integration with etcd (Core OS) -:name: Tamaya -:rootpackage: org.apache.tamaya.integration.etcd -:title: Apache Tamaya Extension: Integration with etcd service -:revdate: January 2016 -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: - -''' - -<<< - toc::[] -<<< -:numbered!: -<<< + [[Optional]] == Integration with etcd (Extension Module) === Overview http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_events.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_events.adoc b/src/site/asciidoc/extensions/mod_events.adoc index a399e0d..d325948 100644 --- a/src/site/asciidoc/extensions/mod_events.adoc +++ b/src/site/asciidoc/extensions/mod_events.adoc @@ -17,32 +17,9 @@ = Apache Tamaya -- Extension: Events -:name: Tamaya -:rootpackage: org.apache.tamaya.ext.events -:title: Apache Tamaya Extension: Events -:revnumber: 0.1.1 -:revremark: Incubator -:revdate: March 2015 -:longversion: {revnumber} ({revremark}) {revdate} -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: - -''' - -<<< - toc::[] -<<< -:numbered!: -<<< + [[Core]] == Tamaya Events (Extension Module) === Overview http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_filter.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_filter.adoc b/src/site/asciidoc/extensions/mod_filter.adoc index 1b810b8..9b3cd0f 100644 --- a/src/site/asciidoc/extensions/mod_filter.adoc +++ b/src/site/asciidoc/extensions/mod_filter.adoc @@ -17,29 +17,9 @@ = Apache Tamaya -- Extension: Integration with etcd (Core OS) -:name: Tamaya -:rootpackage: org.apache.tamaya.filter -:title: Apache Tamaya Extension: Progrmmatic filtering of config entries -:revdate: January 2016 -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: - -''' - -<<< - toc::[] -<<< -:numbered!: -<<< + [[Optional]] == COnfiguration Filtering (Extension Module) === Overview http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_formats.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_formats.adoc b/src/site/asciidoc/extensions/mod_formats.adoc index 951cf4e..4905586 100644 --- a/src/site/asciidoc/extensions/mod_formats.adoc +++ b/src/site/asciidoc/extensions/mod_formats.adoc @@ -17,32 +17,9 @@ = Apache Tamaya -- Extension: Formats -:name: Tamaya -:rootpackage: org.apache.tamaya.ext.formats -:title: Apache Tamaya Extension: Formats -:revnumber: 0.1.1 -:revremark: Incubator -:revdate: March 2015 -:longversion: {revnumber} ({revremark}) {revdate} -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: - -''' - -<<< - toc::[] -<<< -:numbered!: -<<< + [[Core]] == Tamaya Formats (Extension Module) === Overview http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_functions.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_functions.adoc b/src/site/asciidoc/extensions/mod_functions.adoc index 9f3d930..041ef75 100644 --- a/src/site/asciidoc/extensions/mod_functions.adoc +++ b/src/site/asciidoc/extensions/mod_functions.adoc @@ -17,32 +17,8 @@ = Apache Tamaya -- Extension: Functions -:name: Tamaya -:rootpackage: org.apache.tamaya.functions -:title: Apache Tamaya Extension: Functions -:revnumber: 0.1.1 -:revremark: Incubator -:revdate: August 2015 -:longversion: {revnumber} ({revremark}) {revdate} -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: - -''' - -<<< - toc::[] -<<< -:numbered!: -<<< [[Core]] == Tamaya Functions (Extension Module) === Overview http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_injection.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_injection.adoc b/src/site/asciidoc/extensions/mod_injection.adoc index 2b31c16..4b85f3e 100644 --- a/src/site/asciidoc/extensions/mod_injection.adoc +++ b/src/site/asciidoc/extensions/mod_injection.adoc @@ -17,32 +17,9 @@ = Apache Tamaya -- Extension: Injection -:name: Tamaya -:rootpackage: org.apache.tamaya.ext.injection -:title: Apache Tamaya Extension: Injection -:revnumber: 0.1.1 -:revremark: Incubator -:revdate: March 2015 -:longversion: {revnumber} ({revremark}) {revdate} -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: - -''' - -<<< - toc::[] -<<< -:numbered!: -<<< + [[Core]] == Tamaya Injection (Extension Module) === Overview http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_jodatime.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_jodatime.adoc b/src/site/asciidoc/extensions/mod_jodatime.adoc index 0f7f1c9..6dd05b6 100644 --- a/src/site/asciidoc/extensions/mod_jodatime.adoc +++ b/src/site/asciidoc/extensions/mod_jodatime.adoc @@ -17,32 +17,8 @@ = Apache Tamaya -- Extension: JodaTime -:name: Tamaya -:rootpackage: org.apache.tamaya.ext.jodatime -:title: Apache Tamaya Extension: JodaTime -:revnumber: 0.1.1 -:revremark: Incubator -:revdate: April 2015 -:longversion: {revnumber} ({revremark}) {revdate} -:authorinitials: OBF -:author: Oliver B. Fischer -:email: <ple...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: - -''' - -<<< - toc::[] -<<< -:numbered!: -<<< [[Core]] == Tamaya JodaTime (Extension Module) http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_json.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_json.adoc b/src/site/asciidoc/extensions/mod_json.adoc index a851bcf..f85eb55 100644 --- a/src/site/asciidoc/extensions/mod_json.adoc +++ b/src/site/asciidoc/extensions/mod_json.adoc @@ -17,47 +17,9 @@ = Apache Tamaya -- Extension: Builder -:name: Tamaya -:rootpackage: org.apache.tamaya.json -:title: Apache Tamaya Extension: JSON -:revnumber: 0.1.1 -:revremark: Incubator -:revdate: March 2015 -:longversion: {revnumber} ({revremark}) {revdate} -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: -// 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. -''' - -<<< - toc::[] -<<< -:numbered!: -<<< + [[BuilderCore]] == Tamaya JSON (Extension Module) === Overview http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_management.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_management.adoc b/src/site/asciidoc/extensions/mod_management.adoc index 390c737..b9f8de0 100644 --- a/src/site/asciidoc/extensions/mod_management.adoc +++ b/src/site/asciidoc/extensions/mod_management.adoc @@ -17,32 +17,9 @@ = Apache Tamaya -- Extension: JMX Management Access -:name: Tamaya -:rootpackage: org.apache.tamaya.management -:title: Apache Tamaya Extension: JMX Management Access -:revnumber: 0.1 -:revremark: Incubator -:revdate: August 2015 -:longversion: {revnumber} ({revremark}) {revdate} -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: - -''' - -<<< - toc::[] -<<< -:numbered!: -<<< + [[ExtModel]] == Tamaya Management (JMX Support) (Extension Module) === Overview http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_metamodel-staged.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_metamodel-staged.adoc b/src/site/asciidoc/extensions/mod_metamodel-staged.adoc index b6dfd5a..9fb89c3 100644 --- a/src/site/asciidoc/extensions/mod_metamodel-staged.adoc +++ b/src/site/asciidoc/extensions/mod_metamodel-staged.adoc @@ -17,29 +17,9 @@ = Apache Tamaya -- Extension: Staged PropertySources -:name: Tamaya -:rootpackage: org.apache.tamaya.integration.cdi -:title: Apache Tamaya Extension: Staged PropertySources -:revdate: October 2015 -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: - -''' - -<<< - toc::[] -<<< -:numbered!: -<<< + [[Remote]] == Tamaya Metamodel: Staged PropertySources (Extension Module) === Overview http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_model.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_model.adoc b/src/site/asciidoc/extensions/mod_model.adoc index add7de9..b1cb3af 100644 --- a/src/site/asciidoc/extensions/mod_model.adoc +++ b/src/site/asciidoc/extensions/mod_model.adoc @@ -17,32 +17,9 @@ = Apache Tamaya -- Extension: Model Documentation and Validation -:name: Tamaya -:rootpackage: org.apache.tamaya.model -:title: Apache Tamaya Extension: Model Documentation and Validation -:revnumber: 0.1 -:revremark: Incubator -:revdate: August 2015 -:longversion: {revnumber} ({revremark}) {revdate} -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: - -''' - -<<< - toc::[] -<<< -:numbered!: -<<< + [[ExtModel]] == Tamaya Model Documentation and Validation (Extension Module) === Overview http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_mutable_config.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_mutable_config.adoc b/src/site/asciidoc/extensions/mod_mutable_config.adoc index cbe0e8d..a63c262 100644 --- a/src/site/asciidoc/extensions/mod_mutable_config.adoc +++ b/src/site/asciidoc/extensions/mod_mutable_config.adoc @@ -17,32 +17,9 @@ = Apache Tamaya -- Extension: Mutable Configuration -:name: Tamaya -:rootpackage: org.apache.tamaya.mutableconfig -:title: Apache Tamaya Extension: Mutable Configuration -:revnumber: 0.1 -:revremark: Incubator -:revdate: March 2016 -:longversion: {revnumber} ({revremark}) {revdate} -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: - -''' - -<<< - toc::[] -<<< -:numbered!: -<<< + [[Core]] == Tamaya Mutable Configuration (Extension Module) === Overview http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_optional.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_optional.adoc b/src/site/asciidoc/extensions/mod_optional.adoc index 6296f6b..369df68 100644 --- a/src/site/asciidoc/extensions/mod_optional.adoc +++ b/src/site/asciidoc/extensions/mod_optional.adoc @@ -17,32 +17,9 @@ = Apache Tamaya -- Extension: Optional Tamaya Configuration -:name: Tamaya -:rootpackage: org.apache.tamaya.optional -:title: Apache Tamaya Extension: Optional Tamaya Configuration -:revnumber: 0.1.1 -:revremark: Incubator -:revdate: March 2015 -:longversion: {revnumber} ({revremark}) {revdate} -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: - -''' - -<<< - toc::[] -<<< -:numbered!: -<<< + [[Optional]] == Tamaya Optional Configuration (Extension Module) === Overview http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_osgi.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_osgi.adoc b/src/site/asciidoc/extensions/mod_osgi.adoc index b44553d..52518a7 100644 --- a/src/site/asciidoc/extensions/mod_osgi.adoc +++ b/src/site/asciidoc/extensions/mod_osgi.adoc @@ -17,32 +17,9 @@ = Apache Tamaya -- Extensions: OSGI Integrations -:name: Tamaya -:rootpackage: org.apache.tamaya.osgi -:title: Apache Tamaya Extensions: OSGI Integration -:revnumber: 0.1.1 -:revremark: Incubator -:revdate: December 2015 -:longversion: {revnumber} ({revremark}) {revdate} -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: - -''' - -<<< - toc::[] -<<< -:numbered!: -<<< + [[Optional]] == Tamaya OSGI Support === Overview http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_remote.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_remote.adoc b/src/site/asciidoc/extensions/mod_remote.adoc index c4c1faf..d82b7ba 100644 --- a/src/site/asciidoc/extensions/mod_remote.adoc +++ b/src/site/asciidoc/extensions/mod_remote.adoc @@ -17,32 +17,9 @@ = Apache Tamaya -- Extension: Remote Configuration -:name: Tamaya -:rootpackage: org.apache.tamaya.remote -:title: Apache Tamaya Extension: Remote Configuration -:revnumber: 0.1.1 -:revremark: Incubator -:revdate: March 2015 -:longversion: {revnumber} ({revremark}) {revdate} -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: - -''' - -<<< - toc::[] -<<< -:numbered!: -<<< + [[Remote]] == Tamaya Remote Configuration (Extension Module) === Overview http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_resolver.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_resolver.adoc b/src/site/asciidoc/extensions/mod_resolver.adoc index fe0e774..96df765 100644 --- a/src/site/asciidoc/extensions/mod_resolver.adoc +++ b/src/site/asciidoc/extensions/mod_resolver.adoc @@ -19,21 +19,6 @@ include::temp-properties-files-for-site/attributes.adoc[] -:name: Tamaya -:rootpackage: org.apache.tamaya.ext.resolver -:title: Apache Tamaya Extension: Resolver -:revnumber: 0.1.1 -:revremark: Incubator -:revdate: March 2015 -:longversion: {revnumber} ({revremark}) {revdate} -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:encoding: UTF-8 -:numbered: - [[Core]] == Tamaya Resolver (Extension Module) http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_resources.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_resources.adoc b/src/site/asciidoc/extensions/mod_resources.adoc index b30dfa8..92fd240 100644 --- a/src/site/asciidoc/extensions/mod_resources.adoc +++ b/src/site/asciidoc/extensions/mod_resources.adoc @@ -19,21 +19,6 @@ include::temp-properties-files-for-site/attributes.adoc[] -:name: Tamaya -:rootpackage: org.apache.tamaya.ext.resources -:title: Apache Tamaya Extension: Resources -:revnumber: 0.1.1 -:revremark: Incubator -:revdate: March 2015 -:longversion: {revnumber} ({revremark}) {revdate} -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:encoding: UTF-8 -:numbered: - [[Core]] == Tamaya Resources (Extension Module) === Overview http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_server.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_server.adoc b/src/site/asciidoc/extensions/mod_server.adoc index 02dfe56..44398d7 100644 --- a/src/site/asciidoc/extensions/mod_server.adoc +++ b/src/site/asciidoc/extensions/mod_server.adoc @@ -1,21 +1,3 @@ -= Apache Tamaya -- Extension: Configuration Server - -:name: Tamaya -:rootpackage: org.apache.tamaya.server -:title: Apache Tamaya Extension: Configuration Server -:revnumber: 0.1.1 -:revremark: Incubator -:revdate: March 2015 -:longversion: {revnumber} ({revremark}) {revdate} -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: // 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 @@ -32,15 +14,12 @@ // KIND, either express or implied. See the License for the // specific language governing permissions and limitations // under the License. -''' -<<< += Apache Tamaya -- Extension: Configuration Server toc::[] -<<< -:numbered!: -<<< + [[Remote]] == Tamaya Configuration Server (Extension Module) === Overview http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_spi-support.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_spi-support.adoc b/src/site/asciidoc/extensions/mod_spi-support.adoc index 7194919..c507c1a 100644 --- a/src/site/asciidoc/extensions/mod_spi-support.adoc +++ b/src/site/asciidoc/extensions/mod_spi-support.adoc @@ -17,29 +17,9 @@ = Apache Tamaya -- Extension: Classloader Isolation Support -:name: Tamaya -:rootpackage: org.apache.tamaya.integration.cdi -:title: Apache Tamaya Extension: SPI Implementation Support Classes -:revdate: October 2015 -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: - -''' - -<<< - toc::[] -<<< -:numbered!: -<<< + [[SPISupport]] == Tamaya SPI Support (Extension Module) === Overview http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_spring.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_spring.adoc b/src/site/asciidoc/extensions/mod_spring.adoc index a1be554..5f6d65e 100644 --- a/src/site/asciidoc/extensions/mod_spring.adoc +++ b/src/site/asciidoc/extensions/mod_spring.adoc @@ -17,28 +17,9 @@ = Apache Tamaya -- Extension: Spring Integration -:name: Tamaya -:rootpackage: org.apache.tamaya.integration.spring -:title: Apache Tamaya Extension: Spring Integration -:revdate: November 2015 -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 - -''' - -<<< - toc::[] -<<< -:numbered!: -<<< + [[Remote]] == Tamaya Spring Integration (Extension Module) === Overview http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/extensions/mod_yaml.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/extensions/mod_yaml.adoc b/src/site/asciidoc/extensions/mod_yaml.adoc index f5560b9..61b5fb3 100644 --- a/src/site/asciidoc/extensions/mod_yaml.adoc +++ b/src/site/asciidoc/extensions/mod_yaml.adoc @@ -17,47 +17,9 @@ = Apache Tamaya -- Extension: Builder -:name: Tamaya -:rootpackage: org.apache.tamaya.yaml -:title: Apache Tamaya Extension: YAML -:revnumber: 0.1 -:revremark: Incubator -:revdate: March 2016 -:longversion: {revnumber} ({revremark}) {revdate} -:authorinitials: ATR -:author: Anatole Tresch -:email: <anat...@apache.org> -:source-highlighter: coderay -:website: http://tamaya.incubator.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: -// 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. -''' - -<<< - toc::[] -<<< -:numbered!: -<<< + [[BuilderCore]] == Tamaya YAML (Extension Module) === Overview http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/history.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/history.adoc b/src/site/asciidoc/history.adoc index d99979f..9fe1d8f 100644 --- a/src/site/asciidoc/history.adoc +++ b/src/site/asciidoc/history.adoc @@ -20,7 +20,7 @@ include::temp-properties-files-for-site/attributes.adoc[] :linkattrs: true -= Release History of Tamaya +== Release History of Tamaya Overview off all released versions of Apache Tamaya. http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/misc/PossibleContributions.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/misc/PossibleContributions.adoc b/src/site/asciidoc/misc/PossibleContributions.adoc index 095a276..23840c2 100644 --- a/src/site/asciidoc/misc/PossibleContributions.adoc +++ b/src/site/asciidoc/misc/PossibleContributions.adoc @@ -1,31 +1,26 @@ -Apache Tamaya - Possible Tasks -============================== -:name: Tamaya -:rootpackage: org.apache.tamaya -:title: Apache Tamaya -:revnumber: 0.1-SNAPSHOT -:revremark: Draft -:revdate: October 2014 -:longversion: {revnumber} ({revremark}) {revdate} -:authorinitials: ATR -:author: Anatole Tresch -:email: <atsti...@gmail.com> -:source-highlighter: coderay -:website: http://tamaya.apache.org/ -:toc: -:toc-placement: manual -:encoding: UTF-8 -:numbered: - -''' - -<<< - --> add image : : https://raw.githubusercontent.com/JavaConfig/config-api/master/src/main/asciidoc/images/javaconfig.jpg[] +// 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[] toc::[] -<<< += Apache Tamaya - Possible Tasks + :numbered!: ----------------------------------------------------------- Licensed to the Apache Software Foundation (ASF) under one http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/quickstart.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/quickstart.adoc b/src/site/asciidoc/quickstart.adoc index 3e1c53b..8dc342b 100644 --- a/src/site/asciidoc/quickstart.adoc +++ b/src/site/asciidoc/quickstart.adoc @@ -17,7 +17,7 @@ include::temp-properties-files-for-site/attributes.adoc[] -= Apache Tamaya Quickstart +== Apache Tamaya Quickstart The fastest way to start with Tamaya is just using the _Core_ implementation, implementing the **API** in small, minimalistic way. For that add the following @@ -51,7 +51,7 @@ These modules doe not depend on core, so alternative implementations of the Tamaya API should work similarly. -== Multiple configuration files +=== Multiple configuration files By default you can provide multiple `javaconfig.properties` files, e.g. as part of multiple jars loaded into your system. The system internally creates one @@ -86,14 +86,14 @@ tamaya.ordinal=123 This assigns an ordinal of 123 to each entry in that configuration resource. -== Using additional features of Tamaya +=== Using additional features of Tamaya There many modules that extend the capabilities of Tamaya. These modules doe not depend on core, so alternative implementations of the Tamaya API should work similarly. Following a small extract of most important modules available (or available soon): -=== Dynamic Resolution and Value Placeholders +==== Dynamic Resolution and Value Placeholders [source,xml,subs="verbatim,attributes"] ---- @@ -117,7 +117,7 @@ String resolved = Resolver.evaluateExpression(myExpression); ---- -=== Ant-styled Path Resolution of Resources +==== Ant-styled Path Resolution of Resources [source,xml,subs="verbatim,attributes"] ---- @@ -141,7 +141,7 @@ Collection<URL> urls = ResourceResolver.getResources("META-INF/cfg/**/*.properti For further details refer to the module documentation. -=== Configuration Injection +==== Configuration Injection [source,xml,subs="verbatim,attributes"] ---- @@ -203,9 +203,3 @@ Currently the following resolvers are available: |=== - -// @todo -//Look [here][1] For further documentation on available extension modules. - - -// [1]: documentation/modules.html http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/release-guide.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/release-guide.adoc b/src/site/asciidoc/release-guide.adoc index 49e017e..73f480f 100644 --- a/src/site/asciidoc/release-guide.adoc +++ b/src/site/asciidoc/release-guide.adoc @@ -15,15 +15,15 @@ // specific language governing permissions and limitations // under the License. -= Apache Tamaya -- Release Guide - include::temp-properties-files-for-site/attributes.adoc[] +== Apache Tamaya -- Release Guide + Performing a release requires several steps. This document describes each step, so everybody in the committer's team should be able to perform the release procedure. -== Tell the others you would proceed with the release procedure +=== Tell the others you would proceed with the release procedure [listing,text] ---------------------------------------- @@ -39,7 +39,7 @@ team should be able to perform the release procedure. ---------------------------------------- -== Check everything is ready +=== Check everything is ready * Check the jenkins builds. * Ensure all JIRA-tickets targeting the release are resolved. If not, get in contact with the ticket @@ -48,7 +48,7 @@ team should be able to perform the release procedure. ** how long it takes to resolve it and if one can help. -== Prepare the release +=== Prepare the release * Create release notes and commit them to `tamaya/readme/` (format `ReleaseNotes-[version].html`) * Create a release branch in git and switch to this branch: @@ -111,7 +111,7 @@ git push * Check contents on https://dist.apache.org/repos/dist/dev/incubator/tamaya/[version] -== Start the vote +=== Start the vote [listing,text] ---------------------------------------- @@ -213,7 +213,7 @@ If the binding majority approved the vote continue: ---------------------------------------- -== Updating the Tamaya Project Site +=== Updating the Tamaya Project Site Currently Tamaya's Site located at https://svn.apache.org/repos/asf/incubator/tamaya/site/trunk must be updated manually. This should change in the future (then a simple mvn site site:deploy) should be sufficient. This http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/source.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/source.adoc b/src/site/asciidoc/source.adoc index ab33754..39837f9 100644 --- a/src/site/asciidoc/source.adoc +++ b/src/site/asciidoc/source.adoc @@ -17,8 +17,7 @@ include::temp-properties-files-for-site/attributes.adoc[] - -= Sources of Apache Tamaya +== Sources of Apache Tamaya The current source code can be found at: @@ -33,4 +32,4 @@ The GitHub mirror also provides the project as downloadable zip archive. == Contributions If you like to contribute to Apache Tamaya please also refer also to our -<<devguide/index.adoc#contributing-workflow,section on contributing to Apache Tamaya>>. \ No newline at end of file +<<devguide.adoc#contributing-workflow,section on contributing to Apache Tamaya>>. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/usecases.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/usecases.adoc b/src/site/asciidoc/usecases.adoc new file mode 100644 index 0000000..a82f6b7 --- /dev/null +++ b/src/site/asciidoc/usecases.adoc @@ -0,0 +1,273 @@ +// 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 -- Use Cases + +toc::[] + + +=== Simple Access + +Users want to be able to access configuration in a unified way both in SE and EE. EE may provide additional +mechanism, such as injection, but the SE mechanisms should work as well, so any code written in SE is fully +portable to EE as well. +This can only be achieved by providing a static accessor, e.g. + +[source,java] +------------------------------------------------------------ +Configuration config = Configuration.current(); +------------------------------------------------------------ + +The call above should work exactly the same in EE. To enable this the static call must be delegated in the +internals of the singleton, depending on the runtime. In EE the executing component can behave contextually, +or even be loaded within the CDI environment (at least for post loading, application runtime aspects, but not earlier). + +Additionally in EE it should also be possible to inject Configuration, which gives you the same results as the call +above: + +[source,java] +------------------------------------------------------------ +@Inject +private Configuration cfg; +------------------------------------------------------------ + + +=== Simple Lookup of Properties + +Users just want to create a configuration ad hoc, from given property files. The +files could be locally in the file system, on the classpath. + +Tamaya should provide a simple Java API for accessing key/value based configuration. Hereby users want to access +properties as simple String values. + +Hereby returning Java 8 Optional values must be considered as well, instead of returning +null+. + + +=== Value Placeholders + +Users just want to to be able to add placeholders to the values of configuration (not the keys). The mechanisms for +resolving the placeholders hereby should be not constraint to one single lanmguage like EL. Instead of different +replacement strategies should be selectable, e.g. by prefixing an expression with the name of the resolver that +should do the work (eg +"blabla ${env:HOME} using Java version ${sys:java.version}."+. +This allows resolution mechanism to be isolated easily and also allows to use simpler mechanisms, if no more complex +ones like EL are required. This is especially useful to deal with low resource environment like ME. + + +=== Type Safe Properties + +Users just want to access properties not only as Strings, but let Tamaya do the conversion to the required +or the configred target type. By defauklt all java.lang wrapper and primitive types should be supported, but also +other common types like date/time types, math numeric types and more. + +It must be possible that users can register their own custom types. + +Finally users also want to be able to dynamically provide or override type adaption (conversion), when reading a value, +for a certain key/value pair. + + +=== Configuration Templates + +Users want to be able to let Tamaya implement an interface template based on configuration. +This use case is pretty similar to the injection use case. Basically the values are not injected, +but cached within the template proxy returned, e.g. as +DynamicValue+. +Similarly it could even be possible to define callback methods (default methods) +or register listeners to DynamicValue instances returned. + +Templates hereby can easily be managed, but provide a excellent mechanism to provide type-safe configuration +to clients in a very transparent way. Details can be controlled by using the same annotations as for +normal configuration injection. + + +=== Java 8 Functional Support + +Users want to be able to benefit from the new programming styles introduced with Java 8. Configuration +should provide extension points for different aspects, where additional code can be hooked in easily. +In short: were possible functional interfaces should be modelled. + +Examples: + +* code that converts a configuration to another kind of configuration: +UnaryOperator<Configuration>+ +* code that creates any kind of result based on a configuration: +Function<Configuration,T>+ +* Adapters for type conversion are defined as +Function<String,T>+ +* Key, value filters ccan be modelled as +BiFunction<String,String,String>+ +* etc. + + +=== Configuration Locations + +Users want to be able to + +* read configuration from different locations. +* By default classpath and file resources are + supported. But similarly remote access using a JSON ReST call should be possible. +* Tamaya should define a JSON and XML format for configuration. +* Configuration locations should be scannable using ant-styled resource patterns, if possible. +* Scanning and reading logic can be modularized by using a +ConfigReader+ interface. + + +=== Configuration Formats + +Users want to be able to use the format they prefer. + +* properties, xml-properties and ini-format should be supported by default +* Other/custom formats should be easily addable by registering or providing the format on configuration evaluation (read). +* When possible Tamaya should figure out which format to be used and how the InputStream should be correctly + interpreted. + + +=== Multiple Configurations + +When systems grow they must be modularized to keep control. Whereas that sounds not really fancy, it leads to additional +aspects to be considered by a configuration system. + +* Different code modules, libraries, plugins or products want to have their "own" separated configuration. +* Similar it should be possible to add fully specific additional configurations. + +The default configuration hereby should always be present, whereas additional configurations are optional. +Users want to be able to check the availability of such an additional configuration. + +Of course, additional configuration must be identifiable. The best way to do is to be discussed, nevertheless the +mechanism must not depend on Java EE and the identifying keys must be serializable easily. +Basically simple names are sufficient and woukld provide exact this required functionality. + + +=== External Configuration + +Users want to be able to replace, override, extend or adapt any parts or all of an existing configuration from +external sources. +This also must be the case for multi-context environments, where the context identifiers are +the only way to link to the correct remote configuration. + + +=== Context Dependent Configuration + +In multi tenancy setups or complex systems a hierarchical/graph model of contexts for configurations is required, or different runtime contexts are executed in parallel +within the same VN. What sounds normal for EE also may be the case for pure SE environments: + +* Users want to be able to model different layers of runtime context +* Users want to identiofy the current layer, so configuration used may be adapted. + + + +=== Dynamic Provisioning (UC8) + +In Cloud Computing, especially the PaaS and SaaS areas a typical use case would be that an application (or server) +is deployed, configured and started dynamically. Typically things are controlled by some "active controller components", +which are capable of + +* creating new nodes (using IaaS services) +* deploying and starting the required runtime platform , e.g. as part of a PaaS solution. +* deploying and starting the application modules. + +All these steps require some kind of configuration. As of today required files are often created on the target node +before the systems are started, using proprietary formats and mechanism. Similarly accessing the configuration in place +may require examining the file system or using again proprietary management functions. Of course, a configuration +solution should not try to solve that, but it can provide a significant bunch of functionality useful in such scenarios: + +* provide remote capabilities for configuration +* allow configuration to be updated remotely. +* allow client code to listen for configuration changes and react as needed. + + +=== Minimal Property Source SPI + +Users expect that implementing an additional configuration property source is as easy as possible. +So there should be an SPI defined that allows any kind of data source to be used for providing configuration data. +The interface to be implemented is expected to be minimal to reduce the implementation burden. Default +methods should be used where possible, so only a few methods are expected to be required to implement. + + +=== Scannable Properties + +If possible configuration should be scannable, meaning it should be possible to evaluate the keys available. +The corresponding capabilities should be accessible by a +isScannable()+ method. + + +=== Combine Configurations + +Users want to be able to combine different configurations to a new configuration instance. +Hereby the resulting configuration can be + +* a union of both, ignoring duplicates (and optionally log them) +* a union of both, duplicates are ignored +* a union of both, conflicts are thrown as ConfigException +* an intersection of both, containing only keys present and equal in both configurations +* an arbitrary mapping or filter, modelled by an +CombinationPolicy+, which basically can be modelled + as +BiFunction<String, String, String>+, hereby + ** a result of +null+ will remove the key + ** any other result will use the value returned as final value of the combination. + + +=== MX/ReST Management + +Users want to be have comprehensive management support, which should allow + +* to change configuration +* to remove configuration +* to view configuration and its provider details + + +=== Adaptable Service Context + +Tamaya should support an adaptable +ServiceContext+ to resolve any kind of implememntation services, both API services as core +framework services. The +ServiceContext+ should be dynamically replecable by configuring an alternate instance of +using the Java *ServiceContet+. + +This decouples component usage from its load and management part and als greatly simplifies integration with +new/alternate runtime environments. +The service context is exptected to provide + +* single singleton instances: these service can be cached. +* access to multiple instances which implement some commons SPI interface. +* as useful priorization of components is done by the model itself. + + +=== Configuration Injection + +Users want to be able to polulate configured items by injecting configured values. Hereby + +* the lifecycle of the instances is not managed by Tamaya +* all references to items configured are managed as weak references, to prevent memoryleaks. +* Injection should if possible evaluate the properties by defaults. Even properties without + any annotations are possible. +* Users expect to exclude certain properties from calculation +* Beside injection of properties it is also possible to call setter methods with one parameter similarly. +* Basically injection is performed, when the instance is passed to the Tamaya configuration system. It should also + be possible to inject/provide final values, especially Strings. Changes on configured values should be + reflected in the current value. Setters methods similarly can be called again, with the new values, on changes. +* Users expect to control dynamic values and recall of setter methods, basically the following strategies should be + supported: + ** inject only once and ignore further changes. + ** reinject/reinitialize on each change + +* Dynamic Values can easily be modeled as +ConfiguredValue+ instances, which should have the following functionality: + ** access the current value + ** access the new value + ** access the latest value access time in ms + ** access the latest value update time in ms + ** evaluate easily if the value has changed since the last access + ** accept the change + *** as a shortcut it should be possible to accept the change on access of the value implicitly, hereby always accessing + the latest valid value. + ** ignore the change + ** register +Consumer<DynamicValue>+ liasteners to listen on the changes (ans also removing them later again). + +All observing functionality can be done completely asynchronously and in parallel. + + http://git-wip-us.apache.org/repos/asf/incubator-tamaya/blob/fbda5b8e/src/site/asciidoc/userguide.adoc ---------------------------------------------------------------------- diff --git a/src/site/asciidoc/userguide.adoc b/src/site/asciidoc/userguide.adoc new file mode 100644 index 0000000..86a3602 --- /dev/null +++ b/src/site/asciidoc/userguide.adoc @@ -0,0 +1,36 @@ +// 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 -- User Guide + +This user guide contains detailed documentation on Tamaya's architecture, design and core API. Also included are +references to additional project documentation such as use cases and derived requirements. + +toc::[] + + +include::usecases.adoc[] + +include::Requirements.adoc[] + +include::HighLevelDesign.adoc[] +include::API.adoc[] +include::Core.adoc[] + +include::examples.adoc[] \ No newline at end of file
